From ab830b43c77ab981496539bdbc12bf413d94b2e5 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Tue, 17 May 2022 15:10:42 +0530 Subject: [PATCH 01/10] EPAS - Added content to EPAS 14 as per DF-270 and DF-292 --- .../14/epas_compat_sql/11a_alter_synonym.mdx | 65 +++++++++++++++++++ .../docs/epas/14/epas_compat_sql/index.mdx | 6 -- ...audit_logging_configuration_parameters.mdx | 7 +- 3 files changed, 69 insertions(+), 9 deletions(-) create mode 100644 product_docs/docs/epas/14/epas_compat_sql/11a_alter_synonym.mdx diff --git a/product_docs/docs/epas/14/epas_compat_sql/11a_alter_synonym.mdx b/product_docs/docs/epas/14/epas_compat_sql/11a_alter_synonym.mdx new file mode 100644 index 00000000000..38d0e5b8deb --- /dev/null +++ b/product_docs/docs/epas/14/epas_compat_sql/11a_alter_synonym.mdx @@ -0,0 +1,65 @@ +--- +title: "ALTER SYNONYM" +legacyRedirectsGenerated: + # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. + - "/edb-docs/d/edb-postgres-advanced-server/reference/database-compatibility-for-oracle-developers-reference-guide/9.6/Database_Compatibility_for_Oracle_Developers_Reference_Guide.1.026.html" + - "/edb-docs/d/edb-postgres-advanced-server/user-guides/database-compatibility-for-oracle-developers-guide/9.5/Database_Compatibility_for_Oracle_Developers_Guide.1.056.html" +--- + +## Name + +`ALTER SYNONYM` -- change ownership of synonym object + +## Synopsis + +```text +ALTER SYNONYM OWNER TO +``` + +## Description + +The `ALTER SYNONYM` command changes owner of the synonym. + + +## Examples + +```text +-- create user t1 and t2 +edb=# create user t1; +CREATE ROLE +edb=# create user t2; +CREATE ROLE + +-- grant all the privileges to user t1 and t2 on public schema +edb=# GRANT ALL PRIVILEGES ON SCHEMA public TO GROUP t1; +GRANT +edb=# GRANT ALL PRIVILEGES ON SCHEMA public TO GROUP t2; +GRANT + +-- connect to the database as user t1 and create the table +edb=# \c - t1 +You are now connected to database "edb" as user "t1". +edb=> create table t(n int); +CREATE TABLE + +-- create a synonym for table t +edb=> create public synonym x for t; +CREATE SYNONYM + +-- check the owner of the synonym x is t1 +edb=# select * from all_synonyms; + owner | schema_name | objid | synonym_name | table_owner | table_schema_name | table_name | db_link +-------+-------------+-------+--------------+-------------+-------------------+------------+--------- + T1 | PUBLIC | 16390 | X | T1 | PUBLIC | T | + +-- connect the database as user edb and change the owner of the synonym x to user t2 +edb=> \c - edb +You are now connected to database "edb" as user "edb". +edb=# alter synonym x owner to t2; + +-- check the owner of the synonym x is changed to t2 +edb=# select * from all_synonyms; + owner | schema_name | objid | synonym_name | table_owner | table_schema_name | table_name | db_link +-------+-------------+-------+--------------+-------------+-------------------+------------+--------- + T2 | PUBLIC | 16390 | X | T1 | PUBLIC | T | +``` \ No newline at end of file diff --git a/product_docs/docs/epas/14/epas_compat_sql/index.mdx b/product_docs/docs/epas/14/epas_compat_sql/index.mdx index 0dff518b5fd..71c456c5d47 100644 --- a/product_docs/docs/epas/14/epas_compat_sql/index.mdx +++ b/product_docs/docs/epas/14/epas_compat_sql/index.mdx @@ -10,9 +10,3 @@ Note the following points: - EDB Postgres Advanced Server supports other commands that are not listed here. These commands may have no Oracle equivalent or they may provide the similar or same functionality as an Oracle SQL command, but with different syntax. - The SQL commands in this section don't necessarily represent the full syntax, options, and functionality available for each command. In most cases, syntax, options, and functionality that are not compatible with Oracle databases have been omitted from the command description and syntax. - The EDB Postgres Advanced Server documentation set documents command functionality that may not be compatible with Oracle databases. - -
- -introduction alter_directory alter_index alter_procedure alter_profile alter_queue alter_queue_table alter_role_identified_by alter_role_managing_database_link_and_dbms_rls_privileges alter_sequence alter_session alter_table alter_trigger alter_tablespace alter_user_identified_by alter_user_role_profile_management_clauses call comment commit create_database create_public_database_link create_directory create_function create_index create_materialized_view create_package create_package_body create_procedure create_profile create_queue create_queue_table create_role create_schema create_sequence create_synonym create_table create_table_as create_trigger create_type create_type_body create_user create_user_role_profile_management_clauses create_view delete drop_public_database_link drop_directory drop_function drop_index drop_package drop_procedure drop_profile drop_queue drop_queue_table drop_synonym drop_role drop_sequence drop_table drop_tablespace drop_trigger drop_type drop_user drop_view exec grant insert lock revoke rollback rollback_to_savepoint savepoint select set_constraints set_role set_transaction truncate update conclusion - -
diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx index 68f0bea3bc4..86f8794a2a9 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx @@ -1,15 +1,16 @@ --- -title: "Audit logging configuration arameters" +title: "Audit logging configuration Parameters" --- - - Use the following configuration parameters to control database auditing. See [Summary of configuration parameters](../01_configuration_parameters/02_summary_of_configuration_parameters/#summary_of_configuration_parameters) to determine if a change to the configuration parameter takes effect immediately, or if the configuration needs to be reloaded, or if the database server needs to be restarted. `edb_audit` Enables or disables database auditing. The values `xml` or `csv` enable database auditing. These values represent the file format in which auditing information is captured. `none` disables database auditing and is also the default. +!!! Note + The `logging_collector` parameter must be set to `on` to enable the `edb_audit` parameter. + `edb_audit_archiver` Enables or disables database audit archiving. From b48c55b221ebb0e03db2c196f4caa55d69aeee6c Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Tue, 17 May 2022 18:07:56 +0530 Subject: [PATCH 02/10] Added content for versions 10 to 13 --- .../10/epas_compat_sql/11a_alter_synonym.mdx | 65 +++++++++++++++++++ ...audit_logging_configuration_parameters.mdx | 6 +- .../11/epas_compat_sql/11a_alter_synonym.mdx | 65 +++++++++++++++++++ ...audit_logging_configuration_parameters.mdx | 5 +- .../12/epas_compat_sql/11a_alter_synonym.mdx | 65 +++++++++++++++++++ ...audit_logging_configuration_parameters.mdx | 5 +- .../13/epas_compat_sql/11a_alter_synonym.mdx | 65 +++++++++++++++++++ ...audit_logging_configuration_parameters.mdx | 4 +- 8 files changed, 272 insertions(+), 8 deletions(-) create mode 100644 product_docs/docs/epas/10/epas_compat_sql/11a_alter_synonym.mdx create mode 100644 product_docs/docs/epas/11/epas_compat_sql/11a_alter_synonym.mdx create mode 100644 product_docs/docs/epas/12/epas_compat_sql/11a_alter_synonym.mdx create mode 100644 product_docs/docs/epas/13/epas_compat_sql/11a_alter_synonym.mdx diff --git a/product_docs/docs/epas/10/epas_compat_sql/11a_alter_synonym.mdx b/product_docs/docs/epas/10/epas_compat_sql/11a_alter_synonym.mdx new file mode 100644 index 00000000000..38d0e5b8deb --- /dev/null +++ b/product_docs/docs/epas/10/epas_compat_sql/11a_alter_synonym.mdx @@ -0,0 +1,65 @@ +--- +title: "ALTER SYNONYM" +legacyRedirectsGenerated: + # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. + - "/edb-docs/d/edb-postgres-advanced-server/reference/database-compatibility-for-oracle-developers-reference-guide/9.6/Database_Compatibility_for_Oracle_Developers_Reference_Guide.1.026.html" + - "/edb-docs/d/edb-postgres-advanced-server/user-guides/database-compatibility-for-oracle-developers-guide/9.5/Database_Compatibility_for_Oracle_Developers_Guide.1.056.html" +--- + +## Name + +`ALTER SYNONYM` -- change ownership of synonym object + +## Synopsis + +```text +ALTER SYNONYM OWNER TO +``` + +## Description + +The `ALTER SYNONYM` command changes owner of the synonym. + + +## Examples + +```text +-- create user t1 and t2 +edb=# create user t1; +CREATE ROLE +edb=# create user t2; +CREATE ROLE + +-- grant all the privileges to user t1 and t2 on public schema +edb=# GRANT ALL PRIVILEGES ON SCHEMA public TO GROUP t1; +GRANT +edb=# GRANT ALL PRIVILEGES ON SCHEMA public TO GROUP t2; +GRANT + +-- connect to the database as user t1 and create the table +edb=# \c - t1 +You are now connected to database "edb" as user "t1". +edb=> create table t(n int); +CREATE TABLE + +-- create a synonym for table t +edb=> create public synonym x for t; +CREATE SYNONYM + +-- check the owner of the synonym x is t1 +edb=# select * from all_synonyms; + owner | schema_name | objid | synonym_name | table_owner | table_schema_name | table_name | db_link +-------+-------------+-------+--------------+-------------+-------------------+------------+--------- + T1 | PUBLIC | 16390 | X | T1 | PUBLIC | T | + +-- connect the database as user edb and change the owner of the synonym x to user t2 +edb=> \c - edb +You are now connected to database "edb" as user "edb". +edb=# alter synonym x owner to t2; + +-- check the owner of the synonym x is changed to t2 +edb=# select * from all_synonyms; + owner | schema_name | objid | synonym_name | table_owner | table_schema_name | table_name | db_link +-------+-------------+-------+--------------+-------------+-------------------+------------+--------- + T2 | PUBLIC | 16390 | X | T1 | PUBLIC | T | +``` \ No newline at end of file diff --git a/product_docs/docs/epas/10/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx b/product_docs/docs/epas/10/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx index 75d0b6c9c5e..0e77ecc748a 100644 --- a/product_docs/docs/epas/10/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx +++ b/product_docs/docs/epas/10/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx @@ -1,16 +1,16 @@ --- title: "Audit Logging Configuration Parameters" - --- - - Use the following configuration parameters to control database auditing. See [Summary of Configuration Parameters](../01_configuration_parameters/02_summary_of_configuration_parameters/#summary_of_configuration_parameters) to determine if a change to the configuration parameter takes effect immediately, or if the configuration needs to be reloaded, or if the database server needs to be restarted. `edb_audit` Enables or disables database auditing. The values `xml` or `csv` will enable database auditing. These values represent the file format in which auditing information will be captured. `none` will disable database auditing and is also the default. +!!! Note + The `logging_collector` parameter must be set to `on` to enable the `edb_audit` parameter. + `edb_audit_directory` Specifies the directory where the log files will be created. The path of the directory can be relative or absolute to the data folder. The default is the `PGDATA/edb_audit` directory. diff --git a/product_docs/docs/epas/11/epas_compat_sql/11a_alter_synonym.mdx b/product_docs/docs/epas/11/epas_compat_sql/11a_alter_synonym.mdx new file mode 100644 index 00000000000..38d0e5b8deb --- /dev/null +++ b/product_docs/docs/epas/11/epas_compat_sql/11a_alter_synonym.mdx @@ -0,0 +1,65 @@ +--- +title: "ALTER SYNONYM" +legacyRedirectsGenerated: + # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. + - "/edb-docs/d/edb-postgres-advanced-server/reference/database-compatibility-for-oracle-developers-reference-guide/9.6/Database_Compatibility_for_Oracle_Developers_Reference_Guide.1.026.html" + - "/edb-docs/d/edb-postgres-advanced-server/user-guides/database-compatibility-for-oracle-developers-guide/9.5/Database_Compatibility_for_Oracle_Developers_Guide.1.056.html" +--- + +## Name + +`ALTER SYNONYM` -- change ownership of synonym object + +## Synopsis + +```text +ALTER SYNONYM OWNER TO +``` + +## Description + +The `ALTER SYNONYM` command changes owner of the synonym. + + +## Examples + +```text +-- create user t1 and t2 +edb=# create user t1; +CREATE ROLE +edb=# create user t2; +CREATE ROLE + +-- grant all the privileges to user t1 and t2 on public schema +edb=# GRANT ALL PRIVILEGES ON SCHEMA public TO GROUP t1; +GRANT +edb=# GRANT ALL PRIVILEGES ON SCHEMA public TO GROUP t2; +GRANT + +-- connect to the database as user t1 and create the table +edb=# \c - t1 +You are now connected to database "edb" as user "t1". +edb=> create table t(n int); +CREATE TABLE + +-- create a synonym for table t +edb=> create public synonym x for t; +CREATE SYNONYM + +-- check the owner of the synonym x is t1 +edb=# select * from all_synonyms; + owner | schema_name | objid | synonym_name | table_owner | table_schema_name | table_name | db_link +-------+-------------+-------+--------------+-------------+-------------------+------------+--------- + T1 | PUBLIC | 16390 | X | T1 | PUBLIC | T | + +-- connect the database as user edb and change the owner of the synonym x to user t2 +edb=> \c - edb +You are now connected to database "edb" as user "edb". +edb=# alter synonym x owner to t2; + +-- check the owner of the synonym x is changed to t2 +edb=# select * from all_synonyms; + owner | schema_name | objid | synonym_name | table_owner | table_schema_name | table_name | db_link +-------+-------------+-------+--------------+-------------+-------------------+------------+--------- + T2 | PUBLIC | 16390 | X | T1 | PUBLIC | T | +``` \ No newline at end of file diff --git a/product_docs/docs/epas/11/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx b/product_docs/docs/epas/11/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx index 2ef5336a3ef..2ce56b361ec 100644 --- a/product_docs/docs/epas/11/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx +++ b/product_docs/docs/epas/11/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx @@ -3,14 +3,15 @@ title: "Audit Logging Configuration Parameters" --- - - Use the following configuration parameters to control database auditing. See [Summary of Configuration Parameters](../01_configuration_parameters/02_summary_of_configuration_parameters/#summary_of_configuration_parameters) to determine if a change to the configuration parameter takes effect immediately, or if the configuration needs to be reloaded, or if the database server needs to be restarted. `edb_audit` Enables or disables database auditing. The values `xml` or `csv` will enable database auditing. These values represent the file format in which auditing information will be captured. `none` will disable database auditing and is also the default. +!!! Note + The `logging_collector` parameter must be set to `on` to enable the `edb_audit` parameter. + `edb_audit_directory` Specifies the directory where the log files will be created. The path of the directory can be relative or absolute to the data folder. The default is the `PGDATA/edb_audit` directory. diff --git a/product_docs/docs/epas/12/epas_compat_sql/11a_alter_synonym.mdx b/product_docs/docs/epas/12/epas_compat_sql/11a_alter_synonym.mdx new file mode 100644 index 00000000000..38d0e5b8deb --- /dev/null +++ b/product_docs/docs/epas/12/epas_compat_sql/11a_alter_synonym.mdx @@ -0,0 +1,65 @@ +--- +title: "ALTER SYNONYM" +legacyRedirectsGenerated: + # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. + - "/edb-docs/d/edb-postgres-advanced-server/reference/database-compatibility-for-oracle-developers-reference-guide/9.6/Database_Compatibility_for_Oracle_Developers_Reference_Guide.1.026.html" + - "/edb-docs/d/edb-postgres-advanced-server/user-guides/database-compatibility-for-oracle-developers-guide/9.5/Database_Compatibility_for_Oracle_Developers_Guide.1.056.html" +--- + +## Name + +`ALTER SYNONYM` -- change ownership of synonym object + +## Synopsis + +```text +ALTER SYNONYM OWNER TO +``` + +## Description + +The `ALTER SYNONYM` command changes owner of the synonym. + + +## Examples + +```text +-- create user t1 and t2 +edb=# create user t1; +CREATE ROLE +edb=# create user t2; +CREATE ROLE + +-- grant all the privileges to user t1 and t2 on public schema +edb=# GRANT ALL PRIVILEGES ON SCHEMA public TO GROUP t1; +GRANT +edb=# GRANT ALL PRIVILEGES ON SCHEMA public TO GROUP t2; +GRANT + +-- connect to the database as user t1 and create the table +edb=# \c - t1 +You are now connected to database "edb" as user "t1". +edb=> create table t(n int); +CREATE TABLE + +-- create a synonym for table t +edb=> create public synonym x for t; +CREATE SYNONYM + +-- check the owner of the synonym x is t1 +edb=# select * from all_synonyms; + owner | schema_name | objid | synonym_name | table_owner | table_schema_name | table_name | db_link +-------+-------------+-------+--------------+-------------+-------------------+------------+--------- + T1 | PUBLIC | 16390 | X | T1 | PUBLIC | T | + +-- connect the database as user edb and change the owner of the synonym x to user t2 +edb=> \c - edb +You are now connected to database "edb" as user "edb". +edb=# alter synonym x owner to t2; + +-- check the owner of the synonym x is changed to t2 +edb=# select * from all_synonyms; + owner | schema_name | objid | synonym_name | table_owner | table_schema_name | table_name | db_link +-------+-------------+-------+--------------+-------------+-------------------+------------+--------- + T2 | PUBLIC | 16390 | X | T1 | PUBLIC | T | +``` \ No newline at end of file diff --git a/product_docs/docs/epas/12/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx b/product_docs/docs/epas/12/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx index dac3425f17c..038c0f8a780 100644 --- a/product_docs/docs/epas/12/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx +++ b/product_docs/docs/epas/12/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx @@ -3,14 +3,15 @@ title: "Audit Logging Configuration Parameters" --- - - Use the following configuration parameters to control database auditing. See [Summary of Configuration Parameters](../01_configuration_parameters/02_summary_of_configuration_parameters/#summary_of_configuration_parameters) to determine if a change to the configuration parameter takes effect immediately, or if the configuration needs to be reloaded, or if the database server needs to be restarted. `edb_audit` Enables or disables database auditing. The values `xml` or `csv` will enable database auditing. These values represent the file format in which auditing information will be captured. `none` will disable database auditing and is also the default. +!!! Note + The `logging_collector` parameter must be set to `on` to enable the `edb_audit` parameter. + `edb_audit_directory` Specifies the directory where the log files will be created. The path of the directory can be relative or absolute to the data folder. The default is the `PGDATA/edb_audit` directory. diff --git a/product_docs/docs/epas/13/epas_compat_sql/11a_alter_synonym.mdx b/product_docs/docs/epas/13/epas_compat_sql/11a_alter_synonym.mdx new file mode 100644 index 00000000000..38d0e5b8deb --- /dev/null +++ b/product_docs/docs/epas/13/epas_compat_sql/11a_alter_synonym.mdx @@ -0,0 +1,65 @@ +--- +title: "ALTER SYNONYM" +legacyRedirectsGenerated: + # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. + - "/edb-docs/d/edb-postgres-advanced-server/reference/database-compatibility-for-oracle-developers-reference-guide/9.6/Database_Compatibility_for_Oracle_Developers_Reference_Guide.1.026.html" + - "/edb-docs/d/edb-postgres-advanced-server/user-guides/database-compatibility-for-oracle-developers-guide/9.5/Database_Compatibility_for_Oracle_Developers_Guide.1.056.html" +--- + +## Name + +`ALTER SYNONYM` -- change ownership of synonym object + +## Synopsis + +```text +ALTER SYNONYM OWNER TO +``` + +## Description + +The `ALTER SYNONYM` command changes owner of the synonym. + + +## Examples + +```text +-- create user t1 and t2 +edb=# create user t1; +CREATE ROLE +edb=# create user t2; +CREATE ROLE + +-- grant all the privileges to user t1 and t2 on public schema +edb=# GRANT ALL PRIVILEGES ON SCHEMA public TO GROUP t1; +GRANT +edb=# GRANT ALL PRIVILEGES ON SCHEMA public TO GROUP t2; +GRANT + +-- connect to the database as user t1 and create the table +edb=# \c - t1 +You are now connected to database "edb" as user "t1". +edb=> create table t(n int); +CREATE TABLE + +-- create a synonym for table t +edb=> create public synonym x for t; +CREATE SYNONYM + +-- check the owner of the synonym x is t1 +edb=# select * from all_synonyms; + owner | schema_name | objid | synonym_name | table_owner | table_schema_name | table_name | db_link +-------+-------------+-------+--------------+-------------+-------------------+------------+--------- + T1 | PUBLIC | 16390 | X | T1 | PUBLIC | T | + +-- connect the database as user edb and change the owner of the synonym x to user t2 +edb=> \c - edb +You are now connected to database "edb" as user "edb". +edb=# alter synonym x owner to t2; + +-- check the owner of the synonym x is changed to t2 +edb=# select * from all_synonyms; + owner | schema_name | objid | synonym_name | table_owner | table_schema_name | table_name | db_link +-------+-------------+-------+--------------+-------------+-------------------+------------+--------- + T2 | PUBLIC | 16390 | X | T1 | PUBLIC | T | +``` \ No newline at end of file diff --git a/product_docs/docs/epas/13/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx b/product_docs/docs/epas/13/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx index d559c095825..252a8c9d509 100644 --- a/product_docs/docs/epas/13/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx +++ b/product_docs/docs/epas/13/epas_guide/03_database_administration/05_edb_audit_logging/01_audit_logging_configuration_parameters.mdx @@ -6,7 +6,6 @@ legacyRedirectsGenerated: - "/edb-docs/d/edb-postgres-advanced-server/user-guides/user-guide/13/audit_logging_configuration_parameters.html" --- - Use the following configuration parameters to control database auditing. See [Summary of Configuration Parameters](../01_configuration_parameters/02_summary_of_configuration_parameters/#summary_of_configuration_parameters) to determine if a change to the configuration parameter takes effect immediately, or if the configuration needs to be reloaded, or if the database server needs to be restarted. @@ -14,6 +13,9 @@ Use the following configuration parameters to control database auditing. See [Su Enables or disables database auditing. The values `xml` or `csv` will enable database auditing. These values represent the file format in which auditing information will be captured. `none` will disable database auditing and is also the default. +!!! Note + The `logging_collector` parameter must be set to `on` to enable the `edb_audit` parameter. + `edb_audit_directory` Specifies the directory where the log files will be created. The path of the directory can be relative or absolute to the data folder. The default is the `PGDATA/edb_audit` directory. From cbd8e340cda64ea25b46c0fe119bf74fd34d3ff9 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 18 May 2022 11:33:36 -0400 Subject: [PATCH 03/10] PGD: latest comments from Kelly --- product_docs/docs/pgd/4/deployments/tpaexec/index.mdx | 2 ++ product_docs/docs/pgd/4/overview/index.mdx | 3 ++- product_docs/docs/pgd/4/terminology.mdx | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/pgd/4/deployments/tpaexec/index.mdx b/product_docs/docs/pgd/4/deployments/tpaexec/index.mdx index 4fe43c9ad8c..d7397db1239 100644 --- a/product_docs/docs/pgd/4/deployments/tpaexec/index.mdx +++ b/product_docs/docs/pgd/4/deployments/tpaexec/index.mdx @@ -13,6 +13,8 @@ including physical and virtual machines, both self-hosted and in the cloud TPAexec is an orchestration tool that uses Ansible to build Postgres clusters as specified by TPA (Trusted Postgres Architecture), a set of reference architectures that document how to set up and operate Postgres in various scenarios. TPA represents the best practices followed by EDB, and its recommendations are as applicable to quick testbed setups as to production environments. +TPAexec packages are available to EDB customers by prior arrangement. Please contact your account manager to request access. + ## Capabilities and supported software ### Configuration diff --git a/product_docs/docs/pgd/4/overview/index.mdx b/product_docs/docs/pgd/4/overview/index.mdx index 5985e25146c..6bf8f8bd9e9 100644 --- a/product_docs/docs/pgd/4/overview/index.mdx +++ b/product_docs/docs/pgd/4/overview/index.mdx @@ -31,13 +31,14 @@ node. BDR nodes can be either data nodes or witness nodes. Witness nodes don't participate in data replication and are only used as a tie-breaker for consensus. -### pglogical3 (3.6/3.7) +!!!note "pglogical3 (3.6/3.7)" pglogical is a Postgres extension that provides logical replication using logical decoding. It has been supported since Postgres 9.4. Older versions of BDR (3.6/3.7) depend on pglogical3 to provide the replication channel upon which BDR builds. +!!! ## HARP diff --git a/product_docs/docs/pgd/4/terminology.mdx b/product_docs/docs/pgd/4/terminology.mdx index c568e92c73f..2e6b41df661 100644 --- a/product_docs/docs/pgd/4/terminology.mdx +++ b/product_docs/docs/pgd/4/terminology.mdx @@ -1,5 +1,5 @@ --- -title: Terminology +title: Concepts --- The terminology that follows is important for understanding EDB Postgres Distributed functionality and the requirements that it addresses in the realms of high availability, replication, and clustering. From 118c1c6dd74b2b1d826535b6247e18fd9e56b949 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 18 May 2022 13:44:49 -0400 Subject: [PATCH 04/10] changes to GS nav titles --- product_docs/docs/pgd/4/index.mdx | 3 +-- product_docs/docs/pgd/4/overview/index.mdx | 2 +- product_docs/docs/pgd/4/terminology.mdx | 2 +- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/pgd/4/index.mdx b/product_docs/docs/pgd/4/index.mdx index 094d709e8f6..7406af4e2db 100644 --- a/product_docs/docs/pgd/4/index.mdx +++ b/product_docs/docs/pgd/4/index.mdx @@ -2,8 +2,7 @@ title: "EDB Postgres Distributed" indexCards: none navigation: - - rel_notes - - "#Getting started" + - "#Concepts" - terminology - overview - "#Planning" diff --git a/product_docs/docs/pgd/4/overview/index.mdx b/product_docs/docs/pgd/4/overview/index.mdx index 6bf8f8bd9e9..50e8d1baef6 100644 --- a/product_docs/docs/pgd/4/overview/index.mdx +++ b/product_docs/docs/pgd/4/overview/index.mdx @@ -1,5 +1,5 @@ --- -title: "Components and architecture" +title: "Key components" --- EDB Postgres Distributed provides loosely-coupled multi-master logical replication diff --git a/product_docs/docs/pgd/4/terminology.mdx b/product_docs/docs/pgd/4/terminology.mdx index 2e6b41df661..c568e92c73f 100644 --- a/product_docs/docs/pgd/4/terminology.mdx +++ b/product_docs/docs/pgd/4/terminology.mdx @@ -1,5 +1,5 @@ --- -title: Concepts +title: Terminology --- The terminology that follows is important for understanding EDB Postgres Distributed functionality and the requirements that it addresses in the realms of high availability, replication, and clustering. From 8779ba5a28340650ecfaaf96f8b6ba21a1542de7 Mon Sep 17 00:00:00 2001 From: kelpoole <44814688+kelpoole@users.noreply.github.com> Date: Wed, 18 May 2022 15:14:28 -0700 Subject: [PATCH 05/10] Update index.mdx --- .../docs/pgd/4/deployments/tpaexec/index.mdx | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/pgd/4/deployments/tpaexec/index.mdx b/product_docs/docs/pgd/4/deployments/tpaexec/index.mdx index d7397db1239..89072e93ef5 100644 --- a/product_docs/docs/pgd/4/deployments/tpaexec/index.mdx +++ b/product_docs/docs/pgd/4/deployments/tpaexec/index.mdx @@ -13,7 +13,7 @@ including physical and virtual machines, both self-hosted and in the cloud TPAexec is an orchestration tool that uses Ansible to build Postgres clusters as specified by TPA (Trusted Postgres Architecture), a set of reference architectures that document how to set up and operate Postgres in various scenarios. TPA represents the best practices followed by EDB, and its recommendations are as applicable to quick testbed setups as to production environments. -TPAexec packages are available to EDB customers by prior arrangement. Please contact your account manager to request access. +TPAexec packages are only available to EDB customers with an active BDR subscription. Please contact your account manager to request access. ## Capabilities and supported software @@ -24,10 +24,11 @@ The configuration options include: | Flags | Description | | ---------------------------- | ----------- | -| --architecture BDR-Always-ON | Required. Produces a working configuration. | -| --layout layoutname | Required. Specify one of the supported BDR use-case variations: bronze, silver, gold, and platinum. See [Choosing your architecture][/pgd/4/architectures] for more information. | -| --bdr-node-group groupname | Optional. Set the name of the BDR node group. The default is bdrgroup. | -| --bdr-database dbname | Optional. Set the name of the database with BDR enabled. The default is bdrdb. | +| --architecture BDR-Always-ON | Required. Set to 'BDR-Always-ON' for EDB Postgres Distributed deployments | +| --layout layoutname | Required. Specify one of the four supported architectures: bronze, silver, gold, and platinum. See [Choosing your architecture][/pgd/4/architectures] for more information. | +| --harp-consensus-protocol. | Required. `bdr` is recommended if your layout is bronze or silver. `etcd` is recommended if your layout is gold or platinum. See [Choosing your DCS]/pgd/4/dcs] for more information. | +| --bdr-node-group groupname | Optional. Set the name of the BDR node group. The default is `bdrgroup`. | +| --bdr-database dbname | Optional. Set the name of the database with BDR enabled. The default is `bdrdb`. | | --enable-camo | Optional. Set the pair of BDR primary instances in each region to be each other's CAMO partners. | @@ -35,6 +36,7 @@ The configuration options include: [tpa]$ tpaexec configure ~/clusters/bdr \ --architecture BDR-Always-ON \ --layout gold \ + --harp-consensus-protocol etcd\ --platform aws --region eu-west-1 --instance-type t3.micro \ --distribution Debian-minimal ``` From a155f025dbc677981284592b1cc312244aaee5c2 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 18 May 2022 19:48:47 -0400 Subject: [PATCH 06/10] more feedback --- product_docs/docs/pgd/4/cli.mdx | 12 ++++++++++++ product_docs/docs/pgd/4/index.mdx | 1 + product_docs/docs/pgd/4/overview/index.mdx | 9 +++------ src/pages/index.js | 2 +- 4 files changed, 17 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/pgd/4/cli.mdx b/product_docs/docs/pgd/4/cli.mdx index 584e2f6c799..83334ca18e9 100644 --- a/product_docs/docs/pgd/4/cli.mdx +++ b/product_docs/docs/pgd/4/cli.mdx @@ -1,7 +1,19 @@ --- title: "PGD CLI" +navTitle: "Command Line Interface" --- The EDB Postgres Distributed Command Line Interface (PGD CLI) is a tool to manage your BDR cluster. It allows you to run commands against BDR clusters. +You can use it to inspect and manage cluster resources and to get information on the following: + +- node summary +- BDR/Postgres version on each node +- replication and subscription details +- membership and worker events +- raft consensus details +- CAMO (Commit at Most Once) details +- clock skew +- cluster health summary + See [EDB Postgres Distributed Command Line Interface](/pgd_cli/latest) for more information. \ No newline at end of file diff --git a/product_docs/docs/pgd/4/index.mdx b/product_docs/docs/pgd/4/index.mdx index 7406af4e2db..ced18fe35af 100644 --- a/product_docs/docs/pgd/4/index.mdx +++ b/product_docs/docs/pgd/4/index.mdx @@ -2,6 +2,7 @@ title: "EDB Postgres Distributed" indexCards: none navigation: + - rel_notes - "#Concepts" - terminology - overview diff --git a/product_docs/docs/pgd/4/overview/index.mdx b/product_docs/docs/pgd/4/overview/index.mdx index 50e8d1baef6..8ef3a46046b 100644 --- a/product_docs/docs/pgd/4/overview/index.mdx +++ b/product_docs/docs/pgd/4/overview/index.mdx @@ -31,13 +31,10 @@ node. BDR nodes can be either data nodes or witness nodes. Witness nodes don't participate in data replication and are only used as a tie-breaker for consensus. -!!!note "pglogical3 (3.6/3.7)" +!!!note "pglogical3" -pglogical is a Postgres extension that provides logical replication using -logical decoding. It has been supported since Postgres 9.4. - -Older versions of BDR (3.6/3.7) depend on pglogical3 to provide the replication -channel upon which BDR builds. +Older versions of BDR (3.6/3.7) depended on pglogical3 to provide the replication +channel upon which BDR builds. It is no longer used. !!! ## HARP diff --git a/src/pages/index.js b/src/pages/index.js index e18e2c204d1..65e66415888 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -209,7 +209,7 @@ const Page = () => ( EDB Postgres Distributed - BDR (Bi-Directional Replication) + Bi-Directional Replication (BDR) HA Routing for Postgres (HARP) From b72623c6aced41ebff36e2d9103812e5ce2f05eb Mon Sep 17 00:00:00 2001 From: Petr Jelinek Date: Thu, 19 May 2022 13:22:48 +0200 Subject: [PATCH 07/10] Move Known Issues from BDR to PGD and add a HARP issue --- product_docs/docs/bdr/4/index.mdx | 1 - product_docs/docs/pgd/4/index.mdx | 1 + .../4/known_issues.mdx} | 18 ++++++++++++++---- 3 files changed, 15 insertions(+), 5 deletions(-) rename product_docs/docs/{bdr/4/known-issues.mdx => pgd/4/known_issues.mdx} (87%) diff --git a/product_docs/docs/bdr/4/index.mdx b/product_docs/docs/bdr/4/index.mdx index cc31cff2bc7..6b60271fcb4 100644 --- a/product_docs/docs/bdr/4/index.mdx +++ b/product_docs/docs/bdr/4/index.mdx @@ -26,7 +26,6 @@ navigation: - twophase - catalogs - functions - - known-issues title: BDR (Bi-Directional Replication) directoryDefaults: description: >- diff --git a/product_docs/docs/pgd/4/index.mdx b/product_docs/docs/pgd/4/index.mdx index ced18fe35af..017f44b22c8 100644 --- a/product_docs/docs/pgd/4/index.mdx +++ b/product_docs/docs/pgd/4/index.mdx @@ -18,6 +18,7 @@ navigation: - "#Using" - backups - monitoring + - known_issues --- diff --git a/product_docs/docs/bdr/4/known-issues.mdx b/product_docs/docs/pgd/4/known_issues.mdx similarity index 87% rename from product_docs/docs/bdr/4/known-issues.mdx rename to product_docs/docs/pgd/4/known_issues.mdx index c60710f19d5..987e36b3f21 100644 --- a/product_docs/docs/bdr/4/known-issues.mdx +++ b/product_docs/docs/pgd/4/known_issues.mdx @@ -1,10 +1,8 @@ --- -title: 'Appendix A: Known Issues' - - +title: 'Known Issues' --- -This section discusses currently known issues in BDR4. +This section discusses currently known issues in EDB Postgres Distributed 4. ## Data Consistency @@ -18,6 +16,18 @@ In this section we list a number of known issues that are tracked in BDR's ticketing system, that are expected to be re-solved in one of the future releases. +- Performance of HARP in terms of failover and switchover time depends + non-linearly on the latencies between DCS nodes. Which is why + we currently recommend using etcd cluster per region for HARP in case + of EDB Postgres Distributed deployment over multiple regions (typically + the Gold and Platinum layouts). TPAexec already sets up the etcd do run + per region cluster for these when `harp_consensus_protocol` option + is set to `etcd` in the `config.yml`. + + It's recommended to increase the `leader_lease_duration` HARP option + (`harp_leader_lease_duration` in TPAexec) for DCS deployments across higher + latency network. + - If the resolver for the `update_origin_change` conflict is set to `skip`, and `synchronous_commit=remote_apply` is used, and concurrent updates of the same row are repeatedly applied on two From 651ec14ab062aac25c9a802e85d84c1f3ddf25e4 Mon Sep 17 00:00:00 2001 From: Petr Jelinek Date: Thu, 19 May 2022 13:48:05 +0200 Subject: [PATCH 08/10] Fix couple of links --- product_docs/docs/pgd/4/known_issues.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/pgd/4/known_issues.mdx b/product_docs/docs/pgd/4/known_issues.mdx index 987e36b3f21..33b134a514d 100644 --- a/product_docs/docs/pgd/4/known_issues.mdx +++ b/product_docs/docs/pgd/4/known_issues.mdx @@ -6,7 +6,7 @@ This section discusses currently known issues in EDB Postgres Distributed 4. ## Data Consistency -Please remember to read about [Conflicts](conflicts) to understand +Please remember to read about [Conflicts](/bdr/latest/conflicts/) to understand the implications of the asynchronous operation mode in terms of data consistency. @@ -33,7 +33,7 @@ releases. concurrent updates of the same row are repeatedly applied on two different nodes, then one of the update statements might hang due to a deadlock with the BDR writer. As mentioned in the - [Conflicts](conflicts) chapter, `skip` is not the default + [Conflicts](/bdr/latest/conflicts/) chapter, `skip` is not the default resolver for the `update_origin_change` conflict, and this combination is not intended to be used in production: it discards one of the two conflicting updates based on the order of arrival @@ -63,8 +63,8 @@ releases. Adding or removing a pair does not need a restart of Postgres or even a reload of the configuration. -- Group Commit cannot be combined with [CAMO](camo) or [Eager All Node - replication](eager). Eager Replication currently only works by using the +- Group Commit cannot be combined with [CAMO](/bdr/latest/camo/) or [Eager All Node + replication](/bdr/latest/eager/). Eager Replication currently only works by using the "global" BDR commit scope. - Neither Eager replication nor Group Commit support @@ -82,9 +82,9 @@ releases. - Parallel apply is not currently supported in combination with Group Commit, please make sure to disable it when using Group Commit by either setting `num_writers` to 1 for the node group (using - [`bdr.alter_node_group_config`](nodes#bdralter_node_group_config)) or + [`bdr.alter_node_group_config`](/bdr/latest/nodes#bdralter_node_group_config)) or via the GUC `bdr.writers_per_subscription` (see - [Configuration of Generic Replication](configuration#generic-replication)). + [Configuration of Generic Replication](/bdr/latest/configuration#generic-replication)). - There currently is no protection against altering or removing a commit scope. Running transactions in a commit scope that is concurrently From f0ddaadcea79efdea4d6f366905325e962877e00 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 19 May 2022 11:04:03 -0400 Subject: [PATCH 09/10] typos in PGD TPAexec content --- product_docs/docs/pgd/4/deployments/tpaexec/index.mdx | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/pgd/4/deployments/tpaexec/index.mdx b/product_docs/docs/pgd/4/deployments/tpaexec/index.mdx index 4fe43c9ad8c..06215006462 100644 --- a/product_docs/docs/pgd/4/deployments/tpaexec/index.mdx +++ b/product_docs/docs/pgd/4/deployments/tpaexec/index.mdx @@ -22,17 +22,20 @@ The configuration options include: | Flags | Description | | ---------------------------- | ----------- | -| --architecture BDR-Always-ON | Required. Produces a working configuration. | -| --layout layoutname | Required. Specify one of the supported BDR use-case variations: bronze, silver, gold, and platinum. See [Choosing your architecture][/pgd/4/architectures] for more information. | -| --bdr-node-group groupname | Optional. Set the name of the BDR node group. The default is bdrgroup. | -| --bdr-database dbname | Optional. Set the name of the database with BDR enabled. The default is bdrdb. | +| --architecture BDR-Always-ON | Required. Set to 'BDR-Always-ON' for EDB Postgres Distributed deployments | +| --layout layoutname | Required. Specify one of the four supported architectures: bronze, silver, gold, and platinum. See [Choosing your architecture][/pgd/4/architectures] for more information. | +| --harp-consensus-protocol | Required. `bdr` is recommended if your layout is bronze or silver. `etcd` is recommended if your layout is gold or platinum. See [Choosing your DCS]/pgd/4/dcs] for more information. | +| --bdr-node-group groupname | Optional. Set the name of the BDR node group. The default is `bdrgroup`. | +| --bdr-database dbname | Optional. Set the name of the database with BDR enabled. The default is `bdrdb`. | | --enable-camo | Optional. Set the pair of BDR primary instances in each region to be each other's CAMO partners. | +For example: ``` [tpa]$ tpaexec configure ~/clusters/bdr \ --architecture BDR-Always-ON \ --layout gold \ + --harp-consensus-protocol etcd \ --platform aws --region eu-west-1 --instance-type t3.micro \ --distribution Debian-minimal ``` From e2ab35871a582ba0cefa1ae0ecb7798b202f95e3 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 19 May 2022 12:40:07 -0400 Subject: [PATCH 10/10] BigAnimal: added redirect --- .../release/getting_started/preparing_cloud_account/index.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/index.mdx b/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/index.mdx index 35bf2614da3..df84ac09c72 100644 --- a/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/index.mdx @@ -1,6 +1,8 @@ --- title: "Checking your cloud readiness" indexCards: simple +redirects: + - /biganimal/latest/getting_started/01_check_resource_limits/ --- Each time you create a new cluster you must ensure the readiness of your cloud to work with BigAnimal.