Merge pull request #6258 from EnterpriseDB/mtk/unquoted_pw

MTK: added note on unquoted password for toolkit-properties

product_docs/docs/migration_toolkit/55/06_building_toolkit.properties_file.mdx

@@ -1,6 +1,6 @@
 ---
 title: "Specifying connection properities"
-
+DeepToC: true
 ---
 
 <div id="building_toolkit_properties_file" class="registered_link"></div>
@@ -21,20 +21,20 @@ Before executing Migration Toolkit commands, modify the `toolkit.properties` fil
 
 -   `SRC_DB_URL` specifies how Migration Toolkit connects to the source database. Details on forming the URL for each source database follows.
 -   `SRC_DB_USER` specifies a user name (with sufficient privileges) in the source database.
--   `SRC_DB_PASSWORD` specifies the password of the source database user.
--   `TARGET_DB_URL` specifies the JDBC URL of the target database.
+-   `SRC_DB_PASSWORD` specifies the password of the source database user. Provide the password without any surrounding quotes.
+-   `TARGET_DB_URL` specifies the JDBC URL of the target database. 
 -   `TARGET_DB_USER` specifies the name of a privileged target database user.
--   `TARGET_DB_PASSWORD` specifies the password of the target database user.
+-   `TARGET_DB_PASSWORD` specifies the password of the target database user. Provide the password without any surrounding quotes.
 
 !!! Note
 
     Unless specified in the command line, Migration Toolkit expects the source database to be Oracle and the target database to be EDB Postgres Advanced Server. For any other source or target database, specify the `-sourcedbtype` or `-targetdbtype` options as described in [Migrating from a non-Oracle source database](/migration_toolkit/latest/07_invoking_mtk/#migrating-schemas-from-a-non-oracle-source-database).
 
-For specifying a target database on BigAnimal, see [Defining a BigAnimal URL](#defining-a-biganimal-url).
+For specifying a target database on Cloud Service, see [Defining the URL and configuring the required parameters for Cloud Service](#url-and-parameters-for-cloud-service).
 
 <div id="define_epas_url" class="registered_link"></div>
 
-## Defining an Advanced Server URL
+## URL and parameters for an Advanced Server
 
 Migration Toolkit helps with migration from the following platforms to Advanced Server:
 
@@ -70,13 +70,15 @@ An Advanced Server URL contains the following information:
 
 -   `<database_id>` — The name of the source or target database.
 
+Ensure these values are set in the `toolkit.properties` file:
+
 -   `{TARGET_DB_USER|SRC_DB_USER}` — Specifies a user with privileges to create each type of object migrated. If migrating data into a table, the specified user might also require insert, truncate, and references privileges for each target table.
 
--   `{TARGET_DB_PASSWORD|SRC_DB_PASSWORD}` — Set to the password of the privileged Advanced Server user.
+-   `{TARGET_DB_PASSWORD|SRC_DB_PASSWORD}` — Set to the password of the privileged Advanced Server user. Provide the password without any surrounding quotes.
 
 <div id="define_pg_url" class="registered_link"></div>
 
-## Defining a PostgreSQL URL
+## URL and parameters for PostgreSQL
 
 Migration Toolkit helps with migration from the following platforms to PostgreSQL:
 
@@ -111,15 +113,17 @@ The URL contains the following information:
 
 -   `<database_id>` — The name of the source or target database.
 
+Ensure these values are set in the `toolkit.properties` file:
+
 -   `{SRC_DB_USER|TARGET_DB_USER}` — Specify a user with privileges to create each type of object migrated. If migrating data into a table, the specified user might also need insert, truncate, and references privileges for each target table.
 
--   `{SRC_DB_PASSWORD|TARGET_DB_PASSWORD}` — Set to the password of the privileged PostgreSQL user.
+-   `{SRC_DB_PASSWORD|TARGET_DB_PASSWORD}` — Set to the password of the privileged PostgreSQL user. Provide the password without any surrounding quotes.
 
 <div id="define_oracle_url" class="registered_link"></div>
 
-## Defining a BigAnimal URL
+## URL and parameters for Cloud Service
 
-Migration Toolkit helps with migration from the following platforms to BigAnimal:
+Migration Toolkit helps with migration from the following platforms to Cloud Service:
 
 -   Oracle
 -   Advanced Server
@@ -133,15 +137,15 @@ Migration Toolkit reads connection specifications for the source and the target
 -   The name of a privileged user
 -   The password associated with the specified user
 
-When migrating to BigAnimal, `TARGET_DB_URL` takes the form of a JDBC URL. For example:
+When migrating to Cloud Service, `TARGET_DB_URL` takes the form of a JDBC URL. For example:
 
 ```text
 jdbc:<postgres_type>://<host_name>[:<port>]/<database_id>?sslmode=<sslmode>
 ```
 
 !!!Note
 
-Many of the values you need for the target database URL are available from the BigAnimal portal. In BigAnimal, select your cluster and go to the **Connect** tab to find the values. 
+Many of the values you need for the target database URL are available from the Cloud Service portal. In Cloud Service, select your cluster and go to the **Connect** tab to find the values. 
 !!!
 
 The URL contains the following information:
@@ -150,19 +154,21 @@ The URL contains the following information:
 
 -   `postgres_type` — The subprotocol is the Postgres type. Specify `edb` if you're using Advanced Server or `postgresql` if you're using PostgreSQL. 
 
--   `<host_name>` — The host name of your cluster. You can copy it from the **Host** field on the **Connect** tab in the BigAnimal portal.
+-   `<host_name>` — The host name of your cluster. You can copy it from the **Host** field on the **Connect** tab in the Cloud Service portal.
 
--   `<port>` — The port number that the database listener is monitoring. You can copy it from the **Port** field on the **Connect** tab in the BigAnimal portal.
+-   `<port>` — The port number that the database listener is monitoring. You can copy it from the **Port** field on the **Connect** tab in the Cloud Service portal.
 
--   `<database_id>` — The name of the target database.  Set this to the name of the database in your cluster that you want to use as your migration target database.  The name of the default database for your cluster is shown in the **Dbname** field on the **Connect** tab in the BigAnimal portal.  Often a separate database is created for use as the migration target. 
+-   `<database_id>` — The name of the target database.  Set this to the name of the database in your cluster that you want to use as your migration target database.  The name of the default database for your cluster is shown in the **Dbname** field on the **Connect** tab in the Cloud Service portal.  Often a separate database is created for use as the migration target.
 
--   `TARGET_DB_USER` — Specifies the name of a privileged database user. You can copy it from the **User** field on the **Connect** tab in the BigAnimal portal.
+-   `sslmode` — Either "require" or "verify-full". See [Recommended settings for SSL mode](/edb-postgres-ai/cloud-service/using_cluster/connect_from_a_client/#recommended-settings-for-ssl-mode). Listed at the end of the **Service URI** value on the **Connect** tab in the Cloud Service portal.
 
--   `TARGET_DB_PASSWORD` — Contains the password of the specified user. 
+Ensure these values are set in the `toolkit.properties` file:
 
--   `sslmode` — Either "require" or "verify-full". See [Recommended settings for SSL mode](/edb-postgres-ai/cloud-service/using_cluster/connect_from_a_client/#recommended-settings-for-ssl-mode). Listed at the end of the **Service URI** value on the **Connect** tab in the BigAnimal portal.
+-   `TARGET_DB_USER` — Specifies the name of a privileged database user. You can copy it from the **User** field on the **Connect** tab in the Cloud Service portal.
 
-## Defining an Oracle URL
+-   `TARGET_DB_PASSWORD` — Contains the password of the specified user. Provide the password without any surrounding quotes.
+
+## URL and parameters for Oracle
 
 Migration Toolkit helps with migration from an Oracle database to a PostgreSQL or Advanced Server database. When migrating from Oracle, you must specify connection specifications for the Oracle source database in the `toolkit.properties` file. The connection information must include:
 
@@ -198,6 +204,8 @@ An Oracle URL contains the following information:
 
 -   `<service_name>` — The name of the Oracle service.
 
+Ensure these values are set in the `toolkit.properties` file:
+
 -   `SRC_DB_USER` — Specifies the name of a privileged Oracle user. The Oracle user needs read access to the source database objects you want to migrate. If you want to migrate users/roles and related profiles/privileges, grant the Oracle user SELECT privileges on the following Oracle catalog objects:
 
     -   `DBA_ROLES`
@@ -209,11 +217,11 @@ An Oracle URL contains the following information:
     -   `DBA_SYS_PRIVS`
 
 
--   `SRC_DB_PASSWORD` — Contains the password of the specified user.
+-   `SRC_DB_PASSWORD` — Contains the password of the specified user. Provide the password without any surrounding quotes.
 
 <div id="define_mysql_url" class="registered_link"></div>
 
-## Defining a SQL Server URL
+## URL and parameters for an SQL Server
 
 Migration Toolkit helps with migration from an SQL Server database to a PostgreSQL or Advanced Server database. Migration Toolkit supports migration of the following object definitions:
 
@@ -251,9 +259,11 @@ A SQL server URL contains the following information:
 
 -   `<database_id>` — The name of the source database.
 
+Ensure these values are set in the `toolkit.properties` file:
+
 -   `SRC_DB_USER` — Specifies the name of a privileged SQL Server user.
 
--   `SRC_DB_PASSWORD` — Contains the password of the specified user.
+-   `SRC_DB_PASSWORD` — Contains the password of the specified user. Provide the password without any surrounding quotes.
 
 ### JTDS URL
 
@@ -279,11 +289,13 @@ A SQL server URL contains the following information:
 
 -   `<database_id>` — The name of the source database.
 
+Ensure these values are set in the `toolkit.properties` file:
+
 -   `SRC_DB_USER` — Specifies the name of a privileged SQL Server user.
 
--   `SRC_DB_PASSWORD` — Contains the password of the specified user.
+-   `SRC_DB_PASSWORD` — Contains the password of the specified user. Provide the password without any surrounding quotes.
 
-## Defining a MySQL URL
+## URL and parameters for MySQL
 
 Migration Toolkit helps with migration from a MySQL database to an Advanced Server or PostgreSQL database. When migrating from MySQL, you must specify connection specifications for the MySQL source database in the `toolkit.properties` file. The connection information must include:
 
@@ -309,9 +321,11 @@ The URL contains the following information:
 
 -   `<database_id>` — The name of the source database.
 
+Ensure these values are set in the `toolkit.properties` file:
+
 -   `SRC_DB_USER` — Specifies the name of a privileged MySQL user.
 
--   `SRC_DB_PASSWORD` — Contains the password of the specified user.
+-   `SRC_DB_PASSWORD` — Contains the password of the specified user. Provide the password without any surrounding quotes.
 
 !!! Note
 
@@ -333,7 +347,7 @@ In this case, the JDBC driver reports `TINYINT(1)` as `TINYINT` and is mapped to
 
 <div id="define_sybase_url" class="registered_link"></div>
 
-## Defining a Sybase URL
+## URL and parameters for Sybase
 
 Migration Toolkit helps with migration from a Sybase database to an Advanced Server database. When migrating from Sybase, you must specify connection specifications for the Sybase source database in the `toolkit.properties` file. The connection information must include:
 
@@ -365,6 +379,8 @@ A Sybase URL contains the following information:
 
 -   `<database_id>` — The name of the source database.
 
+Ensure these values are set in the `toolkit.properties` file:
+
 -   `SRC_DB_USER` — Specifies the name of a privileged Sybase user.
 
--   `SRC_DB_PASSWORD` — Contains the password of the specified user.
+-   `SRC_DB_PASSWORD` — Contains the password of the specified user. Provide the password without any surrounding quotes.

product_docs/docs/migration_toolkit/55/09_mtk_errors.mdx

@@ -117,7 +117,7 @@ Check the connectivity credentials.
 
 The JDBC URL for the target database (EDB Postgres Advanced Server) specified in the `toolkit.properties` file contains invalid connection properties.
 
-To resolve this error, edit the `toolkit.properties` file, specifying valid connection information for the target database in the `TARGET_DB_URL` property. For information about forming a JDBC URL for EDB Postgres Advanced Server, see [Defining an EDB Postgres Advanced Server URL](06_building_toolkit.properties_file/#defining-an-advanced-server-url).
+To resolve this error, edit the `toolkit.properties` file, specifying valid connection information for the target database in the `TARGET_DB_URL` property. For information about forming a JDBC URL for EDB Postgres Advanced Server, see [Defining an EDB Postgres Advanced Server URL](06_building_toolkit.properties_file/#url-and-parameters-for-an-advanced-server).
 
 <div id="migration_errors" class="registered_link"></div>