Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] voyager-1.7.2 changes #23116

Merged
merged 3 commits into from
Jul 4, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ When you run an assessment, Voyager collects metadata or metrics from the source
The recommendations are based on testing using a [RF3](../../../architecture/docdb-replication/replication/#replication-factor) YugabyteDB cluster on instance types with 4GiB memory per core and running v2024.1.
{{< /warning >}}

Note that if providing database access to the client machine running Voyager is not possible, you can gather metadata from the source database using the provided bash scripts and then use Voyager to assess the migration. Currently, these scripts require the machine to have Voyager installed due to dependencies (like psql, sqlplus clients, and so on) included with Voyager. Standalone installers are planned to be provided for these dependencies in the future.
Note that if providing database access to the client machine running Voyager is not possible, you can gather metadata from the source database using the provided bash scripts and then use Voyager to assess the migration.

The following table describes the type of data that is collected during a migration assessment.

Expand Down Expand Up @@ -136,12 +136,6 @@ A sample Migration Assessment report for PostgreSQL is as follows:
CREATE USER ybvoyager IDENTIFIED BY password;
GRANT CONNECT TO ybvoyager;
GRANT <SCHEMA_NAME>_reader_role TO ybvoyager;
```

If you're using [accelerated data export](#accelerate-data-export-for-mysql-and-oracle), run the additional grant as follows:

```sql
GRANT FLASHBACK ANY TABLE TO ybvoyager;
```

{{% /tab %}}
Expand All @@ -161,7 +155,7 @@ A sample Migration Assessment report for PostgreSQL is as follows:

1. **Without source database connectivity**: In situations where direct access to the source database is restricted, there is an alternative approach. Voyager includes packages with scripts for both PostgreSQL and Oracle present at `/etc/yb-voyager/gather-assessment-metadata`. You can perform the following steps for PostgreSQL with these scripts (similar for Oracle).
aishwarya24 marked this conversation as resolved.
Show resolved Hide resolved

1. Copy the scripts to a machine which has access to the source database.
1. On a machine which has access to the source database, copy the scripts and install dependencies psql, and pg_dump version 14 or later. Alternatively, you can install yb-voyager on the machine to automatically get the dependencies.
1. Run the `yb-voyager-pg-gather-assessment-metadata.sh` script by providing the source connection string, the schema names, path to a directory where metadata will be saved, and an optional argument of an interval to capture the IOPS metadata of the source (in seconds with a default value of 120). For example,

```sh
Expand All @@ -183,7 +177,7 @@ For the most accurate migration assessment, the source database must be actively

1. Create a target YugabyteDB cluster as follows:

1. Create a cluster in [Enhanced Postgres Compatibility Mode](/preview/releases/ybdb-releases/v2024.1/#highlights) based on the sizing recommendations in the assessment report.
1. Create a cluster in [Enhanced Postgres Compatibility Mode](/preview/releases/ybdb-releases/v2024.1/#highlights) based on the sizing recommendations in the assessment report. For a universe in YugabyteDB Anywhere, [enable the compatibility mode](/preview/releases/yba-releases/v2024.1/#highlights) by setting some flags on the universe.
1. Create a database with colocation set to TRUE.

```sql
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,10 @@ yb-voyager import data file --data-dir /dir/data-dir --file-table-map 'orders.cs
```

After new rows are added to `orders.csv`, use the following command to load them with the flags `--start-clean` and `--enable-upsert`.
Note: Ensure that tables on the target YugabyteDB database do not have secondary indexes. If a table has secondary indexes, using `--enable-upsert true` may lead to corruption of the indexes.

{{<warning title="Note">}}
Ensure that tables on the target YugabyteDB database do not have secondary indexes. If a table has secondary indexes, using `--enable-upsert true` may lead to corruption of the indexes.
{{</warning>}}

```sh
yb-voyager import data file --data-dir /dir/data-dir \
Expand Down
2 changes: 2 additions & 0 deletions docs/content/preview/yugabyte-voyager/migrate/postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Create a database user and provide the user with READ access to all the resource
SELECT 'GRANT SELECT ON ALL SEQUENCES IN SCHEMA ' || schema_name || ' TO ybvoyager;' FROM information_schema.schemata; \gexec
```

Note that on RDS, you may get "Permission Denied" errors for `pg_catalog tables` (such as pg_statistic). These errors do not affect the migration and can be ignored.

The `ybvoyager` user can now be used for migration.

If you want yb-voyager to connect to the source database over SSL, refer to [SSL Connectivity](../../reference/yb-voyager-cli/#ssl-connectivity).
4 changes: 3 additions & 1 deletion docs/content/preview/yugabyte-voyager/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ What follows are the release notes for the YugabyteDB Voyager v1 release series.

### New features

- Support for running [Assess Migration](../migrate/assess-migration/) against Oracle source database.
- Support for [Oracle Assess Migration Assessment](../migrate/assess-migration/) using assess-migration command.

### Enhancements

Expand All @@ -32,6 +32,8 @@ What follows are the release notes for the YugabyteDB Voyager v1 release series.
- Minimum recommendation for node cores is now 4.
- Improved recommendation logic based on experiments.

aishwarya24 marked this conversation as resolved.
Show resolved Hide resolved
- Optimized execution time of [get data-migration-report](../reference/data-migration/import-data/#get-data-migration-report) by 90% for large databases.

### Bug fixes

- Fixed a bug where `import-schema --continue-on-error true` could miss listing certain failed statements in `failed.sql`.
Expand Down