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

update and clean up migration docs #18527

Merged
merged 9 commits into from
May 20, 2024
Merged
6 changes: 0 additions & 6 deletions src/current/_data/redirects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,6 @@

# Pages undergoing maintenance

- destination: migration-overview.md
sources:
- migrate-from-oracle.md
temporary: true
versions: ['v21.2', 'v22.1', 'v22.2', 'v23.1']

# Renamed pages

- destination: admin-ui-overview.md
Expand Down
17 changes: 14 additions & 3 deletions src/current/_includes/v23.1/sidebar-data/migrate.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
]
},
{
"title": "Migration Tools",
"title": "MOLT Tools",
"items": [
{
"title": "Schema Conversion Tool",
Expand All @@ -18,7 +18,7 @@
]
},
{
"title": "MOLT Verify",
"title": "Verify",
"urls": [
"/${VERSION}/molt-verify.html"
]
Expand All @@ -28,7 +28,12 @@
"urls": [
"/${VERSION}/live-migration-service.html"
]
},
}
]
},
{
"title": "Third-Party Migration Tools",
"items": [
{
"title": "AWS DMS",
"urls": [
Expand Down Expand Up @@ -120,6 +125,12 @@
"/${VERSION}/migrate-from-mysql.html"
]
},
{
"title": "Migrate from Oracle",
"urls": [
"/${VERSION}/migrate-from-oracle.html"
]
},
{
"title": "Migration Strategy: Lift and Shift",
"urls": [
Expand Down
19 changes: 15 additions & 4 deletions src/current/_includes/v23.2/sidebar-data/migrate.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
]
},
{
"title": "Migration Tools",
"title": "MOLT Tools",
"items": [
{
"title": "Schema Conversion Tool",
Expand All @@ -18,13 +18,13 @@
]
},
{
"title": "MOLT Fetch",
"title": "Fetch",
"urls": [
"/${VERSION}/molt-fetch.html"
]
},
{
"title": "MOLT Verify",
"title": "Verify",
"urls": [
"/${VERSION}/molt-verify.html"
]
Expand All @@ -34,7 +34,12 @@
"urls": [
"/${VERSION}/live-migration-service.html"
]
},
}
]
},
{
"title": "Third-Party Migration Tools",
"items": [
{
"title": "AWS DMS",
"urls": [
Expand Down Expand Up @@ -126,6 +131,12 @@
"/${VERSION}/migrate-from-mysql.html"
]
},
{
"title": "Migrate from Oracle",
"urls": [
"/${VERSION}/migrate-from-oracle.html"
]
},
{
"title": "Migration Strategy: Lift and Shift",
"urls": [
Expand Down
19 changes: 15 additions & 4 deletions src/current/_includes/v24.1/sidebar-data/migrate.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
]
},
{
"title": "Migration Tools",
"title": "MOLT Tools",
"items": [
{
"title": "Schema Conversion Tool",
Expand All @@ -18,13 +18,13 @@
]
},
{
"title": "MOLT Fetch",
"title": "Fetch",
"urls": [
"/${VERSION}/molt-fetch.html"
]
},
{
"title": "MOLT Verify",
"title": "Verify",
"urls": [
"/${VERSION}/molt-verify.html"
]
Expand All @@ -34,7 +34,12 @@
"urls": [
"/${VERSION}/live-migration-service.html"
]
},
}
]
},
{
"title": "Third-Party Migration Tools",
"items": [
{
"title": "AWS DMS",
"urls": [
Expand Down Expand Up @@ -126,6 +131,12 @@
"/${VERSION}/migrate-from-mysql.html"
]
},
{
"title": "Migrate from Oracle",
"urls": [
"/${VERSION}/migrate-from-oracle.html"
]
},
{
"title": "Migration Strategy: Lift and Shift",
"urls": [
Expand Down
14 changes: 5 additions & 9 deletions src/current/cockroachcloud/migrations-page.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: Use the Schema Conversion Tool
summary: Use the Schema Conversion Tool to begin a database migration to CockroachDB.
title: Use the MOLT Schema Conversion Tool
summary: Use the MOLT Schema Conversion Tool to begin a database migration to CockroachDB.
toc: true
cloud: true
docs_area: migrate
---

{% capture version_prefix %}{{site.current_cloud_version}}/{% endcapture %}

The **Migrations** page on the CockroachDB {{ site.data.products.cloud }} Console features a **Schema Conversion Tool** that helps you:
The **Migrations** page on the CockroachDB {{ site.data.products.cloud }} Console features the MOLT Schema Conversion Tool. This tool helps you:

- Convert a schema from a PostgreSQL, MySQL, Oracle, or Microsoft SQL Server database for use with CockroachDB.
- [Export the converted schema.](#export-the-schema) {% include cockroachcloud/migration/sct-self-hosted.md %}
- Migrate directly to a CockroachDB {{ site.data.products.cloud }} database that uses the converted schema. You specify the target database and database owner when [migrating the schema](#migrate-the-schema).
- [Export the converted schema.](#export-the-schema) {% include cockroachcloud/migration/sct-self-hosted.md %}

{{site.data.alerts.callout_info}}
The **Migrations** page is used to convert a schema for use with CockroachDB and to create a new database that uses the schema. It does not include moving data to the new database. For details on all steps required to complete a database migration, see the [Migration Overview]({% link {{version_prefix}}migration-overview.md %}).
Expand Down Expand Up @@ -102,10 +102,6 @@ The dump file must be smaller than 4 MB. `INSERT` and `COPY` statements will be
<section class="filter-content" markdown="1" data-scope="postgres mysql">
### Use Credentials

{{site.data.alerts.callout_info}}
{% include feature-phases/preview.md %}
{{site.data.alerts.end}}

The Schema Conversion Tool can connect directly to a PostgreSQL or MySQL database to obtain the schema. To add a schema using credentials:

1. In step 2 of the **Add SQL Schema** dialog, click **Use Credential**. Select the credentials to use. If the list is empty, this is because no credentials have been created for the selected database type. You can [add credentials](#add-database-credentials) directly from the pulldown menu.
Expand All @@ -125,7 +121,7 @@ Credentials can be added for PostgreSQL and MySQL databases.
1. Provide the following information:
- A **Credential Name** to associate with the credentials.
- The **Dialect** of the database you are connecting to. Currently, PostgreSQL and MySQL are supported.
- The **Host** for accessing the database. For example, `migrations.cockroachlabs.com`. Local hosts such as `localhost` and `127.0.0.1` are not allowed.
- The **Host** (i.e., hostname or IP address) for accessing the database. Exclude the protocol (e.g., `tcp://`). For example, `migrations.cockroachlabs.com`. Local hosts such as `localhost` and `127.0.0.1` are not allowed.
- The **Port** for accessing the database.
- A valid **Username** and **Password** for accessing the database.
- The **Database Name** to access. The Schema Conversion Tool will obtain the schema for this database.
Expand Down
2 changes: 1 addition & 1 deletion src/current/v23.1/live-migration-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ docs_area: migrate
{% include feature-phases/preview.md %}
{{site.data.alerts.end}}

MOLT LMS (Live Migration Service) is used to perform a [live migration]({% link {{ page.version.version }}/migration-overview.md %}#minimal-downtime) to CockroachDB.
MOLT LMS (Live Migration Service) is used during a [live migration]({% link {{ page.version.version }}/migration-overview.md %}#minimal-downtime) to CockroachDB.
taroface marked this conversation as resolved.
Show resolved Hide resolved

The LMS is a self-hosted, horizontally scalable proxy that routes traffic between an application, a source database, and a target CockroachDB database. You use the LMS to control which database, as the "source of truth", is serving reads and writes to an application. You can optionally configure the LMS to [shadow production traffic](#shadowing-modes) from the source database and validate the query results on CockroachDB. When you have sufficiently tested your application and are confident with its consistency and performance on CockroachDB, you use the LMS to [perform the cutover](#perform-a-cutover) to CockroachDB.

Expand Down
6 changes: 3 additions & 3 deletions src/current/v23.1/migrate-from-oracle.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ docs_area: migrate
---

{{site.data.alerts.callout_danger}}
The instructions on this page require updates. We currently recommend [using AWS Database Migration Service (DMS) to migrate data]({% link {{ page.version.version }}/aws-dms.md %}) from Oracle to CockroachDB. You can also [migrate from CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}).
{{site.data.alerts.end}}
The instructions on this page are outdated. Use the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}?filters=oracle) to convert an Oracle schema into a compatible CockroachDB schema, and a tool such as [AWS Database Migration Service (DMS)]({% link {{ page.version.version }}/aws-dms.md %}) or [Qlik]({% link {{ page.version.version }}/qlik.md %}) to migrate data from Oracle to CockroachDB.

This page has instructions for migrating data from Oracle into CockroachDB by [importing]({% link {{ page.version.version }}/import.md %}) CSV files. Note that `IMPORT` only works for creating new tables. For information on how to add CSV data to existing tables, see [`IMPORT INTO`]({% link {{ page.version.version }}/import-into.md %}).
`IMPORT` is deprecated. To move data into CockroachDB, use [`IMPORT INTO`]({% link {{ page.version.version }}/import-into.md %}) or [`COPY FROM`]({% link {{ page.version.version }}/copy-from.md %}).
{{site.data.alerts.end}}

To illustrate this process, we use the following sample data and tools:

Expand Down
2 changes: 1 addition & 1 deletion src/current/v23.2/live-migration-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ docs_area: migrate
{% include feature-phases/preview.md %}
{{site.data.alerts.end}}

MOLT LMS (Live Migration Service) is used to perform a [live migration]({% link {{ page.version.version }}/migration-overview.md %}#minimal-downtime) to CockroachDB.
MOLT LMS (Live Migration Service) is used during a [live migration]({% link {{ page.version.version }}/migration-overview.md %}#minimal-downtime) to CockroachDB.

The LMS is a self-hosted, horizontally scalable proxy that routes traffic between an application, a source database, and a target CockroachDB database. You use the LMS to control which database, as the "source of truth", is serving reads and writes to an application. You can optionally configure the LMS to [shadow production traffic](#shadowing-modes) from the source database and validate the query results on CockroachDB. When you have sufficiently tested your application and are confident with its consistency and performance on CockroachDB, you use the LMS to [perform the cutover](#perform-a-cutover) to CockroachDB.

Expand Down
6 changes: 3 additions & 3 deletions src/current/v23.2/migrate-from-oracle.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ docs_area: migrate
---

{{site.data.alerts.callout_danger}}
The instructions on this page require updates. We currently recommend [using AWS Database Migration Service (DMS) to migrate data]({% link {{ page.version.version }}/aws-dms.md %}) from Oracle to CockroachDB. You can also [migrate from CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}).
{{site.data.alerts.end}}
The instructions on this page are outdated. Use the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}?filters=oracle) to convert an Oracle schema into a compatible CockroachDB schema, and a tool such as [AWS Database Migration Service (DMS)]({% link {{ page.version.version }}/aws-dms.md %}) or [Qlik]({% link {{ page.version.version }}/qlik.md %}) to migrate data from Oracle to CockroachDB.

This page has instructions for migrating data from Oracle into CockroachDB by [importing]({% link {{ page.version.version }}/import.md %}) CSV files. Note that `IMPORT` only works for creating new tables. For information on how to add CSV data to existing tables, see [`IMPORT INTO`]({% link {{ page.version.version }}/import-into.md %}).
Note that `IMPORT` is deprecated. To move data into CockroachDB, use [`IMPORT INTO`]({% link {{ page.version.version }}/import-into.md %}) or [`COPY FROM`]({% link {{ page.version.version }}/copy-from.md %}).
{{site.data.alerts.end}}

To illustrate this process, we use the following sample data and tools:

Expand Down