diff --git a/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/connecting_from_a_client.mdx b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/connecting_from_a_client.mdx new file mode 100644 index 00000000000..98bce62cff0 --- /dev/null +++ b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/connecting_from_a_client.mdx @@ -0,0 +1,146 @@ +--- +title: Connecting from a client app +--- + +You can connect to your cluster using the client of your choice including: +- [`psql`](http://postgresguide.com/utilities/psql.html) — terminal-based client for Postgres +- other common database drivers +- pgAdmin — desktop or web UI client to inspect, monitor, manage, and query your cluster's databases + + +## Recommended settings for SSL mode + +Different clients can have different default TLS/SSL modes (sslmode). For example, `psql` defaults to `prefer`, which means the client will attempt to establish a TLS connection but fall back to non-TLS if the server does not support it. In the `psql` example provided by EDB in the **Quick Connect** field, `sslmode` is explicitly set to `require`, which means the client will attempt a TLS connection and fail if the connection to the server can't be encrypted. + +For public connections and in most environments, EDB recommends setting `sslmode` to `verify-full`. This setting ensures that you connect to the server you specified and that the connection is encrypted. + +BigAnimal generates certificates with LetsEncrypt, a widely trusted certificate authority. Your client machine might already have a bundled CA certificate for LetsEncrypt, for example, at `/etc/ssl/certs/ca-certificates.crt` or `/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem`. If it doesn't, your client machine needs a [CA certificate for Let's Encrypt](https://letsencrypt.org/certificates/). Once the CA certificate is in place on your client machine, configure the `sslrootcert` parameter to its location and set the `sslmode` parameter to `verify-full` to verify the certificate to fully validate the connection. + +To view the encryption protocol being used for communication, [connect to the cluster using `psql`](#connect-to-your-cluster-using-psql) and use the `conninfo` meta-command. In the case of BigAnimal, TLS (v1.2+) is supported: + +``` +edb_admin=> \conninfo +You are connected to database "edb_admin" as user "edb_admin" on host "xxxxxxxxx.xxxxx.biganimal.io" at port "5432". +SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off) +``` + +## Connect to your cluster using `psql` or `edb-psql` + +!!!note + When connecting to a EDB Postgres Advanced Server database, use `edb-psql`. `edb-psql` is a symbolic link to a binary called `psql`, a modified version of the PostgreSQL community `psql`, with added support for EDB Postgres Advanced Server features. + +1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. + +2. Go to the [Clusters](https://portal.biganimal.com/clusters) page. + +3. Select the name of your cluster. + +4. On the **Overview** tab, select the copy icon to the right of the **Quick Connect** field to copy the command for connecting to your cluster using `psql` to your clipboard. `psql` prompts for the edb_admin user password you selected when you created the cluster. + +5. Paste the command in your terminal. + +## Connect to your cluster using common database drivers + +1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. + +2. Go to the [Clusters](https://portal.biganimal.com/clusters) page. + +3. Select the name of your cluster. + +4. Select the **Connect** tab. You can review and copy all the relevant information you need from this screen except for the edb_admin user password. + + Connection string examples for common database drivers using the recommended setting for SSL mode (consult the client driver documentation for more information): + + - #### libpq (psql or edb-psql) + + ``` + psql -W "postgres://edb_admin@xxxxxxxxx.xxxxx.biganimal.io:5432/edb_admin?sslmode=verify-full&sslrootcert=/usr/share/ca-certificates/ca-cert_name.pem" + ``` + + - #### JDBC for Java + + ``` + jdbc:postgresql://xxxxxxxxx.xxxxx.biganimal.io:5432/edb_admin?&sslrootcert=/usr/share/ca-certificates/ca-cert_name.pem&sslmode=verify-full?user=edb_admin&password=$PWD + ``` + + - #### Npgsql for DotNet Core + + ``` + Host=xxxxxxxxx.xxxxx.biganimal.io;Port=5432;Username=edb_admin;Password=$PWD;Database=edb_admin;SslRootCert=/usr/share/ca-certificates/ca-cert_name.pem;SslMode=verify-full + ``` + + - #### ODBC for Windows + + ``` + Driver={PostgreSQL};Server=xxxxxxxxx.xxxxx.biganimal.io;Port=5432;Database=myDataBase;Uid=edb_admin;Pwd=$PWD;sslrootcert=C:\\ssl\\ca-certificate.pem;sslmode=verify-full; + ``` + + + +## Connect to your cluster using pgAdmin + +To connect to your BigAnimal cluster from [pgAdmin](https://www.pgadmin.org/docs/), you need to enter your cluster values into pgAdmin. Keep BigAnimal and pgAdmin open to copy and paste the values. + +Navigate to the location of the values: + +1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. + +1. Go to the [Clusters](https://portal.biganimal.com/clusters) page. + +1. Select the cluster you want to connect to. + +1. Select the **Connect** tab. + +Enter the values in pgAdmin: + +1. Open pgAdmin. + +1. In the **Quick Links** panel, select **Add New Server**. + +1. In the Create-Server dialog box, under the **General** tab, enter a server name in the **Name** field. + +1. Select the **Connection** tab. + +1. Copy the corresponding values from BigAnimal and paste them into pgAdmin. + + | BigAnimal field | pgAdmin field | Example value | + |-----------------|-------------------|---------------| + | Host | Host name/address | p-n85scw2ies.fcrziuxgkqazmhkl.s.edbcloud.io | + | Port | Port | 5432 | + | Dbname | Maintenance database | edb_admin | + +1. In the **Username** and **Password** fields, enter the cluster's administrator credentials. These are the same credentials you set when configuring the cluster. If you didn't set the username, then copy and paste the default administrator username from the **User** field in BigAnimal. + +1. In the **SSL** tab, set the **SSL mode** field to **Require**. + +1. Select **Save**. pgAdmin attempts to connect to the BigAnimal cluster. + +## Connect a read-only workload + +Clusters that are read-only enabled display separate connection strings for **Read-only** and **Read/write** access. + +To connect to your cluster with the read-only workload: + +1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. + +1. Go to [Clusters](https://portal.biganimal.com/clusters). + +1. Select the cluster you want to connect to. + +1. Select the **Connect** tab. + +1. Copy the **Read-only Service URI**. + +1. Use the **Read-only Service URI** to connect to the cluster according to your database driver. + +We recommend that your applications run `SET default_transaction_read_only = true` for all read-only activity. For a libpq driver, add `options='-c default_transaction_read_only=true'` to the database connection string. Other drivers use similiar connection parameters. Also, applications can run `BEGIN TRANSACTION READ ONLY` to mark individual transactions as read-only. + +!!!Note + On read-only workloads, BigAnimal might cancel long-running queries and display an error message like the following: + + ```text + ERROR: canceling statement due to conflict with recovery + ``` + +For more information on querying standby replicas, see the [PostgreSQL Hot Standby documentation](https://www.postgresql.org/docs/current/hot-standby.html). + diff --git a/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/index.mdx b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/index.mdx index 689e28e6248..62d8c6e277d 100644 --- a/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/index.mdx @@ -7,162 +7,37 @@ redirects: - connecting_your_cluster --- -You can connect to your cluster using the client of your choice including: -- [`psql`](http://postgresguide.com/utilities/psql.html) — terminal-based client for Postgres -- pgAdmin — desktop or web UI client to inspect, monitor, manage, and query your cluster's databases -- other common database drivers +You can connect to your cluster from your cloud applications, from your client apps, and from integration points such as EDB's migration tools or PgBouncer. -You can manage your connections using the EDB PgBouncer connection pooler. For more information, see [Configuring EDB PgBouncer for BigAnimal](pgbouncer_configuring). - -For additional security measures see: - -- [Recommendations for settings for SSL mode](#recommended-settings-for-ssl-mode) -- [Using a private network to connect to your cluster](#setting-up-cloud-infrastructure-to-connect-to-a-private-network-cluster) - -## Recommended settings for SSL mode - -Different clients can have different default TLS/SSL modes (sslmode). For example, `psql` defaults to `prefer`, which means the client will attempt to establish a TLS connection but fall back to non-TLS if the server does not support it. In the `psql` example provided by EDB in the **Quick Connect** field, `sslmode` is explicitly set to `require`, which means the client will attempt a TLS connection and fail if the connection to the server can't be encrypted. - -For public connections and in most environments, EDB recommends setting `sslmode` to `verify-full`. This setting ensures that you connect to the server you specified and that the connection is encrypted. - -BigAnimal generates certificates with LetsEncrypt, a widely trusted certificate authority. Your client machine might already have a bundled CA certificate for LetsEncrypt, for example, at `/etc/ssl/certs/ca-certificates.crt` or `/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem`. If it doesn't, your client machine needs a [CA certificate for Let's Encrypt](https://letsencrypt.org/certificates/). Once the CA certificate is in place on your client machine, configure the `sslrootcert` parameter to its location and set the `sslmode` parameter to `verify-full` to verify the certificate to fully validate the connection. - -To view the encryption protocol being used for communication, [connect to the cluster using `psql`](#connect-to-your-cluster-using-psql) and use the `conninfo` meta-command. In the case of BigAnimal, TLS (v1.2+) is supported: - -``` -edb_admin=> \conninfo -You are connected to database "edb_admin" as user "edb_admin" on host "xxxxxxxxx.xxxxx.biganimal.io" at port "5432". -SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off) -``` - -## Connect to your cluster using `psql` - -1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. - -2. Go to the [Clusters](https://portal.biganimal.com/clusters) page. - -3. Select the name of your cluster. - -4. On the **Overview** tab, select the copy icon to the right of the **Quick Connect** field to copy the command for connecting to your cluster using `psql` to your clipboard. `psql` prompts for the edb_admin user password you selected when you created the cluster. - -5. Paste the command in your terminal. - -## Connect to your cluster using common database drivers +## From your applications -1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. - -2. Go to the [Clusters](https://portal.biganimal.com/clusters) page. +The Private Networking option offers a higher level of isolation and security by moving your cluster out of the public Internet. Clusters with Private Networking enabled are by default not accessible from outside of your cluster's resource network. You need to perform additional configuration steps to connect your applications in other parts of your cloud infrastructure to your clusters via private network links. -3. Select the name of your cluster. +!!!Note + EDB strongly discourages provisioning additional resources in the cluster's resource virtual network. -4. Select the **Connect** tab. You can review and copy all the relevant information you need from this screen except for the edb_admin user password. +See: - Connection string examples for common database drivers using the recommended setting for SSL mode (consult the client driver documentation for more information): + - [Connecting from Azure](01_connecting_from_azure) + - [Connecting from AWS](02_connecting_from_aws) - - libpq (psql) - - ``` - psql -W "postgres://edb_admin@xxxxxxxxx.xxxxx.biganimal.io:5432/edb_admin?sslmode=verify-full&sslrootcert=/usr/share/ca-certificates/ca-cert_name.pem" - ``` - - JDBC for Java +## From a client app - ``` - jdbc:postgresql://xxxxxxxxx.xxxxx.biganimal.io:5432/edb_admin?&sslrootcert=/usr/share/ca-certificates/ca-cert_name.pem&sslmode=verify-full?user=edb_admin&password=$PWD - ``` +For details on connecting from psql or edb-psql, other common database drivers, and pgAdmin, see [Connecting from a client app](connecting_from_a_client). - - Npgsql for DotNet Core - - ``` - Host=xxxxxxxxx.xxxxx.biganimal.io;Port=5432;Username=edb_admin;Password=$PWD;Database=edb_admin;SslRootCert=/usr/share/ca-certificates/ca-cert_name.pem;SslMode=verify-full - ``` +- [psql or edb-psql](connecting_from_a_client/#connect-to-your-cluster-using-psql-or-edb-psql) +- [other common database drivers](connecting_from_a_client/#connect-to-your-cluster-using-common-database-drivers) +- [pgAdmin](connecting_from_a_client/#connect-to-your-cluster-using-pgadmin) - - ODBC for Windows +There you'll also find details on connecting read-only workloads and configuring SSL settings. - ``` - Driver={PostgreSQL};Server=xxxxxxxxx.xxxxx.biganimal.io;Port=5432;Database=myDataBase;Uid=edb_admin;Pwd=$PWD;sslrootcert=C:\\ssl\\ca-certificate.pem;sslmode=verify-full; - ``` -## Connect your cluster to EDB's migration tools +## From an EDB's migration tools integration point To connect your cluster to EDB's migration tools, see [Migrating databases to BigAnimal](/biganimal/latest/migration/). +## From an EDB PgBouncer integration point -## Connect to your cluster using pgAdmin - -To connect to your BigAnimal cluster from [pgAdmin](https://www.pgadmin.org/docs/), you need to enter your cluster values into pgAdmin. Keep BigAnimal and pgAdmin open to copy and paste the values. - -Navigate to the location of the values: - -1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. - -1. Go to the [Clusters](https://portal.biganimal.com/clusters) page. - -1. Select the cluster you want to connect to. - -1. Select the **Connect** tab. - -Enter the values in pgAdmin: - -1. Open pgAdmin. - -1. In the **Quick Links** panel, select **Add New Server**. - -1. In the Create-Server dialog box, under the **General** tab, enter a server name in the **Name** field. - -1. Select the **Connection** tab. - -1. Copy the corresponding values from BigAnimal and paste them into pgAdmin. - - | BigAnimal field | pgAdmin field | Example value | - |-----------------|-------------------|---------------| - | Host | Host name/address | p-n85scw2ies.fcrziuxgkqazmhkl.s.edbcloud.io | - | Port | Port | 5432 | - | Dbname | Maintenance database | edb_admin | - -1. In the **Username** and **Password** fields, enter the cluster's administrator credentials. These are the same credentials you set when configuring the cluster. If you didn't set the username, then copy and paste the default administrator username from the **User** field in BigAnimal. - -1. In the **SSL** tab, set the **SSL mode** field to **Require**. - -1. Select **Save**. pgAdmin attempts to connect to the BigAnimal cluster. - -## Connect a read-only workload - -Clusters that are read-only enabled display separate connection strings for **Read-only** and **Read/write** access. - -To connect to your cluster with the read-only workload: - -1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. - -1. Go to [Clusters](https://portal.biganimal.com/clusters). - -1. Select the cluster you want to connect to. - -1. Select the **Connect** tab. - -1. Copy the **Read-only Service URI**. - -1. Use the **Read-only Service URI** to connect to the cluster according to your database driver. - -We recommend that your applications run `SET default_transaction_read_only = true` for all read-only activity. For a libpq driver, add `options='-c default_transaction_read_only=true'` to the database connection string. Other drivers use similiar connection parameters. Also, applications can run `BEGIN TRANSACTION READ ONLY` to mark individual transactions as read-only. - -!!!Note - On read-only workloads, BigAnimal might cancel long-running queries and display an error message like the following: - - ```text - ERROR: canceling statement due to conflict with recovery - ``` - -For more information on querying standby replicas, see the [PostgreSQL Hot Standby documentation](https://www.postgresql.org/docs/current/hot-standby.html). - -## Setting up cloud infrastructure to connect to a private network cluster - -The Private Networking option offers a higher level of isolation and security by moving your cluster out of the public Internet. Clusters with Private Networking enabled are by default not accessible from outside of your cluster's resource network. You need to perform additional configuration steps to connect your applications in other parts of your cloud infrastructure to your clusters via private network links. - -!!!Note - EDB strongly discourages provisioning additional resources in the cluster's resource virtual network. - -For examples to guide you through the different methods of connecting to your cluster, see +You can manage your connections using the EDB PgBouncer connection pooler. For more information, see [Configuring EDB PgBouncer for BigAnimal](pgbouncer_configuring). - - [Connecting from Azure](01_connecting_from_azure) - - [Connecting from AWS](02_connecting_from_aws) diff --git a/product_docs/docs/epas/13/epas_inst_linux/05_managing_an_advanced_server_installation.mdx b/product_docs/docs/epas/13/epas_inst_linux/05_managing_an_advanced_server_installation.mdx index 069408064d2..b679fdabfca 100644 --- a/product_docs/docs/epas/13/epas_inst_linux/05_managing_an_advanced_server_installation.mdx +++ b/product_docs/docs/epas/13/epas_inst_linux/05_managing_an_advanced_server_installation.mdx @@ -136,7 +136,7 @@ Where: `-U` specifies the identity of the database user that will be used for the session. -`edb-psql` is a symbolic link to PostgreSQL community `psql`. For more information about using the command line client, see the PostgreSQL Core Documentation at: +`edb-psql` is a symbolic link to a binary called `psql`, a modified version of the PostgreSQL community `psql`, with added support for Advanced Server features. . For more information about using the command line client, see the PostgreSQL Core Documentation at: diff --git a/product_docs/docs/epas/13/epas_inst_windows/06_configuring_advanced_server/02_connecting_to_advanced_server_with_psql.mdx b/product_docs/docs/epas/13/epas_inst_windows/06_configuring_advanced_server/02_connecting_to_advanced_server_with_psql.mdx index a2fd8a3dec2..72856eb64e9 100644 --- a/product_docs/docs/epas/13/epas_inst_windows/06_configuring_advanced_server/02_connecting_to_advanced_server_with_psql.mdx +++ b/product_docs/docs/epas/13/epas_inst_windows/06_configuring_advanced_server/02_connecting_to_advanced_server_with_psql.mdx @@ -29,6 +29,6 @@ Where: If you have performed an installation with the interactive installer, you can access the `edb-psql` client by selecting `EDB-PSQL` from the `EDB Postgres` menu. When the client opens, provide connection information for your session. -`edb-psql` is a symbolic link to PostgreSQL community `psql`. For more information about using the command line client, see the PostgreSQL Core Documentation at: +`edb-psql` is a symbolic link to a binary called `psql`, a modified version of the PostgreSQL community `psql`, with added support for Advanced Server features. For more information about using the command line client, see the PostgreSQL Core Documentation at: diff --git a/product_docs/docs/epas/14/epas_inst_linux/managing_an_advanced_server_installation.mdx b/product_docs/docs/epas/14/epas_inst_linux/managing_an_advanced_server_installation.mdx index 1942de04098..4fdb2a8640e 100644 --- a/product_docs/docs/epas/14/epas_inst_linux/managing_an_advanced_server_installation.mdx +++ b/product_docs/docs/epas/14/epas_inst_linux/managing_an_advanced_server_installation.mdx @@ -135,7 +135,7 @@ Where: `-U` specifies the identity of the database user to use for the session. -`edb-psql` is a symbolic link to PostgreSQL community `psql`. For more information about using the command line client, see the PostgreSQL Core Documentation at: +`edb-psql` is a symbolic link to a binary called `psql`, a modified version of the PostgreSQL community `psql`, with added support for Advanced Server features. For more information about using the command line client, see the PostgreSQL Core Documentation at: diff --git a/product_docs/docs/epas/14/epas_inst_windows/managing_an_advanced_server_installation/configuring_epas.mdx b/product_docs/docs/epas/14/epas_inst_windows/managing_an_advanced_server_installation/configuring_epas.mdx index 4139904bd09..4df9b56eed4 100644 --- a/product_docs/docs/epas/14/epas_inst_windows/managing_an_advanced_server_installation/configuring_epas.mdx +++ b/product_docs/docs/epas/14/epas_inst_windows/managing_an_advanced_server_installation/configuring_epas.mdx @@ -83,7 +83,7 @@ Where: If you have performed an installation with the interactive installer, you can access the `edb-psql` client by selecting `EDB-PSQL` from the `EDB Postgres` menu. When the client opens, provide connection information for your session. -`edb-psql` is a symbolic link to PostgreSQL community `psql`. For more information about using the command line client, see the PostgreSQL Core Documentation at: +`edb-psql` is a symbolic link to a binary called `psql`, a modified version of the PostgreSQL community `psql`, with added support for Advanced Server features. For more information about using the command line client, see the PostgreSQL Core Documentation at: diff --git a/product_docs/docs/migration_portal/4/04_mp_migrating_database/01_mp_schema_extraction/01_data_pump_utility.mdx b/product_docs/docs/migration_portal/4/04_mp_migrating_database/01_mp_schema_extraction/01_data_pump_utility.mdx index c9ae4e098f7..dbd82f648cd 100644 --- a/product_docs/docs/migration_portal/4/04_mp_migrating_database/01_mp_schema_extraction/01_data_pump_utility.mdx +++ b/product_docs/docs/migration_portal/4/04_mp_migrating_database/01_mp_schema_extraction/01_data_pump_utility.mdx @@ -15,15 +15,21 @@ Migration Portal requires only the metadata in the SQL dump file to assess the e **On Linux**: - `SQL> create directory DMPDIR as '/sample/file/path';` + ```sql + create directory DMPDIR as '/sample/file/path'; + ``` **On Windows**: - `SQL> create directory DMPDIR as 'c:\sample\file\path\';` + ```sql + create directory DMPDIR as 'c:\sample\file\path\'; + ``` - In SQL\*Plus, grant read-write permissions to the user running the Data Pump utility. - `SQL> grant read,write on directory DMPDIR to ;` + ```sql + grant read,write on directory DMPDIR to ; + ``` Perform either of the following procedures: @@ -37,13 +43,24 @@ Perform either of the following procedures: ```text CONTENT=metadata_only - - INCLUDE=SYNONYM,SEQUENCE,TYPE,TABLE,CONSTRAINT,PROCEDURE,FUNCTION,PACKAGE,INDEX,MATERIALIZED_VIEW,VIEW,TRIGGER,DB_LINK + INCLUDE=SYNONYM + INCLUDE=SEQUENCE + INCLUDE=TYPE + INCLUDE=TABLE + INCLUDE=CONSTRAINT + INCLUDE=PROCEDURE + INCLUDE=FUNCTION + INCLUDE=PACKAGE + INCLUDE=INDEX + INCLUDE=MATERIALIZED_VIEW + INCLUDE=VIEW + INCLUDE=TRIGGER + INCLUDE=DB_LINK ``` The attributes and values in this command specify the following options: - `CONTENT=metadata_only` extracts only the metadata of the schemas. - - `INCLUDE=` specifies the database object types to include in the extraction. Append a comma-separated list of the [Supported object types](../01_mp_schema_extraction/#supported-object-types) to extract only database object types that are supported by Migration Portal. + - `INCLUDE=` specifies the database object types to include in the extraction. Extract only database object types that are supported by Migration Portal, see [Supported object types](../01_mp_schema_extraction/#supported-object-types). 2. From the command line, run the export command to generate a `schemas_metadata.dump` file. For example, to extract metadata information for ``, ``, ``, and so on, run: @@ -57,8 +74,7 @@ Perform either of the following procedures: For example, to generate a `YourSchemas.SQL` file from the `schemas_metadata.dump` file, enter: ```shell - impdp @ DIRECTORY=DMPDIR TRANSFORM=OID:n,SEGMENT_ATTRIBUTES:n EXCLUDE=STATISTICS SQLFILE=YourSchemas.sql DUMPFILE=schemas_metadata.dump - + impdp @ DIRECTORY=DMPDIR TRANSFORM=OID:n,SEGMENT_ATTRIBUTES:n EXCLUDE=STATISTICS SQLFILE=YourSchemas.sql DUMPFILE=schemas_metadata.dump ``` See [file encoding](known_issues_notes/#file-encoding) for information about the file encoding format expected by the Migration Portal. @@ -73,17 +89,26 @@ See [file encoding](known_issues_notes/#file-encoding) for information about the ```text CONTENT=metadata_only - FULL=Y - - INCLUDE=SYNONYM,SEQUENCE,TYPE,TABLE,CONSTRAINT,PROCEDURE,FUNCTION,PACKAGE,INDEX,MATERIALIZED_VIEW,VIEW,TRIGGER,DB_LINK + INCLUDE=SYNONYM + INCLUDE=SEQUENCE + INCLUDE=TYPE + INCLUDE=TABLE + INCLUDE=CONSTRAINT + INCLUDE=PROCEDURE + INCLUDE=FUNCTION + INCLUDE=PACKAGE + INCLUDE=INDEX + INCLUDE=MATERIALIZED_VIEW + INCLUDE=VIEW + INCLUDE=TRIGGER + INCLUDE=DB_LINK ``` The attributes and values in this command specify the following options: - `CONTENT=metadata_only` extracts only the metadata of the schemas. - - `INCLUDE=` specifies the database object types to include in the extraction. Append a comma-separated list of the [Supported object types](../01_mp_schema_extraction/#supported-object-types) to extract only database object types that are supported by Migration Portal. + - `INCLUDE=` specifies the database object types to include in the extraction. Extract only database object types that are supported by Migration Portal, see [Supported object types](../01_mp_schema_extraction/#supported-object-types). - `FULL=Y` extracts all schemas in the database. - 2. From the command line, run the export command to generate a `schemas_metadata.dump` file: ```shell @@ -92,7 +117,7 @@ See [file encoding](known_issues_notes/#file-encoding) for information about the 3. Before running the `impdp` command, create a parameter file with a `.par` extension (for example, `import.par`) on your server. Add attributes and values to the file: - ```text + ```ini EXCLUDE=SCHEMA:"IN(select username as schema_name from sys.dba_users where LOWER(username) LIKE 'pg_%' OR username IN ('ANONYMOUS','APEX_PUBLIC_USER','APEX_030200','APEX_040000','APEX_040200','APPQOSSYS','AUDSYS','CTXSYS','DMSYS','DBSNMP', 'DBSFWUSER','DEMO','DIP','DMSYS', 'DVF','DVSYS','EXFSYS','FLOWS_FILES','FLOWS_020100', 'FRANCK','GGSYS','GSMADMIN_INTERNAL', @@ -111,6 +136,6 @@ See [file encoding](known_issues_notes/#file-encoding) for information about the For example, to generate `YourSchemas.SQL` file from the `schemas_metadata.dump` file, enter: ```shell - impdp @ DIRECTORY=DMPDIR TRANSFORM=OID:n,SEGMENT_ATTRIBUTES:n SQLFILE=YourSchemas.sql DUMPFILE=schemas_metadata.dump parfile=import.par + impdp @ DIRECTORY=DMPDIR TRANSFORM=OID:n,SEGMENT_ATTRIBUTES:n SQLFILE=YourSchemas.sql DUMPFILE=schemas_metadata.dump parfile=import.par ``` See [file encoding](known_issues_notes/#file-encoding) for information about the file encoding format expected by the Migration Portal. diff --git a/product_docs/docs/migration_portal/4/04_mp_migrating_database/01_mp_schema_extraction/index.mdx b/product_docs/docs/migration_portal/4/04_mp_migrating_database/01_mp_schema_extraction/index.mdx index 7dedca250c0..8e7393c3073 100644 --- a/product_docs/docs/migration_portal/4/04_mp_migrating_database/01_mp_schema_extraction/index.mdx +++ b/product_docs/docs/migration_portal/4/04_mp_migrating_database/01_mp_schema_extraction/index.mdx @@ -40,7 +40,9 @@ You can run the EDB DDL Extractor script in SQL Developer or SQL\*Plus. It uses 1. Connect to SQL\*Plus and run this command: - `SQL>@edb_ddl_extractor.sql` + ```sql + @edb_ddl_extractor.sql + ``` 2. When prompted, if the Oracle user that is running the script has the required privileges, press **Enter** to continue running the script. @@ -53,32 +55,47 @@ You can run the EDB DDL Extractor script in SQL Developer or SQL\*Plus. It uses 5. When prompted, enter `yes`or `no` depending on whether you want to extract dependent objects from other schemas. -For example, on Linux: +For example: -```text -Enter a comma separated list of schemas to be extracted (Default all schemas): HR, SCOTT, FINANCE +1. Run the extractor script: -Location for output file (Default current location) : /home/oracle/extracted_ddls/ + ```text + @edb_ddl_extractor.sql + ``` -WARNING: +2. Press **Enter** -Given schema(s) list may contain objects which are dependent on objects from other schema(s), not mentioned in the list.` `Assessment may fail for such objects. It is suggested to extract all dependent objects together. +3. Specify three schemas by separating them with commas: -Extract dependent object from other schemas?(yes/no) (Default no / Ignored for all schemas option): yes -``` -On Windows: + ```text + Enter a comma separated list of schemas to be extracted (Default all schemas): HR, SCOTT, FINANCE + ``` -```text -Enter comma separated list of schemas to be extracted (Default all schemas): HR, SCOTT, FINANCE +4. Enter a path for the output file: -Location for output file (Default current location) : c:\Users\Example\Desktop\ + On Linux, you might use: -WARNING: + ```text + Location for output file (Default current location) : /home/oracle/extracted_ddls/ + ``` -Given schema(s) list may contain objects which are dependent on objects from other schema(s), not mentioned in the list.` `Assessment may fail for such objects. It is suggested to extract all dependent objects together. + Similarly on Windows: -Extract dependent object from other schemas?(yes/no) (Default no / Ignored for all schemas option): yes -``` + ```text + Location for output file (Default current location) : c:\Users\Example\Desktop\ + ``` + +5. Enter `yes` to extract dependent objects in other schemas: + + ```text + WARNING: + + Given schema(s) list may contain objects which are dependent on objects + from other schema(s), not mentioned in the list.` `Assessment may fail + for such objects. It is suggested to extract all dependent objects + together. + Extract dependent object from other schemas?(yes/no) (Default no / Ignored for all schemas option): yes + ``` #### For SQL Developer diff --git a/product_docs/docs/pgd/4/bdr/nodes.mdx b/product_docs/docs/pgd/4/bdr/nodes.mdx index 897796662aa..ca9cf27986a 100644 --- a/product_docs/docs/pgd/4/bdr/nodes.mdx +++ b/product_docs/docs/pgd/4/bdr/nodes.mdx @@ -933,7 +933,7 @@ bdr.create_node_group(node_group_name text, when a node is creating a shard group that it doesn't want to join. This can be `false` only if you specify `parent_group_name`. - `node_group_type` — The valid values are `NULL`, `subscriber-only`, `datanode`, - `read coordinator`, and `write coordinator`. subscriber-only` type is + `read coordinator`, and `write coordinator`. `subscriber-only` type is used to create a group of nodes that receive changes only from the fully joined nodes in the cluster, but they never send replication changes to other nodes. See [Subscriber-only nodes](#subscriber-only-nodes) for more details.