From d8ed934d7acbbe192febe20146339bf607ca08d6 Mon Sep 17 00:00:00 2001 From: francoughlin Date: Fri, 28 Jul 2023 16:00:41 -0400 Subject: [PATCH 01/28] Edits for topics in the Database administration branch Edits for topics in the Database administration branch --- .../01_setting_new_parameters.mdx | 26 +++++++++---------- .../index.mdx | 1 + ...03_resource_usage_edb_resource_manager.mdx | 2 +- .../04_query_tuning.mdx | 2 +- .../07_auditing_settings/index.mdx | 3 ++- .../14_audit_archiver.mdx | 2 +- .../attribute_descriptions.mdx | 1 - .../index.mdx | 2 +- .../01_configuration_parameters/index.mdx | 4 +-- .../building_the_control_file/index.mdx | 10 +++++-- .../02_edb_loader/data_loading_methods.mdx | 13 +++------- .../edb_loader_overview_and_restrictions.mdx | 21 ++++++++------- .../conventional_path_load.mdx | 4 +++ .../invoking_edb_loader/direct_path_load.mdx | 8 +++--- .../invoking_edb_loader/index.mdx | 18 ++++++------- .../parallel_direct_path_load.mdx | 4 +++ .../performing_remote_loading.mdx | 4 +++ .../cpu_usage_throttling.mdx | 10 +++---- .../creating_resource_groups.mdx | 6 ++--- .../dirty_buffer_throttling.mdx | 21 ++++++++------- .../10_edb_resource_manager/index.mdx | 4 +-- .../copying_a_remote_schema.mdx | 7 +++-- .../14_edb_clone_schema/copying_a_schema.mdx | 5 ++-- .../setting_up_edb_clone_schema.mdx | 11 +++----- 24 files changed, 104 insertions(+), 85 deletions(-) diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/01_setting_new_parameters.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/01_setting_new_parameters.mdx index 06b2201e352..f8d5ace2882 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/01_setting_new_parameters.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/01_setting_new_parameters.mdx @@ -26,6 +26,8 @@ search_path = '"$user", public' shared_buffers = 128MB ``` +## Types of parameter values + Parameter values are specified as one of five types: - **Boolean** — Acceptable values are `on`, `off`, `true`, `false`, `yes`, `no`, `1`, `0`, or any unambiguous prefix of these. @@ -34,7 +36,7 @@ Parameter values are specified as one of five types: - **String** — Text value enclosed in single quotes if the value isn't a simple identifier or number, that is, the value contains special characters such as spaces or other punctuation marks. - **Enum** — Specific set of string values. The allowed values can be found in the system view `pg_settings.enumvals`. Enum values are not case sensitive. -Some settings specify a memory or time value. Each of these has an implicit unit, which is kilobytes, blocks (typically 8 kilobytes), milliseconds, seconds, or minutes. You can find default units by referencing the system view `pg_settings.unit`. You can specify a different explicitly. +Some settings specify a memory or time value. Each of these has an implicit unit, which is kilobytes, blocks (typically 8 kilobytes), milliseconds, seconds, or minutes. You can find default units by referencing the system view `pg_settings.unit`. You can specify a different unit explicitly. Valid memory units are: - `kB` (kilobytes) @@ -50,27 +52,27 @@ Valid time units are: The multiplier for memory units is 1024. -You can set the configuration parameter settings in a number of different ways: +## Specifying configuration parameter settings -- A number of parameter settings are set when the EDB Postgres Advanced Server database product is built. These are read-only parameters, and you can't change their values. A couple of parameters are also permanently set for each database when the database is created. These parameters are read-only and you can't later change them for the database. +A number of parameter settings are set when the EPAS database product is built. These are read-only parameters, and you can't change their values. A couple of parameters are also permanently set for each database when the database is created. These parameters are read-only and you can't later change them for the database. However, there are a number of ways to specify the configuration parameter settings: -- The initial settings for almost all configurable parameters across the entire database cluster are listed in the configuration file `postgresql.conf`. These settings are put into effect upon database server start or restart. You can override some of these initial parameter settings. All configuration parameters have built-in default settings that are in effect if not explicitly overridden. +- The initial settings for almost all configurable parameters across the entire database cluster are listed **in the `postgresql.conf`** configuration file. These settings are put into effect upon database server start or restart. You can override some of these initial parameter settings. All configuration parameters have built-in default settings that are in effect unless they are explicitly overridden. -- Configuration parameters in the `postgresql.conf` file are overridden when the same parameters are included in the `postgresql.auto.conf` file. The `ALTER SYSTEM` command is used to manage the configuration parameters in the `postgresql.auto.conf` file. +- Configuration parameters in the `postgresql.conf` file are overridden when the same parameters are included **in the `postgresql.auto.conf` file**. The `ALTER SYSTEM` command is used to manage the configuration parameters in the `postgresql.auto.conf` file. -- You can modify parameter settings in the configuration file while the database server is running. If the configuration file is then reloaded (meaning a SIGHUP signal is issued), for certain parameter types, the changed parameters settings immediately take effect. For some of these parameter types, the new settings are available in a currently running session immediately after the reload. For other of these parameter types, you must start a new session to use the new settings. And yet for other parameter types, modified settings don't take effect until the database server is stopped and restarted. See the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/config-setting.html) for information on how to reload the configuration file: +- You can modify parameter settings **in the configuration file while the database server is running**. If the configuration file is then reloaded (meaning a SIGHUP signal is issued), for certain parameter types, the changed parameters settings immediately take effect. For some of these parameter types, the new settings are available in a currently running session immediately after the reload. For other of these parameter types, you must start a new session to use the new settings. And yet for other parameter types, modified settings don't take effect until the database server is stopped and restarted. See the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/config-setting.html) for information on how to reload the configuration file: -- You can use the SQL commands `ALTER DATABASE`, `ALTER ROLE`, or `ALTER ROLE IN DATABASE` to modify certain parameter settings. The modified parameter settings take effect for new sessions after you execute the command. `ALTER DATABASE` affects new sessions connecting to the specified database. `ALTER ROLE` affects new sessions started by the specified role. `ALTER ROLE IN DATABASE` affects new sessions started by the specified role connecting to the specified database. Parameter settings established by these SQL commands remain in effect indefinitely, across database server restarts, overriding settings established by the other methods. Parameter settings established using the `ALTER DATABASE`, `ALTER ROLE`, or `ALTER ROLE IN DATABASE` commands can be changed only by either: +- You can **use the SQL commands** `ALTER DATABASE`, `ALTER ROLE`, or `ALTER ROLE IN DATABASE` to modify certain parameter settings. The modified parameter settings take effect for new sessions after you execute the command. `ALTER DATABASE` affects new sessions connecting to the specified database. `ALTER ROLE` affects new sessions started by the specified role. `ALTER ROLE IN DATABASE` affects new sessions started by the specified role connecting to the specified database. Parameter settings established by these SQL commands remain in effect indefinitely, across database server restarts, overriding settings established by the other methods. Parameter settings established using the `ALTER DATABASE`, `ALTER ROLE`, or `ALTER ROLE IN DATABASE` commands can be changed only by either: - Reissuing these commands with a different parameter value. - Issuing these commands using either of the `SET parameter TO DEFAULT` clause or the `RESET parameter` clause. These clauses change the parameter back to using the setting set by the other methods. See the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/sql-commands.html) for the exact syntax of these SQL commands. -- You can make changes for certain parameter settings for the duration of individual sessions using the `PGOPTIONS` environment variable or by using the `SET` command in the EDB-PSQL or PSQL command-line programs. Parameter settings made this way override settings established using any of the methods descussed earlier, but only during that session. +- You can make changes for certain parameter settings for the duration of individual sessions **using the `PGOPTIONS` environment variable** or by **using the `SET` command in the EDB-PSQL or PSQL command-line programs**. Parameter settings made this way override settings established using any of the methods descussed earlier, but only during that session. ## Modifying the postgresql.conf file -The configuration parameters in the `postgresql.conf` file specify server behavior with regard to auditing, authentication, encryption, and other behaviors. On Linux and Windows hosts, the `postgresql.conf` file resides in the `data` directory under your EDB Postgres Advanced Server installation. +The configuration parameters in the `postgresql.conf` file specify server behavior with regard to auditing, authentication, encryption, and other behaviors. On Linux and Windows hosts, the `postgresql.conf` file resides in the `data` directory under your EPAS installation. Parameters that are preceded by a pound sign (#) are set to their default value. To change a parameter value, remove the pound sign and enter a new value. After setting or changing a parameter, you must either `reload` or `restart` the server for the new parameter value to take effect. @@ -86,9 +88,7 @@ SELECT name FROM pg_settings WHERE context = 'postmaster'; Appropriate authentication methods provide protection and security. Entries in the `pg_hba.conf` file specify the authentication methods that the server uses with connecting clients. Before connecting to the server, you might need to modify the authentication properties specified in the `pg_hba.conf` file. -When you invoke the initdb utility to create a cluster, the utility creates a `pg_hba.conf` file for that cluster that specifies the type of authentication required from connecting clients. You can modify this file. After modifying the authentication settings in the `pg_hba.conf` file, restart the server and apply the changes. - -For more information about authentication and modifying the `pg_hba.conf` file, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/auth-pg-hba-conf.html). +When you invoke the `initdb` utility to create a cluster, the utility creates a `pg_hba.conf` file for that cluster that specifies the type of authentication required from connecting clients. You can modify this file. After modifying the authentication settings in the `pg_hba.conf` file, restart the server and apply the changes. For more information about authentication and modifying the `pg_hba.conf` file, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/auth-pg-hba-conf.html). When the server receives a connection request, it verifies the credentials provided against the authentication settings in the `pg_hba.conf` file before allowing a connection to a database. To log the `pg_hba.conf` file entry to authenticate a connection to the server, set the `log_connections` parameter to `ON` in the `postgresql.conf` file. @@ -104,7 +104,7 @@ application_name=psql "local all all md5" ``` -### Obfuscating the LDAP password +## Obfuscating the LDAP password When using [LDAP](https://www.postgresql.org/docs/15/auth-ldap.html) for authentication, the LDAP password used to connect to the LDAP server, (the ldapbindpasswd password) is stored in the pg_hba.conf file. You can store the password there in an obfuscated form, which can then be de-obfuscated by a loadable module which you supply. The loadable module supplies a hook function that performs the de-obfuscation. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/index.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/index.mdx index 82ac239aeb2..f387fa4a138 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/index.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/index.mdx @@ -1,5 +1,6 @@ --- title: "Top performance-related parameters" +indexCards: simple legacyRedirectsGenerated: # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. - "/edb-docs/d/edb-postgres-advanced-server/user-guides/user-guide/9.6/EDB_Postgres_Advanced_Server_Guide.1.12.html" diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/03_resource_usage_edb_resource_manager.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/03_resource_usage_edb_resource_manager.mdx index f2f5ab6319a..1c4ef34e890 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/03_resource_usage_edb_resource_manager.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/03_resource_usage_edb_resource_manager.mdx @@ -6,7 +6,7 @@ redirects: -These configuration parameters control resource use through EDB Resource Manager. +These configuration parameters control resource use through [EDB Resource Manager](../../10_edb_resource_manager/). ## edb_max_resource_groups diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/04_query_tuning.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/04_query_tuning.mdx index 81f4b29e3e3..0cde6b4b2ad 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/04_query_tuning.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/04_query_tuning.mdx @@ -10,7 +10,7 @@ redirects: -These configuration parameters are used for optimizer hints. +These configuration parameters are used for [optimizer hints](../../../application_programming/optimizing_code/05_optimizer_hints/). ## enable_hints diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/index.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/index.mdx index d83a15c8c8d..19677f0eb12 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/index.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/index.mdx @@ -1,12 +1,13 @@ --- title: "Auditing settings" +indexCards: simple redirects: - ../../../../epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings #generated for docs/epas/reorg-role-use-case-mode --- -These configuration parameters are for use with the EDB Postgres Advanced Server database auditing feature. +These configuration parameters are for use with the EDB Postgres Advanced Server database [auditing feature](/../../../epas_security_guide/05_edb_audit_logging/).
diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/14_audit_archiver.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/14_audit_archiver.mdx index 30d27ccf87f..b01cf0f9fc0 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/14_audit_archiver.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/14_audit_archiver.mdx @@ -6,7 +6,7 @@ redirects: -These configuration parameters are used by the EDB Postgres Advanced Server database audit archiving feature. +These configuration parameters are used by the EDB Postgres Advanced Server database [audit archiving feature](/../../../epas_security_guide/05_edb_audit_logging/08_audit_log_archiving/). ## edb_audit_archiver diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/attribute_descriptions.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/attribute_descriptions.mdx index e8134d5a41c..65b3f98a07a 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/attribute_descriptions.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/attribute_descriptions.mdx @@ -1,6 +1,5 @@ --- title: "Description of parameter attributes" -description: "Provides a detailed description of the attributes of each configuration parameter, grouped by function" --- The description of each group of parameters includes this list of attributes: diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/index.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/index.mdx index fe0609b1fa9..6c029601e80 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/index.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/index.mdx @@ -12,7 +12,7 @@ redirects: -Configuration parameters can be grouped by function. See [Description of attributes](attribute_descriptions) for the list of attributes included in each configuration parameter description. +Configuration parameters can be grouped by function. See [Description of parameter attributes](attribute_descriptions) for the list of attributes included in each configuration parameter description.
diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/index.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/index.mdx index 23195c61b14..3aa2b2bed6a 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/index.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/index.mdx @@ -12,9 +12,9 @@ redirects: -The EDB Postgres Advanced Server configuration parameters control various aspects of the database server’s behavior and environment such as data file and log file locations, connection, authentication and security settings, resource allocation and consumption, archiving and replication settings, error logging and statistics gathering, optimization and performance tuning, and locale and formatting settings +The EDB Postgres Advanced Server (EPAS) configuration parameters control various aspects of the database server’s behavior and environment such as data file and log file locations, connection, authentication and security settings, resource allocation and consumption, archiving and replication settings, error logging and statistics gathering, optimization and performance tuning, and locale and formatting settings -Configuration parameters that apply only to EDB Postgres Advanced Server are noted in the [Summary of configuration parameters](/epas/latest/reference/database_administrator_reference/02_summary_of_configuration_parameters/). +Configuration parameters that apply only to EPAS are noted in the [Summary of configuration parameters](/epas/latest/reference/database_administrator_reference/02_summary_of_configuration_parameters/) topic, which lists all EPAS configuration parameters along with a number of key attributes of the parameters. You can find more information about configuration parameters in the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/runtime-config.html). diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/building_the_control_file/index.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/building_the_control_file/index.mdx index a6956e8fbc4..b6dbb908a4d 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/building_the_control_file/index.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/building_the_control_file/index.mdx @@ -6,7 +6,11 @@ description: "Provides information necessary to build a control file" -When you invoke EDB\*Loader, the list of arguments provided must include the name of a control file. The control file includes the instructions that EDB\*Loader uses to load the tables from the input data file. The control file includes information such as: +When you invoke EDB\*Loader, the list of arguments provided must include the name of a control file. The control file includes the instructions that EDB\*Loader uses to load the tables from the input data file. + +## Contents of the control file + +The control file includes information such as: - The name of the input data file containing the data to load - The name of the tables to load from the data file @@ -62,7 +66,7 @@ FLOAT EXTERNAL [()] | DECIMAL EXTERNAL [()] | ZONED EXTERNAL [()] | ZONED [( [,])] ``` -## Description +## Setting the variables The specification of `data_file`, `bad_file`, and `discard_file` can include the full directory path or a relative directory path to the filename. If the filename is specified alone or with a relative directory path, the file is then assumed to exist, in the case of `data_file`, relative to the current working directory from which you invoke `edbldr`. In the case of `bad_file` or `discard_file`, it's created. @@ -83,6 +87,8 @@ The operating system account enterprisedb must have read permission on the direc !!! Note The filenames for `data_file`, `bad_file`, and `discard_file` must have extensions `.dat`, `.bad`, and `.dsc`, respectively. If the provided filename doesn't have an extension, EDB\*Loader assumes the actual filename includes the appropriate extension. +## Example scenarios + Suppose an EDB\*Loader session results in data format errors, the `BADFILE` clause isn't specified, and the `BAD` parameter isn't given on the command line when `edbldr` is invoked. In this case, a bad file is created with the name `control_file_base.bad` in the directory from which `edbldr` is invoked. `control_file_base` is the base name of the control file used in the `edbldr` session. If all of the following conditions are true, the discard file isn't created even if the EDB\*Loader session results in discarded records: diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/data_loading_methods.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/data_loading_methods.mdx index 3ec1342a52a..ab776d3ca94 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/data_loading_methods.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/data_loading_methods.mdx @@ -6,19 +6,12 @@ description: "Description of the data loading methods supported by EDB*Loader" As with Oracle SQL\*Loader, EDB\*Loader supports three data loading methods: -- Conventional path load -- Direct path load -- Parallel direct path load +- *Conventional path load* — Conventional path load is the default method used by EDB\*Loader. Use basic insert processing to add rows to the table. The advantage of a conventional path load is that table constraints and database objects defined on the table are enforced during a conventional path load. Table constraints and database objects include primary keys, not null constraints, check constraints, unique indexes, foreign key constraints, triggers, and so on. One exception is that the EDB Postgres Advanced Server rules defined on the table aren't enforced. EDB\*Loader can load tables on which rules are defined. However, the rules aren't executed. As a consequence, you can't load partitioned tables implemented using rules with EDB\*Loader. -Conventional path load is the default method used by EDB\*Loader. Use basic insert processing to add rows to the table. +- *Direct path loads* — A direct path load is faster than a conventional path load but requires removing most types of constraints and triggers from the table. For more information, see [Direct path load](invoking_edb_loader/direct_path_load.mdx). -The advantage of a conventional path load is that table constraints and database objects defined on the table are enforced during a conventional path load. Table constraints and database objects include primary keys, not null constraints, check constraints, unique indexes, foreign key constraints, triggers, and so on. - -One exception is that the EDB Postgres Advanced Server rules defined on the table aren't enforced. EDB\*Loader can load tables on which rules are defined. However, the rules aren't executed. As a consequence, you can't load partitioned tables implemented using rules with EDB\*Loader. +- *Parallel direct path loads* — A parallel direct path load provides even greater performance improvement by permitting multiple EDB\*Loader sessions to run simultaneously to load a single table. For more information, see [Parallel direct path load](invoking_edb_loader/parallel_direct_path_load.mdx). !!! Note Create EDB Postgres Advanced Server rules using the `CREATE RULE` command. EDB Postgres Advanced Server rules aren't the same database objects as rules and rule sets used in Oracle. -EDB\*Loader also supports direct path loads. A direct path load is faster than a conventional path load but requires removing most types of constraints and triggers from the table. For more information, see [Direct path load](invoking_edb_loader/direct_path_load.mdx). - -EDB\*Loader supports parallel direct path loads. A parallel direct path load provides even greater performance improvement by permitting multiple EDB\*Loader sessions to run simultaneously to load a single table. For more information, see [Parallel direct path load](invoking_edb_loader/parallel_direct_path_load.mdx). diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/edb_loader_overview_and_restrictions.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/edb_loader_overview_and_restrictions.mdx index 6b7d53ef263..6b80c7c88b7 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/edb_loader_overview_and_restrictions.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/edb_loader_overview_and_restrictions.mdx @@ -4,6 +4,8 @@ navTitle: "Key concepts and compatability" description: "Provides an overview of the key features of EDB*Loader as well as important compatability information" --- +## Key features + EDB\*Loader features include: - Support for the Oracle SQL\*Loader data loading methods (conventional path load, direct path load, and parallel direct path load) @@ -15,15 +17,16 @@ EDB\*Loader features include: - Log file for recording the EDB\*Loader session and any error messages - Data loading from standard input and remote loading, particularly useful for large data sources on remote hosts -!!! Note - The following are important version compatibility restrictions between the EDB\*Loader client and the database server. +## Version compatibility restrictions + +The following are important version compatibility restrictions between the EDB\*Loader client and the database server. - - When you invoke the EDB\*Loader program (called `edbldr`), you pass in parameters and directive information to the database server. We strongly recommend that you use the version 14 EDB\*Loader client (the edbldr program supplied with EDB Postgres Advanced Server 14) to load data only into version 14 of the database server. In general, use the same version for the EDB\*Loader client and database server. +- When you invoke the EDB\*Loader program (called `edbldr`), you pass in parameters and directive information to the database server. We strongly recommend that you use the version 14 EDB\*Loader client (the edbldr program supplied with EDB Postgres Advanced Server 14) to load data only into version 14 of the database server. In general, use the same version for the EDB\*Loader client and database server. - - Using EDB\*Loader with connection poolers such as PgPool-II and PgBouncer isn't supported. EDB\*Loader must connect directly to EDB Postgres Advanced Server version 14. Alternatively, the following are some of the commands you can use for loading data through connection poolers: +- Using EDB\*Loader with connection poolers such as PgPool-II and PgBouncer isn't supported. EDB\*Loader must connect directly to EDB Postgres Advanced Server version 14. Alternatively, the following are some of the commands you can use for loading data through connection poolers: - ```shell - psql \copy - jdbc copyIn - psycopg2 copy_from - ``` +```shell +psql \copy +jdbc copyIn +psycopg2 copy_from +``` diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/conventional_path_load.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/conventional_path_load.mdx index 31662351d80..7ab16cf7f79 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/conventional_path_load.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/conventional_path_load.mdx @@ -13,6 +13,8 @@ You can use EDB\*Loader with a conventional path load to update the rows in a ta To use EDB\*Loader to update a table, the table must have a primary key. You can't use EDB\*Loader to update a partitioned table. +## Performing the update + To perform `UPDATE`, use the same steps as when performing a conventional path load: 1. Create a data file that contains the rows you want to update or insert. @@ -71,6 +73,8 @@ Invoke EDB\*Loader, specifying the name of the database (`edb`), the name of a d edbldr -d edb userid=user_name/password control=emp_update.ctl ``` +## Results of the update + After performing the update, the `emp` table contains: ```sql diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/direct_path_load.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/direct_path_load.mdx index af0ade12ca2..41058312503 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/direct_path_load.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/direct_path_load.mdx @@ -6,14 +6,14 @@ description: "Describes how to use EDB*Loader to write data directly to the data -During a direct path load, EDB\*Loader writes the data directly to the database pages, which is then synchronized to disk. The insert processing associated with a conventional path load is bypassed, resulting in a performance improvement. - -Bypassing insert processing reduces the types of constraints on the target table. The following types of constraints are permitted on the target table of a direct path load: +During a direct path load, EDB\*Loader writes the data directly to the database pages, which is then synchronized to disk. The insert processing associated with a conventional path load is bypassed, resulting in a performance improvement. Bypassing insert processing reduces the types of constraints on the target table. The following types of constraints are permitted on the target table of a direct path load: - Primary key - Not null constraints - Indexes (unique or non-unique) +## Restrictions + The following are restrictions on the target table of a direct path load: - Triggers aren't permitted. @@ -30,6 +30,8 @@ The following are restrictions on the target table of a direct path load: - You can't use SQL expressions in the data field definitions of the `INTO TABLE` clause. - The `FREEZE` option isn't supported for direct path loading. +## Running the direct path load + To run a direct path load, add the `DIRECT=TRUE` option: ```shell diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/index.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/index.mdx index dc625146219..a3e9f3391ff 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/index.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/index.mdx @@ -37,21 +37,21 @@ edbldr [ -d ] [ -p ] [ -h ] ## Description -If you omit the `-d` option, the `-p` option, or the `-h` option, the defaults for the database, port, and host are determined by the same rules as other EDB Postgres Advanced Server utility programs, such as `edb-psql`. - You can specify parameters listed in the syntax diagram in a *parameter file*. Exeptions include the `-d` option, `-p` option, `-h` option, and the `PARFILE` parameter. Specify the parameter file on the command line when you invoke `edbldr` using `PARFILE=param_file`. You can specify some parameters in the `OPTIONS` clause in the control file. For more information on the control file, see [Building the EDB\*Loader control file](../building_the_control_file/). You can include the full directory path or a relative directory path to the file name when specifying `control_file`, `data_file`, `bad_file`, `discard_file`, `log_file`, and `param_file`. If you specify the file name alone or with a relative directory path, the file is assumed to exist in the case of `control_file`, `data_file`, or `param_file` relative to the current working directory from which `edbldr` is invoked. In the case of `bad_file`, `discard_file`, or `log_file`, the file is created. -!!! Note - The control file must exist in the character set encoding of the client where `edbldr` is invoked. If the client is in an encoding different from the database encoding, then you must set the `PGCLIENTENCODING` environment variable on the client to the client’s encoding prior to invoking `edbldr`. This technique ensures character set conversion between the client and the database server is done correctly. +If you omit the `-d` option, the `-p` option, or the `-h` option, the defaults for the database, port, and host are determined by the same rules as other EDB Postgres Advanced Server (EPAS) utility programs, such as `edb-psql`. + +## Requirements + +- The control file must exist in the character set encoding of the client where `edbldr` is invoked. If the client is in an encoding different from the database encoding, then you must set the `PGCLIENTENCODING` environment variable on the client to the client’s encoding prior to invoking `edbldr`. This technique ensures character set conversion between the client and the database server is done correctly. -The operating system account used to invoke `edbldr` must have read permission on the directories and files specified by `control_file`, `data_file`, and `param_file`. +- The file names for `control_file`, `data_file`, `bad_file`, `discard_file`, and `log_file` must include the extensions `.ctl`, `.dat`, `.bad`, `.dsc`, and `.log`, respectively. If the provided file name doesn't contain an extension, EDB\*Loader assumes the actual file name includes the appropriate extension. -The operating system account `enterprisedb` must have write permission on the directories where `bad_file`, `discard_file`, and `log_file` are written. +- The operating system account used to invoke `edbldr` must have read permission on the directories and files specified by `control_file`, `data_file`, and `param_file`. -!!! Note - The file names for `control_file`, `data_file`, `bad_file`, `discard_file`, and `log_file` must include the extensions `.ctl`, `.dat`, `.bad`, `.dsc`, and `.log`, respectively. If the provided file name doesn't contain an extension, EDB\*Loader assumes the actual file name includes the appropriate extension. +- The operating system account `enterprisedb` must have write permission on the directories where `bad_file`, `discard_file`, and `log_file` are written. ## Parameters @@ -78,7 +78,7 @@ The operating system account `enterprisedb` must have write permission on the di If you specify `USERID=username`, then EDB\*Loader prompts for `password`. If you specify `USERID=/`, the connection is attempted using the operating system account as the user name. !!! Note - EDB\*Loader ignores the EDB Postgres Advanced Server connection environment variables `PGUSER` and `PGPASSWORD`. See the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/libpq-pgpass.html) for information on the `PGPASSFILE` environment variable and the password file. + EDB\*Loader ignores the EPAS connection environment variables `PGUSER` and `PGPASSWORD`. See the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/libpq-pgpass.html) for information on the `PGPASSFILE` environment variable and the password file. `-c CONNECTION_STRING` diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/parallel_direct_path_load.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/parallel_direct_path_load.mdx index 462108389d2..b0c47ba23d8 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/parallel_direct_path_load.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/parallel_direct_path_load.mdx @@ -10,6 +10,8 @@ You can further improve the performance of a direct path load by distributing th Since the same table is loaded from multiple sessions, the input records to load into the table must be divided among several data files. This way, each EDB\*Loader session uses its own data file, and the same record isn't loaded into the table more than once. +## Restrictions + The target table of a parallel direct path load is under the same restrictions as a direct path load run in a single session. The following are the restrictions on the target table of a direct path load: @@ -23,6 +25,8 @@ The following are the restrictions on the target table of a direct path load: In addition, you must specify the `APPEND` clause in the control file used by each EDB\*Loader session. +## Running a parallel direct path load + To run a parallel direct path load, run EDB\*Loader in a separate session for each participant of the parallel direct path load. You must include the `DIRECT=TRUE` and `PARALLEL=TRUE` parameters when invoking each such EDB\*Loader session. Each EDB\*Loader session runs as an independent transaction. Aborting and rolling back changes of one of the parallel sessions doesn't affect the loading done by the other parallel sessions. diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/performing_remote_loading.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/performing_remote_loading.mdx index 7c68bcd0de3..44bb3cba953 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/performing_remote_loading.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/performing_remote_loading.mdx @@ -12,6 +12,8 @@ This feature is useful if you have a large amount of data to load, and you don't In addition, you can use the standard input feature to pipe the data from the data source, such as another program or script, directly to EDB\*Loader. EDB\*Loader then loads the table in the remote database. This feature bypasses having to create a data file on disk for EDB\*Loader. +## Requirements + Performing remote loading along with using standard input requires the following: - The `edbldr` program must be installed on the client host on which to invoke it with the data source for the EDB\*Loader session. @@ -20,6 +22,8 @@ Performing remote loading along with using standard input requires the following - When invoking EDB\*Loader, use the `-h` option to specify the IP address of the remote database server. For more information, see [Invoking EDB\*Loader](../). - Use the operating system pipe operator (`|`) or input redirection operator (`<`) to supply the input data to EDB\*Loader. +## Loading a database + This example loads a database running on a database server at `192.168.1.14` using data piped from a source named `datasource`: ```shell diff --git a/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/cpu_usage_throttling.mdx b/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/cpu_usage_throttling.mdx index f8cba087c68..e9622fa8567 100644 --- a/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/cpu_usage_throttling.mdx +++ b/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/cpu_usage_throttling.mdx @@ -3,15 +3,15 @@ title: "CPU usaqe throttling" description: "How to use EDB Resource Manager to control the CPU use of a resource group" --- -Control CPU use of a resource group by setting the `cpu_rate_limit` resource type parameter. +EDB Resource Manager uses *CPU throttling* to keep the aggregate CPU usage of all processes in the group within the limit specified by the `cpu_rate_limit` parameter. A process in the group might be interrupted and put into sleep mode for a short time to maintain the defined limit. When and how such interruptions occur is defined by a proprietary algorithm used by EDB Resource Manager. -Set the `cpu_rate_limit` parameter to the fraction of CPU time over wall-clock time to which the combined, simultaneous CPU usage of all processes in the group must not exceed. The value assigned to `cpu_rate_limit` is typically less than or equal to 1. +To control CPU use of a resource group, set the `cpu_rate_limit` resource type parameter. -On multicore systems, you can apply the `cpu_rate_limit` to more than one CPU core by setting it to greater than 1. For example, if `cpu_rate_limit` is set to 2.0, you use 100% of two CPUs. The valid range of the `cpu_rate_limit` parameter is 0 to 1.67772e+07. A setting of 0 means no CPU rate limit was set for the resource group. +- Set the `cpu_rate_limit` parameter to the fraction of CPU time over wall-clock time to which the combined, simultaneous CPU usage of all processes in the group must not exceed. The value assigned to `cpu_rate_limit` is typically less than or equal to 1. -When the value is multiplied by 100, you can also interpret the `cpu_rate_limit` as the CPU usage percentage for a resource group. +- On multicore systems, you can apply the `cpu_rate_limit` to more than one CPU core by setting it to greater than 1. For example, if `cpu_rate_limit` is set to 2.0, you use 100% of two CPUs. The valid range of the `cpu_rate_limit` parameter is 0 to 1.67772e+07. A setting of 0 means no CPU rate limit was set for the resource group. -EDB Resource Manager uses *CPU throttling* to keep the aggregate CPU usage of all processes in the group within the limit specified by the `cpu_rate_limit` parameter. A process in the group might be interrupted and put into sleep mode for a short time to maintain the defined limit. When and how such interruptions occur is defined by a proprietary algorithm used by EDB Resource Manager. +- When the value is multiplied by 100, you can also interpret the `cpu_rate_limit` as the CPU usage percentage for a resource group. ## Setting the CPU rate limit for a resource group diff --git a/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/creating_resource_groups.mdx b/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/creating_resource_groups.mdx index 1a4d7516e2e..0723a4a35b7 100644 --- a/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/creating_resource_groups.mdx +++ b/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/creating_resource_groups.mdx @@ -5,7 +5,7 @@ description: "How to use EDB Resource Manager to create and manage resource grou Use these data definition language commands to create and manage resource groups. -## CREATE RESOURCE GROUP +## Creating a resource group Use the `CREATE RESOURCE GROUP` command to create a new resource group. @@ -51,7 +51,7 @@ __OUTPUT__ (3 rows) ``` -## ALTER RESOURCE GROUP +## Modifying a resource group Use the `ALTER RESOURCE GROUP` command to change the attributes of an existing resource group. The command syntax comes in three forms. @@ -132,7 +132,7 @@ __OUTPUT__ (3 rows) ``` -## DROP RESOURCE GROUP +## Removing a resource group Use the `DROP RESOURCE GROUP` command to remove a resource group. diff --git a/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/dirty_buffer_throttling.mdx b/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/dirty_buffer_throttling.mdx index 697969f9b56..f6121c03e8d 100644 --- a/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/dirty_buffer_throttling.mdx +++ b/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/dirty_buffer_throttling.mdx @@ -3,13 +3,13 @@ title: "Dirty buffer throttling" description: "How to use EDB Resource Manager to control writing to shared buffers" --- +EDB Resource Manager uses *dirty buffer throttling* to keep the aggregate shared buffer writing rate of all processes in the group near the limit specified by the `dirty_rate_limit` parameter. A process in the group might be interrupted and put into sleep mode for a short time to maintain the defined limit. When and how such interruptions occur is defined by a proprietary algorithm used by EDB Resource Manager. + To control writing to shared buffers, set the `dirty_rate_limit` resource type parameter. -Set the `dirty_rate_limit` parameter to the number of kilobytes per second for the combined rate at which all the processes in the group write to, or “dirty”, the shared buffers. An example setting is 3072 kilobytes per seconds. +- Set the `dirty_rate_limit` parameter to the number of kilobytes per second for the combined rate at which all the processes in the group write to, or “dirty”, the shared buffers. An example setting is 3072 kilobytes per seconds. -The valid range of the `dirty_rate_limit` parameter is 0 to 1.67772e+07. A setting of 0 means no dirty rate limit was set for the resource group. - -EDB Resource Manager uses *dirty buffer throttling* to keep the aggregate shared buffer writing rate of all processes in the group near the limit specified by the `dirty_rate_limit` parameter. A process in the group might be interrupted and put into sleep mode for a short time to maintain the defined limit. When and how such interruptions occur is defined by a proprietary algorithm used by EDB Resource Manager. +- The valid range of the `dirty_rate_limit` parameter is 0 to 1.67772e+07. A setting of 0 means no dirty rate limit was set for the resource group. ## Setting the dirty rate limit for a resource group @@ -38,6 +38,7 @@ __OUTPUT__ resgrp_c | 3072 (3 rows) ``` +## Changing the dirty rate limit Changing the `dirty_rate_limit` of a resource group affects new processes that are assigned to the group. Any currently running processes that are members of the group are also immediately affected by the change. That is, if the `dirty_rate_limit` is changed from 12288 to 3072, currently running processes in the group are throttled downward so that the aggregate group dirty rate is near 3072 kilobytes per second instead of 12288 kilobytes per second. @@ -49,6 +50,8 @@ CREATE TABLE t1 (c1 INTEGER, c2 CHARACTER(500)) WITH (FILLFACTOR = 10); The `FILLFACTOR = 10` clause results in `INSERT` commands packing rows up to only 10% per page. The result is a larger sampling of dirty shared blocks for the purpose of these examples. +## Displaying the number of dirty buffers + The `pg_stat_statements` module is used to display the number of shared buffer blocks that are dirtied by a SQL command and the amount of time the command took to execute. This information is used to calculate the actual kilobytes per second writing rate for the SQL command and thus compare it to the dirty rate limit set for a resource group. To use the `pg_stat_statements` module: @@ -104,7 +107,7 @@ edb=# INSERT INTO t1 VALUES (generate_series (1,10000), 'aaa'); INSERT 0 10000 ``` -The following shows the results from the `INSERT` command: +The following example shows the results from the `INSERT` command: ```sql edb=# SELECT query, rows, total_time, shared_blks_dirtied FROM @@ -149,7 +152,7 @@ edb=# INSERT INTO t1 VALUES (generate_series (1,10000), 'aaa'); INSERT 0 10000 ``` -The following shows the results from the `INSERT` command without the use of a resource group: +The following example shows the results from the `INSERT` command without the use of a resource group: ```sql edb=# SELECT query, rows, total_time, shared_blks_dirtied FROM @@ -178,7 +181,7 @@ The actual dirty rate of 33692 kilobytes per second is much higher than when the As stated previously, the dirty rate limit applies to the aggregate of all processes in the resource group. This concept is illustrated in the following example. -For this example. the inserts are performed simultaneously on two different tables in two separate `psql` sessions, each of which was added to resource group `resgrp_b` that has a `dirty_rate_limit` set to 6144 kilobytes per second. +For this example, the inserts are performed simultaneously on two different tables in two separate `psql` sessions, each of which was added to resource group `resgrp_b` that has a `dirty_rate_limit` set to 6144 kilobytes per second. ### Session 1 @@ -226,7 +229,7 @@ INSERT 0 10000 !!! Note The `INSERT` commands in session 1 and session 2 started after the `SELECT pg_stat_statements_reset()` command in session 2 ran. -The following shows the results from the `INSERT` commands in the two sessions. `RECORD 3` shows the results from session 1. `RECORD 2` shows the results from session 2. +The following example shows the results from the `INSERT` commands in the two sessions. `RECORD 3` shows the results from session 1. `RECORD 2` shows the results from session 2. ```sql edb=# SELECT query, rows, total_time, shared_blks_dirtied FROM @@ -322,7 +325,7 @@ INSERT 0 10000 !!! Note The `INSERT` commands in all four sessions started after the `SELECT pg_stat_statements_reset()` command in session 4 ran. -The following shows the results from the `INSERT` commands in the four sessions: +The following example shows the results from the `INSERT` commands in the four sessions: - `RECORD 3` shows the results from session 1. `RECORD 2` shows the results from session 2. diff --git a/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/index.mdx b/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/index.mdx index 41fb57fbdc7..003b66cc59b 100644 --- a/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/index.mdx +++ b/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/index.mdx @@ -27,8 +27,8 @@ redirects: -EDB Resource Manager is an EDB Postgres Advanced Server feature that lets you control the use of operating system resources used by EDB Postgres Advanced Server processes. +EDB Resource Manager is an EDB Postgres Advanced Server (EPAS) feature that lets you control the use of operating system resources used by EPAS processes. -This capability allows you to protect the system from processes that might uncontrollably overuse and monopolize certain system resources. The following topics discuss the capabilities of the EDB Resource Manager. +This capability allows you to protect the system from processes that might uncontrollably overuse and monopolize certain system resources. diff --git a/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/copying_a_remote_schema.mdx b/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/copying_a_remote_schema.mdx index 8c7275a8364..809dbd4c91c 100644 --- a/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/copying_a_remote_schema.mdx +++ b/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/copying_a_remote_schema.mdx @@ -9,7 +9,7 @@ There are two functions you can use with EDB Clone Schema to perform a remote co - `remotecopyschema` — This function copies a schema and its database objects from a source database to a different target database. Use this function when the source schema and the copy will reside in separate databases. The separate databases can reside in the same EDB Postgres Advanced Server database clusters or in different ones. See [remotecopyschema](#remotecopyschema) for more information. - `remotecopyschema_nb` — This function performs the same purpose as `remotecopyschema` but as a background job, which frees up the terminal from which the function was initiated. This function is a non-blocking function. See [remotecopyschema_nb](#remotecopyschema_nb) for more information. -## remotecopyschema +## Copying a remote schema @@ -159,6 +159,8 @@ __OUTPUT__ (1 row) ``` +### Results + The following shows the cloned tables: ```sql @@ -207,7 +209,7 @@ The `DATA-COPY` log message includes two square-bracket numbers, for example, `[ In case two clone schema jobs are running in parallel, the first log file has `0` as the job index, and the second has `1` as the job index. -## remotecopyschema_nb +## Copying a remote schema using a batch job @@ -287,6 +289,7 @@ The following command starts pgAgent on the target database `tgtdb`. The `pgagen [root@localhost bin]# ./pgagent -l 1 -s /tmp/pgagent_tgtdb_log hostaddr=127.0.0.1 port=5444 user=enterprisedb dbname=tgtdb password=password ``` +### Results The `remotecopyschema_nb` function returns the job ID shown as `2` in the example: diff --git a/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/copying_a_schema.mdx b/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/copying_a_schema.mdx index f0a18dcec9b..303d4dc36cd 100644 --- a/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/copying_a_schema.mdx +++ b/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/copying_a_schema.mdx @@ -9,7 +9,7 @@ There are two functions you can use with EDB Clone Schema to perform a local cop - `localcopyschema` — This function copies a schema and its database objects from a source database into the same database (the target) but with a different schema name from the original. Use this function when the source schema and the copy will reside within the same database. See [localcopyschema](#localcopyschema) for more information. - `localcopyschema_nb` — This function performs the same purpose as `localcopyschema` but as a background job, which frees up the terminal from which the function was initiated. This function is referred to as a *non-blocking* function. See [localcopyschema_nb](#localcopyschema_nb) for more information. -## localcopyschema +## Performing a local copy of a schema @@ -111,6 +111,7 @@ __OUTPUT__ (FINISH,"2017-06-29 11:07:36.830783-04",3855,INFO,"STAGE: FINAL","successfully cloned schema") (1 row) ``` +## Results After the clone is complete, the following shows some of the database objects copied to the `edbcopy` schema: @@ -190,7 +191,7 @@ __OUTPUT__ (24 rows) ``` -## localcopyschema_nb +## Performing a local copy of a schema as a batch job diff --git a/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/setting_up_edb_clone_schema.mdx b/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/setting_up_edb_clone_schema.mdx index d0e18be352d..3234aa1f0ac 100644 --- a/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/setting_up_edb_clone_schema.mdx +++ b/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/setting_up_edb_clone_schema.mdx @@ -188,15 +188,9 @@ For the `remotecopyschema` and `remotecopyschema_nb` functions, the source and t The foreign server defining the originating database server and its database containing the source schema to clone is referred to as the *source server* or the *remote server*. -The foreign server defining the database server and its database to receive the schema to clone is referred to as the *target server* or the *local server*. +The foreign server defining the database server and its database to receive the schema to clone is referred to as the *target server* or the *local server*. The target server is also referred to as the local server because this server is the one to which you must be connected when invoking the `remotecopyschema` or `remotecopyschema_nb` function. -The target server is also referred to as the local server because this server is the one to which you must be connected when invoking the `remotecopyschema` or `remotecopyschema_nb` function. - -The user mappings define the connection and authentication information for the foreign servers. - -You must create all of these foreign servers and user mappings in the target database of the target/local server. - -The database user for whom the user mappings are defined must be a superuser and the user connected to the local server when invoking an EDB Clone Schema function. +The user mappings define the connection and authentication information for the foreign servers. You must create all of these foreign servers and user mappings in the target database of the target/local server. The database user for whom the user mappings are defined must be a superuser and the user connected to the local server when invoking an EDB Clone Schema function. This example creates the foreign server for the local, target database that receives the cloned schema: @@ -239,6 +233,7 @@ CREATE USER MAPPING FOR enterprisedb SERVER src_server password 'srcpassword' ); ``` +## Displaying foreign servers and user mappings The following `psql` commands show the foreign servers and user mappings: From b707c5fde6f16e7f5f5230f825b86471d85d8b53 Mon Sep 17 00:00:00 2001 From: francoughlin Date: Mon, 31 Jul 2023 12:51:17 -0400 Subject: [PATCH 02/28] New Running EDB*Loader topic and assorted edits Split out content into a new Running EDB*Loader topic, as well as assorted edits based on further review --- .../02_edb_loader/data_loading_methods.mdx | 6 +- .../edb_loader_overview_and_restrictions.mdx | 4 +- .../invoking_edb_loader/direct_path_load.mdx | 4 +- .../invoking_edb_loader/index.mdx | 283 +---------------- .../parallel_direct_path_load.mdx | 4 +- .../performing_remote_loading.mdx | 2 +- .../running_edb_loader.mdx | 285 ++++++++++++++++++ .../02_edb_loader/using_edb_loader.mdx | 4 +- .../edb_resource_manager_key_concepts.mdx | 2 +- .../copying_a_remote_schema.mdx | 4 +- .../setting_up_edb_clone_schema.mdx | 14 +- .../epas/15/database_administration/index.mdx | 2 +- 12 files changed, 311 insertions(+), 303 deletions(-) create mode 100644 product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/running_edb_loader.mdx diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/data_loading_methods.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/data_loading_methods.mdx index ab776d3ca94..ffec8551e62 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/data_loading_methods.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/data_loading_methods.mdx @@ -6,11 +6,11 @@ description: "Description of the data loading methods supported by EDB*Loader" As with Oracle SQL\*Loader, EDB\*Loader supports three data loading methods: -- *Conventional path load* — Conventional path load is the default method used by EDB\*Loader. Use basic insert processing to add rows to the table. The advantage of a conventional path load is that table constraints and database objects defined on the table are enforced during a conventional path load. Table constraints and database objects include primary keys, not null constraints, check constraints, unique indexes, foreign key constraints, triggers, and so on. One exception is that the EDB Postgres Advanced Server rules defined on the table aren't enforced. EDB\*Loader can load tables on which rules are defined. However, the rules aren't executed. As a consequence, you can't load partitioned tables implemented using rules with EDB\*Loader. +- *Conventional path load* — Conventional path load is the default method used by EDB\*Loader. Use basic insert processing to add rows to the table. The advantage of a conventional path load is that table constraints and database objects defined on the table are enforced during a conventional path load. Table constraints and database objects include primary keys, not null constraints, check constraints, unique indexes, foreign key constraints, triggers, and so on. One exception is that the EDB Postgres Advanced Server rules defined on the table aren't enforced. EDB\*Loader can load tables on which rules are defined. However, the rules aren't executed. As a consequence, you can't load partitioned tables implemented using rules with EDB\*Loader. See [Conventional path load](invoking_edb_loader/conventional_path_load.mdx) -- *Direct path loads* — A direct path load is faster than a conventional path load but requires removing most types of constraints and triggers from the table. For more information, see [Direct path load](invoking_edb_loader/direct_path_load.mdx). +- *Direct path loads* — A direct path load is faster than a conventional path load but requires removing most types of constraints and triggers from the table. See [Direct path load](invoking_edb_loader/direct_path_load.mdx). -- *Parallel direct path loads* — A parallel direct path load provides even greater performance improvement by permitting multiple EDB\*Loader sessions to run simultaneously to load a single table. For more information, see [Parallel direct path load](invoking_edb_loader/parallel_direct_path_load.mdx). +- *Parallel direct path loads* — A parallel direct path load provides even greater performance improvement by permitting multiple EDB\*Loader sessions to run simultaneously to load a single table. See [Parallel direct path load](invoking_edb_loader/parallel_direct_path_load.mdx). !!! Note Create EDB Postgres Advanced Server rules using the `CREATE RULE` command. EDB Postgres Advanced Server rules aren't the same database objects as rules and rule sets used in Oracle. diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/edb_loader_overview_and_restrictions.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/edb_loader_overview_and_restrictions.mdx index 6b80c7c88b7..9e87a46566c 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/edb_loader_overview_and_restrictions.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/edb_loader_overview_and_restrictions.mdx @@ -19,11 +19,11 @@ EDB\*Loader features include: ## Version compatibility restrictions -The following are important version compatibility restrictions between the EDB\*Loader client and the database server. +The important version compatibility restrictions between the EDB\*Loader client and the database server are: - When you invoke the EDB\*Loader program (called `edbldr`), you pass in parameters and directive information to the database server. We strongly recommend that you use the version 14 EDB\*Loader client (the edbldr program supplied with EDB Postgres Advanced Server 14) to load data only into version 14 of the database server. In general, use the same version for the EDB\*Loader client and database server. -- Using EDB\*Loader with connection poolers such as PgPool-II and PgBouncer isn't supported. EDB\*Loader must connect directly to EDB Postgres Advanced Server version 14. Alternatively, the following are some of the commands you can use for loading data through connection poolers: +- Using EDB\*Loader with connection poolers such as PgPool-II and PgBouncer isn't supported. EDB\*Loader must connect directly to EDB Postgres Advanced Server version 14. Alternatively, there are commands you can use for loading data through connection poolers: ```shell psql \copy diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/direct_path_load.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/direct_path_load.mdx index 41058312503..6a392190530 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/direct_path_load.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/direct_path_load.mdx @@ -6,7 +6,7 @@ description: "Describes how to use EDB*Loader to write data directly to the data -During a direct path load, EDB\*Loader writes the data directly to the database pages, which is then synchronized to disk. The insert processing associated with a conventional path load is bypassed, resulting in a performance improvement. Bypassing insert processing reduces the types of constraints on the target table. The following types of constraints are permitted on the target table of a direct path load: +During a direct path load, EDB\*Loader writes the data directly to the database pages, which is then synchronized to disk. The insert processing associated with a conventional path load is bypassed, resulting in a performance improvement. Bypassing insert processing reduces the types of constraints on the target table. The types of constraints permitted on the target table of a direct path load are: - Primary key - Not null constraints @@ -14,7 +14,7 @@ During a direct path load, EDB\*Loader writes the data directly to the database ## Restrictions -The following are restrictions on the target table of a direct path load: +The restrictions on the target table of a direct path load are: - Triggers aren't permitted. - Check constraints aren't permitted. diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/index.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/index.mdx index a3e9f3391ff..cdc6f169c82 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/index.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/index.mdx @@ -1,8 +1,9 @@ --- title: "Invoking EDB*Loader" -description: "Describes how to run EDB*Loader from the command line" +description: "Describes how to run EDB*Loader" indexCards: simple navigation: +- running_edb_loader - conventional_path_load - direct_path_load - parallel_direct_path_load @@ -11,283 +12,5 @@ navigation: -You can run EDB\*Loader as superuser or as a normal user. Use the following command to invoke EDB\*Loader from the command line: - -```sql -edbldr [ -d ] [ -p ] [ -h ] -[ USERID={ | / | | / } ] -[ { -c | connstr= } ] - CONTROL= -[ DATA= ] -[ BAD=] -[ DISCARD= ] -[ DISCARDMAX= ] -[ HANDLE_CONFLICTS={ FALSE | TRUE } ] -[ LOG= ] -[ PARFILE= ] -[ DIRECT={ FALSE | TRUE } ] -[ FREEZE={ FALSE | TRUE } ] -[ ERRORS= ] -[ PARALLEL={ FALSE | TRUE } ] -[ ROWS= ] -[ SKIP= ] -[ SKIP_INDEX_MAINTENANCE={ FALSE | TRUE } ] -[ edb_resource_group= ] -``` - -## Description - -You can specify parameters listed in the syntax diagram in a *parameter file*. Exeptions include the `-d` option, `-p` option, `-h` option, and the `PARFILE` parameter. Specify the parameter file on the command line when you invoke `edbldr` using `PARFILE=param_file`. You can specify some parameters in the `OPTIONS` clause in the control file. For more information on the control file, see [Building the EDB\*Loader control file](../building_the_control_file/). - -You can include the full directory path or a relative directory path to the file name when specifying `control_file`, `data_file`, `bad_file`, `discard_file`, `log_file`, and `param_file`. If you specify the file name alone or with a relative directory path, the file is assumed to exist in the case of `control_file`, `data_file`, or `param_file` relative to the current working directory from which `edbldr` is invoked. In the case of `bad_file`, `discard_file`, or `log_file`, the file is created. - -If you omit the `-d` option, the `-p` option, or the `-h` option, the defaults for the database, port, and host are determined by the same rules as other EDB Postgres Advanced Server (EPAS) utility programs, such as `edb-psql`. - -## Requirements - -- The control file must exist in the character set encoding of the client where `edbldr` is invoked. If the client is in an encoding different from the database encoding, then you must set the `PGCLIENTENCODING` environment variable on the client to the client’s encoding prior to invoking `edbldr`. This technique ensures character set conversion between the client and the database server is done correctly. - -- The file names for `control_file`, `data_file`, `bad_file`, `discard_file`, and `log_file` must include the extensions `.ctl`, `.dat`, `.bad`, `.dsc`, and `.log`, respectively. If the provided file name doesn't contain an extension, EDB\*Loader assumes the actual file name includes the appropriate extension. - -- The operating system account used to invoke `edbldr` must have read permission on the directories and files specified by `control_file`, `data_file`, and `param_file`. - -- The operating system account `enterprisedb` must have write permission on the directories where `bad_file`, `discard_file`, and `log_file` are written. - -## Parameters - -`dbname` - - Name of the database containing the tables to load. - -`port` - - Port number on which the database server is accepting connections. - -`host` - - IP address of the host on which the database server is running. - -`USERID={ username/password | username/ | username | / }` - - EDB\*Loader connects to the database with `username`. `username` must be a superuser or a username with the required privileges. `password` is the password for `username`. - - If you omit the `USERID` parameter, EDB\*Loader prompts for `username` and `password`. If you specify `USERID=username/`, then EDB\*Loader either: - - Uses the password file specified by environment variable `PGPASSFILE` if `PGPASSFILE` is set - - Uses the `.pgpass` password file (`pgpass.conf` on Windows systems) if `PGPASSFILE` isn't set - - If you specify `USERID=username`, then EDB\*Loader prompts for `password`. If you specify `USERID=/`, the connection is attempted using the operating system account as the user name. - - !!! Note - EDB\*Loader ignores the EPAS connection environment variables `PGUSER` and `PGPASSWORD`. See the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/libpq-pgpass.html) for information on the `PGPASSFILE` environment variable and the password file. - -`-c CONNECTION_STRING` - -`connstr=CONNECTION_STRING` - - The `-c` or `connstr=` option allows you to specify all the connection parameters supported by libpq. With this option, you can also specify SSL connection parameters or other connection parameters supported by libpq. If you provide connection options such as `-d`, `-h`, `-p` or `userid=dbuser/dbpass` separately, they might override the values provided by the `-c` or `connstr=` option. - -`CONTROL=control_file` - - `control_file` specifies the name of the control file containing EDB\*Loader directives. If you don't specify a file extension, an extension of `.ctl` is assumed. - - For more information on the control file, see [Building the EDB\*Loader control file](../building_the_control_file/). - -`DATA=data_file` - - `data_file` specifies the name of the file containing the data to load into the target table. If you don't specify a file extension, an extension of `.dat` is assumed. Specifying a `data_file` on the command line overrides the `INFILE` clause specified in the control file. - - For more information about `data_file`, see [Building the EDB\*Loader control file](../building_the_control_file/). - -`BAD=bad_file` - - `bad_file` specifies the name of a file that receives input data records that can't be loaded due to errors. Specifying a `bad_file` on the command line overrides any `BADFILE` clause specified in the control file. - - For more information about `bad_file`, see [Building the EDB\*Loader control file](../building_the_control_file/). - -`DISCARD=discard_file` - - `discard_file` is the name of the file that receives input data records that don't meet any table’s selection criteria. Specifying a `discard_file` on the command line overrides the `DISCARDFILE` clause in the control file. - - For more information about `discard_file`, see [Building the EDB\*Loader control file](../building_the_control_file/). - -`DISCARDMAX=max_discard_recs` - - `max_discard_recs` is the maximum number of discarded records that can be encountered from the input data records before terminating the EDB\*Loader session. Specifying `max_discard_recs` on the command line overrides the `DISCARDMAX` or `DISCARDS` clause in the control file. - - For more information about `max_discard_recs`, see [Building the EDB\*Loader control file](../building_the_control_file/). - -`HANDLE_CONFLICTS={ FALSE | TRUE }` - - If any record insertion fails due to a unique constraint violation, EDB\*Loader aborts the entire operation. You can instruct EDB\*Loader to instead move the duplicate record to the `BAD` file and continue processing by setting `HANDLE_CONFLICTS` to `TRUE`. This behavior applies only if indexes are present. By default, `HANDLE_CONFLICTS` is set to `FALSE`. - - Setting `HANDLE_CONFLICTS` to `TRUE` isn't supported with direct path loading. If you set this parameter to `TRUE` when direct path loading, EDB\*Loader throws an error. - -`LOG=log_file` - - `log_file` specifies the name of the file in which EDB\*Loader records the results of the EDB\*Loader session. - - If you omit the `LOG` parameter, EDB\*Loader creates a log file with the name `control_file_base.log` in the directory from which `edbldr` is invoked. `control_file_base` is the base name of the control file used in the EDB\*Loader session. The operating system account `enterprisedb` must have write permission on the directory where the log file is written. - -`PARFILE=param_file` - - `param_file` specifies the name of the file that contains command line parameters for the EDB\*Loader session. You can specify command line parameters listed in this section in `param_file` instead of on the command line. Exceptions are the `-d`, `-p`, and `-h` options, and the `PARFILE` parameter. - - Any parameter given in `param_file` overrides the same parameter supplied on the command line before the `PARFILE` option. Any parameter given on the command line that appears after the `PARFILE` option overrides the same parameter given in `param_file`. - - !!! Note - Unlike other EDB\*Loader files, there's no default file name or extension assumed for `param_file`. However, by Oracle SQL\*Loader convention, `.par` is typically used as an extension. It isn't required. - -`DIRECT= { FALSE | TRUE }` - - If `DIRECT` is set to `TRUE` EDB\*Loader performs a direct path load instead of a conventional path load. The default value of `DIRECT` is `FALSE`. - - Don't set `DIRECT=true` when loading the data into a replicated table. If you're using EDB\*Loader to load data into a replicated table and set `DIRECT=true`, indexes might omit rows that are in a table or might contain references to rows that were deleted. EnterpriseDB doesn't support direct inserts to load data into replicated tables. - - For information about direct path loads, see [Direct path load](direct_path_load). - -`FREEZE= { FALSE | TRUE }` - - Set `FREEZE` to `TRUE` to copy the data with the rows `frozen`. A tuple guaranteed to be visible to all current and future transactions is marked as frozen to prevent transaction ID wraparound. For more information about frozen tuples, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/routine-vacuuming.html). - - You must specify a data-loading type of `TRUNCATE` in the control file when using the `FREEZE` option. `FREEZE` isn't supported for direct loading. - - By default, `FREEZE` is `FALSE`. - -`ERRORS=error_count` - - `error_count` specifies the number of errors permitted before aborting the EDB\*Loader session. The default is `50`. - -`PARALLEL= { FALSE | TRUE }` - - Set `PARALLEL` to `TRUE` to indicate that this EDB\*Loader session is one of a number of concurrent EDB\*Loader sessions participating in a parallel direct path load. The default value of `PARALLEL` is `FALSE`. - - When `PARALLEL` is `TRUE`, the `DIRECT` parameter must also be set to `TRUE`. - - For more information about parallel direct path loads, see [Parallel direct path load](parallel_direct_path_load). - -`ROWS=n` - - `n` specifies the number of rows that EDB\*Loader commits before loading the next set of `n` rows. - -`SKIP=skip_count` - - Number of records at the beginning of the input data file to skip before loading begins. The default is `0`. - -`SKIP_INDEX_MAINTENANCE= { FALSE | TRUE }` - - If set to `TRUE`, index maintenance isn't performed as part of a direct path load, and indexes on the loaded table are marked as invalid. The default value of `SKIP_INDEX_MAINTENANCE` is `FALSE`. - - During a parallel direct path load, target table indexes aren't updated. They are marked as invalid after the load is complete. - - You can use the `REINDEX` command to rebuild an index. For more information about the `REINDEX` command, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/sql-reindex.htm). - -`edb_resource_group=group_name` - - `group_name` specifies the name of an EDB Resource Manager resource group to which to assign the EDB\*Loader session. - - Any default resource group that was assigned to the session is overridden by the resource group given by the `edb_resource_group` parameter specified on the `edbldr` command line. An example of such a group is a database user running the EDB\*Loader session who was assigned a default resource group with the `ALTER ROLE ... SET` `edb_resource_group` command. - -## Examples - -This example invokes EDB\*Loader using a control file named `emp.ctl` to load a table in database `edb`. The file is located in the current working directory. - -```shell -$ /usr/edb/as14/bin/edbldr -d edb USERID=enterprisedb/password -CONTROL=emp.ctl -EDB*Loader: Copyright (c) 2007-2021, EnterpriseDB Corporation. - -Successfully loaded (4) records -``` - -In this example, EDB\*Loader prompts for the user name and password since they are omitted from the command line. In addition, the files for the bad file and log file are specified with the `BAD` and `LOG` command line parameters. - -```shell -$ /usr/edb/as14/bin/edbldr -d edb CONTROL=emp.ctl BAD=/tmp/emp.bad -LOG=/tmp/emp.log -Enter the user name : enterprisedb -Enter the password : -EDB*Loader: Copyright (c) 2007-2021, EnterpriseDB Corporation. - -Successfully loaded (4) records -``` - -This example runs EDB\*Loader using a parameter file located in the current working directory. The `SKIP` and `ERRORS` parameter default values are specified in the parameter file in addition the `CONTROL`, `BAD`, and `LOG` files. The parameter file, `emp.par`, contains the following: - -```ini -CONTROL=emp.ctl -BAD=/tmp/emp.bad -LOG=/tmp/emp.log -SKIP=1 -ERRORS=10 -``` - -Invoke EDB\*Loader with the parameter file: - -```shell -$ /usr/edb/as14/bin/edbldr -d edb PARFILE=emp.par -Enter the user name : enterprisedb -Enter the password : -EDB*Loader: Copyright (c) 2007-2021, EnterpriseDB Corporation. - -Successfully loaded (3) records -``` - -This example invokes EDB\*Loader using a `connstr=` option that uses the `emp.ctl` control file located in the current working directory to load a table in a database named `edb`: - -```shell -$ /usr/edb/as14/bin/edbldr connstr=\"sslmode=verify-ca sslcompression=0 -host=127.0.0.1 dbname=edb port=5444 user=enterprisedb\" CONTROL=emp.ctl -EDB*Loader: Copyright (c) 2007-2021, EnterpriseDB Corporation. - -Successfully loaded (4) records -``` - -This example invokes EDB\*Loader using a normal user. For this example, one empty table `bar` is created and a normal user `bob` is created. The `bob` user is granted all privileges on the table `bar`. The CREATE TABLE command creates the empty table. The CREATE USER command creates the user and the GRANT command gives required privileges to the user `bob` on the `bar` table: - -```sql -CREATE TABLE bar(i int); -CREATE USER bob identified by '123'; -GRANT ALL on bar TO bob; -``` - -The control file and data file: - -```shell -## Control file -EDBAS/ - (master) $ cat /tmp/edbldr.ctl -LOAD DATA INFILE '/tmp/edbldr.dat' -truncate into table bar -( -i position(1:1) -) - -## Data file -EDBAS/ - (master) $ cat /tmp/edbldr.dat -1 -2 -3 -5 -``` - -Invoke EDB*Loader: - -```shell -EDBAS/ - (master) $ /usr/edb/as15/bin/edbldr -d edb userid=bob/123 control=/tmp/edbldr.ctl -EDB*Loader: Copyright (c) 2007-2022, EnterpriseDB Corporation. - -Successfully loaded (4) records -``` - - - -## Exit codes - -When EDB\*Loader exits, it returns one of the following codes: - -| Exit code | Description | -| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `0` | Indicates that all rows loaded successfully. | -| `1` | Indicates that EDB\*Loader encountered command line or syntax errors or aborted the load operation due to an unrecoverable error. | -| `2` | Indicates that the load completed, but some (or all) rows were rejected or discarded. | -| `3` | Indicates that EDB\*Loader encountered fatal errors (such as OS errors). This class of errors is equivalent to the `FATAL` or `PANIC` severity levels of PostgreSQL errors. | +You can run EDB\*Loader as superuser or as a normal user. diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/parallel_direct_path_load.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/parallel_direct_path_load.mdx index b0c47ba23d8..1de412f045b 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/parallel_direct_path_load.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/parallel_direct_path_load.mdx @@ -14,7 +14,7 @@ Since the same table is loaded from multiple sessions, the input records to load The target table of a parallel direct path load is under the same restrictions as a direct path load run in a single session. -The following are the restrictions on the target table of a direct path load: +The restrictions on the target table of a direct path load are: - Triggers aren't permitted. - Check constraints aren't permitted. @@ -113,7 +113,7 @@ WARNING: index maintenance will be skipped with PARALLEL load EDB*Loader: Copyright (c) 2007-2021, EnterpriseDB Corporation. ``` -EDB\*Loader displays the following message in each session when the load operation completes: +EDB\*Loader displays a message in each session when the load operation completes: ```text Successfully loaded (10000) records diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/performing_remote_loading.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/performing_remote_loading.mdx index 44bb3cba953..6ed2b29ae07 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/performing_remote_loading.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/performing_remote_loading.mdx @@ -14,7 +14,7 @@ In addition, you can use the standard input feature to pipe the data from the da ## Requirements -Performing remote loading along with using standard input requires the following: +Performing remote loading along with using standard input requires: - The `edbldr` program must be installed on the client host on which to invoke it with the data source for the EDB\*Loader session. - The control file must contain the clause `INFILE 'stdin'` so you can pipe the data directly into EDB\*Loader’s standard input. For information on the `INFILE` clause and the EDB\*Loader control file, see [Building the EDB\*Loader control file](../building_the_control_file/). diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/running_edb_loader.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/running_edb_loader.mdx new file mode 100644 index 00000000000..ab018dcd42a --- /dev/null +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/invoking_edb_loader/running_edb_loader.mdx @@ -0,0 +1,285 @@ +--- +title: "Running EDB*Loader" +description: "Describes how to run EDB*Loader from the command line" +--- + +Use the following command to invoke EDB\*Loader from the command line: + +```sql +edbldr [ -d ] [ -p ] [ -h ] +[ USERID={ | / | | / } ] +[ { -c | connstr= } ] + CONTROL= +[ DATA= ] +[ BAD=] +[ DISCARD= ] +[ DISCARDMAX= ] +[ HANDLE_CONFLICTS={ FALSE | TRUE } ] +[ LOG= ] +[ PARFILE= ] +[ DIRECT={ FALSE | TRUE } ] +[ FREEZE={ FALSE | TRUE } ] +[ ERRORS= ] +[ PARALLEL={ FALSE | TRUE } ] +[ ROWS= ] +[ SKIP= ] +[ SKIP_INDEX_MAINTENANCE={ FALSE | TRUE } ] +[ edb_resource_group= ] +``` + +## Description + +You can specify parameters listed in the syntax diagram in a *parameter file*. Exeptions include the `-d` option, `-p` option, `-h` option, and the `PARFILE` parameter. Specify the parameter file on the command line when you invoke `edbldr` using `PARFILE=param_file`. You can specify some parameters in the `OPTIONS` clause in the control file. For more information on the control file, see [Building the EDB\*Loader control file](../building_the_control_file/). + +You can include the full directory path or a relative directory path to the file name when specifying `control_file`, `data_file`, `bad_file`, `discard_file`, `log_file`, and `param_file`. If you specify the file name alone or with a relative directory path, the file is assumed to exist in the case of `control_file`, `data_file`, or `param_file` relative to the current working directory from which `edbldr` is invoked. In the case of `bad_file`, `discard_file`, or `log_file`, the file is created. + +If you omit the `-d` option, the `-p` option, or the `-h` option, the defaults for the database, port, and host are determined by the same rules as other EDB Postgres Advanced Server (EPAS) utility programs, such as `edb-psql`. + +## Requirements + +- The control file must exist in the character set encoding of the client where `edbldr` is invoked. If the client is in an encoding different from the database encoding, then you must set the `PGCLIENTENCODING` environment variable on the client to the client’s encoding prior to invoking `edbldr`. This technique ensures character set conversion between the client and the database server is done correctly. + +- The file names for `control_file`, `data_file`, `bad_file`, `discard_file`, and `log_file` must include the extensions `.ctl`, `.dat`, `.bad`, `.dsc`, and `.log`, respectively. If the provided file name doesn't contain an extension, EDB\*Loader assumes the actual file name includes the appropriate extension. + +- The operating system account used to invoke `edbldr` must have read permission on the directories and files specified by `control_file`, `data_file`, and `param_file`. + +- The operating system account `enterprisedb` must have write permission on the directories where `bad_file`, `discard_file`, and `log_file` are written. + +## Parameters + +`dbname` + + Name of the database containing the tables to load. + +`port` + + Port number on which the database server is accepting connections. + +`host` + + IP address of the host on which the database server is running. + +`USERID={ username/password | username/ | username | / }` + + EDB\*Loader connects to the database with `username`. `username` must be a superuser or a username with the required privileges. `password` is the password for `username`. + + If you omit the `USERID` parameter, EDB\*Loader prompts for `username` and `password`. If you specify `USERID=username/`, then EDB\*Loader either: + - Uses the password file specified by environment variable `PGPASSFILE` if `PGPASSFILE` is set + - Uses the `.pgpass` password file (`pgpass.conf` on Windows systems) if `PGPASSFILE` isn't set + + If you specify `USERID=username`, then EDB\*Loader prompts for `password`. If you specify `USERID=/`, the connection is attempted using the operating system account as the user name. + + !!! Note + EDB\*Loader ignores the EPAS connection environment variables `PGUSER` and `PGPASSWORD`. See the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/libpq-pgpass.html) for information on the `PGPASSFILE` environment variable and the password file. + +`-c CONNECTION_STRING` + +`connstr=CONNECTION_STRING` + + The `-c` or `connstr=` option allows you to specify all the connection parameters supported by libpq. With this option, you can also specify SSL connection parameters or other connection parameters supported by libpq. If you provide connection options such as `-d`, `-h`, `-p` or `userid=dbuser/dbpass` separately, they might override the values provided by the `-c` or `connstr=` option. + +`CONTROL=control_file` + + `control_file` specifies the name of the control file containing EDB\*Loader directives. If you don't specify a file extension, an extension of `.ctl` is assumed. + + For more information on the control file, see [Building the EDB\*Loader control file](../building_the_control_file/). + +`DATA=data_file` + + `data_file` specifies the name of the file containing the data to load into the target table. If you don't specify a file extension, an extension of `.dat` is assumed. Specifying a `data_file` on the command line overrides the `INFILE` clause specified in the control file. + + For more information about `data_file`, see [Building the EDB\*Loader control file](../building_the_control_file/). + +`BAD=bad_file` + + `bad_file` specifies the name of a file that receives input data records that can't be loaded due to errors. Specifying a `bad_file` on the command line overrides any `BADFILE` clause specified in the control file. + + For more information about `bad_file`, see [Building the EDB\*Loader control file](../building_the_control_file/). + +`DISCARD=discard_file` + + `discard_file` is the name of the file that receives input data records that don't meet any table’s selection criteria. Specifying a `discard_file` on the command line overrides the `DISCARDFILE` clause in the control file. + + For more information about `discard_file`, see [Building the EDB\*Loader control file](../building_the_control_file/). + +`DISCARDMAX=max_discard_recs` + + `max_discard_recs` is the maximum number of discarded records that can be encountered from the input data records before terminating the EDB\*Loader session. Specifying `max_discard_recs` on the command line overrides the `DISCARDMAX` or `DISCARDS` clause in the control file. + + For more information about `max_discard_recs`, see [Building the EDB\*Loader control file](../building_the_control_file/). + +`HANDLE_CONFLICTS={ FALSE | TRUE }` + + If any record insertion fails due to a unique constraint violation, EDB\*Loader aborts the entire operation. You can instruct EDB\*Loader to instead move the duplicate record to the `BAD` file and continue processing by setting `HANDLE_CONFLICTS` to `TRUE`. This behavior applies only if indexes are present. By default, `HANDLE_CONFLICTS` is set to `FALSE`. + + Setting `HANDLE_CONFLICTS` to `TRUE` isn't supported with direct path loading. If you set this parameter to `TRUE` when direct path loading, EDB\*Loader throws an error. + +`LOG=log_file` + + `log_file` specifies the name of the file in which EDB\*Loader records the results of the EDB\*Loader session. + + If you omit the `LOG` parameter, EDB\*Loader creates a log file with the name `control_file_base.log` in the directory from which `edbldr` is invoked. `control_file_base` is the base name of the control file used in the EDB\*Loader session. The operating system account `enterprisedb` must have write permission on the directory where the log file is written. + +`PARFILE=param_file` + + `param_file` specifies the name of the file that contains command line parameters for the EDB\*Loader session. You can specify command line parameters listed in this section in `param_file` instead of on the command line. Exceptions are the `-d`, `-p`, and `-h` options, and the `PARFILE` parameter. + + Any parameter given in `param_file` overrides the same parameter supplied on the command line before the `PARFILE` option. Any parameter given on the command line that appears after the `PARFILE` option overrides the same parameter given in `param_file`. + + !!! Note + Unlike other EDB\*Loader files, there's no default file name or extension assumed for `param_file`. However, by Oracle SQL\*Loader convention, `.par` is typically used as an extension. It isn't required. + +`DIRECT= { FALSE | TRUE }` + + If `DIRECT` is set to `TRUE` EDB\*Loader performs a direct path load instead of a conventional path load. The default value of `DIRECT` is `FALSE`. + + Don't set `DIRECT=true` when loading the data into a replicated table. If you're using EDB\*Loader to load data into a replicated table and set `DIRECT=true`, indexes might omit rows that are in a table or might contain references to rows that were deleted. EnterpriseDB doesn't support direct inserts to load data into replicated tables. + + For information about direct path loads, see [Direct path load](direct_path_load). + +`FREEZE= { FALSE | TRUE }` + + Set `FREEZE` to `TRUE` to copy the data with the rows `frozen`. A tuple guaranteed to be visible to all current and future transactions is marked as frozen to prevent transaction ID wraparound. For more information about frozen tuples, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/routine-vacuuming.html). + + You must specify a data-loading type of `TRUNCATE` in the control file when using the `FREEZE` option. `FREEZE` isn't supported for direct loading. + + By default, `FREEZE` is `FALSE`. + +`ERRORS=error_count` + + `error_count` specifies the number of errors permitted before aborting the EDB\*Loader session. The default is `50`. + +`PARALLEL= { FALSE | TRUE }` + + Set `PARALLEL` to `TRUE` to indicate that this EDB\*Loader session is one of a number of concurrent EDB\*Loader sessions participating in a parallel direct path load. The default value of `PARALLEL` is `FALSE`. + + When `PARALLEL` is `TRUE`, the `DIRECT` parameter must also be set to `TRUE`. + + For more information about parallel direct path loads, see [Parallel direct path load](parallel_direct_path_load). + +`ROWS=n` + + `n` specifies the number of rows that EDB\*Loader commits before loading the next set of `n` rows. + +`SKIP=skip_count` + + Number of records at the beginning of the input data file to skip before loading begins. The default is `0`. + +`SKIP_INDEX_MAINTENANCE= { FALSE | TRUE }` + + If set to `TRUE`, index maintenance isn't performed as part of a direct path load, and indexes on the loaded table are marked as invalid. The default value of `SKIP_INDEX_MAINTENANCE` is `FALSE`. + + During a parallel direct path load, target table indexes aren't updated. They are marked as invalid after the load is complete. + + You can use the `REINDEX` command to rebuild an index. For more information about the `REINDEX` command, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/sql-reindex.htm). + +`edb_resource_group=group_name` + + `group_name` specifies the name of an EDB Resource Manager resource group to which to assign the EDB\*Loader session. + + Any default resource group that was assigned to the session is overridden by the resource group given by the `edb_resource_group` parameter specified on the `edbldr` command line. An example of such a group is a database user running the EDB\*Loader session who was assigned a default resource group with the `ALTER ROLE ... SET` `edb_resource_group` command. + +## Examples + +This example invokes EDB\*Loader using a control file named `emp.ctl` to load a table in database `edb`. The file is located in the current working directory. + +```shell +$ /usr/edb/as14/bin/edbldr -d edb USERID=enterprisedb/password +CONTROL=emp.ctl +EDB*Loader: Copyright (c) 2007-2021, EnterpriseDB Corporation. + +Successfully loaded (4) records +``` + +In this example, EDB\*Loader prompts for the user name and password since they are omitted from the command line. In addition, the files for the bad file and log file are specified with the `BAD` and `LOG` command line parameters. + +```shell +$ /usr/edb/as14/bin/edbldr -d edb CONTROL=emp.ctl BAD=/tmp/emp.bad +LOG=/tmp/emp.log +Enter the user name : enterprisedb +Enter the password : +EDB*Loader: Copyright (c) 2007-2021, EnterpriseDB Corporation. + +Successfully loaded (4) records +``` + +This example runs EDB\*Loader using a parameter file located in the current working directory. The `SKIP` and `ERRORS` parameter default values are specified in the parameter file in addition the `CONTROL`, `BAD`, and `LOG` files. The parameter file, `emp.par`, contains: + +```ini +CONTROL=emp.ctl +BAD=/tmp/emp.bad +LOG=/tmp/emp.log +SKIP=1 +ERRORS=10 +``` + +Invoke EDB\*Loader with the parameter file: + +```shell +$ /usr/edb/as14/bin/edbldr -d edb PARFILE=emp.par +Enter the user name : enterprisedb +Enter the password : +EDB*Loader: Copyright (c) 2007-2021, EnterpriseDB Corporation. + +Successfully loaded (3) records +``` + +This example invokes EDB\*Loader using a `connstr=` option that uses the `emp.ctl` control file located in the current working directory to load a table in a database named `edb`: + +```shell +$ /usr/edb/as14/bin/edbldr connstr=\"sslmode=verify-ca sslcompression=0 +host=127.0.0.1 dbname=edb port=5444 user=enterprisedb\" CONTROL=emp.ctl +EDB*Loader: Copyright (c) 2007-2021, EnterpriseDB Corporation. + +Successfully loaded (4) records +``` + +This example invokes EDB\*Loader using a normal user. For this example, one empty table `bar` is created and a normal user `bob` is created. The `bob` user is granted all privileges on the table `bar`. The CREATE TABLE command creates the empty table. The CREATE USER command creates the user and the GRANT command gives required privileges to the user `bob` on the `bar` table: + +```sql +CREATE TABLE bar(i int); +CREATE USER bob identified by '123'; +GRANT ALL on bar TO bob; +``` + +The control file and data file: + +```shell +## Control file +EDBAS/ - (master) $ cat /tmp/edbldr.ctl +LOAD DATA INFILE '/tmp/edbldr.dat' +truncate into table bar +( +i position(1:1) +) + +## Data file +EDBAS/ - (master) $ cat /tmp/edbldr.dat +1 +2 +3 +5 +``` + +Invoke EDB*Loader: + +```shell +EDBAS/ - (master) $ /usr/edb/as15/bin/edbldr -d edb userid=bob/123 control=/tmp/edbldr.ctl +EDB*Loader: Copyright (c) 2007-2022, EnterpriseDB Corporation. + +Successfully loaded (4) records +``` + + + +## Exit codes + +When EDB\*Loader exits, it returns one of the following codes: + +| Exit code | Description | +| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `0` | Indicates that all rows loaded successfully. | +| `1` | Indicates that EDB\*Loader encountered command line or syntax errors or aborted the load operation due to an unrecoverable error. | +| `2` | Indicates that the load completed, but some (or all) rows were rejected or discarded. | +| `3` | Indicates that EDB\*Loader encountered fatal errors (such as OS errors). This class of errors is equivalent to the `FATAL` or `PANIC` severity levels of PostgreSQL errors. | + diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/using_edb_loader.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/using_edb_loader.mdx index a2cc9db8437..e053521548d 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/using_edb_loader.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/using_edb_loader.mdx @@ -1,6 +1,6 @@ --- -title: "Using EDB*Loader" -description: "Describes the general usage of the EDB*Loader utility" +title: "EDB*Loader error handling" +description: "Describes the types of errors the EDB*Loader utility can encounter" --- diff --git a/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/edb_resource_manager_key_concepts.mdx b/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/edb_resource_manager_key_concepts.mdx index 6d56b7d0947..873501369b8 100644 --- a/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/edb_resource_manager_key_concepts.mdx +++ b/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/edb_resource_manager_key_concepts.mdx @@ -6,7 +6,7 @@ description: "Describes key points about using EDB Resource Manager" You use EDB Resource Manager to control the use of operating system resources used by EDB Postgres Advanced Server processes. -The following are some key points about using EDB Resource Manager: +Some key points about using EDB Resource Manager are: - The basic component of EDB Resource Manager is a *resource group*. A resource group is a named, global group. It's available to all databases in an EDB Postgres Advanced Server instance, and you can define various resource usage limits on it. EDB Postgres Advanced Server processes that are assigned as members of a given resource group are then controlled by EDB Resource Manager. This configuration keeps the aggregate resource use of all processes in the group near the limits defined on the group. - Data definition language commands are used to create, alter, and drop resource groups. Only a database user with superuser privileges can use these commands. diff --git a/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/copying_a_remote_schema.mdx b/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/copying_a_remote_schema.mdx index 809dbd4c91c..80ee0ea6a19 100644 --- a/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/copying_a_remote_schema.mdx +++ b/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/copying_a_remote_schema.mdx @@ -110,7 +110,7 @@ __OUTPUT__ (1 row) ``` -The following displays the status from the log file during various points in the cloning process: +The following example displays the status from the log file during various points in the cloning process: ```sql tgtdb=# SELECT edb_util.process_status_from_log('clone_rmt_src_tgt'); @@ -314,7 +314,7 @@ __OUTPUT__ (1 row) ``` -The following removes the log file and the pgAgent job: +The following command removes the log file and the pgAgent job: ```sql tgtdb=# SELECT edb_util.remove_log_file_and_job ('clone_rmt_src_tgt',2); diff --git a/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/setting_up_edb_clone_schema.mdx b/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/setting_up_edb_clone_schema.mdx index 3234aa1f0ac..63ef8d89c69 100644 --- a/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/setting_up_edb_clone_schema.mdx +++ b/product_docs/docs/epas/15/database_administration/14_edb_clone_schema/setting_up_edb_clone_schema.mdx @@ -14,7 +14,7 @@ Perform this installation on any database to be used as the source or target dat 1. Install the following extensions on the database: `postgres_fdw`, `dblink`, `adminpack` and `pgagent`. 1. Ensure that pgAgent is installed before creating the `pgagent` extension. On Linux, you can use the `edb-asxx-pgagent` RPM package, where `xx` is the EDB Postgres Advanced Server version number to install pgAgent. On Windows, use StackBuilder Plus to download and install pgAgent. - You can install the extensions using the following commands: + Install the extensions: ```sql CREATE EXTENSION postgres_fdw SCHEMA public; @@ -72,7 +72,7 @@ For information about the configuration parameters, see the [PostgreSQL core doc Status logging by the cloning functions creates log files in the directory specified by the `log_directory` parameter in the `postgresql.conf` file for the database server to which you're connected when invoking the cloning function. -The default location is `PGDATA/log`, as shown by the following: +The default location is `PGDATA/log`: ```ini #log_directory = 'log' # directory where log files are written, @@ -138,7 +138,7 @@ CREATE SERVER local_server FOREIGN DATA WRAPPER postgres_fdw For more information about using the `CREATE SERVER` command, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/sql-createserver.html). -The user mapping for this server is the following: +The user mapping for this server is: ```sql CREATE USER MAPPING FOR enterprisedb SERVER local_server @@ -150,7 +150,7 @@ CREATE USER MAPPING FOR enterprisedb SERVER local_server For more information about using the `CREATE USER MAPPING` command, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/sql-createusermapping.html). -The following `psql` commands show the foreign server and user mapping: +These `psql` commands show the foreign server and user mapping: ```sql edb=# \des+ @@ -203,7 +203,7 @@ CREATE SERVER tgt_server FOREIGN DATA WRAPPER postgres_fdw ); ``` -The following is the user mapping for this server: +The user mapping for this server is: ```sql CREATE USER MAPPING FOR enterprisedb SERVER tgt_server @@ -224,7 +224,7 @@ CREATE SERVER src_server FOREIGN DATA WRAPPER postgres_fdw ); ``` -The following is the user mapping for this server: +The user mapping for this server is: ```sql CREATE USER MAPPING FOR enterprisedb SERVER src_server @@ -235,7 +235,7 @@ CREATE USER MAPPING FOR enterprisedb SERVER src_server ``` ## Displaying foreign servers and user mappings -The following `psql` commands show the foreign servers and user mappings: +These `psql` commands show the foreign servers and user mappings: ```sql tgtdb=# \des+ diff --git a/product_docs/docs/epas/15/database_administration/index.mdx b/product_docs/docs/epas/15/database_administration/index.mdx index 48712593d96..1843b72b994 100644 --- a/product_docs/docs/epas/15/database_administration/index.mdx +++ b/product_docs/docs/epas/15/database_administration/index.mdx @@ -8,4 +8,4 @@ navigation: - 14_edb_clone_schema --- -EDB Postgres Advanced Server includes features to help you to maintain, secure, and operate EDB Postgres Advanced Server databases. \ No newline at end of file +EDB Postgres Advanced Server (EPAS) includes features to help you to maintain, secure, and operate EPAS databases. \ No newline at end of file From 4d42742a65b807b5c9dc264ab64e0f1a3ab65dfc Mon Sep 17 00:00:00 2001 From: Simon Notley <43099400+sonotley@users.noreply.github.com> Date: Wed, 2 Aug 2023 12:41:28 +0100 Subject: [PATCH 03/28] Add support for PGE as a backend --- product_docs/docs/pem/9/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/pem/9/index.mdx b/product_docs/docs/pem/9/index.mdx index 4e0c5d69ff9..973793644a3 100644 --- a/product_docs/docs/pem/9/index.mdx +++ b/product_docs/docs/pem/9/index.mdx @@ -70,6 +70,6 @@ Supported versions of Postgres for PEM 9.x: |:-----------------------------------------|:---------------------------|:---------------------| |**EDB Postgres Advanced Server (EPAS)** |11, 12, 13, 14, 15 |11, 12, 13, 14, 15 | |**PostgreSQL (PG)** |11, 12, 13, 14, 15 |11, 12, 13, 14, 15 | -|**EDB Postgres Extended Server (PGE)** |11, 12, 13, 14, 15 |Note[^1] | +|**EDB Postgres Extended Server (PGE)** |11, 12, 13, 14, 15 |12, 13, 14, 15[^1] | -[^1]: PEM will support PGE as a backend when sslutils is available for this server distribution. It is expected to be available in the second quarter of 2023. +[^1]: sslutils is not available for RHEL 7 on Power, so this distribution cannot use PGE as a backend. From 7cdf3832dec7617c4d718505fa348900897f236f Mon Sep 17 00:00:00 2001 From: Simon Notley <43099400+sonotley@users.noreply.github.com> Date: Wed, 2 Aug 2023 15:26:09 +0100 Subject: [PATCH 04/28] Clarify for RHEL-like systems RHEL-like systems are also subject to the same constraints documented for RHEL. --- .../docs/pem/9/upgrading/upgrading_httpd.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/pem/9/upgrading/upgrading_httpd.mdx b/product_docs/docs/pem/9/upgrading/upgrading_httpd.mdx index ad1a505003f..5163bef6d76 100644 --- a/product_docs/docs/pem/9/upgrading/upgrading_httpd.mdx +++ b/product_docs/docs/pem/9/upgrading/upgrading_httpd.mdx @@ -12,8 +12,8 @@ On Windows the PEM installer bundles a version of HTTPD. ## Upgrading HTTPD on Linux !!! Important - If you are using Red Hat Enterprise Linux (RHEL) and seeking to update HTTPD in order to address a vulnerability, - please read [Note on HTTPD versioning in RHEL](#note-on-httpd-versioning-in-rhel), below. + If you are using Red Hat Enterprise Linux (RHEL), Rocky, Alma, or Oracle Linux, and seeking to update HTTPD in order to address a vulnerability, + please read [Note on HTTPD versioning in RHEL and RHEL-like distros](#note-on-httpd-versioning-in-rhel-and-rhel-like-distros), below. If you are running Linux, HTTPD should be managed along with other system software on your servers. We recommend always using the latest version available from your package manager. @@ -36,9 +36,9 @@ sudo apt upgrade apache2 sudo zypper update apache2 ``` -### Note on HTTPD versioning in RHEL -You may notice that the latest version of HTTPD available from Red Hat has a significantly older version number than the latest community release. -Specifically RHEL 7 provides HTTPD 2.4.6 and RHEL 8 provides 2.4.37. It is very important to understand that Red Hat builds custom HTTPD packages for RHEL and backports security fixes. +### Note on HTTPD versioning in RHEL and RHEL-like distros +You may notice that the latest version of HTTPD available from Red Hat (or other distributions that re-package Red Hat RPMs) has a significantly older version number than the latest community release. +Specifically, RHEL 7 provides HTTPD 2.4.6 and RHEL 8 provides 2.4.37. It is very important to understand that Red Hat builds custom HTTPD packages for RHEL and backports security fixes. For this reason, you should not assume that a vulnerability present in the community 2.4.37 release is present in the RHEL package of the same version. If you are trying to install a newer version of HTTPD for this reason, it is almost certainly not necessary. Please see [this Red Hat article](https://access.redhat.com/solutions/445713) for more information. @@ -53,4 +53,4 @@ To upgrade to the latest version of HTTPD packaged for PEM by EDB, you should do or [StackBuilder Plus](/epas/latest/installing/windows/installing_advanced_server_with_the_interactive_installer/using_stackbuilder_plus/) respectively to update PEM-HTTPD. PEM-HTTPD is located under the 'Web Development' category. -![PEM-HTTPD in Stack Builder](../images/stackbuilder_pemhttpd.png) \ No newline at end of file +![PEM-HTTPD in Stack Builder](../images/stackbuilder_pemhttpd.png) From aaea91377dafe338e202478669d09d0850a134a4 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 3 Aug 2023 06:20:56 -0400 Subject: [PATCH 05/28] copy edits --- .../docs/pem/9/upgrading/upgrading_httpd.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/pem/9/upgrading/upgrading_httpd.mdx b/product_docs/docs/pem/9/upgrading/upgrading_httpd.mdx index 5163bef6d76..00dcba9560e 100644 --- a/product_docs/docs/pem/9/upgrading/upgrading_httpd.mdx +++ b/product_docs/docs/pem/9/upgrading/upgrading_httpd.mdx @@ -12,8 +12,8 @@ On Windows the PEM installer bundles a version of HTTPD. ## Upgrading HTTPD on Linux !!! Important - If you are using Red Hat Enterprise Linux (RHEL), Rocky, Alma, or Oracle Linux, and seeking to update HTTPD in order to address a vulnerability, - please read [Note on HTTPD versioning in RHEL and RHEL-like distros](#note-on-httpd-versioning-in-rhel-and-rhel-like-distros), below. + If you are using Red Hat Enterprise Linux (RHEL), Rocky Linux, AlmaLinux, or Oracle Linux, and updating HTTPD in order to address a vulnerability, + read [Note on HTTPD versioning in RHEL and RHEL derivatives](#httpd-versioning-in-rhel-and-rhel-derivatives). If you are running Linux, HTTPD should be managed along with other system software on your servers. We recommend always using the latest version available from your package manager. @@ -36,15 +36,15 @@ sudo apt upgrade apache2 sudo zypper update apache2 ``` -### Note on HTTPD versioning in RHEL and RHEL-like distros -You may notice that the latest version of HTTPD available from Red Hat (or other distributions that re-package Red Hat RPMs) has a significantly older version number than the latest community release. +### HTTPD versioning in RHEL and RHEL derivatives +You may notice that the latest version of HTTPD available from RHEL (or other RHEL derivatives) has a significantly older version number than the latest community release. Specifically, RHEL 7 provides HTTPD 2.4.6 and RHEL 8 provides 2.4.37. It is very important to understand that Red Hat builds custom HTTPD packages for RHEL and backports security fixes. For this reason, you should not assume that a vulnerability present in the community 2.4.37 release is present in the RHEL package of the same version. -If you are trying to install a newer version of HTTPD for this reason, it is almost certainly not necessary. Please see [this Red Hat article](https://access.redhat.com/solutions/445713) for more information. +If you are trying to install a newer version of HTTPD for this reason, it is almost certainly not necessary. See the [Apache HTTPD versions supported by Red Hat](https://access.redhat.com/solutions/445713) article in the Red Hat knowledgebase for more information. !!! Warning Neither community HTTPD nor HTTPD built from source is supported by Red Hat. - If you are considering using any other source of HTTPD on a RHEL system please read the article linked above and ensure you understand the implications. + If you are considering using any other source of HTTPD on a RHEL system, read the [Apache HTTPD versions supported by Red Hat](https://access.redhat.com/solutions/445713) article and ensure you understand the implications. ## Upgrading HTTPD on Windows From b8decbcc205439b9510316d01d1df2f6de09b4a2 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 3 Aug 2023 06:30:30 -0400 Subject: [PATCH 06/28] removed intro content from Getting started landing page --- .../docs/biganimal/release/getting_started/index.mdx | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/index.mdx b/product_docs/docs/biganimal/release/getting_started/index.mdx index 93c25b10dd1..2eeb8f676a0 100644 --- a/product_docs/docs/biganimal/release/getting_started/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/index.mdx @@ -11,14 +11,3 @@ navigation: - creating_a_cluster --- -As a cloud administrator, you can: -- Set up BigAnimal with your existing Azure subscription, AWS account, or Google Cloud account. -- Invite others to join you in exploring what EDB has to offer. -- Create initial clusters as an account owner so that development can begin. - - - -BigAnimal's portal can serve as an identity provider for users that have EDB accounts. After signing in for the first time, you can then [set up your own identity provider](/biganimal/release/getting_started/identity_provider/#setting-up-your-own-identity-provider). - -!!! Note - If you purchased from Azure Marketplace, you need to [set up your Azure account](/biganimal/release/getting_started/02_azure_market_setup) to be your identity provider. From 22ab960bf9f53115d899b396f5dbe4f01ceca1a1 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 3 Aug 2023 06:32:41 -0400 Subject: [PATCH 07/28] Revert "removed intro content from Getting started landing page" This reverts commit b8decbcc205439b9510316d01d1df2f6de09b4a2. --- .../docs/biganimal/release/getting_started/index.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/product_docs/docs/biganimal/release/getting_started/index.mdx b/product_docs/docs/biganimal/release/getting_started/index.mdx index 2eeb8f676a0..93c25b10dd1 100644 --- a/product_docs/docs/biganimal/release/getting_started/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/index.mdx @@ -11,3 +11,14 @@ navigation: - creating_a_cluster --- +As a cloud administrator, you can: +- Set up BigAnimal with your existing Azure subscription, AWS account, or Google Cloud account. +- Invite others to join you in exploring what EDB has to offer. +- Create initial clusters as an account owner so that development can begin. + + + +BigAnimal's portal can serve as an identity provider for users that have EDB accounts. After signing in for the first time, you can then [set up your own identity provider](/biganimal/release/getting_started/identity_provider/#setting-up-your-own-identity-provider). + +!!! Note + If you purchased from Azure Marketplace, you need to [set up your Azure account](/biganimal/release/getting_started/02_azure_market_setup) to be your identity provider. From 08a3e551ed3240364d525babea43ac30ff643d85 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Tue, 8 Aug 2023 13:32:37 +0530 Subject: [PATCH 08/28] Update product_docs/docs/pem/9/index.mdx Co-authored-by: Dee Dee Rothery <83650384+drothery-edb@users.noreply.github.com> --- product_docs/docs/pem/9/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pem/9/index.mdx b/product_docs/docs/pem/9/index.mdx index 973793644a3..5ffaceaf497 100644 --- a/product_docs/docs/pem/9/index.mdx +++ b/product_docs/docs/pem/9/index.mdx @@ -72,4 +72,4 @@ Supported versions of Postgres for PEM 9.x: |**PostgreSQL (PG)** |11, 12, 13, 14, 15 |11, 12, 13, 14, 15 | |**EDB Postgres Extended Server (PGE)** |11, 12, 13, 14, 15 |12, 13, 14, 15[^1] | -[^1]: sslutils is not available for RHEL 7 on Power, so this distribution cannot use PGE as a backend. +[^1]: sslutils is not available for RHEL 7 on IBM Power, so this distribution cannot use PGE as a backend. From 0ea17b9b1d21843bedbe96f226cb53ff27b675b6 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Tue, 8 Aug 2023 11:03:28 +0100 Subject: [PATCH 09/28] Added previously proposed line on ssl Signed-off-by: Dj Walker-Morgan --- product_docs/docs/pgd/4/harp/04_configuration.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/product_docs/docs/pgd/4/harp/04_configuration.mdx b/product_docs/docs/pgd/4/harp/04_configuration.mdx index 23c2e4bd5e2..9c23cc9590e 100644 --- a/product_docs/docs/pgd/4/harp/04_configuration.mdx +++ b/product_docs/docs/pgd/4/harp/04_configuration.mdx @@ -109,6 +109,8 @@ configuration file: - **`ssl_key_file`**: Client SSL key file. +Note that when `ssl` is set to `on`, the etcd endpoint URLs must contain the `https` scheme, e.g. `https://host1:2379`. + #### Example This example shows how to configure HARP to contact an etcd DCS @@ -144,6 +146,7 @@ The following `http` settings apply and are mandatory if `secure: true` is set: - **`key_file`**: HTTP server SSL key file. Mandatory if `secure` is set to `true`. + #### Example ```yaml From 165dac84a2feecfcb9a50fc8d8d995ad3ba658d4 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan <126472455+djw-m@users.noreply.github.com> Date: Tue, 8 Aug 2023 11:17:07 +0100 Subject: [PATCH 10/28] Update product_docs/docs/pgd/4/harp/04_configuration.mdx Co-authored-by: Dee Dee Rothery <83650384+drothery-edb@users.noreply.github.com> --- product_docs/docs/pgd/4/harp/04_configuration.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/pgd/4/harp/04_configuration.mdx b/product_docs/docs/pgd/4/harp/04_configuration.mdx index 9c23cc9590e..e7e55e2878e 100644 --- a/product_docs/docs/pgd/4/harp/04_configuration.mdx +++ b/product_docs/docs/pgd/4/harp/04_configuration.mdx @@ -109,7 +109,8 @@ configuration file: - **`ssl_key_file`**: Client SSL key file. -Note that when `ssl` is set to `on`, the etcd endpoint URLs must contain the `https` scheme, e.g. `https://host1:2379`. +!!! Tip + When `ssl` is set to `on`, the etcd endpoint URLs must contain the `https` scheme. For example, `https://host1:2379`. #### Example From 878063e6bf270d2df72d7b01c45ec78ad9fc88dc Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Tue, 8 Aug 2023 10:43:48 +0100 Subject: [PATCH 11/28] Orders changed, ticks installed Signed-off-by: Dj Walker-Morgan --- .../pgd/3.7/bdr/upgrades/supported_paths.mdx | 8 ++--- .../docs/pgd/4/upgrades/upgrade_paths.mdx | 32 ++++++++++--------- .../docs/pgd/5/upgrades/upgrade_paths.mdx | 14 ++++---- 3 files changed, 28 insertions(+), 26 deletions(-) diff --git a/product_docs/docs/pgd/3.7/bdr/upgrades/supported_paths.mdx b/product_docs/docs/pgd/3.7/bdr/upgrades/supported_paths.mdx index b24da2c3a04..57248d65691 100644 --- a/product_docs/docs/pgd/3.7/bdr/upgrades/supported_paths.mdx +++ b/product_docs/docs/pgd/3.7/bdr/upgrades/supported_paths.mdx @@ -1,13 +1,13 @@ --- title: Supported BDR upgrade paths --- -### Upgrading from version 3.6 to version 3.7 -We recommend you upgrade your cluster to the latest version of 3.6 before upgrading your cluster to 3.7. You will then be able to upgrade to a version of 3.7 released on the same date or later. +### Upgrading within version 3.7 +BDR 3.7 does not follow semantic versioning. Instead, it uses 2 position majors similar to PostgreSQL releases prior to version 10 (e.g. 9.6). BDR 3.7 also considered releases prior to 3.7.9 as beta releases and they could include breaking changes. BDR 3.7.9 was declared a Long Term Support version under the previous versioning nomenclature. All releases 3.7.9 and later maintain backward compatibility allowing upgrades to later versions. -### Upgrading within version 3.7 -BDR 3.7 does not follow semantic versioning. Instead, it uses 2 position majors similar to PostgreSQL releases prior to version 10 (e.g. 9.6). BDR 3.7 also considered releases prior to 3.7.9 as beta releases and they could include breaking changes. BDR 3.7.9 was declared a Long Term Sppoort version under the previous versioning nomenclature. All releses 3.7.9 and later maintain backward compatibility allowing upgrades to later versions. +### Upgrading from version 3.6 to version 3.7 +We recommend you upgrade your cluster to the latest version of 3.6 before upgrading your cluster to 3.7. You will then be able to upgrade to a version of 3.7 released on the same date or later. diff --git a/product_docs/docs/pgd/4/upgrades/upgrade_paths.mdx b/product_docs/docs/pgd/4/upgrades/upgrade_paths.mdx index 43ec2f3035d..740a02f67a3 100644 --- a/product_docs/docs/pgd/4/upgrades/upgrade_paths.mdx +++ b/product_docs/docs/pgd/4/upgrades/upgrade_paths.mdx @@ -2,9 +2,17 @@ title: Supported BDR upgrade paths --- -## Upgrading from version 3.6 to version 4 +## Upgrading within version 4 -Currently there are no direct upgrade paths from 3.6 to 4. You must first upgrade your cluster to 3.7 before upgrading to 4. See [Upgrading from 3.6](/pgd/3.7/bdr/upgrades/supported_paths/#upgrading-from-version-36) in the 3.7 documentation for more information. +Beginning with version 4, EDB Postgres Distributed has adopted semantic versioning. All changes within the same major will be backward compatible lowering the risk when upgrading and allowing you to choose any later minor or patch release as the upgrade target. + +| 4.0.0 | 4.0.1 | 4.0.2 | 4.1.0 | 4.1.1 | Target BDR version | +|-------|-------|-------|--------|------|--------------------| +| ✓ | ✓ | ✓ | ✓ | ✓ | 4.2.0 | +| ✓ | ✓ | ✓ | ✓ | | 4.1.1 | +| ✓ | ✓ | ✓ | | | 4.1.0 | +| ✓ | ✓ | | | | 4.0.2 | +| ✓ | | | | | 4.0.1 | ## Upgrading from version 3.7 to version 4 @@ -12,21 +20,15 @@ Currently it is recommended that you are using 3.7.15 or later before upgrading | 3.7.15 | 3.7.16 | 3.7.17 | Target BDR version | |--------|--------|--------|--------------------| -| X | X | X | 4.2.0 | -| X | X | | 4.1.1 | -| X | X | | 4.1.0 | -| X | | | 4.0.2 | +| ✓ | ✓ | ✓ | 4.2.0 | +| ✓ | ✓ | | 4.1.1 | +| ✓ | ✓ | | 4.1.0 | +| ✓ | | | 4.0.2 | -## Upgrading within version 4 +## Upgrading from version 3.6 to version 4 + +Currently there are no direct upgrade paths from 3.6 to 4. You must first upgrade your cluster to 3.7 before upgrading to 4. See [Upgrading from 3.6](/pgd/3.7/bdr/upgrades/supported_paths/#upgrading-from-version-36) in the 3.7 documentation for more information. -Beginning with version 4, EDB Postgres Distributed has adopted semantic versioning. All changes within the same major will be backward compatible lowering the risk when upgrading and allowing you to choose any later minor or patch release as the upgrade target. -| 4.0.0 | 4.0.1 | 4.0.2 | 4.1.0 | 4.1.1 | Target BDR version | -|-------|-------|-------|--------|------|--------------------| -| X | X | X | X | X | 4.2.0 | -| X | X | X | X | | 4.1.1 | -| X | X | X | | | 4.1.0 | -| X | X | | | | 4.0.2 | -| X | | | | | 4.0.1 | diff --git a/product_docs/docs/pgd/5/upgrades/upgrade_paths.mdx b/product_docs/docs/pgd/5/upgrades/upgrade_paths.mdx index 94351cc4e84..2a114d3af7c 100644 --- a/product_docs/docs/pgd/5/upgrades/upgrade_paths.mdx +++ b/product_docs/docs/pgd/5/upgrades/upgrade_paths.mdx @@ -7,9 +7,9 @@ title: Supported PGD upgrade paths | 5.0.0 | 5.0.1 | 5.1.0 | Target PGD version | |-------|-------|-------|--------------------| -| X | X | X | 5.2.0 | -| X | X | | 5.1.0 | -| X | | | 5.0.1 | +| ✓ | ✓ | ✓ | 5.2.0 | +| ✓ | ✓ | | 5.1.0 | +| ✓ | | | 5.0.1 | ## Upgrading from version 4 to version 5 @@ -18,10 +18,10 @@ Upgrades from PGD 4 to PGD 5 are supported from version 4.3.0. For older version | 4.3.0 | 4.3.0-1 | 4.3.1 | 4.3.1-1 | Target PGD version | |-------|---------|-------|---------|--------------------| -| X | X | X | X | 5.2.0 | -| X | X | X | | 5.1.0 | -| X | X | | | 5.0.1 | -| X | | | | 5.0.0 | +| ✓ | ✓ | ✓ | ✓ | 5.2.0 | +| ✓ | ✓ | ✓ | | 5.1.0 | +| ✓ | ✓ | | | 5.0.1 | +| ✓ | | | | 5.0.0 | From ce66015f7922ca10fc5240b2b114629f1411e57a Mon Sep 17 00:00:00 2001 From: Dee Dee Rothery <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 8 Aug 2023 05:54:28 -0400 Subject: [PATCH 12/28] Update product_docs/docs/pgd/3.7/bdr/upgrades/supported_paths.mdx --- product_docs/docs/pgd/3.7/bdr/upgrades/supported_paths.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pgd/3.7/bdr/upgrades/supported_paths.mdx b/product_docs/docs/pgd/3.7/bdr/upgrades/supported_paths.mdx index 57248d65691..ef681afd1f3 100644 --- a/product_docs/docs/pgd/3.7/bdr/upgrades/supported_paths.mdx +++ b/product_docs/docs/pgd/3.7/bdr/upgrades/supported_paths.mdx @@ -4,7 +4,7 @@ title: Supported BDR upgrade paths ### Upgrading within version 3.7 -BDR 3.7 does not follow semantic versioning. Instead, it uses 2 position majors similar to PostgreSQL releases prior to version 10 (e.g. 9.6). BDR 3.7 also considered releases prior to 3.7.9 as beta releases and they could include breaking changes. BDR 3.7.9 was declared a Long Term Support version under the previous versioning nomenclature. All releases 3.7.9 and later maintain backward compatibility allowing upgrades to later versions. +BDR 3.7 does not follow semantic versioning. Instead, it uses 2 position majors similar to PostgreSQL releases prior to version 10 (for example, 9.6). BDR 3.7 also considered releases prior to 3.7.9 as beta releases and they could include breaking changes. BDR 3.7.9 was declared a Long Term Support version under the previous versioning nomenclature. All releases 3.7.9 and later maintain backward compatibility allowing upgrades to later versions. ### Upgrading from version 3.6 to version 3.7 From 3cb92ff9ebe2feece9fb07d6a15b451cf6f4e331 Mon Sep 17 00:00:00 2001 From: francoughlin Date: Tue, 8 Aug 2023 08:15:16 -0400 Subject: [PATCH 13/28] Update per Nidhi's review comments Changing "loads" to "load" for consistency --- .../02_edb_loader/data_loading_methods.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/epas/15/database_administration/02_edb_loader/data_loading_methods.mdx b/product_docs/docs/epas/15/database_administration/02_edb_loader/data_loading_methods.mdx index ffec8551e62..d75c1ccd3ea 100644 --- a/product_docs/docs/epas/15/database_administration/02_edb_loader/data_loading_methods.mdx +++ b/product_docs/docs/epas/15/database_administration/02_edb_loader/data_loading_methods.mdx @@ -8,9 +8,9 @@ As with Oracle SQL\*Loader, EDB\*Loader supports three data loading methods: - *Conventional path load* — Conventional path load is the default method used by EDB\*Loader. Use basic insert processing to add rows to the table. The advantage of a conventional path load is that table constraints and database objects defined on the table are enforced during a conventional path load. Table constraints and database objects include primary keys, not null constraints, check constraints, unique indexes, foreign key constraints, triggers, and so on. One exception is that the EDB Postgres Advanced Server rules defined on the table aren't enforced. EDB\*Loader can load tables on which rules are defined. However, the rules aren't executed. As a consequence, you can't load partitioned tables implemented using rules with EDB\*Loader. See [Conventional path load](invoking_edb_loader/conventional_path_load.mdx) -- *Direct path loads* — A direct path load is faster than a conventional path load but requires removing most types of constraints and triggers from the table. See [Direct path load](invoking_edb_loader/direct_path_load.mdx). +- *Direct path load* — A direct path load is faster than a conventional path load but requires removing most types of constraints and triggers from the table. See [Direct path load](invoking_edb_loader/direct_path_load.mdx). -- *Parallel direct path loads* — A parallel direct path load provides even greater performance improvement by permitting multiple EDB\*Loader sessions to run simultaneously to load a single table. See [Parallel direct path load](invoking_edb_loader/parallel_direct_path_load.mdx). +- *Parallel direct path load* — A parallel direct path load provides even greater performance improvement by permitting multiple EDB\*Loader sessions to run simultaneously to load a single table. See [Parallel direct path load](invoking_edb_loader/parallel_direct_path_load.mdx). !!! Note Create EDB Postgres Advanced Server rules using the `CREATE RULE` command. EDB Postgres Advanced Server rules aren't the same database objects as rules and rule sets used in Oracle. From cb56112eb6e613a6d4d2104928ce8e4745b8b33e Mon Sep 17 00:00:00 2001 From: francoughlin Date: Tue, 8 Aug 2023 09:05:49 -0400 Subject: [PATCH 14/28] Acronym cleanup Removed improper use of EPAS --- .../01_setting_new_parameters.mdx | 4 ++-- .../01_shared_buffers.mdx | 2 +- .../04_wal_buffers.mdx | 2 +- .../06_checkpoint_completion_target.mdx | 2 +- .../07_checkpoint_timeout.mdx | 2 +- .../08_max_wal_size.mdx | 2 +- .../09_min_wal_size.mdx | 2 +- .../10_bgwriter_delay.mdx | 2 +- .../15_edb_max_spins_per_delay.mdx | 2 +- .../16_pg_prewarm.autoprewarm.mdx | 2 +- .../17_pg_prewarm.autoprewarm_interval.mdx | 2 +- .../02_resource_usage_memory.mdx | 4 ++-- ...03_resource_usage_edb_resource_manager.mdx | 2 +- .../07_auditing_settings/01_edb_audit.mdx | 2 +- .../02_edb_audit_directory.mdx | 2 +- .../03_edb_audit_filename.mdx | 2 +- .../04_edb_audit_rotation_day.mdx | 2 +- .../05_edb_audit_rotation_size.mdx | 2 +- .../06_edb_audit_rotation_seconds.mdx | 2 +- .../07_edb_audit_connect.mdx | 2 +- .../08_edb_audit_disconnect.mdx | 2 +- .../09_edb_audit_statement.mdx | 2 +- .../11_edb_audit_destination.mdx | 2 +- .../10_ccd_other_defaults.mdx | 4 ++-- .../12_customized_options.mdx | 20 ++++++++--------- .../14_audit_archiver.mdx | 22 +++++++++---------- .../01_configuration_parameters/index.mdx | 4 ++-- .../10_edb_resource_manager/index.mdx | 4 ++-- .../epas/15/database_administration/index.mdx | 2 +- 29 files changed, 53 insertions(+), 53 deletions(-) diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/01_setting_new_parameters.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/01_setting_new_parameters.mdx index f8d5ace2882..b8ce0d69c9d 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/01_setting_new_parameters.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/01_setting_new_parameters.mdx @@ -54,7 +54,7 @@ The multiplier for memory units is 1024. ## Specifying configuration parameter settings -A number of parameter settings are set when the EPAS database product is built. These are read-only parameters, and you can't change their values. A couple of parameters are also permanently set for each database when the database is created. These parameters are read-only and you can't later change them for the database. However, there are a number of ways to specify the configuration parameter settings: +A number of parameter settings are set when the EDB Postgres Advanced Server database product is built. These are read-only parameters, and you can't change their values. A couple of parameters are also permanently set for each database when the database is created. These parameters are read-only and you can't later change them for the database. However, there are a number of ways to specify the configuration parameter settings: - The initial settings for almost all configurable parameters across the entire database cluster are listed **in the `postgresql.conf`** configuration file. These settings are put into effect upon database server start or restart. You can override some of these initial parameter settings. All configuration parameters have built-in default settings that are in effect unless they are explicitly overridden. @@ -72,7 +72,7 @@ A number of parameter settings are set when the EPAS database product is built. ## Modifying the postgresql.conf file -The configuration parameters in the `postgresql.conf` file specify server behavior with regard to auditing, authentication, encryption, and other behaviors. On Linux and Windows hosts, the `postgresql.conf` file resides in the `data` directory under your EPAS installation. +The configuration parameters in the `postgresql.conf` file specify server behavior with regard to auditing, authentication, encryption, and other behaviors. On Linux and Windows hosts, the `postgresql.conf` file resides in the `data` directory under your EDB Postgres Advanced Server installation. Parameters that are preceded by a pound sign (#) are set to their default value. To change a parameter value, remove the pound sign and enter a new value. After setting or changing a parameter, you must either `reload` or `restart` the server for the new parameter value to take effect. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/01_shared_buffers.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/01_shared_buffers.mdx index a514724d48c..0e90a9a9c40 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/01_shared_buffers.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/01_shared_buffers.mdx @@ -16,7 +16,7 @@ redirects: **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Sets the amount of memory the database server uses for shared memory buffers. The default is typically 32MB but might be less if your kernel settings don't support it, as determined during `initdb`. This setting must be at least 128kB. (Nondefault values of `BLCKSZ` change the minimum.) However, you usually need settings significantly higher than the minimum for good performance. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/04_wal_buffers.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/04_wal_buffers.mdx index f600b0f31b5..9c53a52b925 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/04_wal_buffers.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/04_wal_buffers.mdx @@ -16,7 +16,7 @@ redirects: **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account The amount of memory used in shared memory for WAL data. Because the data is written out to disk at every transaction commit, the setting must be large enough only to hold the amount of WAL data generated by one typical transaction. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/06_checkpoint_completion_target.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/06_checkpoint_completion_target.mdx index 9014452bc04..adbdcb489a6 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/06_checkpoint_completion_target.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/06_checkpoint_completion_target.mdx @@ -16,7 +16,7 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the target of checkpoint completion as a fraction of total time between checkpoints. This parameter spreads out the checkpoint writes while the system starts working toward the next checkpoint. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/07_checkpoint_timeout.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/07_checkpoint_timeout.mdx index 7f76898fbcf..e0f89d66104 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/07_checkpoint_timeout.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/07_checkpoint_timeout.mdx @@ -16,7 +16,7 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Maximum time between automatic WAL checkpoints, in seconds. Increasing this parameter can increase the amount of time needed for crash recovery. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/08_max_wal_size.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/08_max_wal_size.mdx index f9ee8c69acd..100e406451b 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/08_max_wal_size.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/08_max_wal_size.mdx @@ -16,7 +16,7 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account `max_wal_size` specifies the maximum size for the WAL to reach between automatic WAL checkpoints. This is a soft limit. WAL size can exceed `max_wal_size` under special circumstances, such as when under a heavy load, with a failing archive_command, or with a high `wal_keep_segments` setting. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/09_min_wal_size.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/09_min_wal_size.mdx index 03194af3263..78880fb71fd 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/09_min_wal_size.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/09_min_wal_size.mdx @@ -16,6 +16,6 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account If WAL disk usage stays below the value specified by `min_wal_size`, old WAL files are recycled for future use at a checkpoint rather than removed. This feature ensures that enough WAL space is reserved to handle spikes in WAL usage, like when running large batch jobs. You can set this parameter in the `postgresql.conf` file or on the server command line. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/10_bgwriter_delay.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/10_bgwriter_delay.mdx index d7ad42fc57f..93dbbaa3f1c 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/10_bgwriter_delay.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/10_bgwriter_delay.mdx @@ -16,7 +16,7 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the delay between activity rounds for the background writer. In each round, the writer issues writes for some number of dirty buffers. (You can control the number of dirty buffers using the `bgwriter_lru_maxpages` and `bgwriter_lru_multiplier` parameters.) It then sleeps for `bgwriter_delay` milliseconds, and repeats. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/15_edb_max_spins_per_delay.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/15_edb_max_spins_per_delay.mdx index c8b3bc4307c..218045c9a70 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/15_edb_max_spins_per_delay.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/15_edb_max_spins_per_delay.mdx @@ -16,7 +16,7 @@ redirects: **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the maximum number of times that a session spins while waiting for a spin lock. If a lock isn't acquired, the session sleeps. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/16_pg_prewarm.autoprewarm.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/16_pg_prewarm.autoprewarm.mdx index 3f0bf06d351..d9fa1becfff 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/16_pg_prewarm.autoprewarm.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/16_pg_prewarm.autoprewarm.mdx @@ -16,7 +16,7 @@ redirects: **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Controls whether the database server runs `autoprewarm`, a background worker process that dumps shared buffers to disk before a shutdown. It then *prewarms* the shared buffers the next time the server is started, meaning it loads blocks from the disk back into the buffer pool. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/17_pg_prewarm.autoprewarm_interval.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/17_pg_prewarm.autoprewarm_interval.mdx index fff6c2e243c..ab90420f574 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/17_pg_prewarm.autoprewarm_interval.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/17_pg_prewarm.autoprewarm_interval.mdx @@ -16,7 +16,7 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account The minimum number of seconds after which the `autoprewarm` background worker dumps shared buffers to disk. If set to 0, shared buffers aren't dumped at regular intervals. They're dumped only when you shut down the server. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/02_resource_usage_memory.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/02_resource_usage_memory.mdx index 266e339c653..53a8db90fb8 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/02_resource_usage_memory.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/02_resource_usage_memory.mdx @@ -24,7 +24,7 @@ These configuration parameters control resource use pertaining to memory. **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Determines how much of the host system’s resources for the database server to use based on the host machine’s total available resources and the intended use of the host machine. @@ -52,7 +52,7 @@ After you select a value for `edb_dynatune`, you can further fine-tune database **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Controls tuning aspects based on the expected workload profile on the database server. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/03_resource_usage_edb_resource_manager.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/03_resource_usage_edb_resource_manager.mdx index 1c4ef34e890..b7bef5c581e 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/03_resource_usage_edb_resource_manager.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/03_resource_usage_edb_resource_manager.mdx @@ -20,7 +20,7 @@ These configuration parameters control resource use through [EDB Resource Manage **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Controls the maximum number of resource groups that EDB Resource Manager can use simultaneously. You can create more resource groups than the value specified by `edb_max_resource_groups`. However, the number of resource groups in active use by processes in these groups can't exceed this value. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/01_edb_audit.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/01_edb_audit.mdx index d5bb7f1c3ed..2dc3dcdbfa6 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/01_edb_audit.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/01_edb_audit.mdx @@ -16,6 +16,6 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Enables or disables database auditing. The values `xml` or `csv` enable database auditing. These values determine the file format in which to capture auditing information. `none` disables database auditing. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/02_edb_audit_directory.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/02_edb_audit_directory.mdx index ab277ab83f9..681d84f5b34 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/02_edb_audit_directory.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/02_edb_audit_directory.mdx @@ -16,6 +16,6 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the directory where the audit log files are created. Specify either an absolute path or a path relative to the EDB Postgres Advanced Server `data` directory. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/03_edb_audit_filename.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/03_edb_audit_filename.mdx index aea10578730..dd4595ed3cf 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/03_edb_audit_filename.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/03_edb_audit_filename.mdx @@ -16,6 +16,6 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the file name of the audit file where the auditing information is stored. The default file name is `audit-%Y%m%d_%H%M%S`. The escape sequences, such as `%Y` and `%m`, are replaced by the appropriate current values of the system date and time. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/04_edb_audit_rotation_day.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/04_edb_audit_rotation_day.mdx index ee3417c872a..457b69d1f58 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/04_edb_audit_rotation_day.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/04_edb_audit_rotation_day.mdx @@ -16,6 +16,6 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the day of the week on which to rotate the audit files. Valid values are `sun`, `mon`, `tue`, `wed`, `thu`, `fri`, `sat`, `every`, and `none`. To disable rotation, set the value to `none`. To rotate the file every day, set the `edb_audit_rotation_day` value to `every`. To rotate the file on a specific day of the week, set the value to the desired day of the week. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/05_edb_audit_rotation_size.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/05_edb_audit_rotation_size.mdx index ceecb88ed2d..d120566146f 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/05_edb_audit_rotation_size.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/05_edb_audit_rotation_size.mdx @@ -16,6 +16,6 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies a file size threshold in megabytes when file rotation occurs. If the parameter is commented out or set to 0, rotating the file based on size doesn't occur. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/06_edb_audit_rotation_seconds.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/06_edb_audit_rotation_seconds.mdx index 7e5b6a682bc..34a060a5ddf 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/06_edb_audit_rotation_seconds.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/06_edb_audit_rotation_seconds.mdx @@ -16,6 +16,6 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the rotation time in seconds when a new log file is created. To disable this feature, leave this parameter set to 0. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/07_edb_audit_connect.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/07_edb_audit_connect.mdx index ed518b05f68..f91db89a71e 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/07_edb_audit_connect.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/07_edb_audit_connect.mdx @@ -16,6 +16,6 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Enables auditing of database connection attempts by users. To disable auditing of all connection attempts, set `edb_audit_connect` to `none`. To audit all failed connection attempts, set the value to `failed`. To audit all connection attempts, set the value to `all`. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/08_edb_audit_disconnect.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/08_edb_audit_disconnect.mdx index 66e81cd69d1..f781c37ea12 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/08_edb_audit_disconnect.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/08_edb_audit_disconnect.mdx @@ -16,6 +16,6 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Enables auditing of database disconnections by connected users. To enable auditing of disconnections, set the value to `all`. To disable, set the value to `none`. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/09_edb_audit_statement.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/09_edb_audit_statement.mdx index 83c247beba8..dab49a15fdf 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/09_edb_audit_statement.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/09_edb_audit_statement.mdx @@ -16,7 +16,7 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies auditing of different categories of SQL statements as well as statements related to specific SQL commands. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/11_edb_audit_destination.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/11_edb_audit_destination.mdx index f7ba0f90402..d539b8d8968 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/11_edb_audit_destination.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/11_edb_audit_destination.mdx @@ -16,7 +16,7 @@ redirects: **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies whether to record the audit log information in the directory as given by the `edb_audit_directory` parameter or to the directory and file managed by the `syslog` process. Set to `file` to use the directory specified by `edb_audit_directory`. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/10_ccd_other_defaults.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/10_ccd_other_defaults.mdx index 703f896c27d..034252584f4 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/10_ccd_other_defaults.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/10_ccd_other_defaults.mdx @@ -20,7 +20,7 @@ These parameters set miscellaneous client connection defaults. **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Before creating a link to an Oracle server, you must direct EDB Postgres Advanced Server to the correct Oracle home directory. Set the `LD_LIBRARY_PATH` environment variable on Linux or `PATH` on Windows to the `lib` directory of the Oracle client installation directory. @@ -56,7 +56,7 @@ After setting the `oracle_home` configuration parameter, you must restart the se **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account If you're using an ODBC driver manager and if it's installed in a nonstandard location, specify the location by setting the `odbc_lib_path` configuration parameter in the `postgresql.conf` file: diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/12_customized_options.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/12_customized_options.mdx index ffb917ef039..b93d127ddea 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/12_customized_options.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/12_customized_options.mdx @@ -26,7 +26,7 @@ The `custom_variable_classes` parameter was deprecated in EDB Postgres Advanced **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the maximum number of concurrent alerts allowed on a system using the `DBMS_ALERTS` package. @@ -42,7 +42,7 @@ Specifies the maximum number of concurrent alerts allowed on a system using the **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the total size of the buffer used for the `DBMS_PIPE` package. @@ -117,7 +117,7 @@ __OUTPUT__ **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Controls whether SQL/Protect is actively monitoring protected roles by analyzing SQL statements issued by those roles and reacting according to the setting of `edb_sql_protect.level`. When you're ready to begin monitoring with SQL/Protect, set this parameter to `on`. @@ -133,7 +133,7 @@ Controls whether SQL/Protect is actively monitoring protected roles by analyzing **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Sets the action taken by SQL/Protect when a SQL statement is issued by a protected role. @@ -157,7 +157,7 @@ If you're using SQL/Protect for the first time, set `edb_sql_protect.level` to ` **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Sets the maximum number of relations that can be protected per role. The total number of protected relations for the server is the number of protected relations times the number of protected roles. Every protected relation consumes space in shared memory. The space for the maximum possible protected relations is reserved during database server startup. @@ -199,7 +199,7 @@ In this case, reduce the parameter value until you can start the database server **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Sets the maximum number of roles that can be protected. @@ -243,7 +243,7 @@ In this cases, reduce the parameter value until you can start the database serve **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Sets the maximum number of offending queries to save in the view `edb_sql_protect_queries`. @@ -286,7 +286,7 @@ In this case, reduce the parameter value until you can start the database server **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Sets the directory path where the EDB wait states log files are stored. Use a full, absolute path, not a relative path. However, the default setting is `edb_wait_states`, which makes `$PGDATA/edb_wait_states` the default directory location. See [EDB Wait States](/pg_extensions/wait_states/) for more information. @@ -302,7 +302,7 @@ Sets the directory path where the EDB wait states log files are stored. Use a fu **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Sets the time to wait before deleting the log files for EDB wait states. The default is 604,800 seconds, which is 7 days. See [EDB Wait States](/pg_extensions/wait_states/) for more information. @@ -318,7 +318,7 @@ Sets the time to wait before deleting the log files for EDB wait states. The def **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Sets the timing interval between two sampling cycles for EDB wait states. The default setting is 1 second. See [EDB Wait States](/pg_extensions/wait_states/) for more information. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/14_audit_archiver.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/14_audit_archiver.mdx index b01cf0f9fc0..747f2793eb9 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/14_audit_archiver.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/14_audit_archiver.mdx @@ -20,7 +20,7 @@ These configuration parameters are used by the EDB Postgres Advanced Server data **When value changes take effect:** Restart -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Enables or disables database audit archiving. @@ -36,7 +36,7 @@ Enables or disables database audit archiving. **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Enforces a timeout in seconds when a database attempts to archive a log file. @@ -52,7 +52,7 @@ Enforces a timeout in seconds when a database attempts to archive a log file. **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the file name of an audit log file that needs to be archived. The file name must align with the `edb_audit_filename` parameter. The audit files with `edb_audit_archiver_filename_prefix` in the `edb_audit_directory` are eligible for compression or expiration. @@ -68,7 +68,7 @@ Specifies the file name of an audit log file that needs to be archived. The file **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the time in seconds after which audit logs are eligible for compression. The possible values to set this parameter are: @@ -87,7 +87,7 @@ Specifies the time in seconds after which audit logs are eligible for compressio **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies a file size threshold in megabytes, after which audit logs are eligible for compression. If the parameter is set to -1, no compression of the log file occurs based on size. @@ -103,7 +103,7 @@ Specifies a file size threshold in megabytes, after which audit logs are eligibl **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the command to execute compressing of the audit log files. The default value for `edb_audit_archiver_compress_command` is `gzip %p`. The `gzip` provides a standard method of compressing files. The `%p` in the string is replaced by the path name of the file to archive. @@ -119,7 +119,7 @@ Specifies the command to execute compressing of the audit log files. The default **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the file name of an already compressed log file. The file name must align with `edb_audit_archiver_compress_command`. The default file name is `.gz`. @@ -135,7 +135,7 @@ Specifies the file name of an already compressed log file. The file name must al **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the time in seconds after which audit logs are eligible to expire. The possible values to set this parameter are: @@ -154,7 +154,7 @@ Specifies the time in seconds after which audit logs are eligible to expire. The **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies a file size threshold in megabytes, after which audit logs are eligible to expire. If the parameter is set to -1, no expiration of a log file based on size occurs. @@ -170,7 +170,7 @@ Specifies a file size threshold in megabytes, after which audit logs are eligibl **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Specifies the command to execute on an expired audit log file before removal. @@ -186,7 +186,7 @@ Specifies the command to execute on an expired audit log file before removal. **When value changes take effect:** Reload -**Required authorization to activate:** EPAS service account +**Required authorization to activate:** EDB Postgres Advanced Server service account Identifies the oldest log file to sort alphabetically or based on `mtime`. diff --git a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/index.mdx b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/index.mdx index 3aa2b2bed6a..2b48a5f7eeb 100644 --- a/product_docs/docs/epas/15/database_administration/01_configuration_parameters/index.mdx +++ b/product_docs/docs/epas/15/database_administration/01_configuration_parameters/index.mdx @@ -12,9 +12,9 @@ redirects: -The EDB Postgres Advanced Server (EPAS) configuration parameters control various aspects of the database server’s behavior and environment such as data file and log file locations, connection, authentication and security settings, resource allocation and consumption, archiving and replication settings, error logging and statistics gathering, optimization and performance tuning, and locale and formatting settings +The EDB Postgres Advanced Server configuration parameters control various aspects of the database server’s behavior and environment such as data file and log file locations, connection, authentication and security settings, resource allocation and consumption, archiving and replication settings, error logging and statistics gathering, optimization and performance tuning, and locale and formatting settings -Configuration parameters that apply only to EPAS are noted in the [Summary of configuration parameters](/epas/latest/reference/database_administrator_reference/02_summary_of_configuration_parameters/) topic, which lists all EPAS configuration parameters along with a number of key attributes of the parameters. +Configuration parameters that apply only to EDB Postgres Advanced Server are noted in the [Summary of configuration parameters](/epas/latest/reference/database_administrator_reference/02_summary_of_configuration_parameters/) topic, which lists all EDB Postgres Advanced Server configuration parameters along with a number of key attributes of the parameters. You can find more information about configuration parameters in the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/runtime-config.html). diff --git a/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/index.mdx b/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/index.mdx index 003b66cc59b..d03e7326733 100644 --- a/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/index.mdx +++ b/product_docs/docs/epas/15/database_administration/10_edb_resource_manager/index.mdx @@ -2,7 +2,7 @@ title: "Throttling CPU and I/O at the process level" navTitle: "EDB Resource Manager" indexCards: simple -description: "How to use EDB Resource Manager to control the use of operating system resources used by EPAS processes" +description: "How to use EDB Resource Manager to control the use of operating system resources used by EDB Postgres Advanced Server processes" navigation: - edb_resource_manager_key_concepts - creating_resource_groups @@ -27,7 +27,7 @@ redirects: -EDB Resource Manager is an EDB Postgres Advanced Server (EPAS) feature that lets you control the use of operating system resources used by EPAS processes. +EDB Resource Manager is an EDB Postgres Advanced Server feature that lets you control the use of operating system resources used by EDB Postgres Advanced Server processes. This capability allows you to protect the system from processes that might uncontrollably overuse and monopolize certain system resources. diff --git a/product_docs/docs/epas/15/database_administration/index.mdx b/product_docs/docs/epas/15/database_administration/index.mdx index 1843b72b994..48712593d96 100644 --- a/product_docs/docs/epas/15/database_administration/index.mdx +++ b/product_docs/docs/epas/15/database_administration/index.mdx @@ -8,4 +8,4 @@ navigation: - 14_edb_clone_schema --- -EDB Postgres Advanced Server (EPAS) includes features to help you to maintain, secure, and operate EPAS databases. \ No newline at end of file +EDB Postgres Advanced Server includes features to help you to maintain, secure, and operate EDB Postgres Advanced Server databases. \ No newline at end of file From 2633ea54f789a44e10313b12284e40380a0c3297 Mon Sep 17 00:00:00 2001 From: francoughlin Date: Thu, 27 Jul 2023 15:26:03 -0400 Subject: [PATCH 15/28] Edits for topics in the Installing and Upgrading branches Edits for topics in the Installing and Upgrading branches; some additional restructuring for the Linux install details section --- .../component_locations.mdx | 6 +- ...installing_epas_using_local_repository.mdx | 4 +- ...naging_an_advanced_server_installation.mdx | 471 ------------------ .../configuring_a_package_installation.mdx | 62 +++ .../connecting_to_epas.mdx | 26 + .../index.mdx | 12 + .../modifying_the_data_directory_location.mdx | 128 +++++ .../specifying_cluster_options.mdx | 95 ++++ .../starting_and_stopping_services.mdx | 115 +++++ .../starting_multiple_postmasters.mdx | 41 ++ .../linux_install_details/rpm_packages.mdx | 86 ++-- .../installing/linux_ppc64le/epas_rhel_7.mdx | 2 +- .../installing/linux_ppc64le/epas_rhel_8.mdx | 2 +- .../installing/linux_ppc64le/epas_rhel_9.mdx | 2 +- .../installing/linux_ppc64le/epas_sles_12.mdx | 2 +- .../installing/linux_ppc64le/epas_sles_15.mdx | 2 +- .../installing/linux_x86_64/epas_centos_7.mdx | 2 +- .../linux_x86_64/epas_other_linux_8.mdx | 2 +- .../linux_x86_64/epas_other_linux_9.mdx | 2 +- .../installing/linux_x86_64/epas_rhel_7.mdx | 2 +- .../installing/linux_x86_64/epas_rhel_8.mdx | 2 +- .../installing/linux_x86_64/epas_rhel_9.mdx | 2 +- .../installing/linux_x86_64/epas_sles_12.mdx | 2 +- .../installing/linux_x86_64/epas_sles_15.mdx | 2 +- .../uninstalling/linux_uninstall.mdx | 10 +- .../uninstalling/windows_uninstall.mdx | 6 +- .../docs/epas/15/installing/windows/index.mdx | 1 + .../index.mdx | 35 +- ...n_installation_with_limited_privileges.mdx | 10 +- .../performing_an_unattended_installation.mdx | 8 +- .../reference_command_line_options.mdx | 38 +- ...ng_a_graphical_installation_on_windows.mdx | 64 +-- .../setting_cluster_preferences.mdx | 27 + .../using_stackbuilder_plus.mdx | 8 +- .../configuring_epas.mdx | 24 +- ...ing_server_startup_behavior_on_windows.mdx | 4 +- .../index.mdx | 18 +- .../starting_and_stopping_epas.mdx | 17 + ...sing_pg_ctl_to_control_advanced_server.mdx | 4 +- .../using_the_windows_services_applet.mdx | 14 +- .../docs/epas/15/upgrading/03_limitations.mdx | 18 +- .../01_performing_an_upgrade/index.mdx | 10 +- .../01_command_line_options_reference.mdx | 8 +- .../03_upgrading_to_advanced_server.mdx | 34 +- .../04_upgrading_a_pgAgent_installation.mdx | 2 +- .../05_pg_upgrade_troubleshooting.mdx | 4 +- .../how_pg_upgrade_works.mdx | 8 +- ...plus_to_perform_a_minor_version_update.mdx | 10 +- product_docs/docs/epas/15/upgrading/index.mdx | 4 +- 49 files changed, 734 insertions(+), 724 deletions(-) delete mode 100644 product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation.mdx create mode 100644 product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/configuring_a_package_installation.mdx create mode 100644 product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx create mode 100644 product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/index.mdx create mode 100644 product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx create mode 100644 product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options.mdx create mode 100644 product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_and_stopping_services.mdx create mode 100644 product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_multiple_postmasters.mdx create mode 100644 product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/setting_cluster_preferences.mdx create mode 100644 product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/starting_and_stopping_epas.mdx diff --git a/product_docs/docs/epas/15/installing/linux_install_details/component_locations.mdx b/product_docs/docs/epas/15/installing/linux_install_details/component_locations.mdx index 2619fc2125c..46dc82f3e82 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/component_locations.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/component_locations.mdx @@ -5,14 +5,14 @@ redirects: - /epas/latest/epas_inst_linux/install_details/component_locations/ --- -The package managers for the various Linux variations install EDB Postgres Advanced Server components in different locations. If you need to access the components after installation, see: +The package managers for the various Linux variations install EDB Postgres Advanced Server (EPAS) components in different locations. If you need to access the components after installation, see: - [RHEL/OL/Rocky Linux/AlmaLinux/CentOS/SLES locations](#rhelolrocky-linuxalmalinuxcentossles-locations) - [Debian/Ubuntu locations](#debianubuntu-locations) ## RHEL/OL/Rocky Linux/AlmaLinux/CentOS/SLES Locations -The RPM installers place EDB Postgres Advanced Server components in the directories listed in the table. +The RPM installers place EPAS components in the directories listed in the table. | Component | Location | | --------------------------------- | ------------------------------------------ | @@ -37,7 +37,7 @@ The RPM installers place EDB Postgres Advanced Server components in the director ## Debian/Ubuntu Locations -The Debian package manager places EDB Postgres Advanced Server and supporting components in the directories listed in the table. +The Debian package manager places EPAS and supporting components in the directories listed in the table. | Component | Location | | -------------------------------- | --------------------------------------------------------------------------------------- | diff --git a/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx b/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx index 7d60d41b87d..63d35e018c6 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx @@ -7,7 +7,7 @@ redirects: - /epas/latest/epas_inst_linux/installing_epas_using_local_repository/ --- -You can create a local repository to act as a host for the EDB Postgres Advanced Server native packages if the server on which you want to install EDB Postgres Advanced Server or supporting components can't directly access the EDB repository. This is a high-level listing of the steps required. Modify the process for your network. +You can create a local repository to act as a host for the EDB Postgres Advanced Server (EPAS) native packages if the server on which you want to install EPAS or supporting components can't directly access the EDB repository. This is a high-level listing of the steps required. Modify the process for your network. To create and use a local repository, you must: @@ -56,7 +56,7 @@ To create and use a local repository, you must: gpgcheck=0 ``` -After specifying the location and connection information for your local repository, you can use `yum` or `dnf` commands to install EDB Postgres Advanced Server and its supporting components on the isolated servers. For example: +After specifying the location and connection information for your local repository, you can use `yum` or `dnf` commands to install EPAS and its supporting components on the isolated servers. For example: - On RHEL or CentOS 7: diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation.mdx deleted file mode 100644 index 6155a7a524e..00000000000 --- a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation.mdx +++ /dev/null @@ -1,471 +0,0 @@ ---- -title: "Managing an EDB Postgres Advanced Server installation" -navTitle: "Managing an installation" -description: "Provides information about managing start/stop/restart of services, managing authentication, and initializing new clusters" -redirects: -- /epas/latest/epas_inst_linux/03_using_a_package_manager_to_install_advanced_server/#configuring-a-package-installation -- /epas/latest/epas_inst_linux/07_managing_an_advanced_server_installation/ -- /epas/latest/epas_inst_linux/03_using_a_package_manager_to_install_advanced_server/#starting-multiple-postmasters-with-different-clusters -- /epas/latest/epas_inst_linux/managing_an_advanced_server_installation/ ---- - -Unless otherwise noted, the commands and paths in these instructions assume that you performed an installation using the native packages. - -## Starting and stopping services - -A service is a program that runs in the background and doesn't require user interaction. A service provides no user interface. You can configure a service to start at boot time or manually on demand. Services are best controlled using the platform-specific operating system service control utility. Many of the EDB Postgres Advanced Server supporting components are services. - -The following table lists the names of the services that control EDB Postgres Advanced Server and services that control EDB Postgres Advanced Server supporting components. - -| EDB Postgres Advanced Server component name | Linux service Name | Debian service name | -| ------------------------------ | ------------------------ | --------------------------------------- | -| EDB Postgres Advanced Server | edb-as-15 | edb-as@15-main | -| pgAgent | edb-pgagent-15 | edb-as15-pgagent | -| PgBouncer | edb-pgbouncer-1.15 | edb-pgbouncer115 | -| pgPool-II | edb-pgpool-4.1 | edb-pgpool41 | -| Slony | edb-slony-replication-15 | edb-as15-slony-replication | -| EFM | edb-efm-4.0 | edb-efm-4.0 | - -You can use the Linux command line to control EDB Postgres Advanced Server's database server and the services of EDB Postgres Advanced Server's supporting components. The commands that control the EDB Postgres Advanced Server service on a Linux platform are host specific. - -### Controlling a service on RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x - -If your installation of EDB Postgres Advanced Server resides on version 7.x | 8.x of RHEL and CentOS, you must use the `systemctl` command to control the EDB Postgres Advanced Server service and supporting components. - -The `systemctl` command must be in your search path and you must invoke it with superuser privileges. To use the command, open a command line, and enter: - -```text -systemctl -``` - -Where: - -`service_name` specifies the name of the service. - -`action` specifies the action taken by the service command. Specify: - -- `start` to start the service. -- `stop` to stop the service. -- `restart` to stop and then start the service. -- `status` to discover the current status of the service. - -### Controlling a service on Debian 10.x or Ubuntu 18.04 | 20.04 - -If your installation of EDB Postgres Advanced Server resides on version 18.04 | 20.04 of Ubuntu, assume superuser privileges and invoke the following commands (using bundled scripts) to manage the service. Use the following commands to: - -- Discover the current status of a service: - - ```text - /usr/edb/as15/bin/epas_ctlcluster 15 main status - ``` - -- Stop a service: - - ```text - /usr/edb/as15/bin/epas_ctlcluster 15 main stop - ``` - -- Restart a service: - - ```text - /usr/edb/as15/bin/epas_ctlcluster 15 main restart - ``` - -- Reload a service: - - ```text - /usr/edb/as15/bin/epas_ctlcluster 15 main reload - ``` - -- Control the component services: - - ```text - systemctl restart edb-as@15-main - ``` - -### Using pg_ctl to control EDB Postgres Advanced Server - -You can use the `pg_ctl` utility to control an EDB Postgres Advanced Server service from the command line on any platform. `pg_ctl` allows you to: - -- Start, stop, or restart the EDB Postgres Advanced Server database server -- Reload the configuration parameters -- Display the status of a running server - -To invoke the utility, assume the identity of the cluster owner. In the home directory of EDB Postgres Advanced Server, issue the command: - -```text -./bin/pg_ctl -D -``` - -`data_directory` is the location of the data controlled by the EDB Postgres Advanced Server cluster. - -`action` specifies the action taken by the `pg_ctl` utility. Specify: - -- `start` to start the service. -- `stop` to stop the service. -- `restart` to stop and then start the service. -- `reload` to send the server a `SIGHUP` signal, reloading configuration parameters -- `status` to discover the current status of the service. - -For more information about using the `pg_ctl` utility or the command line options available, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/app-pg-ctl.html). - -#### Choosing between pg_ctl and the service command - -You can use the `pg_ctl` utility to manage the status of an EDB Postgres Advanced Server cluster. However, it's important to note that `pg_ctl` doesn't alert the operating system service controller to changes in the status of a server. We recommend using the `service` command when possible. - -### Configuring component services to autostart at system reboot - -After installing, configuring, and starting the services of EDB Postgres Advanced Server supporting components on a Linux system, you must manually configure your system to autostart the service when your system restarts. To configure a service to autostart on a Linux system, open a command line, assume superuser privileges, and enter the command. - -On a Redhat-compatible Linux system, enter: - -```text -/sbin/chkconfig on -``` - -Where `service_name` specifies the name of the service. - -## Connecting to EDB Postgres Advanced Server with edb-psql - -`edb-psql` is a command line client application that allows you to execute SQL commands and view the results. To open the `edb-psql` client, the client must be in your search path. The executable resides in the `bin` directory under your EDB Postgres Advanced Server installation. - -Use the following command and options to start the `edb-psql` client: - -```text -psql -d edb -U enterprisedb -``` - -Where: - -`-d` specifies the database to which `edb-psql` connects. - -`-U` specifies the identity of the database user to use for the session. - -`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. For more information about using the command line client, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/app-psql.html). - -### Managing authentication on a Debian or Ubuntu host - -By default, the server is running with the peer or md5 permission on a Debian or Ubuntu host. You can change the authentication method by modifying the `pg_hba.conf` file, located under `/etc/edb-as/15/main/`. - -For more information about modifying the `pg_hba.conf` file, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html). - -## Configuring a package installation - -The packages that install the database server component create a unit file on version 7.x or 8.x hosts and service startup scripts. - -### Creating a database cluster and starting the service - -The PostgreSQL `initdb` command creates a database cluster. When installing EDB Postgres Advanced Server with an RPM package, the `initdb` executable is in `/usr/edb/asx.x/bin`. After installing EDB Postgres Advanced Server, you must manually configure the service and invoke `initdb` to create your cluster. When invoking `initdb`, you can: - -- Specify environment options on the command line. -- Include the `systemd` service manager on RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x and use a service configuration file to configure the environment. - -For more information, see the [`initdb` documentation](https://www.postgresql.org/docs/current/static/app-initdb.html). - -After specifying any options in the service configuration file, you can create the database cluster and start the service. The steps are platform specific. - -#### On RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x - -To invoke `initdb` on a RHEL/CentOS 7.x or Rocky Linux/AlmaLinux 8.x system with the options specified in the service configuration file, assume the identity of the operating system superuser: - -```text -su - root -``` - -To initialize a cluster with the non-default values, you can use the `PGSETUP_INITDB_OPTIONS` environment variable. You can initialize the cluster using the `edb-as-15-setup` script under `EPAS_Home/bin`. - -To invoke `initdb`, export the `PGSETUP_INITDB_OPTIONS` environment variable: - -```text -PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb -``` - -After creating the cluster, use `systemctl` to start, stop, or restart the service: - -```text -systemctl { start | stop | restart } edb-as-15 -``` - -#### On Debian 10.x or Ubuntu 18.04 | 20.04 - -You can initialize multiple clusters using the bundled scripts. To create a new cluster, assume `root` privileges, and invoke the bundled script: - -```text -/usr/bin/epas_createcluster 15 main2 -``` - -To start a new cluster: - -```text -/usr/bin/epas_ctlcluster 15 main2 start   -``` - -To list all the available clusters: - -```text -/usr/bin/epas_lsclusters -``` - -!!! Note - The data directory is created under `/var/lib/edb-as/15/main2`, and the configuration directory is created under `/etc/edb-as/15/main/`. - - -## Specifying cluster options with INITDBOPTS - -You can use the `INITDBOPTS` variable to specify your cluster configuration preferences. By default, the `INITDBOPTS` variable is commented out in the service configuration file. Unless you modify it, when you run the service startup script, the new cluster is created in a mode compatible with Oracle databases. Clusters created in this mode contain a database named `edb` and have a database superuser named `enterprisedb`. - -### Initializing the cluster in Oracle mode - -If you initialize the database using Oracle compatibility mode, the installation includes: - -- Data dictionary views compatible with Oracle databases. -- Oracle data type conversions. -- Date values displayed in a format compatible with Oracle syntax. -- Support for Oracle-styled concatenation rules. If you concatenate a string value with a `NULL` value, the returned value is the value of the string. -- Support for the following Oracle built-in packages. - -| Package | Functionality compatible with Oracle databases | -| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dbms_alert` | Provides the capability to register for, send, and receive alerts. | -| `dbms_job` | Provides the capability to create, schedule, and manage jobs. | -| `dbms_lob` | Provides the capability to manage on large objects. | -| `dbms_output` | Provides the capability to send messages to a message buffer or get messages from the message buffer. | -| `dbms_pipe` | Provides the capability to send messages through a pipe within or between sessions connected to the same database cluster. | -| `dbms_rls` | Enables the implementation of Virtual Private Database on certain EDB Postgres Advanced Server database objects. | -| `dbms_sql` | Provides an application interface to the EDB dynamic SQL functionality. | -| `dbms_utility` | Provides various utility programs. | -| `dbms_aqadm` | Provides supporting procedures for Advanced Queueing functionality. | -| `dbms_aq` | Provides message queueing and processing for EDB Postgres Advanced Server. | -| `dbms_profiler` | Collects and stores performance information about the PL/pgSQL and SPL statements that are executed during a performance profiling session. | -| `dbms_random` | Provides a number of methods to generate random values. | -| `dbms_redact` | Enables redacting or masking data that's returned by a query. | -| `dbms_lock` | Provides support for the `DBMS_LOCK.SLEEP` procedure. | -| `dbms_scheduler` | Provides a way to create and manage jobs, programs, and job schedules. | -| `dbms_crypto` | Provides functions and procedures to encrypt or decrypt RAW, BLOB or CLOB data. You can also use `DBMS_CRYPTO` functions to generate cryptographically strong random values. | -| `dbms_mview` | Provides a way to manage and refresh materialized views and their dependencies. | -| `dbms_session` | Provides support for the `DBMS_SESSION.SET_ROLE` procedure. | -| `utl_encode` | Provides a way to encode and decode data. | -| `utl_http` | Provides a way to use the HTTP or HTTPS protocol to retrieve information found at an URL. | -| `utl_file` | Provides the capability to read from and write to files on the operating system’s file system. | -| `utl_smtp` | Provides the capability to send e-mails over the Simple Mail Transfer Protocol (SMTP). | -| `utl_mail` | Provides the capability to manage email. | -| `utl_url` | Provides a way to escape illegal and reserved characters in a URL. | -| `utl_raw` | Provides a way to manipulate or retrieve the length of raw data types. | - - -### Initializing the cluster in Postgres mode - -Clusters created in PostgreSQL mode don't include compatibility features. To create a new cluster in PostgreSQL mode, remove the pound sign (#) in front of the `INITDBOPTS` variable, enabling the `"--no-redwood-compat"` option. Clusters created in PostgreSQL mode contain a database named `postgres` and have a database superuser named `postgres`. - -You can also specify multiple `initdb` options. For example, the following statement creates a database cluster without compatibility features for Oracle. The cluster contains a database named `postgres` that's owned by a user named `alice`. The cluster uses `UTF-8` encoding. - -```text -INITDBOPTS="--no-redwood-compat -U alice --locale=en_US.UTF-8" -``` - -If you initialize the database using `"--no-redwood-compat"` mode, the installation includes the following package: - -| Package | Functionality noncompatible with Oracle databases | -| ------------------ | ---------------------------------------------------------------------------------------------------------------- | -| `dbms_aqadm` | Provides supporting procedures for Advanced Queueing functionality. | -| `dbms_aq` | Provides message queueing and processing for EDB Postgres Advanced Server. | -| `edb_bulkload` | Provides direct/conventional data loading capability when loading huge amount of data into a database. | -| `edb_gen` | Provides miscellaneous packages to run built-in packages. | -| `edb_objects` | Provides Oracle-compatible objects such as packages and procedures. | -| `waitstates` | Provides monitor session blocking. | -| `edb_dblink_libpq` | Provides link to foreign databases via libpq. | -| `edb_dblink_oci` | Provides link to foreign databases via OCI. | -| `snap_tables` | Creates tables to hold wait information. Included with DRITA scripts. | -| `snap_functions` | Creates functions to return a list of snap ids and the time the snapshot was taken. Included with DRITA scripts. | -| `sys_stats` | Provides OS performance statistics. | - -In addition to the cluster configuration options documented in the PostgreSQL core documentation, EDB Postgres Advanced Server supports the following `initdb` options: - -`--no-redwood-compat` - -Include the `--no-redwood-compat` keywords to create the cluster in PostgreSQL mode. When the cluster is created in PostgreSQL mode, the name of the database superuser is `postgres`, and the name of the default database is `postgres`. The few EDB Postgres Advanced Server features compatible with Oracle databases are available with this mode. However, we recommend using the EDB Postgres Advanced Server in redwood compatibility mode to use all its features. - -`--redwood-like` - -Include the `--redwood-like` keywords to use an escape character, that is, an empty string (''), following the `LIKE` (or PostgreSQL-compatible `ILIKE`) operator in a SQL statement that's compatible with Oracle syntax. - -`--icu-short-form` - -Include the `--icu-short-form` keywords to create a cluster that uses a default International Components for Unicode (ICU) collation for all databases in the cluster. For more information about Unicode collations, see [Unicode collation algorithm](/epas/latest/tools_utilities_and_components/application_developer_tools/06_unicode_collation_algorithm/). - -For more information about using `initdb` and the available cluster configuration options, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/app-initdb.html). - -You can also view online help for `initdb` by assuming superuser privileges and entering: - -```text -/path_to_initdb_installation_directory/initdb --help -``` - -Where `path_to_initdb_installation_directory` specifies the location of the `initdb` binary file. - -## Modifying the data directory location - -### On RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x - -On a RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x host, the unit file is named `edb-as-15.service` and resides in `/usr/lib/systemd/system`. The unit file contains references to the location of the EDB Postgres Advanced Server `data` directory. Avoid making any modifications directly to the unit file because they might be overwritten during package upgrades. - -By default, data files reside under `/var/lib/edb/as15/data` directory. To use a data directory that resides in a non-default location: - -- Create a copy of the unit file under the `/etc` directory: - - ```text - cp /usr/lib/systemd/system/edb-as-15.service /etc/systemd/system/ - ``` - -- After copying the unit file to the new location, create the service file `/etc/systemd/system/edb-as-15.service`. - -- Update the following values with new location of data directory in the `/lib/systemd/system/edb-as-15.service` file: - - ```text - Environment=PGDATA=/var/lib/edb/as15/data - PIDFile=/var/lib/edb/as15/data/postmaster.pid - ``` - -- Delete the content of the `/etc/systemd/system/edb-as-15.service` file except the following line: - - ```text - .include /lib/systemd/system/edb-as-15.service - ``` - -- Run the following command to initialize the cluster at the new location: - - ```text - PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb - ``` - -- Use the following command to reload `systemd`, updating the modified service scripts: - - ```text - systemctl daemon-reload - ``` - -- Start the EDB Postgres Advanced Server service with the following command: - - ```text - systemctl start edb-as-15 - ``` - -### Configuring SELinux policy to change the data directory location on RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x - -By default, the data files reside under the `/var/lib/edb/as15/data` directory. To change the default data directory location depending on individual environment preferences, you must configure the SELinux policy: - -- Stop the server: - - ```text - systemctl stop edb-as-15 - ``` - -- Check the status of SELinux using the `getenforce` or `sestatus` command: - - ```text - # getenforce - Enforcing - - # sestatus - SELinux status: enabled - SELinuxfs mount: /sys/fs/selinux - SELinux root directory: /etc/selinux - Loaded policy name: targeted - Current mode: enforcing - Mode from config file: enforcing - Policy MLS status: enabled - Policy deny_unknown status: allowed - Max kernel policy version: 31 - ``` - -- View the SELinux context of the default database location: - - ```text - ls -lZ /var/lib/edb/as15/data - drwx------. enterprisedb enterprisedb unconfined_u:object_r:var_lib_t:s0 log - ``` - -- Create a new directory for a new location of the database: - - ```text - mkdir /opt/edb - ``` - -- Move the data directory to `/opt/edb`: - - ```text - mv /var/lib/edb/as15/data /opt/edb/ - ``` - -- Create a file `edb-as-15.service` under `/etc/systemd/system` to include the location of a new data directory: - - ```text - .include /lib/systemd/system/edb-as-15.service - [Service] - Environment=PGDATA=/opt/edb/data - PIDFile=/opt/edb/data/postmaster.pid - ``` - -- Use the `semanage` utility to set the context mapping for `/opt/edb/`. The mapping is written to `/etc/selinux/targeted/contexts/files/file.contexts.local` file. - - ```text - semanage fcontext --add --equal /var/lib/edb/as15/data /opt/edb - ``` - -- Apply the context mapping using the `restorecon` utility: - - ```text - restorecon -rv /opt/edb/ - ``` - -- Reload `systemd` to modify the service script : - - ```text - systemctl daemon-reload - ``` - -- With the `/opt/edb` location labeled correctly with the context, start the service: - - ```text - systemctl start edb-as-15 - ``` - -## Starting multiple postmasters with different clusters - -You can configure EDB Postgres Advanced Server to use multiple postmasters, each with its own database cluster. The steps required are version specific to the Linux host. - -### On RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x - -The `edb-as15-server-core` RPM for version 7.x | 8.x contains a unit file that starts the EDB Postgres Advanced Server instance. The file allows you to start multiple services, with unique `data` directories and monitor different ports. You need to have `root` access to invoke or modify the script. - -This example creates an EDB Postgres Advanced Server installation with two instances. The secondary instance is named `secondary`. - -- Make a copy of the default file with the new name. As noted at the top of the file, all modifications must reside under `/etc`. You must pick a name that isn't already used in `/etc/systemd/system`. - - ```text - cp /usr/lib/systemd/system/edb-as-15.service /etc/systemd/system/secondary-edb-as-15.service - ``` - -- Edit the file, changing `PGDATA` to point to the new `data` directory that you'll create the cluster against. - -- Create the target `PGDATA` with user `enterprisedb`. - -- Run `initdb`, specifying the setup script: - - ```text - /usr/edb/as15/bin/edb-as-15-setup initdb secondary-edb-as-15 - ``` - -- Edit the `postgresql.conf` file for the new instance, specifying the port, the IP address, TCP/IP settings, and so on. - -- Make sure that the new cluster runs after a reboot: - - ```text - systemctl enable secondary-edb-as-15 - ``` - -- Start the second cluster: - - ```text - systemctl start secondary-edb-as-15 - ``` diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/configuring_a_package_installation.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/configuring_a_package_installation.mdx new file mode 100644 index 00000000000..50c064b4b02 --- /dev/null +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/configuring_a_package_installation.mdx @@ -0,0 +1,62 @@ +--- +title: "Configuring a package installation" +--- + +The packages that install the database server component create a unit file on version 7.x or 8.x hosts and service startup scripts. + +## Creating a database cluster and starting the service + +The PostgreSQL `initdb` command creates a database cluster. When installing EDB Postgres Advanced Server (EPAS) with an RPM package, the `initdb` executable is in `/usr/edb/asx.x/bin`. After installing EPAS, you must manually configure the service and invoke `initdb` to create your cluster. When invoking `initdb`, you can: + +- Specify environment options on the command line. +- Include the `systemd` service manager on RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x and use a service configuration file to configure the environment. + +For more information, see the [`initdb` documentation](https://www.postgresql.org/docs/current/static/app-initdb.html). + +After specifying any options in the service configuration file, you can create the database cluster and start the service. The steps are platform specific. + +### On RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x + +To invoke `initdb` on a RHEL/CentOS 7.x or Rocky Linux/AlmaLinux 8.x system with the options specified in the service configuration file, assume the identity of the operating system superuser: + +```text +su - root +``` + +To initialize a cluster with the non-default values, you can use the `PGSETUP_INITDB_OPTIONS` environment variable. You can initialize the cluster using the `edb-as-15-setup` script under `EPAS_Home/bin`. + +To invoke `initdb`, export the `PGSETUP_INITDB_OPTIONS` environment variable: + +```text +PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb +``` + +After creating the cluster, use `systemctl` to start, stop, or restart the service: + +```text +systemctl { start | stop | restart } edb-as-15 +``` + +### On Debian 10.x or Ubuntu 18.04 | 20.04 + +You can initialize multiple clusters using the bundled scripts. To create a new cluster, assume `root` privileges, and invoke the bundled script: + +```text +/usr/bin/epas_createcluster 15 main2 +``` + +To start a new cluster: + +```text +/usr/bin/epas_ctlcluster 15 main2 start   +``` + +To list all the available clusters: + +```text +/usr/bin/epas_lsclusters +``` + +!!! Note + The data directory is created under `/var/lib/edb-as/15/main2`, and the configuration directory is created under `/etc/edb-as/15/main/`. + diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx new file mode 100644 index 00000000000..2a3cb9eb61a --- /dev/null +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx @@ -0,0 +1,26 @@ +--- +title: "Connecting to EDB Postgres Advanced Server with edb-psql" +navTitle: "Connecting to EPAS" +--- + +`edb-psql` is a command line client application that allows you to execute SQL commands and view the results. To open the `edb-psql` client, the client must be in your search path. The executable resides in the `bin` directory under your EDB Postgres Advanced Server (EPAS) installation. + +Use the following command and options to start the `edb-psql` client: + +```text +psql -d edb -U enterprisedb +``` + +Where: + +`-d` specifies the database to which `edb-psql` connects. + +`-U` specifies the identity of the database user to use for the session. + +`edb-psql` is a symbolic link to a binary called `psql`, a modified version of the PostgreSQL community `psql`, with added support for EPAS features. For more information about using the command line client, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/app-psql.html). + +## Managing authentication on a Debian or Ubuntu host + +By default, the server is running with the peer or md5 permission on a Debian or Ubuntu host. You can change the authentication method by modifying the `pg_hba.conf` file, located under `/etc/edb-as/15/main/`. + +For more information about modifying the `pg_hba.conf` file, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html). diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/index.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/index.mdx new file mode 100644 index 00000000000..df815b67bd4 --- /dev/null +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/index.mdx @@ -0,0 +1,12 @@ +--- +title: "Managing an EDB Postgres Advanced Server installation" +navTitle: "Managing an installation" +description: "Provides information about managing start/stop/restart of services, managing authentication, and initializing new clusters" +redirects: +- /epas/latest/epas_inst_linux/03_using_a_package_manager_to_install_advanced_server/#configuring-a-package-installation +- /epas/latest/epas_inst_linux/07_managing_an_advanced_server_installation/ +- /epas/latest/epas_inst_linux/03_using_a_package_manager_to_install_advanced_server/#starting-multiple-postmasters-with-different-clusters +- /epas/latest/epas_inst_linux/managing_an_advanced_server_installation/ +--- + + The commands and paths shown in the following topics assume that you performed an installation using the native packages, unless otherwise noted. diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx new file mode 100644 index 00000000000..d0565793994 --- /dev/null +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx @@ -0,0 +1,128 @@ +--- +title: "Modifying the data directory location" +--- + +## On RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x + +On a RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x host, the unit file is named `edb-as-15.service` and resides in `/usr/lib/systemd/system`. The unit file contains references to the location of the EDB Postgres Advanced Server (EPAS) `data` directory. Avoid making any modifications directly to the unit file because they might be overwritten during package upgrades. + +By default, data files reside under `/var/lib/edb/as15/data` directory. To use a data directory that resides in a non-default location: + +- Create a copy of the unit file under the `/etc` directory: + + ```text + cp /usr/lib/systemd/system/edb-as-15.service /etc/systemd/system/ + ``` + +- After copying the unit file to the new location, create the service file `/etc/systemd/system/edb-as-15.service`. + +- Update the following values with new location of data directory in the `/lib/systemd/system/edb-as-15.service` file: + + ```text + Environment=PGDATA=/var/lib/edb/as15/data + PIDFile=/var/lib/edb/as15/data/postmaster.pid + ``` + +- Delete the content of the `/etc/systemd/system/edb-as-15.service` file except the following line: + + ```text + .include /lib/systemd/system/edb-as-15.service + ``` + +- Run the following command to initialize the cluster at the new location: + + ```text + PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb + ``` + +- Use the following command to reload `systemd`, updating the modified service scripts: + + ```text + systemctl daemon-reload + ``` + +- Start the EPAS service with the following command: + + ```text + systemctl start edb-as-15 + ``` + +## Configuring SELinux policy to change the data directory location on RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x + +By default, the data files reside under the `/var/lib/edb/as15/data` directory. To change the default data directory location depending on individual environment preferences, you must configure the SELinux policy: + +- Stop the server: + + ```text + systemctl stop edb-as-15 + ``` + +- Check the status of SELinux using the `getenforce` or `sestatus` command: + + ```text + # getenforce + Enforcing + + # sestatus + SELinux status: enabled + SELinuxfs mount: /sys/fs/selinux + SELinux root directory: /etc/selinux + Loaded policy name: targeted + Current mode: enforcing + Mode from config file: enforcing + Policy MLS status: enabled + Policy deny_unknown status: allowed + Max kernel policy version: 31 + ``` + +- View the SELinux context of the default database location: + + ```text + ls -lZ /var/lib/edb/as15/data + drwx------. enterprisedb enterprisedb unconfined_u:object_r:var_lib_t:s0 log + ``` + +- Create a new directory for a new location of the database: + + ```text + mkdir /opt/edb + ``` + +- Move the data directory to `/opt/edb`: + + ```text + mv /var/lib/edb/as15/data /opt/edb/ + ``` + +- Create a file `edb-as-15.service` under `/etc/systemd/system` to include the location of a new data directory: + + ```text + .include /lib/systemd/system/edb-as-15.service + [Service] + Environment=PGDATA=/opt/edb/data + PIDFile=/opt/edb/data/postmaster.pid + ``` + +- Use the `semanage` utility to set the context mapping for `/opt/edb/`. The mapping is written to `/etc/selinux/targeted/contexts/files/file.contexts.local` file. + + ```text + semanage fcontext --add --equal /var/lib/edb/as15/data /opt/edb + ``` + +- Apply the context mapping using the `restorecon` utility: + + ```text + restorecon -rv /opt/edb/ + ``` + +- Reload `systemd` to modify the service script : + + ```text + systemctl daemon-reload + ``` + +- With the `/opt/edb` location labeled correctly with the context, start the service: + + ```text + systemctl start edb-as-15 + ``` diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options.mdx new file mode 100644 index 00000000000..b7493d2dbbb --- /dev/null +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options.mdx @@ -0,0 +1,95 @@ +--- +title: "Specifying cluster options with INITDBOPTS" +navTitle: "Specifying cluster options" +--- + +You can use the `INITDBOPTS` variable to specify your cluster configuration preferences. By default, the `INITDBOPTS` variable is commented out in the service configuration file. Unless you modify it, when you run the service startup script, the new cluster is created in a mode compatible with Oracle databases. Clusters created in this mode contain a database named `edb` and have a database superuser named `enterprisedb`. + +## Initializing the cluster in Oracle mode + +If you initialize the database using Oracle compatibility mode, the installation includes: + +- Data dictionary views compatible with Oracle databases. +- Oracle data type conversions. +- Date values displayed in a format compatible with Oracle syntax. +- Support for Oracle-styled concatenation rules. If you concatenate a string value with a `NULL` value, the returned value is the value of the string. +- Support for the following Oracle built-in packages. + +| Package | Functionality compatible with Oracle databases | +| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `dbms_alert` | Provides the capability to register for, send, and receive alerts. | +| `dbms_job` | Provides the capability to create, schedule, and manage jobs. | +| `dbms_lob` | Provides the capability to manage on large objects. | +| `dbms_output` | Provides the capability to send messages to a message buffer or get messages from the message buffer. | +| `dbms_pipe` | Provides the capability to send messages through a pipe within or between sessions connected to the same database cluster. | +| `dbms_rls` | Enables the implementation of Virtual Private Database on certain EDB Postgres Advanced Server database objects. | +| `dbms_sql` | Provides an application interface to the EDB dynamic SQL functionality. | +| `dbms_utility` | Provides various utility programs. | +| `dbms_aqadm` | Provides supporting procedures for Advanced Queueing functionality. | +| `dbms_aq` | Provides message queueing and processing for EDB Postgres Advanced Server. | +| `dbms_profiler` | Collects and stores performance information about the PL/pgSQL and SPL statements that are executed during a performance profiling session. | +| `dbms_random` | Provides a number of methods to generate random values. | +| `dbms_redact` | Enables redacting or masking data that's returned by a query. | +| `dbms_lock` | Provides support for the `DBMS_LOCK.SLEEP` procedure. | +| `dbms_scheduler` | Provides a way to create and manage jobs, programs, and job schedules. | +| `dbms_crypto` | Provides functions and procedures to encrypt or decrypt RAW, BLOB or CLOB data. You can also use `DBMS_CRYPTO` functions to generate cryptographically strong random values. | +| `dbms_mview` | Provides a way to manage and refresh materialized views and their dependencies. | +| `dbms_session` | Provides support for the `DBMS_SESSION.SET_ROLE` procedure. | +| `utl_encode` | Provides a way to encode and decode data. | +| `utl_http` | Provides a way to use the HTTP or HTTPS protocol to retrieve information found at an URL. | +| `utl_file` | Provides the capability to read from and write to files on the operating system’s file system. | +| `utl_smtp` | Provides the capability to send e-mails over the Simple Mail Transfer Protocol (SMTP). | +| `utl_mail` | Provides the capability to manage email. | +| `utl_url` | Provides a way to escape illegal and reserved characters in a URL. | +| `utl_raw` | Provides a way to manipulate or retrieve the length of raw data types. | + + +## Initializing the cluster in Postgres mode + +Clusters created in PostgreSQL mode don't include compatibility features. To create a new cluster in PostgreSQL mode, remove the pound sign (#) in front of the `INITDBOPTS` variable, enabling the `"--no-redwood-compat"` option. Clusters created in PostgreSQL mode contain a database named `postgres` and have a database superuser named `postgres`. + +You can also specify multiple `initdb` options. For example, the following statement creates a database cluster without compatibility features for Oracle. The cluster contains a database named `postgres` that's owned by a user named `alice`. The cluster uses `UTF-8` encoding. + +```text +INITDBOPTS="--no-redwood-compat -U alice --locale=en_US.UTF-8" +``` + +If you initialize the database using `"--no-redwood-compat"` mode, the installation includes the following package: + +| Package | Functionality noncompatible with Oracle databases | +| ------------------ | ---------------------------------------------------------------------------------------------------------------- | +| `dbms_aqadm` | Provides supporting procedures for Advanced Queueing functionality. | +| `dbms_aq` | Provides message queueing and processing for EDB Postgres Advanced Server. | +| `edb_bulkload` | Provides direct/conventional data loading capability when loading huge amount of data into a database. | +| `edb_gen` | Provides miscellaneous packages to run built-in packages. | +| `edb_objects` | Provides Oracle-compatible objects such as packages and procedures. | +| `waitstates` | Provides monitor session blocking. | +| `edb_dblink_libpq` | Provides link to foreign databases via libpq. | +| `edb_dblink_oci` | Provides link to foreign databases via OCI. | +| `snap_tables` | Creates tables to hold wait information. Included with DRITA scripts. | +| `snap_functions` | Creates functions to return a list of snap ids and the time the snapshot was taken. Included with DRITA scripts. | +| `sys_stats` | Provides OS performance statistics. | + +In addition to the cluster configuration options documented in the PostgreSQL core documentation, EDB Postgres Advanced Server supports the following `initdb` options: + +`--no-redwood-compat` + +Include the `--no-redwood-compat` keywords to create the cluster in PostgreSQL mode. When the cluster is created in PostgreSQL mode, the name of the database superuser is `postgres`, and the name of the default database is `postgres`. The few EDB Postgres Advanced Server features compatible with Oracle databases are available with this mode. However, we recommend using the EDB Postgres Advanced Server in redwood compatibility mode to use all its features. + +`--redwood-like` + +Include the `--redwood-like` keywords to use an escape character, that is, an empty string (''), following the `LIKE` (or PostgreSQL-compatible `ILIKE`) operator in a SQL statement that's compatible with Oracle syntax. + +`--icu-short-form` + +Include the `--icu-short-form` keywords to create a cluster that uses a default International Components for Unicode (ICU) collation for all databases in the cluster. For more information about Unicode collations, see [Unicode collation algorithm](/epas/latest/tools_utilities_and_components/application_developer_tools/06_unicode_collation_algorithm/). + +For more information about using `initdb` and the available cluster configuration options, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/app-initdb.html). + +You can also view online help for `initdb` by assuming superuser privileges and entering: + +```text +/path_to_initdb_installation_directory/initdb --help +``` + +Where `path_to_initdb_installation_directory` specifies the location of the `initdb` binary file. diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_and_stopping_services.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_and_stopping_services.mdx new file mode 100644 index 00000000000..527427e93f2 --- /dev/null +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_and_stopping_services.mdx @@ -0,0 +1,115 @@ +--- +title: "Starting and stopping services" +--- + +A service is a program that runs in the background and doesn't require user interaction. A service provides no user interface. You can configure a service to start at boot time or manually on demand. Services are best controlled using the platform-specific operating system service control utility. Many of the EDB Postgres Advanced Server (EPAS) supporting components are services. + +The following table lists the names of the services that control EPAS and services that control EPAS supporting components. + +| EDB Postgres Advanced Server component name | Linux service Name | Debian service name | +| ------------------------------ | ------------------------ | --------------------------------------- | +| EDB Postgres Advanced Server | edb-as-15 | edb-as@15-main | +| pgAgent | edb-pgagent-15 | edb-as15-pgagent | +| PgBouncer | edb-pgbouncer-1.15 | edb-pgbouncer115 | +| pgPool-II | edb-pgpool-4.1 | edb-pgpool41 | +| Slony | edb-slony-replication-15 | edb-as15-slony-replication | +| EFM | edb-efm-4.0 | edb-efm-4.0 | + +You can use the Linux command line to control the EPAS database server and the services of EPAS's supporting components. The commands that control the EPAS service on a Linux platform are host specific. + +## Controlling a service on RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x + +If your installation of EPAS resides on version 7.x | 8.x of RHEL and CentOS, you must use the `systemctl` command to control the EPAS service and supporting components. + +The `systemctl` command must be in your search path and you must invoke it with superuser privileges. To use the command, open a command line, and enter: + +```text +systemctl +``` + +Where: + +`service_name` specifies the name of the service. + +`action` specifies the action taken by the service command. Specify: + +- `start` to start the service. +- `stop` to stop the service. +- `restart` to stop and then start the service. +- `status` to discover the current status of the service. + +## Controlling a service on Debian 10.x or Ubuntu 18.04 | 20.04 + +If your installation of EPAS resides on version 18.04 | 20.04 of Ubuntu, assume superuser privileges and invoke the following commands (using bundled scripts) to manage the service. Use the following commands to: + +- Discover the current status of a service: + + ```text + /usr/edb/as15/bin/epas_ctlcluster 15 main status + ``` + +- Stop a service: + + ```text + /usr/edb/as15/bin/epas_ctlcluster 15 main stop + ``` + +- Restart a service: + + ```text + /usr/edb/as15/bin/epas_ctlcluster 15 main restart + ``` + +- Reload a service: + + ```text + /usr/edb/as15/bin/epas_ctlcluster 15 main reload + ``` + +- Control the component services: + + ```text + systemctl restart edb-as@15-main + ``` + +## Using pg_ctl to control EDB Postgres Advanced Server + +You can use the `pg_ctl` utility to control an EDB Postgres Advanced Server service from the command line on any platform. `pg_ctl` allows you to: + +- Start, stop, or restart the EPAS database server +- Reload the configuration parameters +- Display the status of a running server + +To invoke the utility, assume the identity of the cluster owner. In the home directory of EPAS, issue the command: + +```text +./bin/pg_ctl -D +``` + +`data_directory` is the location of the data controlled by the EPAS cluster. + +`action` specifies the action taken by the `pg_ctl` utility. Specify: + +- `start` to start the service. +- `stop` to stop the service. +- `restart` to stop and then start the service. +- `reload` to send the server a `SIGHUP` signal, reloading configuration parameters +- `status` to discover the current status of the service. + +For more information about using the `pg_ctl` utility or the command line options available, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/app-pg-ctl.html). + +### Choosing between pg_ctl and the service command + +You can use the `pg_ctl` utility to manage the status of an EPAS cluster. However, it's important to note that `pg_ctl` doesn't alert the operating system service controller to changes in the status of a server. We recommend using the `service` command when possible. + +## Configuring component services to autostart at system reboot + +After installing, configuring, and starting the services of EPAS supporting components on a Linux system, you must manually configure your system to autostart the service when your system restarts. To configure a service to autostart on a Linux system, open a command line, assume superuser privileges, and enter the command. + +On a Redhat-compatible Linux system, enter: + +```text +/sbin/chkconfig on +``` + +Where `service_name` specifies the name of the service. diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_multiple_postmasters.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_multiple_postmasters.mdx new file mode 100644 index 00000000000..8b8183fbc41 --- /dev/null +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_multiple_postmasters.mdx @@ -0,0 +1,41 @@ +--- +title: "Starting multiple postmasters with different clusters" +--- + +You can configure EDB Postgres Advanced Server (EPAS) to use multiple postmasters, each with its own database cluster. The steps required are version specific to the Linux host. + +## On RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x + +The `edb-as15-server-core` RPM for version 7.x | 8.x contains a unit file that starts the EPAS instance. The file allows you to start multiple services, with unique `data` directories and monitor different ports. You need to have `root` access to invoke or modify the script. + +This example creates an EPAS installation with two instances. The secondary instance is named `secondary`. + +- Make a copy of the default file with the new name. As noted at the top of the file, all modifications must reside under `/etc`. You must pick a name that isn't already used in `/etc/systemd/system`. + + ```text + cp /usr/lib/systemd/system/edb-as-15.service /etc/systemd/system/secondary-edb-as-15.service + ``` + +- Edit the file, changing `PGDATA` to point to the new `data` directory that you'll create the cluster against. + +- Create the target `PGDATA` with user `enterprisedb`. + +- Run `initdb`, specifying the setup script: + + ```text + /usr/edb/as15/bin/edb-as-15-setup initdb secondary-edb-as-15 + ``` + +- Edit the `postgresql.conf` file for the new instance, specifying the port, the IP address, TCP/IP settings, and so on. + +- Make sure that the new cluster runs after a reboot: + + ```text + systemctl enable secondary-edb-as-15 + ``` + +- Start the second cluster: + + ```text + systemctl start secondary-edb-as-15 + ``` diff --git a/product_docs/docs/epas/15/installing/linux_install_details/rpm_packages.mdx b/product_docs/docs/epas/15/installing/linux_install_details/rpm_packages.mdx index f18bc2df383..e4008ec993f 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/rpm_packages.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/rpm_packages.mdx @@ -34,26 +34,26 @@ Note: The available package list is subject to change. | Package name | Package installs | | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| edb-as15-server | Installs core components of the EDB Postgres Advanced Server database server. | -| edb-as15-server-client | Client programs and utilities that you can use to access and manage EDB Postgres Advanced Server. | -| edb-as15-server-contrib | Installs contributed tools and utilities that are distributed with EDB Postgres Advanced Server. Files for these modules are installed in:

Documentation: `/usr/edb/as15/share/doc`

Loadable modules: `/usr/edb/as15/lib`

Binaries: `/usr/edb/as15/bin` | -| edb-as15-server-core | Includes the programs needed to create the core functionality behind the EDB Postgres Advanced Server database. | -| edb-as15-server-devel | Installs the header files and libraries needed to compile C or C++ applications that directly interact with an EDB Postgres Advanced Server server and the ecpg or ecpgPlus C preprocessor. | +| edb-as15-server | Installs core components of the EDB Postgres Advanced Server (EPAS) database server. | +| edb-as15-server-client | Client programs and utilities that you can use to access and manage EPAS. | +| edb-as15-server-contrib | Installs contributed tools and utilities that are distributed with EPAS. Files for these modules are installed in:

Documentation: `/usr/edb/as15/share/doc`

Loadable modules: `/usr/edb/as15/lib`

Binaries: `/usr/edb/as15/bin` | +| edb-as15-server-core | Includes the programs needed to create the core functionality behind the EPAS database. | +| edb-as15-server-devel | Installs the header files and libraries needed to compile C or C++ applications that directly interact with an EPAS server and the ecpg or ecpgPlus C preprocessor. | | edb-as15-server-docs | Installs the readme file. | -| edb-as15-server-edb-modules | Installs supporting modules for EDB Postgres Advanced Server. | -| edb-as15-server-indexadvisor | Installs EDB Postgres Advanced Server's Index Advisor feature. The Index Advisor utility helps to determine the columns to index to improve performance in a given workload. | -| edb-as15-server-libs | Provides the essential shared libraries for any EDB Postgres Advanced Server client program or interface. | -| edb-as15-server-llvmjit | Contains support for just-in-time (JIT) compiling parts of EDB Postgres Advanced Server's queries. You need to install this package separately. | -| edb-as15-server-pldebugger | Implements an API for debugging PL/pgSQL functions on EDB Postgres Advanced Server. | -| edb-as15-server-plperl | Installs the PL/Perl procedural language for EDB Postgres Advanced Server. The `edb-as15-server-plperl` package depends on the platform-supplied version of Perl. | -| edb-as15-server-plpython3 | Installs the PL/Python procedural language for EDB Postgres Advanced Server. The PL/Python2 support is no longer available in EDB Postgres Advanced Server version 15 and later. | -| edb-as15-server-pltcl | Installs the PL/Tcl procedural language for EDB Postgres Advanced Server. The `edb-as15-pltcl` package depends on the platform-supplied version of TCL. | -| edb-as15-server-sqlprofiler | Installs EDB Postgres Advanced Server's SQL Profiler feature. SQL Profiler helps identify and optimize SQL code. | -| edb-as15-server-sqlprotect | Installs EDB Postgres Advanced Server's SQL Protect feature. SQL Protect provides protection against SQL injection attacks. | +| edb-as15-server-edb-modules | Installs supporting modules for EPAS. | +| edb-as15-server-indexadvisor | Installs EPAS's Index Advisor feature. The Index Advisor utility helps to determine the columns to index to improve performance in a given workload. | +| edb-as15-server-libs | Provides the essential shared libraries for any EPAS client program or interface. | +| edb-as15-server-llvmjit | Contains support for just-in-time (JIT) compiling parts of EPAS's queries. You need to install this package separately. | +| edb-as15-server-pldebugger | Implements an API for debugging PL/pgSQL functions on EPAS. | +| edb-as15-server-plperl | Installs the PL/Perl procedural language for EPAS. The `edb-as15-server-plperl` package depends on the platform-supplied version of Perl. | +| edb-as15-server-plpython3 | Installs the PL/Python procedural language for EPAS. The PL/Python2 support is no longer available in EPAS version 15 and later. | +| edb-as15-server-pltcl | Installs the PL/Tcl procedural language for EPAS. The `edb-as15-pltcl` package depends on the platform-supplied version of TCL. | +| edb-as15-server-sqlprofiler | Installs EPAS's SQL Profiler feature. SQL Profiler helps identify and optimize SQL code. | +| edb-as15-server-sqlprotect | Installs EPAS's SQL Protect feature. SQL Protect provides protection against SQL injection attacks. | | edb-as15-server-sslutils | Installs functionality that provides SSL support. | | edb-as15-server-cloneschema | Installs the EDB Clone Schema extension. For more information about EDB Clone Schema, see [EDB clone schema](../../database_administration/14_edb_clone_schema/). | | edb-as15-server-parallel-clone | Installs functionality that supports the EDB Clone Schema extension. | -| edb-as15-pgagent | Installs pgAgent: Installs pgAgent, a job scheduler for EDB Postgres Advanced Server. Before installing this package, you must install EPEL repository. For detailed information about installing EPEL, see [Linux installation troubleshooting](../troubleshooting/linux_troubleshooting/installation_troubleshooting_linux/). | +| edb-as15-pgagent | Installs pgAgent: Installs pgAgent, a job scheduler for EPAS. Before installing this package, you must install EPEL repository. For detailed information about installing EPEL, see [Linux installation troubleshooting](../troubleshooting/linux_troubleshooting/installation_troubleshooting_linux/). | | edb-as15-edbplus | The `edb-edbplus` package contains the files required to install the EDB\*Plus command line client. EDB\*Plus commands are compatible with Oracle's SQL\*Plus. | | edb-as15-pgsnmpd | Simple Network Management Protocol (SNMP) is a protocol that allows you to supervise an apparatus connected to the network. | | edb-as15-pgpool41-extensions | Creates pgPool extensions required by the server for use with pgpool. | @@ -69,16 +69,16 @@ Note: The available package list is subject to change. | edb-as15-slony-replication-tools | Contains the Slony altperl tools and utilities that are useful when deploying Slony replication environments. Before installing this package, you must install EPEL repository. For detailed information about installing EPEL, see [Linux installation troubleshooting](../troubleshooting/linux_troubleshooting/installation_troubleshooting_linux/). | | edb-as15-libicu | Contains the supporting library files. | -The following table lists the packages for EDB Postgres Advanced Server 15 supporting components. +The following table lists the packages for EPAS 15 supporting components. | Package name | Package installs | | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| edb-pgpool41 | Contains the pgPool-II installer. The pgpool-II utility package acts as a middleman between client applications and Server database servers. pgpool-II functionality is transparent to client applications; client applications connect to pgpool-II instead of directly to EDB Postgres Advanced Server, and pgpool-II manages the connection. EDB supports the following pgpool-II features:
- Load balancing
- Connection pooling
- High availability
- Connection limits


pgpool-II runs as a service on Linux systems, and is not supported on Windows systems.
| -| edb-jdbc | The `edb-jdbc` package includes the .jar files needed for Java programs to access an EDB Postgres Advanced Server database. | -| edb-migrationtoolkit | The `edb-migrationtoolkit` package installs Migration Toolkit, facilitating migration to an EDB Postgres Advanced Server database from Oracle, PostgreSQL, MySQL, Sybase and SQL Server. | -| edb-oci | The `edb-oci` package installs the EDB Open Client library, allowing applications that use the Oracle Call Interface API to connect to an EDB Postgres Advanced Server database. | +| edb-pgpool41 | Contains the pgPool-II installer. The pgpool-II utility package acts as a middleman between client applications and Server database servers. pgpool-II functionality is transparent to client applications; client applications connect to pgpool-II instead of directly to EPAS, and pgpool-II manages the connection. EDB supports the following pgpool-II features:
- Load balancing
- Connection pooling
- High availability
- Connection limits


pgpool-II runs as a service on Linux systems, and is not supported on Windows systems.
| +| edb-jdbc | The `edb-jdbc` package includes the .jar files needed for Java programs to access an EPAS database. | +| edb-migrationtoolkit | The `edb-migrationtoolkit` package installs Migration Toolkit, facilitating migration to an EPAS database from Oracle, PostgreSQL, MySQL, Sybase and SQL Server. | +| edb-oci | The `edb-oci` package installs the EDB Open Client library, allowing applications that use the Oracle Call Interface API to connect to an EPAS database. | | edb-oci-devel | Installs the OCI include files; install this package if you are developing C/C++ applications that require these files. | -| edb-odbc | Installs the driver needed for applications to access an EDB Postgres Advanced Server system via ODBC. | +| edb-odbc | Installs the driver needed for applications to access an EPAS system via ODBC. | | edb-odbc-devel | Installs the ODBC include files; install this package if you are developing C/C++ applications that require these files. | | edb-pgbouncer115 | Contains PgBouncer (a lightweight connection pooler). This package requires the libevent package. | | ppas-xdb | Contains the xDB installer; xDB provides asynchronous cross-database replication. | @@ -101,7 +101,7 @@ The following table lists the packages for EDB Postgres Advanced Server 15 suppo | edb-rs-libs | Contains certain libraries that are commonly used by ERPS Server, EPRS Client, and Monitoring modules. | | edb-rs-monitor | A Java-based application that provides monitoring capabilities to ensure a smooth functioning of the EPRS replication cluster. | | edb-rs-server | A Java-based replication framework that provides asynchronous replication across Postgres and EDB Postgres Advanced Server database servers. It supports primary-standby, primary-primary, and hybrid configurations. | -| edb-bart | Installs the Backup and Recovery Tool (BART) to support online backup and recovery across local and remote PostgreSQL and EDB EDB Postgres Advanced Servers. | +| edb-bart | Installs the Backup and Recovery Tool (BART) to support online backup and recovery across local and remote PostgreSQL and EDB Postgres Advanced Server servers. | | libevent-edb | Contains supporting library files. | | libiconv-edb | Contains supporting library files. | | libevent-edb-devel | Contains supporting library files. | @@ -121,24 +121,24 @@ apt list edb* | Package name | Package installs | | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| edb-as15-server | Installs core components of the EDB Postgres Advanced Server database server. | -| edb-as15-server-client | Includes client programs and utilities that you can use to access and manage EDB Postgres Advanced Server. | -| edb-as15-server-core | Includes the programs needed to create the core functionality behind the EDB Postgres Advanced Server database. | -| edb-as15-server-dev | Package that contains the header files and libraries needed to compile C or C++ applications that directly interact with an EDB Postgres Advanced Server server and the ecpg or ecpgPlus C preprocessor. | +| edb-as15-server | Installs core components of the EPAS database server. | +| edb-as15-server-client | Includes client programs and utilities that you can use to access and manage EPAS. | +| edb-as15-server-core | Includes the programs needed to create the core functionality behind the EPAS database. | +| edb-as15-server-dev | Package that contains the header files and libraries needed to compile C or C++ applications that directly interact with an EPAS server and the ecpg or ecpgPlus C preprocessor. | | edb-as15-server-doc | Installs the readme file. | -| edb-as15-server-edb-modules | Installs supporting modules for EDB Postgres Advanced Server. | -| edb-as15-server-indexadvisor | Installs EDB Postgres Advanced Server's Index Advisor feature. The Index Advisor utility helps to determine the columns to index to improve performance in a given workload. | -| edb-as15-server-pldebugger | This package implements an API for debugging PL/pgSQL functions on EDB Postgres Advanced Server. | -| edb-as15-server-plpython3 | Installs the PL/Python procedural language for EDB Postgres Advanced Server. PL/Python2 support is no longer available from EDB Postgres Advanced Server version 15 onwards. | -| edb-as15-server-pltcl | Installs the PL/Tcl procedural language for EDB Postgres Advanced Server. The `edb-as15-pltcl` package depends on the platform-supplied version of TCL. | -| edb-as15-server-sqlprofiler | Installs EDB Postgres Advanced Server's SQL Profiler feature. SQL Profiler helps identify and optimize SQL code. | -| edb-as15-server-sqlprotect | Installs EDB Postgres Advanced Server's SQL Protect feature. SQL Protect provides protection against SQL injection attacks. | +| edb-as15-server-edb-modules | Installs supporting modules for EPAS. | +| edb-as15-server-indexadvisor | Installs EPAS's Index Advisor feature. The Index Advisor utility helps to determine the columns to index to improve performance in a given workload. | +| edb-as15-server-pldebugger | This package implements an API for debugging PL/pgSQL functions on EPAS. | +| edb-as15-server-plpython3 | Installs the PL/Python procedural language for EPAS. PL/Python2 support is no longer available from EPAS version 15 onwards. | +| edb-as15-server-pltcl | Installs the PL/Tcl procedural language for EPAS. The `edb-as15-pltcl` package depends on the platform-supplied version of TCL. | +| edb-as15-server-sqlprofiler | Installs EPAS's SQL Profiler feature. SQL Profiler helps identify and optimize SQL code. | +| edb-as15-server-sqlprotect | Installs EPAS's SQL Protect feature. SQL Protect provides protection against SQL injection attacks. | | edb-as15-server-sslutils | Installs functionality that provides SSL support. | | edb-as15-server-cloneschema | Installs the EDB Clone Schema extension. For more information about EDB Clone Schema, see the [EDB clone schema](../../database_administration/14_edb_clone_schema/). | | edb-as15-server-parallel-clone | Installs functionality that supports the EDB Clone Schema extension. | | edb-as15-edbplus | The `edb-edbplus` package contains the files required to install the EDB\*Plus command line client. EDB\*Plus commands are compatible with Oracle's SQL\*Plus. | | edb-as15-pgsnmpd | Simple Network Management Protocol (SNMP) is a protocol that allows you to supervise an apparatus connected to the network. | -| edb-as15-pgadmin4 | pgAdmin 4 provides a graphical management interface for EDB Postgres Advanced Server and PostgreSQL databases. | +| edb-as15-pgadmin4 | pgAdmin 4 provides a graphical management interface for EPAS and PostgreSQL databases. | | edb-as15-pgadmin-apache | Apache support module for pgAdmin 4. | | edb-as15-pgadmin4-common | pgAdmin 4 supporting files. | | edb-as15-pgadmin4-doc | pgAdmin 4 documentation module. | @@ -149,26 +149,26 @@ apt list edb* | edb-as15-postgis3-gui | Provides a GUI for POSTGIS. | | edb-as15-postgis-jdbc | Provides support for POSTGIS. | | edb-as15-postgis-scripts | Provides support for POSTGIS. | -| edb-as15-pgagent | Installs pgAgent, a job scheduler for EDB Postgres Advanced Server. Before installing this package, you must install EPEL repository. For detailed information about installing EPEL, see [Linux installation troubleshooting](../troubleshooting/linux_troubleshooting/installation_troubleshooting_linux/). | +| edb-as15-pgagent | Installs pgAgent, a job scheduler for EPAS. Before installing this package, you must install EPEL repository. For detailed information about installing EPEL, see [Linux installation troubleshooting](../troubleshooting/linux_troubleshooting/installation_troubleshooting_linux/). | | edb-as15-slony-replication | Installs the meta RPM for Slony-I. | | edb-as15-slony-replication-core | Contains core portions of Slony-I to build a primary-standby system that includes all features and capabilities needed to replicate large databases to a reasonably limited number of standby systems. | | edb-as15-slony-replication-docs | Contains the Slony project documentation in pdf form. | | edb-as15-slony-replication-tools | Contains the Slony altperl tools and utilities that are useful when deploying Slony replication environments. Before installing this package, you must install EPEL repository. For detailed information about installing EPEL, see [Linux installation troubleshooting](../troubleshooting/linux_troubleshooting/installation_troubleshooting_linux/). | -| edb-as15-hdfs-fdw | The Hadoop Data Adapter allows you to query and join data from Hadoop environments with your Postgres or EDB Postgres Advanced Server instances. It's YARN Ready certified with HortonWorks and provides optimizations for performance with predicate pushdown support. | +| edb-as15-hdfs-fdw | The Hadoop Data Adapter allows you to query and join data from Hadoop environments with your Postgres or EPAS instances. It's YARN Ready certified with HortonWorks and provides optimizations for performance with predicate pushdown support. | | edb-as15-hdfs-fdw-doc | Documentation for the Hadoop Data Adapter. | -| edb-as15-mongo-fdw | This EDB Postgres Advanced Server extension implements a foreign data wrapper for MongoDB. | +| edb-as15-mongo-fdw | This EPAS extension implements a foreign data wrapper for MongoDB. | | edb-as15-mongo-fdw-doc | Documentation for the foreign data wrapper for MongoDB. | -| edb-as15-mysql-fdw | This EDB Postgres Advanced Server extension implements a foreign data wrapper for MySQL. | -| edb-pgpool41 | Contains the pgPool-II installer. The pgpool-II utility package acts as a middleman between client applications and Server database servers. pgpool-II functionality is transparent to client applications; client applications connect to pgpool-II instead of directly to EDB Postgres Advanced Server, and pgpool-II manages the connection. EDB supports the following pgpool-II features:
- Load balancing
- Connection pooling
- High availability
- Connection limits


pgpool-II runs as a service on Linux systems, and is not supported on Windows systems.
| -| edb-jdbc | Includes the .jar files needed for Java programs to access an EDB Postgres Advanced Server database. | -| edb-migrationtoolkit | Installs Migration Toolkit, facilitating migration to an EDB Postgres Advanced Server database from Oracle, PostgreSQL, MySQL, Sybase and SQL Server. | +| edb-as15-mysql-fdw | This EPAS extension implements a foreign data wrapper for MySQL. | +| edb-pgpool41 | Contains the pgPool-II installer. The pgpool-II utility package acts as a middleman between client applications and Server database servers. pgpool-II functionality is transparent to client applications; client applications connect to pgpool-II instead of directly to EPAS, and pgpool-II manages the connection. EDB supports the following pgpool-II features:
- Load balancing
- Connection pooling
- High availability
- Connection limits


pgpool-II runs as a service on Linux systems, and is not supported on Windows systems.
| +| edb-jdbc | Includes the .jar files needed for Java programs to access an EPAS database. | +| edb-migrationtoolkit | Installs Migration Toolkit, facilitating migration to an EPAS database from Oracle, PostgreSQL, MySQL, Sybase and SQL Server. | | edb-pgbouncer115 | PgBouncer, a lightweight connection pooler. This package requires the libevent package. | | edb-efm40 | Installs EDB Failover Manager that adds fault tolerance to database clusters to minimize downtime when a primary database fails by keeping data online in high availability configurations. | ### Updating an RPM installation -If you have an existing EDB Postgres Advanced Server RPM installation, you can use `yum` or `dnf` to upgrade your repository configuration file and update to a more recent product version. To update the `edb.repo` file, assume superuser privileges and enter: +If you have an existing EPAS RPM installation, you can use `yum` or `dnf` to upgrade your repository configuration file and update to a more recent product version. To update the `edb.repo` file, assume superuser privileges and enter: - On RHEL or CentOS 7: diff --git a/product_docs/docs/epas/15/installing/linux_ppc64le/epas_rhel_7.mdx b/product_docs/docs/epas/15/installing/linux_ppc64le/epas_rhel_7.mdx index 80dd473a3e3..abeb0389a13 100644 --- a/product_docs/docs/epas/15/installing/linux_ppc64le/epas_rhel_7.mdx +++ b/product_docs/docs/epas/15/installing/linux_ppc64le/epas_rhel_7.mdx @@ -68,7 +68,7 @@ Installing the server package creates an operating system user named enterprised This section steps you through getting started with your cluster including logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. -First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/#initializing-the-cluster-in-postgres-mode). +First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options). ```shell sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb diff --git a/product_docs/docs/epas/15/installing/linux_ppc64le/epas_rhel_8.mdx b/product_docs/docs/epas/15/installing/linux_ppc64le/epas_rhel_8.mdx index 2435658d5d5..6f99eaad299 100644 --- a/product_docs/docs/epas/15/installing/linux_ppc64le/epas_rhel_8.mdx +++ b/product_docs/docs/epas/15/installing/linux_ppc64le/epas_rhel_8.mdx @@ -70,7 +70,7 @@ Installing the server package creates an operating system user named enterprised This section steps you through getting started with your cluster including logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. -First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/#initializing-the-cluster-in-postgres-mode). +First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options). ```shell sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb diff --git a/product_docs/docs/epas/15/installing/linux_ppc64le/epas_rhel_9.mdx b/product_docs/docs/epas/15/installing/linux_ppc64le/epas_rhel_9.mdx index cbb6bf89ed6..a4b47b5a297 100644 --- a/product_docs/docs/epas/15/installing/linux_ppc64le/epas_rhel_9.mdx +++ b/product_docs/docs/epas/15/installing/linux_ppc64le/epas_rhel_9.mdx @@ -70,7 +70,7 @@ Installing the server package creates an operating system user named enterprised This section steps you through getting started with your cluster including logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. -First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/#initializing-the-cluster-in-postgres-mode). +First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options). ```shell sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb diff --git a/product_docs/docs/epas/15/installing/linux_ppc64le/epas_sles_12.mdx b/product_docs/docs/epas/15/installing/linux_ppc64le/epas_sles_12.mdx index 57955d0853f..f5963f2f1bd 100644 --- a/product_docs/docs/epas/15/installing/linux_ppc64le/epas_sles_12.mdx +++ b/product_docs/docs/epas/15/installing/linux_ppc64le/epas_sles_12.mdx @@ -64,7 +64,7 @@ Where `package_name` can be any of the available packages from the [available pa This section steps you through getting started with your cluster including logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. -First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/#initializing-the-cluster-in-postgres-mode). +First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options). ```shell sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb diff --git a/product_docs/docs/epas/15/installing/linux_ppc64le/epas_sles_15.mdx b/product_docs/docs/epas/15/installing/linux_ppc64le/epas_sles_15.mdx index 49015002326..7097aa69ee9 100644 --- a/product_docs/docs/epas/15/installing/linux_ppc64le/epas_sles_15.mdx +++ b/product_docs/docs/epas/15/installing/linux_ppc64le/epas_sles_15.mdx @@ -65,7 +65,7 @@ Where `package_name` can be any of the available packages from the [available pa This section steps you through getting started with your cluster including logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. -First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/#initializing-the-cluster-in-postgres-mode). +First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options). ```shell sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb diff --git a/product_docs/docs/epas/15/installing/linux_x86_64/epas_centos_7.mdx b/product_docs/docs/epas/15/installing/linux_x86_64/epas_centos_7.mdx index 5df2e7f734f..b7ab4ef5cce 100644 --- a/product_docs/docs/epas/15/installing/linux_x86_64/epas_centos_7.mdx +++ b/product_docs/docs/epas/15/installing/linux_x86_64/epas_centos_7.mdx @@ -60,7 +60,7 @@ Installing the server package creates an operating system user named enterprised This section steps you through getting started with your cluster including logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. -First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/#initializing-the-cluster-in-postgres-mode). +First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options). ```shell sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb diff --git a/product_docs/docs/epas/15/installing/linux_x86_64/epas_other_linux_8.mdx b/product_docs/docs/epas/15/installing/linux_x86_64/epas_other_linux_8.mdx index fe389de137d..77f2e7d0a6a 100644 --- a/product_docs/docs/epas/15/installing/linux_x86_64/epas_other_linux_8.mdx +++ b/product_docs/docs/epas/15/installing/linux_x86_64/epas_other_linux_8.mdx @@ -66,7 +66,7 @@ Installing the server package creates an operating system user named enterprised This section steps you through getting started with your cluster including logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. -First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/#initializing-the-cluster-in-postgres-mode). +First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options). ```shell sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb diff --git a/product_docs/docs/epas/15/installing/linux_x86_64/epas_other_linux_9.mdx b/product_docs/docs/epas/15/installing/linux_x86_64/epas_other_linux_9.mdx index 93ce553a8c5..80d54bfa31a 100644 --- a/product_docs/docs/epas/15/installing/linux_x86_64/epas_other_linux_9.mdx +++ b/product_docs/docs/epas/15/installing/linux_x86_64/epas_other_linux_9.mdx @@ -66,7 +66,7 @@ Installing the server package creates an operating system user named enterprised This section steps you through getting started with your cluster including logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. -First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/#initializing-the-cluster-in-postgres-mode). +First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options). ```shell sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb diff --git a/product_docs/docs/epas/15/installing/linux_x86_64/epas_rhel_7.mdx b/product_docs/docs/epas/15/installing/linux_x86_64/epas_rhel_7.mdx index c3643c9abf4..8b14d5f0939 100644 --- a/product_docs/docs/epas/15/installing/linux_x86_64/epas_rhel_7.mdx +++ b/product_docs/docs/epas/15/installing/linux_x86_64/epas_rhel_7.mdx @@ -66,7 +66,7 @@ Installing the server package creates an operating system user named enterprised This section steps you through getting started with your cluster including logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. -First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/#initializing-the-cluster-in-postgres-mode). +First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options). ```shell sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb diff --git a/product_docs/docs/epas/15/installing/linux_x86_64/epas_rhel_8.mdx b/product_docs/docs/epas/15/installing/linux_x86_64/epas_rhel_8.mdx index 42637c23ec3..133b9cd0446 100644 --- a/product_docs/docs/epas/15/installing/linux_x86_64/epas_rhel_8.mdx +++ b/product_docs/docs/epas/15/installing/linux_x86_64/epas_rhel_8.mdx @@ -68,7 +68,7 @@ Installing the server package creates an operating system user named enterprised This section steps you through getting started with your cluster including logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. -First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/#initializing-the-cluster-in-postgres-mode). +First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options). ```shell sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb diff --git a/product_docs/docs/epas/15/installing/linux_x86_64/epas_rhel_9.mdx b/product_docs/docs/epas/15/installing/linux_x86_64/epas_rhel_9.mdx index be9fb6e3d53..06671e84b8c 100644 --- a/product_docs/docs/epas/15/installing/linux_x86_64/epas_rhel_9.mdx +++ b/product_docs/docs/epas/15/installing/linux_x86_64/epas_rhel_9.mdx @@ -68,7 +68,7 @@ Installing the server package creates an operating system user named enterprised This section steps you through getting started with your cluster including logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. -First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/#initializing-the-cluster-in-postgres-mode). +First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options). ```shell sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb diff --git a/product_docs/docs/epas/15/installing/linux_x86_64/epas_sles_12.mdx b/product_docs/docs/epas/15/installing/linux_x86_64/epas_sles_12.mdx index 3734aa64d87..fc0045f4375 100644 --- a/product_docs/docs/epas/15/installing/linux_x86_64/epas_sles_12.mdx +++ b/product_docs/docs/epas/15/installing/linux_x86_64/epas_sles_12.mdx @@ -64,7 +64,7 @@ Where `package_name` can be any of the available packages from the [available pa This section steps you through getting started with your cluster including logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. -First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/#initializing-the-cluster-in-postgres-mode). +First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options). ```shell sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb diff --git a/product_docs/docs/epas/15/installing/linux_x86_64/epas_sles_15.mdx b/product_docs/docs/epas/15/installing/linux_x86_64/epas_sles_15.mdx index 274c5cb7db6..1eae407e438 100644 --- a/product_docs/docs/epas/15/installing/linux_x86_64/epas_sles_15.mdx +++ b/product_docs/docs/epas/15/installing/linux_x86_64/epas_sles_15.mdx @@ -65,7 +65,7 @@ Where `package_name` can be any of the available packages from the [available pa This section steps you through getting started with your cluster including logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password. -First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/#initializing-the-cluster-in-postgres-mode). +First you need to initialize and start the database cluster. The `edb-as-15-setup` script creates a cluster in Oracle-compatible mode with the `edb` sample database in the cluster. To create a cluster in Postgres mode, see [Initializing the cluster in Postgres mode](../linux_install_details/managing_an_advanced_server_installation/specifying_cluster_options). ```shell sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/as15/bin/edb-as-15-setup initdb diff --git a/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx b/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx index e9ca0eb7dd4..ae1a9db04a0 100644 --- a/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx +++ b/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx @@ -11,11 +11,11 @@ legacyRedirects: --- !!! Note - After uninstalling EDB Postgres Advanced Server, the cluster data files remain intact, and the service user persists. You can manually remove the cluster `data` and service user from the system. + After uninstalling EDB Postgres Advanced Server (EPAS), the cluster data files remain intact, and the service user persists. You can manually remove the cluster `data` and service user from the system. ## Uninstalling on RHEL/OL/AlmaLinux/Rocky Linux -You can use variations of the `rpm`, `yum`, or `dnf` command to remove installed packages. Removing a package doesn't damage the EDB Postgres Advanced Server `data` directory. +You can use variations of the `rpm`, `yum`, or `dnf` command to remove installed packages. Removing a package doesn't damage the EPAS `data` directory. Include the `-e` option when invoking the `rpm` command to remove an installed package: @@ -46,7 +46,7 @@ Where `package_name` is the name of the package that you want to remove. !!! Note In RHEL or Rocky Linux or AlmaLinux 8, removing a package also removes all its dependencies that aren't required by other packages. To override this default behavior of RHEL or Rocky Linux or AlmaLinux 8, disable the `clean_requirements_on_remove` parameter in the `/etc/yum.conf` file. -To uninstall EDB Postgres Advanced Server and its dependent packages, use the appropriate command. +To uninstall EPAS and its dependent packages, use the appropriate command. - On RHEL or CentOS 7: @@ -62,13 +62,13 @@ To uninstall EDB Postgres Advanced Server and its dependent packages, use the ap ## Uninstalling on Debian or Ubuntu -- To uninstall EDB Postgres Advanced Server, invoke the following command. The configuration files and data directory remains intact. +- To uninstall EPAS, invoke the following command. The configuration files and data directory remains intact. ```text apt-get remove edb-as15-server* ``` -- To uninstall EDB Postgres Advanced Server, configuration files, and data directory, invoke the following command: +- To uninstall EPAS, configuration files, and data directory, invoke the following command: ```text apt-get purge edb-as15-server* diff --git a/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx b/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx index d05502a4503..692eae3fb3c 100644 --- a/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx +++ b/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx @@ -9,11 +9,11 @@ redirects: --- !!! Note - After uninstalling EDB Postgres Advanced Server, the cluster data files remain intact, and the service user persists. You can manually remove the cluster data and service user from the system. + After uninstalling EDB Postgres Advanced Server (EPAS), the cluster data files remain intact, and the service user persists. You can manually remove the cluster data and service user from the system. ## Using EDB Postgres Advanced Server uninstallers at the command line -The EDB Postgres Advanced Server interactive installer creates an uninstaller that you can use to remove EDB Postgres Advanced Server or components that reside on a Windows host. The uninstaller is created in `C:\Program Files\edb\as15`. +The EPAS interactive installer creates an uninstaller that you can use to remove EPAS or components that reside on a Windows host. The uninstaller is created in `C:\Program Files\edb\as15`. 1. Assume superuser privileges and, in the directory that contains the uninstaller, enter: @@ -29,7 +29,7 @@ The EDB Postgres Advanced Server interactive installer creates an uninstaller th 1. Select **Next**. - If you selected components to remove that depend on EDB Postgres Advanced Server, those components are removed first. + If you selected components to remove that depend on EPAS, those components are removed first. ![Acknowledge that dependent components are removed first](../../images/acknowledging_components_removed.png) diff --git a/product_docs/docs/epas/15/installing/windows/index.mdx b/product_docs/docs/epas/15/installing/windows/index.mdx index 39fe9e2b5fb..d01983dcc2c 100644 --- a/product_docs/docs/epas/15/installing/windows/index.mdx +++ b/product_docs/docs/epas/15/installing/windows/index.mdx @@ -7,6 +7,7 @@ redirects: navigation: - installing_advanced_server_with_the_interactive_installer - managing_an_advanced_server_installation +indexCards: simple --- The installation section provides detailed information about: diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/index.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/index.mdx index 6f37a239fa6..5d98e7a8bd6 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/index.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/index.mdx @@ -1,6 +1,7 @@ --- title: "Installing EDB Postgres Advanced Server with the interactive installer" navTitle: "Using the installer" +indexCards: simple redirects: - /epas/latest/epas_inst_windows/03_installing_advanced_server_with_the_interactive_installer/ - /epas/latest/epas_inst_windows/installing_advanced_server_with_the_interactive_installer/ @@ -13,14 +14,9 @@ navigation: -You can use the EDB Postgres Advanced Server interactive installer to install EDB Postgres Advanced Server on Windows. The interactive installer is available from [Downloads page](https://www.enterprisedb.com/advanced-downloads) on the EDB website. +You can use the EDB Postgres Advanced Server (EPAS) interactive installer to install EPAS on Windows. The interactive installer is available from [Downloads page](https://www.enterprisedb.com/advanced-downloads) on the EDB website. -You can invoke the graphical installer in different installation modes to perform an EDB Postgres Advanced Server installation: - -- For information about using the graphical installer, see [Performing a Graphical Installation on Windows](performing_a_graphical_installation_on_windows/#performing_a_graphical_installation_on_windows). -- For information about performing an unattended installation, see [Performing an Unattended Installation](invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation/#performing_an_unattended_installation). -- For information about performing an installation with limited privileges, see [Performing an Installation with Limited Privileges](invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges/#performing_an_installation_with_limited_privileges). -- For information about the command line options you can include when invoking the installer, see [Reference - Command Line Options](invoking_the_graphical_installer_from_the_command_line/reference_command_line_options/#reference_command_line_options). +You can invoke the graphical installer in different installation modes to perform an EPAS installation. During the installation, the graphical installer copies a number of temporary files to the location specified by the `TEMP` environment variable. You can optionally specify an alternate location for the temporary files by modifying the value of the `TEMP` environment variable on the command line: @@ -32,28 +28,3 @@ Where `temp_file_location` specifies the alternate location for the temporary fi !!! Note If you are invoking the installer to perform a system upgrade, the installer preserves the configuration options specified during the previous installation. - -## Setting cluster preferences during a graphical installation - -During an installation, the graphical installer invokes the PostgreSQL `initdb` utility to initialize a cluster. If you are using the graphical installer, you can use the `INITDBOPTS` environment variable to specify your `initdb` preferences. Before invoking the graphical installer, set the value of `INITDBOPTS` at the command line, specifying one or more cluster options. For example: - -```text -SET INITDBOPTS= -k -E=UTF-8 -``` - -If you specify values in `INITDBOPTS` that are also provided by the installer (such as the `–D` option, which specifies the installation directory), the value specified in the graphical installer supersedes the value if specified in `INITDBOPTS`. - -For more information about using `initdb` cluster configuration options, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/app-initdb.html). In addition to the cluster configuration options documented in the PostgreSQL core documentation, EDB Postgres Advanced Server supports the following `initdb` options: - -`--no-redwood-compat` - -`--no-redwood-compat` instructs the server to create the cluster in PostgreSQL mode. When the cluster is created in PostgreSQL mode, the name of the database superuser is `postgres` and the name of the default database is `postgres`. A small subset of Advanced Server features compatible with Oracle databases are available with this mode. However, we recommend using Advanced Server in redwood compatibility mode to have access to all its Oracle compatibility features. - -`--redwood-like` - -`--redwood-like` instructs the server to use an escape character (an empty string ('')) following the `LIKE` (or PostgreSQL compatible `ILIKE`) operator in a SQL statement that is compatible with Oracle syntax. - -`--icu-short-form` - -`--icu-short-form` creates a cluster that uses a default ICU (International Components for Unicode) collation for all databases in the cluster. For more information about Unicode collations, see [Basic Unicode collation algorithm concepts](../../../tools_utilities_and_components/application_developer_tools/06_unicode_collation_algorithm). - diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx index 2bfe400510d..d6c716ad8bc 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx @@ -7,7 +7,7 @@ redirects: -To perform an abbreviated installation of EDB Postgres Advanced Server without access to administrative privileges, invoke the installer from the command line and include the `--extract-only` option. The `--extract-only` option extracts the binary files in an unaltered form, allowing you to experiment with a minimal installation of EDB Postgres Advanced Server. +To perform an abbreviated installation of EDB Postgres Advanced Server (EPAS) without access to administrative privileges, invoke the installer from the command line and include the `--extract-only` option. The `--extract-only` option extracts the binary files in an unaltered form, allowing you to experiment with a minimal installation of EPAS. If you invoke the installer with the `--extract-only` options, you can either manually create a cluster and start the service, or run the installation script. To manually create the cluster, you must: @@ -25,9 +25,9 @@ The installation script: - Configures the server to start at boot-time. - Establishes initial values for Dynatune (dynamic tuning) variables. -The scripted EDB Postgres Advanced Server installation does not create menu shortcuts or provide access to EDB Postgres StackBuilder Plus, and no modifications are made to registry files. +The scripted EPAS installation does not create menu shortcuts or provide access to EDB Postgres StackBuilder Plus, and no modifications are made to registry files. -To perform a limited installation and generate an installation script, download and unpack the EDB Postgres Advanced Server installer. Navigate into the directory that contains the installer, and invoke the installer with the command: +To perform a limited installation and generate an installation script, download and unpack the EPAS installer. Navigate into the directory that contains the installer, and invoke the installer with the command: ```text edb-as14-server-14.x.x-x-windows.exe --extract-only yes @@ -45,7 +45,7 @@ Click `Next` to continue.
Fig. 16: Specify an installation directory
-On Windows, the default EDB Postgres Advanced Server installation directory is: +On Windows, the default EPAS installation directory is: ```text C:\Program Files\edb\as14 @@ -57,7 +57,7 @@ You can accept the default installation location and click `Next` to continue to
Fig. 17: The Setup wizard is ready to install EDB Postgres Advanced Server
-Click `Next` to proceed with the EDB Postgres Advanced Server installation. During the installation, progress bars and popups mark the installation progress. The installer notifies you when the installation is complete. +Click `Next` to proceed with the EPAS installation. During the installation, progress bars and popups mark the installation progress. The installer notifies you when the installation is complete. ![The EDB Postgres Advanced Server installation is complete](../../../../images/advanced_server_installation_completion.png) diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx index 8d7e82b3d92..9691d6a344d 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx @@ -11,11 +11,11 @@ To specify that the installer should run without user interaction, include the ` - Command line options (specified when invoking the installer) - Parameters specified in an option file -- EDB Postgres Advanced Server installation defaults +- EDB Postgres Advanced Server (EPAS) installation defaults -You can embed the non-interactive EDB Postgres Advanced Server installer within another application installer; during the installation process, a progress bar allows the user to view the progression of the installation. +You can embed the non-interactive EPAS installer within another application installer; during the installation process, a progress bar allows the user to view the progression of the installation. -You must have administrative privileges to install EDB Postgres Advanced Server using the `--mode unattended` option. If you are using the `--mode unattended` option to install EDB Postgres Advanced Server with a client, the calling client must be invoked with superuser or administrative privileges. +You must have administrative privileges to install EPAS using the `--mode unattended` option. If you are using the `--mode unattended` option to install EPAS with a client, the calling client must be invoked with superuser or administrative privileges. To start the installer in unattended mode, navigate to the directory that contains the executable file, and enter: @@ -24,6 +24,6 @@ edb-as14-server-14.x.x-x-windows-x64.exe --mode unattended --superpassword database_superuser_password --servicepassword system_password ``` -When invoking the installer, include the `--servicepassword` option to specify an operating system password for the user installing EDB Postgres Advanced Server. +When invoking the installer, include the `--servicepassword` option to specify an operating system password for the user installing EPAS. Use the `--superpassword` option to specify a password that conforms to the password security policies defined on the host; enforced password policies on your system may not accept the default password `(enterprisedb)`. diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx index f94d05f37bd..604654c9140 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx @@ -7,7 +7,7 @@ redirects: -You can optionally include the following parameters for an EDB Postgres Advanced Server installation on the command line or in a configuration file when invoking the EDB Postgres Advanced Server installer. +You can optionally include the following parameters for an EDB Postgres Advanced Server (EPAS) installation on the command line or in a configuration file when invoking the EPASinstaller. `--create_samples { yes | no }` @@ -31,7 +31,7 @@ Helps with troubleshooting installation problems. `debug_log` is the name of the `--disable-components component_list` -Specifies a list of EDB Postgres Advanced Server components to exclude from the installation. By default, `component_list` contains '' (the empty string). `component_list` is a comma-separated list containing one or more of the following components: +Specifies a list of EPAScomponents to exclude from the installation. By default, `component_list` contains '' (the empty string). `component_list` is a comma-separated list containing one or more of the following components: - `dbserver` — EDB Postgres Advanced Server. @@ -39,7 +39,7 @@ Specifies a list of EDB Postgres Advanced Server components to exclude from the `--enable_acledit { 1 | 0 }` -The `--enable_acledit 1` option instructs the installer to grant permission to the user specified by the `--serviceaccount` option to access the EDB Postgres Advanced Server binaries and `data` directory. By default, this option is disabled if `--enable_acledit 0` is specified or if the `--enable_acledit` option is completely omitted. +The `--enable_acledit 1` option instructs the installer to grant permission to the user specified by the `--serviceaccount` option to access the EPASbinaries and `data` directory. By default, this option is disabled if `--enable_acledit 0` is specified or if the `--enable_acledit` option is completely omitted. !!! Note Specifying this option is valid only when installing on Windows. Specify the `--enable_acledit 1` option when a discretionary access control list (DACL) needs to be set for allowing access to objects on which to install EDB Postgres Advanced Server. For information on a DACL, see [DACLs and ACEs](https://msdn.microsoft.com/en-us/library/windows/desktop/aa446597(v=vs.85).aspx) in the Microsoft documentation. @@ -52,7 +52,7 @@ Although this option is listed when you run the installer with the `--help` opti `--extract-only { yes | no }` -Include the `--extract-only` parameter to indicate that the installer should extract the EDB Postgres Advanced Server binaries without performing a complete installation. Superuser privileges aren't required for the `--extract-only` option. The default value is `no`. +Include the `--extract-only` parameter to indicate that the installer should extract the EPASbinaries without performing a complete installation. Superuser privileges aren't required for the `--extract-only` option. The default value is `no`. `--help` @@ -60,7 +60,7 @@ Displays a list of the optional parameters. `--installer-language { en | ja | zh_CN | zh_TW | ko }` -Specifies an installation language for EDB Postgres Advanced Server. The default is `en`. +Specifies an installation language for EPAS. The default is `en`. `en` specifies English. @@ -78,7 +78,7 @@ Specifies whether to install the Microsoft Visual C++ runtime libraries. Default `--locale locale` -Specifies the locale for the EDB Postgres Advanced Server cluster. By default, the installer uses the locale detected by `initdb`. +Specifies the locale for the EPAS cluster. By default, the installer uses the locale detected by `initdb`. `--mode { unattended }` @@ -90,7 +90,7 @@ Specifies the name of a file that contains the installation configuration parame `--prefix installation_dir/as14` -Specifies an installation directory for EDB Postgres Advanced Server. The installer appends a version-specific subdirectory (that is, `as14`) to the specified directory. The default installation directory is: +Specifies an installation directory for EPAS. The installer appends a version-specific subdirectory (that is, `as14`) to the specified directory. The default installation directory is: ```text C:\Program Files\edb\as14 @@ -98,19 +98,19 @@ C:\Program Files\edb\as14 `--serverport port_number` -Specifies a listener port number for EDB Postgres Advanced Server. +Specifies a listener port number for EPAS. -If you're installing EDB Postgres Advanced Server in unattended mode and don't specify a value using the `--serverport` parameter, the installer uses port `5444` or the first available port after port `5444` as the default listener port. +If you're installing EPAS in unattended mode and don't specify a value using the `--serverport` parameter, the installer uses port `5444` or the first available port after port `5444` as the default listener port. `--server_utilization {33 | 66 | 100}` -Specifies a value for the `edb_dynatune` configuration parameter. The `edb_dynatune` configuration parameter determines how EDB Postgres Advanced Server allocates system resources. +Specifies a value for the `edb_dynatune` configuration parameter. The `edb_dynatune` configuration parameter determines how EPAS allocates system resources. - A value of `33` is appropriate for a system used for development. A low value dedicates the least amount of the host machine’s resources to the database server. - A value of `66` is appropriate for an application server with a fixed number of applications. A midrange value dedicates a moderate amount of system resources to the database server. The default value is 66. -- A value of `100` is appropriate for a host machine that's dedicated to running EDB Postgres Advanced Server. A high value dedicates most of the system resources to the database server. +- A value of `100` is appropriate for a host machine that's dedicated to running EPAS. A high value dedicates most of the system resources to the database server. -When the installation is complete, you can adjust the value of `edb_dynatune` by editing the `postgresql.conf` file, located in the `data` directory of your EDB Postgres Advanced Server installation. After editing the `postgresql.conf` file, you must restart the server for the changes to take effect. +When the installation is complete, you can adjust the value of `edb_dynatune` by editing the `postgresql.conf` file, located in the `data` directory of your EPAS installation. After editing the `postgresql.conf` file, you must restart the server for the changes to take effect. `--serviceaccount user_account_name` @@ -121,14 +121,14 @@ Specifies the name of the user account that owns the server process. For security reasons, the `--serviceaccount` parameter must specify the name of an account that doesn't hold administrator privileges. -If you specify both the `--serviceaccount` option and the `--enable_acledit 1` option when invoking the installer, the database service and pgAgent uses the same service account. They therefore have the required permissions to access the EDB Postgres Advanced Server binaries and `data` directory. +If you specify both the `--serviceaccount` option and the `--enable_acledit 1` option when invoking the installer, the database service and pgAgent uses the same service account. They therefore have the required permissions to access the EPAS binaries and `data` directory. !!! Note If you don't include the `--serviceaccount` option when invoking the installer, the `NetworkService` account owns the database service, and the pgAgent service is owned by either `enterprisedb` or `postgres` (depending on the installation mode). `--servicename service_name` -Specifies the name of the EDB Postgres Advanced Server service. The default is `edb-as-14`. +Specifies the name of the EPAS service. The default is `edb-as-14`. `--servicepassword user_password` @@ -149,7 +149,7 @@ Specifies the database superuser password. If you're installing in non-interacti Specifies installer behavior during an unattended installation. -Include `--unattendedmodeui none` to specify for the installer not to display progress bars during the EDB Postgres Advanced Server installation. +Include `--unattendedmodeui none` to specify for the installer not to display progress bars during the EPAS installation. Include `--unattendedmodeui minimal` to specify for the installer to display progress bars during the installation process. This is the default behavior. @@ -163,11 +163,11 @@ Retrieves version information about the installer. Specifies an initial value for the `edb_dynatune_profile` configuration parameter. `edb_dynatune_profile` controls aspects of performance-tuning based on the type of work that the server performs. -- Specify `oltp` if the EDB Postgres Advanced Server installation is used to support heavy online transaction processing workloads. +- Specify `oltp` if the EPAS installation is used to support heavy online transaction processing workloads. - The default value is `oltp`. -- Specify `mixed` if EDB Postgres Advanced Server provides a mix of transaction processing and data reporting. -- Specify `reporting` if EDB Postgres Advanced Server is used for heavy data reporting. +- Specify `mixed` if EPAS provides a mix of transaction processing and data reporting. +- Specify `reporting` if EPAS is used for heavy data reporting. -After the installation is complete, you can adjust the value of `edb_dynatune_profile` by editing the `postgresql.conf` file, located in the `data` directory of your EDB Postgres Advanced Server installation. After editing the `postgresql.conf` file, you must restart the server for the changes to take effect. +After the installation is complete, you can adjust the value of `edb_dynatune_profile` by editing the `postgresql.conf` file, located in the `data` directory of your EPAS installation. After editing the `postgresql.conf` file, you must restart the server for the changes to take effect. For more information about `edb_dynatune` and other performance-related topics, see [Managing performance](../../../../managing_performance/). diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx index dc7cfe3e8fe..3188d11db3e 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx @@ -7,12 +7,12 @@ redirects: -A graphical installation is a quick and easy way to install EDB Postgres Advanced Server 15 on a Windows system. Use the wizard's dialogs to specify information about your system and system usage; when you have completed the dialogs, the installer performs an installation based on the selections made during the setup process. +A graphical installation is a quick and easy way to install EDB Postgres Advanced Server (EPAS) on a Windows system. Use the wizard's dialogs to specify information about your system and system usage; when you have completed the dialogs, the installer performs an installation based on the selections made during the setup process. To invoke the wizard, you must have administrator privileges. Assume administrator privileges, and double-click the `edb-as15-server-15.x.x-x-windows-x64` executable file. !!! Note - To install EDB Postgres Advanced Server on some versions of Windows, you may be required to right click on the file icon and select `Run as Administrator` from the context menu to invoke the installer with `Administrator` privileges. + To install EPAS on some versions of Windows, you may be required to right click on the file icon and select `Run as Administrator` from the context menu to invoke the installer with `Administrator` privileges. ![The EDB Postgres Advanced Server installer Welcome window](../../../images/advanced_server_installer_welcome.png) @@ -34,7 +34,7 @@ The `Installation Directory` window opens.
Fig. 3: The Installation Directory window
-By default, the EDB Postgres Advanced Server installation directory is: +By default, the EPAS installation directory is: ```text C:\Program Files\edb\as15 @@ -49,17 +49,17 @@ You can accept the default installation location, and click `Next` to continue,
Fig. 4: The Select Components window
-The `Select Components` window contains a list of optional components that you can install with the EDB Postgres Advanced Server `Setup` wizard. You can omit a module from the EDB Postgres Advanced Server installation by deselecting the box next to the components name. +The `Select Components` window contains a list of optional components that you can install with the EPAS `Setup` wizard. You can omit a module from the EPAS installation by deselecting the box next to the components name. -The `Setup` wizard can install the following components while installing EDB Postgres Advanced Server 15: +The `Setup` wizard can install the following components while installing EPAS: **EDB Postgres Advanced Server** -Select the `EDB Postgres Advanced Server` option to install EDB Postgres Advanced Server 15. +Select the `EDB Postgres Advanced Server` option to install EDB Postgres Advanced Server. **StackBuilder Plus** -The `StackBuilder Plus` utility is a graphical tool that can update installed products, or download and add supporting modules (and the resulting dependencies) after your EDB Postgres Advanced Server setup and installation completes. See [Using StackBuilder Plus](using_stackbuilder_plus/) for more information about StackBuilder Plus. +The `StackBuilder Plus` utility is a graphical tool that can update installed products, or download and add supporting modules (and the resulting dependencies) after your EPAS setup and installation completes. See [Using StackBuilder Plus](using_stackbuilder_plus/) for more information about StackBuilder Plus. **Command Line Tools** @@ -82,29 +82,29 @@ After selecting the components you wish to install, click `Next` to open the `Ad
Fig. 5: The Additional Directories window
-By default, the EDB Postgres Advanced Server `data` files are saved to: +By default, the EPAS `data` files are saved to: ```text C:\Program Files\edb\as15\data ``` -The default location of the EDB Postgres Advanced Server `Write-Ahead Log (WAL) Directory` is: +The default location of the EPAS `Write-Ahead Log (WAL) Directory` is: ```text C:\Program Files\edb\as15\data\pg_wal ``` -EDB Postgres Advanced Server uses write-ahead logs to promote transaction safety and speed transaction processing; when you make a change to a table, the change is stored in shared memory and a record of the change is written to the write-ahead log. When you perform a `COMMIT`, EDB Postgres Advanced Server writes contents of the write-ahead log to disk. +EPAS uses write-ahead logs to promote transaction safety and speed transaction processing; when you make a change to a table, the change is stored in shared memory and a record of the change is written to the write-ahead log. When you perform a `COMMIT`, EPAS writes contents of the write-ahead log to disk. -Accept the default file locations, or use the `File Browser` icon to select an alternate location; click `Next` to continue to the `EDB Postgres Advanced Server Dialect` window. +Accept the default file locations, or use the `File Browser` icon to select an alternate location; click `Next` to continue to the `EPAS Dialect` window. ![The EDB Postgres Advanced Server Dialect window](../../../images/advanced_server_dialect.png)
Fig. 6: The EDB Postgres Advanced Server Dialect window
-Use the drop-down listbox on the `EDB Postgres Advanced Server Dialect` window to choose a server dialect. The server dialect specifies the compatibility features supported by EDB Postgres Advanced Server. +Use the drop-down listbox on the `EDB Postgres Advanced Server Dialect` window to choose a server dialect. The server dialect specifies the compatibility features supported by EPAS. -By default, EDB Postgres Advanced Server installs in `Compatible with Oracle` mode; you can choose between `Compatible with Oracle` and `Compatible with PostgreSQL` installation modes. +By default, EPAS installs in `Compatible with Oracle` mode; you can choose between `Compatible with Oracle` and `Compatible with PostgreSQL` installation modes. **Compatible with Oracle** @@ -124,11 +124,11 @@ If you select `Compatible with Oracle`, the installation includes the following | `dbms_lob` | Provides the capability to manage on large objects. | | `dbms_output` | Provides the capability to send messages to a message buffer, or get messages from the message buffer. | | `dbms_pipe` | Provides the capability to send messages through a pipe within or between sessions connected to the same database cluster. | -| `dbms_rls` | Enables the implementation of Virtual Private Database on certain EDB Postgres Advanced Server database objects. | +| `dbms_rls` | Enables the implementation of Virtual Private Database on certain EPAS database objects. | | `dbms_sql` | Provides an application interface to the EDB dynamic SQL functionality. | | `dbms_utility` | Provides various utility programs. | | `dbms_aqadm` | Provides supporting procedures for Advanced Queueing functionality. | -| `dbms_aq` | Provides message queueing and processing for EDB Postgres Advanced Server. | +| `dbms_aq` | Provides message queueing and processing for EPAS. | | `dbms_profiler` | Collects and stores performance information about the PL/pgSQL and SPL statements that are executed during a performance profiling session. | | `dbms_random` | Provides a number of methods to generate random values. | | `dbms_redact` | Enables the redacting or masking of data that is returned by a query. | @@ -145,13 +145,13 @@ If you select `Compatible with Oracle`, the installation includes the following | `utl_url` | Provides a way to escape illegal and reserved characters within an URL. | | `utl_raw` | Provides a way to manipulate or retrieve the length of raw data types. | -This is not a comprehensive list of the compatibility features for Oracle included when EDB Postgres Advanced Server is installed in `Compatible with Oracle` mode. For more information, see the [Database compatibility for Oracle developers built-in package](../../../reference/oracle_compatibility_reference/epas_compat_bip_guide/). +This is not a comprehensive list of the compatibility features for Oracle included when EPAS is installed in `Compatible with Oracle` mode. For more information, see the [Database compatibility for Oracle developers built-in package](../../../reference/oracle_compatibility_reference/epas_compat_bip_guide/). -If you choose to install in `Compatible with Oracle` mode, the EDB Postgres Advanced Server superuser name is `enterprisedb`. +If you choose to install in `Compatible with Oracle` mode, the EPAS superuser name is `enterprisedb`. **Compatible with PostgreSQL** -If you select `Compatible with PostgreSQL`, EDB Postgres Advanced Server exhibits compatibility with PostgreSQL version 15. If you choose to install in `Compatible with PostgreSQL` mode, the default EDB Postgres Advanced Server superuser name is `postgres`. +If you select `Compatible with PostgreSQL`, EPAS exhibits compatibility with PostgreSQL version 15. If you choose to install in `Compatible with PostgreSQL` mode, the default EPAS superuser name is `postgres`. For detailed information about PostgreSQL functionality, visit the official [PostgreSQL website](http://www.postgresql.org). @@ -161,7 +161,7 @@ After specifying a configuration mode, click `Next` to continue to the `Password
Fig. 7: The Password window
-EDB Postgres Advanced Server uses the password specified on the `Password` window for the database superuser. The specified password must conform to any security policies existing on the EDB Postgres Advanced Server host. +EPAS uses the password specified on the `Password` window for the database superuser. The specified password must conform to any security policies existing on the EPAS host. After you enter a password in the `Password` field, confirm the password in the `Retype Password` field, and click `Next` to continue. @@ -173,25 +173,25 @@ The `Additional Configuration` window opens. Use the fields on the `Additional Configuration` window to specify installation details: -- Use the `Port` field to specify the port number that EDB Postgres Advanced Server should listen to for connection requests from client applications. The default is `5444`. -- If the `Locale` field is set to `[Default locale]`, EDB Postgres Advanced Server uses the system locale as the working locale. Use the drop-down listbox next to `Locale` to specify an alternate locale for EDB Postgres Advanced Server. +- Use the `Port` field to specify the port number that EPAS should listen to for connection requests from client applications. The default is `5444`. +- If the `Locale` field is set to `[Default locale]`, EPAS uses the system locale as the working locale. Use the drop-down listbox next to `Locale` to specify an alternate locale for EPAS. - By default, the `Setup` wizard installs corresponding sample data for the server dialect specified by the compatibility mode `(Oracle` or `PostgreSQL)`. Clear the check box next to `Install sample tables and procedures` if you don't wish to have sample data installed. After verifying the information on the `Additional Configuration` window, click `Next` to open the `Dynatune Dynamic Tuning: Server Utilization` window. -The graphical `Setup` wizard facilitates performance tuning via the Dynatune Dynamic Tuning feature. Dynatune functionality allows EDB Postgres Advanced Server to make optimal usage of the system resources available on the host machine on which it is installed. +The graphical `Setup` wizard facilitates performance tuning via the Dynatune Dynamic Tuning feature. Dynatune functionality allows EPAS to make optimal usage of the system resources available on the host machine on which it is installed. ![The Dynatune Dynamic Tuning: Server Utilization window](../../../images/dynatune_dynamic_tuning_server_utilization.png)
Fig. 9: The Dynatune Dynamic Tuning: Server Utilization window
-The `edb_dynatune` configuration parameter determines how EDB Postgres Advanced Server allocates system resources. Use the radio buttons on the `Server Utilization` window to set the initial value of the `edb_dynatune` configuration parameter: +The `edb_dynatune` configuration parameter determines how EPAS allocates system resources. Use the radio buttons on the `Server Utilization` window to set the initial value of the `edb_dynatune` configuration parameter: - Select `Development` to set the value of `edb_dynatune` to `33`. A low value dedicates the least amount of the host machine’s resources to the database server. This is a good choice for a development machine. -- Select `General Purpose` to set the value of `edb_dynatune` to `66`. A mid-range value dedicates a moderate amount of system resources to the database server. This would be a good setting for an application server with a fixed number of applications running on the same host as EDB Postgres Advanced Server. +- Select `General Purpose` to set the value of `edb_dynatune` to `66`. A mid-range value dedicates a moderate amount of system resources to the database server. This would be a good setting for an application server with a fixed number of applications running on the same host as EPAS. - Select `Dedicated` to set the value of `edb_dynatune` to `100`. A high value dedicates most of the system resources to the database server. This is a good choice for a dedicated server host. -After the installation is complete, you can adjust the value of `edb_dynatune` by editing the `postgresql.conf` file, located in the `data` directory of your EDB Postgres Advanced Server installation. After editing the `postgresql.conf` file, you must restart the server for your changes to take effect. +After the installation is complete, you can adjust the value of `edb_dynatune` by editing the `postgresql.conf` file, located in the `data` directory of your EPAS installation. After editing the `postgresql.conf` file, you must restart the server for your changes to take effect. Select the appropriate setting for your system, and click `Next` to continue to the `Dynatune Dynamic Tuning: Workload Profile` window. @@ -201,17 +201,17 @@ Select the appropriate setting for your system, and click `Next` to continue to Use the radio buttons on the `Workload Profile` window to specify the initial value of the `edb_dynatune_profile` configuration parameter. The `edb_dynatune_profile` parameter controls performance-tuning aspects based on the type of work that the server performs. -- Select `Transaction Processing (OLTP systems)` to specify an `edb_dynatune_profile` value of `oltp`. Recommended when EDB Postgres Advanced Server is supporting heavy online transaction processing. +- Select `Transaction Processing (OLTP systems)` to specify an `edb_dynatune_profile` value of `oltp`. Recommended when EPAS is supporting heavy online transaction processing. - Select `General Purpose (OLTP and reporting workloads)` to specify an `edb_dynatune_profile` value of `mixed`. Recommended for servers that provide a mix of transaction processing and data reporting. - Select `Reporting (Complex queries or OLAP workloads)` to specify an `edb_dynatune_profile` value of `reporting`. Recommended for database servers used for heavy data reporting. -After the installation is complete, you can adjust the value of `edb_dynatune_profile` by editing the `postgresql.conf` file, located in the `data` directory of your EDB Postgres Advanced Server installation. After editing the `postgresql.conf` file, you must restart the server for your changes to take effect. +After the installation is complete, you can adjust the value of `edb_dynatune_profile` by editing the `postgresql.conf` file, located in the `data` directory of your EPAS installation. After editing the `postgresql.conf` file, you must restart the server for your changes to take effect. For more information about `edb_dynatune` and other performance-related topics, see the [Dynatune](../../../managing_performance/using_dynatune). Click `Next` to continue. -By default, EDB Postgres Advanced Server is configured to start the service when the system boots. The `Pre Installation Summary` opens. +By default, EPAS is configured to start the service when the system boots. The `Pre Installation Summary` opens. ![The Pre Installation Summary](../../../images/pre_installation_summary.png) @@ -219,7 +219,7 @@ By default, EDB Postgres Advanced Server is configured to start the service when The `Pre Installation Summary` provides an overview of the options specified during the `Setup` process. Review the options before clicking `Next`; click `Back` to navigate back through the dialogs and update any options. -The `Ready to Install` window confirms that the installer has the information it needs about your configuration preferences to install EDB Postgres Advanced Server. Click `Next` to continue. +The `Ready to Install` window confirms that the installer has the information it needs about your configuration preferences to install EPAS. Click `Next` to continue. ![The Ready to Install window](../../../images/ready_to_install.png) @@ -231,12 +231,12 @@ The `Ready to Install` window confirms that the installer has the information it As each supporting module is unpacked and installed, the module’s installation is confirmed with a progress bar. -Before the `Setup` wizard completes the EDB Postgres Advanced Server installation, it offers to `Launch StackBuilder Plus at exit?` +Before the `Setup` wizard completes the EPAS installation, it offers to `Launch StackBuilder Plus at exit?` ![The Setup wizard offers to Launch StackBuilder Plus at exit](../../../images/setup_wizard.png)
Fig. 14: The Setup wizard offers to Launch StackBuilder Plus at exit
-You can clear the `StackBuilder Plus` check box and click `Finish` to complete the EDB Postgres Advanced Server installation, or accept the default and proceed to StackBuilder Plus. +You can clear the `StackBuilder Plus` check box and click `Finish` to complete the EPAS installation, or accept the default and proceed to StackBuilder Plus. -EDB Postgres StackBuilder Plus is included with the installation of EDB Postgres Advanced Server and its core supporting components. StackBuilder Plus is a graphical tool that can update installed products, or download and add supporting modules (and the resulting dependencies) after your EDB Postgres Advanced Server setup and installation completes. See [Using StackBuilder Plus](using_stackbuilder_plus/) for more information about StackBuilder Plus. +EDB Postgres StackBuilder Plus is included with the installation of EPAS and its core supporting components. StackBuilder Plus is a graphical tool that can update installed products, or download and add supporting modules (and the resulting dependencies) after your EPAS setup and installation completes. See [Using StackBuilder Plus](using_stackbuilder_plus/) for more information about StackBuilder Plus. diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/setting_cluster_preferences.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/setting_cluster_preferences.mdx new file mode 100644 index 00000000000..644a15d627f --- /dev/null +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/setting_cluster_preferences.mdx @@ -0,0 +1,27 @@ +--- +title: "Setting cluster preferences during a graphical installation" +navTitle: "Setting cluster preferences" +--- + +During an installation, the graphical installer invokes the PostgreSQL `initdb` utility to initialize a cluster. If you are using the graphical installer, you can use the `INITDBOPTS` environment variable to specify your `initdb` preferences. Before invoking the graphical installer, set the value of `INITDBOPTS` at the command line, specifying one or more cluster options. For example: + +```text +SET INITDBOPTS= -k -E=UTF-8 +``` + +If you specify values in `INITDBOPTS` that are also provided by the installer (such as the `–D` option, which specifies the installation directory), the value specified in the graphical installer supersedes the value if specified in `INITDBOPTS`. + +For more information about using `initdb` cluster configuration options, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/app-initdb.html). In addition to the cluster configuration options documented in the PostgreSQL core documentation, EPAS supports the following `initdb` options: + +`--no-redwood-compat` + +`--no-redwood-compat` instructs the server to create the cluster in PostgreSQL mode. When the cluster is created in PostgreSQL mode, the name of the database superuser is `postgres` and the name of the default database is `postgres`. A small subset of Advanced Server features compatible with Oracle databases are available with this mode. However, we recommend using Advanced Server in redwood compatibility mode to have access to all its Oracle compatibility features. + +`--redwood-like` + +`--redwood-like` instructs the server to use an escape character (an empty string ('')) following the `LIKE` (or PostgreSQL compatible `ILIKE`) operator in a SQL statement that is compatible with Oracle syntax. + +`--icu-short-form` + +`--icu-short-form` creates a cluster that uses a default ICU (International Components for Unicode) collation for all databases in the cluster. For more information about Unicode collations, see [Basic Unicode collation algorithm concepts](../../../tools_utilities_and_components/application_developer_tools/06_unicode_collation_algorithm). + diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/using_stackbuilder_plus.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/using_stackbuilder_plus.mdx index 798c99b1ec4..c591ba9e9de 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/using_stackbuilder_plus.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/using_stackbuilder_plus.mdx @@ -7,7 +7,7 @@ redirects: -The StackBuilder Plus utility provides a graphical interface that simplifies the process of updating, downloading, and installing modules that complement your EDB Postgres Advanced Server installation. When you install a module with StackBuilder Plus, StackBuilder Plus automatically resolves any software dependencies. +The StackBuilder Plus utility provides a graphical interface that simplifies the process of updating, downloading, and installing modules that complement your EDB Postgres Advanced Server (EPAS) installation. When you install a module with StackBuilder Plus, StackBuilder Plus automatically resolves any software dependencies. You can invoke StackBuilder Plus at any time after the installation has completed by selecting the `StackBuilder Plus` menu option from the `Apps` menu. Enter your system password (if prompted), and the StackBuilder Plus welcome window opens. @@ -15,11 +15,11 @@ You can invoke StackBuilder Plus at any time after the installation has complete
Fig. 19: The StackBuilder Plus welcome window
-Use the drop-down listbox on the welcome window to select your EDB Postgres Advanced Server installation. +Use the drop-down listbox on the welcome window to select your EPAS installation. -StackBuilder Plus requires Internet access; if your installation of EDB Postgres Advanced Server resides behind a firewall (with restricted Internet access), StackBuilder Plus can download program installers through a proxy server. The module provider determines if the module can be accessed through an HTTP proxy or an FTP proxy; currently, all updates are transferred via an HTTP proxy and the FTP proxy information is not used. +StackBuilder Plus requires Internet access; if your installation of EPAS resides behind a firewall (with restricted Internet access), StackBuilder Plus can download program installers through a proxy server. The module provider determines if the module can be accessed through an HTTP proxy or an FTP proxy; currently, all updates are transferred via an HTTP proxy and the FTP proxy information is not used. -If the selected EDB Postgres Advanced Server installation has restricted Internet access, use the `Proxy Servers` on the `Welcome` window to open the `Proxy servers` dialog. +If the selected EPAS installation has restricted Internet access, use the `Proxy Servers` on the `Welcome` window to open the `Proxy servers` dialog. ![The Proxy Servers dialog](../../../images/proxy_servers.png) diff --git a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/configuring_epas.mdx b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/configuring_epas.mdx index db143ecd6cb..444754c586d 100644 --- a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/configuring_epas.mdx +++ b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/configuring_epas.mdx @@ -9,17 +9,17 @@ redirects: - /epas/latest/epas_inst_windows/managing_an_advanced_server_installation/configuring_epas/ --- -You can easily update parameters that determine the behavior of EDB Postgres Advanced Server and supporting components by modifying the following configuration files: +You can easily update parameters that determine the behavior of EDB Postgres Advanced Server (EPAS) and supporting components by modifying the following configuration files: -- The `postgresql.conf` file determines the initial values of EDB Postgres Advanced Server configuration parameters. +- The `postgresql.conf` file determines the initial values of EPAS configuration parameters. - The `pg_hba.conf` file specifies your preferences for network authentication and authorization. -- The `pg_ident.conf` file maps operating system identities (user names) to EDB Postgres Advanced Server identities (roles) when using `ident`-based authentication. +- The `pg_ident.conf` file maps operating system identities (user names) to EPAS identities (roles) when using `ident`-based authentication. -For more information about Modifying the postgresql.conf file and Modifying the pg_hba.conf file, see [Setting parameters](../../../database_administration/01_configuration_parameters/01_setting_new_parameters). +For more information about Modifying the postgresql.conf file and Modifying the pg_hba.conf file, see [Setting parameters](../../../../database_administration/01_configuration_parameters/01_setting_new_parameters). You can use your editor of choice to open a configuration file, or on Windows navigate through the `EDB Postgres` menu to open a file. -![Accessing the configuration files through the Windows system menu](../../../images/accessing_configuration_files.png) +![Accessing the configuration files through the Windows system menu](../../../../images/accessing_configuration_files.png)
Fig. 1: Accessing the configuration files through the Windows system menu
@@ -27,7 +27,7 @@ You can use your editor of choice to open a configuration file, or on Windows na The graphical installer provides a script that simplifies the task of setting environment variables for Windows users. The script sets the environment variables for your current shell session; when your shell session ends, the environment variables are destroyed. You may wish to invoke `pgplus_env.bat` from your system-wide shell startup script, so that environment variables are automatically defined for each shell session. -The `pgplus_env` script is created during the EDB Postgres Advanced Server installation process and reflects the choices made during installation. To invoke the script, open a command line and enter: +The `pgplus_env` script is created during the EPAS installation process and reflects the choices made during installation. To invoke the script, open a command line and enter: ```text C:\Program Files\edb\as14\pgplus_env.bat @@ -64,7 +64,7 @@ PGLOCALEDIR=C:\Program Files\PostgreSQL\14\share\locale ## Connecting to EDB Postgres Advanced Server with edb-psql -`edb-psql` is a command line client application that allows you to execute SQL commands and view the results. To open the `edb-psql` client, the client must be in your search path. The executable resides in the `bin` directory, under your EDB Postgres Advanced Server installation. +`edb-psql` is a command line client application that allows you to execute SQL commands and view the results. To open the `edb-psql` client, the client must be in your search path. The executable resides in the `bin` directory, under your EPAS installation. Use the following command and options to start the `edb-psql` client: @@ -72,7 +72,7 @@ Use the following command and options to start the `edb-psql` client: psql -d edb -U enterprisedb ``` -![Connecting to the server](../../../images/connecting_to_server.png) +![Connecting to the server](../../../../images/connecting_to_server.png)
Fig. 2: Connecting to the server
@@ -92,19 +92,19 @@ pgAdmin 4 provides an interactive graphical interface that you can use to manage The client is distributed with the graphical installer. To open pgAdmin, select pgAdmin4 from the `EDB Postgres` menu. The client opens in your default browser. -![The pgAdmin 4 client Dashboard](../../../images/pgadmin4_client_dashboard.png) +![The pgAdmin 4 client Dashboard](../../../../images/pgadmin4_client_dashboard.png)
Fig. 1: The pgAdmin 4 client Dashboard
-To connect to the EDB Postgres Advanced Server database server, expand the `Servers` node of the `Browser` tree control, and right click on the `EDB Postgres Advanced Server` node. When the context menu opens, select `Connect Server`. The `Connect to Server` dialog opens. +To connect to the EPAS database server, expand the `Servers` node of the `Browser` tree control, and right click on the `EDB Postgres Advanced Server` node. When the context menu opens, select `Connect Server`. The `Connect to Server` dialog opens. -![The Connect to Server dialog](../../../images/connecting_server.png) +![The Connect to Server dialog](../../../../images/connecting_server.png)
Fig. 2: The Connect to Server dialog
Provide the password associated with the database superuser in the `Password` field, and click `OK` to connect. -![Connecting to an EDB Postgres Advanced Server database](../../../images/connecting_to_advanced_server_database.png) +![Connecting to an EDB Postgres Advanced Server database](../../../../images/connecting_to_advanced_server_database.png)
Fig. 3: Connecting to an EDB Postgres Advanced Server database
diff --git a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/controlling_server_startup_behavior_on_windows.mdx b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/controlling_server_startup_behavior_on_windows.mdx index 24ffb90e41a..e1883df33bc 100644 --- a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/controlling_server_startup_behavior_on_windows.mdx +++ b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/controlling_server_startup_behavior_on_windows.mdx @@ -7,9 +7,9 @@ redirects: You can use the Windows Services utility to control the startup behavior of the server. Right click on the name of the service you wish to update, and select `Properties` from the context menu to open the `Properties` dialog. -Use the drop-down listbox in the `Startup type` field to specify how the EDB Postgres Advanced Server service behaves when the host starts. +Use the drop-down listbox in the `Startup type` field to specify how the EDB Postgres Advanced Server (EPAS) service behaves when the host starts. -![Specifying EDB Postgres Advanced Server's startup behavior](../../../images/advanced_server_startup.png) +![Specifying EDB Postgres Advanced Server's startup behavior](../../../../images/advanced_server_startup.png)
Fig. 2: Specifying EDB Postgres Advanced Server's startup behavior
diff --git a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/index.mdx b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/index.mdx index 952a630c2d0..30d742ec66a 100644 --- a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/index.mdx +++ b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/index.mdx @@ -4,32 +4,18 @@ navTitle: "Managing installations" redirects: - /epas/latest/epas_inst_windows/managing_an_advanced_server_installation/ navigation: - +- starting_and_stopping_epas - using_the_windows_services_applet - using_pg_ctl_to_control_advanced_server - controlling_server_startup_behavior_on_windows - configuring_epas +indexCards: simple --- Unless otherwise noted, the commands and paths noted in the following section assume that you have performed an installation with the interactive installer. -## Starting and stopping EDB Postgres Advanced Server and supporting components - -A service is a program that runs in the background and requires no user interaction (in fact, a service provides no user interface); a service can be configured to start at boot time, or manually on demand. Services are best controlled using the platform-specific operating system service control utility. Many of the EDB Postgres Advanced Server supporting components are services. - -The following table lists the names of the services that control EDB Postgres Advanced Server and services that control EDB Postgres Advanced Server supporting components: - -| EDB Postgres Advanced Server component name | Windows service name | -| ------------------------------ | ------------------------------------------------ | -| EDB Postgres Advanced Server | edb-as-14 | -| pgAgent | EDB Postgres Advanced Server Scheduling Agent | -| PgBouncer | edb-pgbouncer-1.14 | -| Slony | edb-slony-replication-14 | - -You can use the command line or the Windows Services applet to control EDB Postgres Advanced Server's database server and the services of EDB Postgres Advanced Server's supporting components on a Windows host. -
using_the_windows_services_applet using_pg_ctl_to_control_advanced_server controlling_server_startup_behavior_on_windows diff --git a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/starting_and_stopping_epas.mdx b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/starting_and_stopping_epas.mdx new file mode 100644 index 00000000000..a4ac43ce363 --- /dev/null +++ b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/starting_and_stopping_epas.mdx @@ -0,0 +1,17 @@ +--- +title: "Starting and stopping EDB Postgres Advanced Server" +navTitle: "Starting and stopping EPAS" +--- + +A service is a program that runs in the background and requires no user interaction (in fact, a service provides no user interface); a service can be configured to start at boot time, or manually on demand. Services are best controlled using the platform-specific operating system service control utility. Many of the EDB Postgres Advanced Server (EPAS) supporting components are services. + +The following table lists the names of the services that control EPAS and services that control EPAS supporting components: + +| EPAS component name | Windows service name | +| ------------------------------ | ------------------------------------------------ | +| EDB Postgres Advanced Server | edb-as-14 | +| pgAgent | EDB Postgres Advanced Server Scheduling Agent | +| PgBouncer | edb-pgbouncer-1.14 | +| Slony | edb-slony-replication-14 | + +You can use the command line or the Windows Services applet to control EPAS's database server and the services of EPAS's supporting components on a Windows host. diff --git a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_pg_ctl_to_control_advanced_server.mdx b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_pg_ctl_to_control_advanced_server.mdx index 58124318575..f3841544986 100644 --- a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_pg_ctl_to_control_advanced_server.mdx +++ b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_pg_ctl_to_control_advanced_server.mdx @@ -7,7 +7,7 @@ redirects: -You can use the `pg_ctl` utility to control an EDB Postgres Advanced Server service from the command line on any platform. `pg_ctl` allows you to start, stop, or restart the EDB Postgres Advanced Server database server, reload the configuration parameters, or display the status of a running server. To invoke the utility, assume the identity of the cluster owner, navigate into the home directory of EDB Postgres Advanced Server, and issue the command: +You can use the `pg_ctl` utility to control an EDB Postgres Advanced Server (EPAS) service from the command line on any platform. `pg_ctl` allows you to start, stop, or restart the EPAS database server, reload the configuration parameters, or display the status of a running server. To invoke the utility, assume the identity of the cluster owner, navigate into the home directory of EPAS, and issue the command: ```text ./bin/pg_ctl -D data_directory action @@ -15,7 +15,7 @@ You can use the `pg_ctl` utility to control an EDB Postgres Advanced Server serv `data_directory` -`data_directory` is the location of the data controlled by the EDB Postgres Advanced Server cluster. +`data_directory` is the location of the data controlled by the EPAS cluster. `action` diff --git a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_the_windows_services_applet.mdx b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_the_windows_services_applet.mdx index 50e98daf732..d3ef4b30ef6 100644 --- a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_the_windows_services_applet.mdx +++ b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_the_windows_services_applet.mdx @@ -7,15 +7,15 @@ redirects: -The Windows operating system includes a graphical service controller that offers control of EDB Postgres Advanced Server and the services associated with EDB Postgres Advanced Server components. The `Services` utility can be accessed through the `Administrative Tools` section of the Windows `Control Panel`. +The Windows operating system includes a graphical service controller that offers control of EDB Postgres Advanced Server (EPAS) and the services associated with EPAS components. The `Services` utility can be accessed through the `Administrative Tools` section of the Windows `Control Panel`. -![The EDB Postgres Advanced Server service in the Windows Services window](../../../images/advanced_server_services.png) +![The EDB Postgres Advanced Server service in the Windows Services window](../../../../images/advanced_server_services.png)
Fig. 1: The EDB Postgres Advanced Server service in the Windows Services window
-The `Services` window displays an alphabetized list of services; the `edb-as-14` service controls EDB Postgres Advanced Server. +The `Services` window displays an alphabetized list of services; the `edb-as-14` service controls EPAS. -- Use the `Stop the service` option to stop the instance of EDB Postgres Advanced Server. Any user (or client application) connected to the EDB Postgres Advanced Server instance is abruptly disconnected if you stop the service. -- Use the `Start the service` option to start the EDB Postgres Advanced Server service. -- Use the `Pause the service` option to tell EDB Postgres Advanced Server to reload the server configuration parameters without disrupting user sessions for many of the configuration parameters. See [Configuring EDB Postgres Advanced Server](configuring_epas/) for more information about the parameters that can be updated with a server reload. -- Use the `Restart the service` option to stop and then start the EDB Postgres Advanced Server. Any user sessions are terminated when you stop the service. This option is useful to reset server parameters that only take effect on server start. +- Use the `Stop the service` option to stop the instance of EPAS. Any user (or client application) connected to the EPAS instance is abruptly disconnected if you stop the service. +- Use the `Start the service` option to start the EPAS service. +- Use the `Pause the service` option to tell EPAS to reload the server configuration parameters without disrupting user sessions for many of the configuration parameters. See [Configuring EPAS](configuring_epas/) for more information about the parameters that can be updated with a server reload. +- Use the `Restart the service` option to stop and then start the EPAS. Any user sessions are terminated when you stop the service. This option is useful to reset server parameters that only take effect on server start. diff --git a/product_docs/docs/epas/15/upgrading/03_limitations.mdx b/product_docs/docs/epas/15/upgrading/03_limitations.mdx index e3e42f4d636..8f3416cf1d9 100644 --- a/product_docs/docs/epas/15/upgrading/03_limitations.mdx +++ b/product_docs/docs/epas/15/upgrading/03_limitations.mdx @@ -5,13 +5,13 @@ redirects: - /epas/latest/epas_upgrade_guide/03_limitations/ --- -The `pg_upgrade` executable is distributed with EDB Postgres Advanced Server and is installed as part of the Database Server component. You don't need to further install or configure it. The `pg_upgrade` utility performs an in-place transfer of existing data between EDB Postgres Advanced Server and any later version. +The `pg_upgrade` executable is distributed with EDB Postgres Advanced Server (EPAS) and is installed as part of the Database Server component. You don't need to further install or configure it. The `pg_upgrade` utility performs an in-place transfer of existing data between EPAS and any later version. Several factors determine if an in-place upgrade is practical: - The on-disk representation of user-defined tables must not change between the original version and the upgraded version. - The on-disk representation of data types must not change between the original version and the upgraded version. -- To upgrade between major versions of EDB Postgres Advanced Server with `pg_upgrade`, both versions must share a common binary representation for each data type. Therefore, you can't use `pg_upgrade` to migrate from a 32-bit to a 64-bit Linux platform. +- To upgrade between major versions of EPAS with `pg_upgrade`, both versions must share a common binary representation for each data type. Therefore, you can't use `pg_upgrade` to migrate from a 32-bit to a 64-bit Linux platform. Before performing a version upgrade, `pg_upgrade` verifies that the old cluster and the new cluster are compatible. @@ -22,13 +22,13 @@ If the upgrade involves a change in the on-disk representation of database objec 1. Run `initdb` to create a new cluster. 1. Import your old data. -Consider the following when upgrading EDB Postgres Advanced Server: +Consider the following when upgrading EPAS: - The `pg_upgrade` utility can't upgrade a partitioned table if a foreign key refers to the partitioned table. -- If you're upgrading from the **version 9.4 server or a lower version** of EDB Postgres Advanced Server, and you use partitioned tables that include a `SUBPARTITION BY` clause, you must use `pg_dump` and `pg_restore` to upgrade an existing EDB Postgres Advanced Server installation to a later version of EDB Postgres Advanced Server. To upgrade, you must: +- If you're upgrading from the **version 9.4 server or a lower version** of EPAS, and you use partitioned tables that include a `SUBPARTITION BY` clause, you must use `pg_dump` and `pg_restore` to upgrade an existing EPAS installation to a later version of EPAS. To upgrade, you must: 1. Use `pg_dump` to preserve the content of the subpartitioned table. - 2. Drop the table from the EDB Postgres Advanced Server 9.4 database or a lower version of EDB Postgres Advanced Server database. - 3. Use `pg_upgrade` to upgrade the rest of the EDB Postgres Advanced Server database to a more recent version. - 4. Use `pg_restore` to restore the subpartitioned table to the latest upgraded EDB Postgres Advanced Server database. -- If you perform an upgrade of the EDB Postgres Advanced Server installation, you must rebuild any hash-partitioned table on the upgraded server. -- If you're using an ODBC, JDBC, OCI, or .NET driver to connect to your database applications and upgrading to a new major version of EDB Postgres Advanced Server, upgrade your driver to the latest version when upgrading EDB Postgres Advanced Server. + 2. Drop the table from the EPAS 9.4 database or a lower version of EPAS database. + 3. Use `pg_upgrade` to upgrade the rest of the EPAS database to a more recent version. + 4. Use `pg_restore` to restore the subpartitioned table to the latest upgraded EPAS database. +- If you perform an upgrade of the EPAS installation, you must rebuild any hash-partitioned table on the upgraded server. +- If you're using an ODBC, JDBC, OCI, or .NET driver to connect to your database applications and upgrading to a new major version of EPAS, upgrade your driver to the latest version when upgrading EPAS. diff --git a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/01_performing_an_upgrade/index.mdx b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/01_performing_an_upgrade/index.mdx index 345b2ab8efd..5f368ced324 100644 --- a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/01_performing_an_upgrade/index.mdx +++ b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/01_performing_an_upgrade/index.mdx @@ -5,23 +5,23 @@ redirects: - /epas/latest/epas_upgrade_guide/04_upgrading_an_installation_with_pg_upgrade/01_performing_an_upgrade/ --- -To upgrade an earlier version of EDB Postgres Advanced Server to the current version: +To upgrade an earlier version of EDB Postgres Advanced Server (EPAS) to the current version: -1. Install the current version of EDB Postgres Advanced Server. The new installation must contain the same supporting server components as the old installation. +1. Install the current version of EPAS. The new installation must contain the same supporting server components as the old installation. 1. Empty the target database or create a new target cluster with `initdb`. 1. To avoid authentication conflicts, place the `pg_hba.conf` file for both databases in `trust` authentication mode. -1. Shut down the old and new EDB Postgres Advanced Server services. +1. Shut down the old and new EPAS services. 1. Invoke the `pg_upgrade` utility. When `pg_upgrade` starts, it performs a compatibility check to ensure that all required executables are present and contain the expected version numbers. The verification process also checks the old and new `$PGDATA` directories to ensure that the expected files and subdirectories are in place. If the verification process succeeds, `pg_upgrade` starts the old `postmaster` and runs `pg_dumpall --schema-only` to capture the metadata contained in the old cluster. The script produced by `pg_dumpall` is used in later to re-create all user-defined objects in the new cluster. -The script produced by `pg_dumpall` re-creates only user-defined objects and not system-defined objects. The new cluster already contains the system-defined objects created by the latest version of EDB Postgres Advanced Server. +The script produced by `pg_dumpall` re-creates only user-defined objects and not system-defined objects. The new cluster already contains the system-defined objects created by the latest version of EPAS. After extracting the metadata from the old cluster, `pg_upgrade` performs the bookkeeping tasks required to sync the new cluster with the existing data. `pg_upgrade` runs the `pg_dumpall` script against the new cluster to create empty database objects of the same shape and type as those found in the old cluster. Then, `pg_upgrade` links or copies each table and index from the old cluster to the new cluster. -If you're upgrading to EDB Postgres Advanced Server and installed the `edb_dblink_oci` or `edb_dblink_libpq` extension, drop the extension before performing an upgrade. To drop the extension, connect to the server with the psql or PEM client, and invoke the commands: +If you're upgrading to EPAS and installed the `edb_dblink_oci` or `edb_dblink_libpq` extension, drop the extension before performing an upgrade. To drop the extension, connect to the server with the psql or PEM client, and invoke the commands: ```sql DROP EXTENSION edb_dblink_oci; diff --git a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/02_invoking_pg_upgrade/01_command_line_options_reference.mdx b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/02_invoking_pg_upgrade/01_command_line_options_reference.mdx index adb0e2d782a..478743ec329 100644 --- a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/02_invoking_pg_upgrade/01_command_line_options_reference.mdx +++ b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/02_invoking_pg_upgrade/01_command_line_options_reference.mdx @@ -56,15 +56,15 @@ Use the `-O` or `--new-options` keyword to specify options to pass to the new `p `-p old_port_number` `--old-port old_port_number` -Include the `-p` or `--old-port` keyword to specify the port number of the EDB Postgres Advanced Server installation that you're upgrading. +Include the `-p` or `--old-port` keyword to specify the port number of the EDB Postgres Advanced Server (EPAS) installation that you're upgrading. `-P new_port_number` `--new-port new_port_number` -Include the `-P` or `--new-port` keyword to specify the port number of the new EDB Postgres Advanced Server installation. +Include the `-P` or `--new-port` keyword to specify the port number of the new EPAS installation. !!! Note - If the original EDB Postgres Advanced Server installation is using port number `5444` when you invoke the EDB Postgres Advanced Server installer, the installer recommends using listener port `5445` for the new installation of EDB Postgres Advanced Server. + If the original EPAS installation is using port number `5444` when you invoke the EPAS installer, the installer recommends using listener port `5445` for the new installation of EPAS. `-r` `--retain` @@ -74,7 +74,7 @@ During the upgrade process, `pg_upgrade` creates four append-only log files. Whe `-U user_name` `--username user_name` -Include the `-U` or `--username` keyword to specify the name of the EDB Postgres Advanced Server database superuser. The same superuser must exist in both clusters. +Include the `-U` or `--username` keyword to specify the name of the EPAS database superuser. The same superuser must exist in both clusters. `-v` `--verbose` diff --git a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/03_upgrading_to_advanced_server.mdx b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/03_upgrading_to_advanced_server.mdx index b5f8837ab8e..ab6cd3b2429 100644 --- a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/03_upgrading_to_advanced_server.mdx +++ b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/03_upgrading_to_advanced_server.mdx @@ -1,25 +1,25 @@ --- -title: "Upgrading to EDB Postgres Advanced Server 15" +title: "Upgrading to EDB Postgres Advanced Server" description: "Describes how to upgrade into a cluster" redirects: - /epas/latest/epas_upgrade_guide/04_upgrading_an_installation_with_pg_upgrade/03_upgrading_to_advanced_server/ --- -You can use `pg_upgrade` to upgrade from an existing installation of EDB Postgres Advanced Server into the cluster built by the EDB Postgres Advanced Server installer or into an alternative cluster created using the `initdb` command. +You can use `pg_upgrade` to upgrade from an existing installation of EDB Postgres Advanced Server (EPAS) into the cluster built by the EPAS installer or into an alternative cluster created using the `initdb` command. -The basic steps to perform an upgrade into an empty cluster created with the `initdb` command are the same as the steps to upgrade into the cluster created by the EDB Postgres Advanced Server installer. However, you can omit Step 2 - Empty the edb database and substitute the location of the alternative cluster when specifying a target cluster for the upgrade. +The basic steps to perform an upgrade into an empty cluster created with the `initdb` command are the same as the steps to upgrade into the cluster created by the EPAS installer. However, you can omit Step 2 - Empty the edb database and substitute the location of the alternative cluster when specifying a target cluster for the upgrade. If a problem occurs during the upgrade process, you can revert to the previous version. See [Reverting to the old cluster](06_reverting_to_the_old_cluster/#reverting_to_the_old_cluster) for detailed information about this process. -You must be an operating system superuser or Windows Administrator to perform an EDB Postgres Advanced Server upgrade. +You must be an operating system superuser or Windows Administrator to perform an EPAS upgrade. ## Step 1 - Install the new server -Install EDB Postgres Advanced Server 15, specifying the same non-server components that were installed during the previous EDB Postgres Advanced Server installation. The new cluster and the old cluster must reside in different directories. +Install the new version of EDB Postgres Advanced Server, specifying the same non-server components that were installed during the previous EPAS installation. The new cluster and the old cluster must reside in different directories. ## Step 2 - Empty the target database -The target cluster must not contain any data. You can create an empty cluster using the `initdb` command, or you can empty a database that was created during the installation of EDB Postgres Advanced Server. If you installed EDB Postgres Advanced Server in PostgreSQL mode, the installer creates a single database named `postgres`. Installing EDB Postgres Advanced Server in Oracle mode creates a database named `postgres` and a database named `edb`. +The target cluster must not contain any data. You can create an empty cluster using the `initdb` command, or you can empty a database that was created during the installation of EPAS. If you installed EPAS in PostgreSQL mode, the installer creates a single database named `postgres`. Installing EPAS in Oracle mode creates a database named `postgres` and a database named `edb`. The easiest way to empty the target database is to drop the database and then create a new database. Before invoking the `DROP DATABASE` command, you must disconnect any users and halt any services that are currently using the database. @@ -31,7 +31,7 @@ On Linux, open a terminal window, assume superuser privileges, and manually stop service edb-pgagent-14 stop ``` -After stopping any services that are currently connected to EDB Postgres Advanced Server, you can use the EDB-PSQL command line client to drop and create a database. When the client opens, connect to the `template1` database as the database superuser. If prompted, provide authentication information. Then, use the following command to drop your database: +After stopping any services that are currently connected to EPAS, you can use the EDB-PSQL command line client to drop and create a database. When the client opens, connect to the `template1` database as the database superuser. If prompted, provide authentication information. Then, use the following command to drop your database: ```sql DROP DATABASE ; @@ -49,9 +49,9 @@ CREATE DATABASE ; During the upgrade process, `pg_upgrade` connects to the old and new servers several times. To make the connection process easier, you can edit the `pg_hba.conf` file, setting the authentication mode to `trust`. To modify the `pg_hba.conf` file, from the Start menu, select **EDB Postgres > EDB Postgres Advanced Server > Expert Configuration**. Select **Edit pg_hba.conf** to open the `pg_hba.conf` file. -You must allow trust authentication for the previous EDB Postgres Advanced Server installation and EDB Postgres Advanced Server servers. Edit the `pg_hba.conf` file for both installations of EDB Postgres Advanced Server as shown in the figure. +You must allow trust authentication for the previous EPAS installation and EPAS servers. Edit the `pg_hba.conf` file for both installations of EPAS as shown in the figure. -![Configuring EDB Postgres Advanced Server to use trust authentication.](../../images/configuring_advanced_server_to_use_trust_authentication.png) +![Configuring EDB Postgres Advanced Server to use trust authentication.](../../../images/configuring_advanced_server_to_use_trust_authentication.png) After editing each file, save the file, and exit the editor. @@ -59,7 +59,7 @@ If the system is required to maintain `md5` authentication mode during the upgra ## Step 4 - Stop all component services and servers -Before you invoke `pg_upgrade`, you must stop any services that belong to the original EDB Postgres Advanced Server installation, EDB Postgres Advanced Server, or the supporting components. Stopping these services ensures that a service doesn't attempt to access either cluster during the upgrade process. +Before you invoke `pg_upgrade`, you must stop any services that belong to the original EPAS installation, EPAS, or the supporting components. Stopping these services ensures that a service doesn't attempt to access either cluster during the upgrade process. The services in the table are most likely to be running in your installation. @@ -100,13 +100,13 @@ Open a terminal window and manually stop each service at the command line. ## Step 5 for Linux only - Assume the identity of the cluster owner -If you're using Linux, assume the identity of the EDB Postgres Advanced Server cluster owner. This example assumes EDB Postgres Advanced Server was installed in the default, compatibility-with-Oracle database mode, assigning `enterprisedb` as the cluster owner. (If installed in compatibility-with-PostgreSQL database mode, `postgres` is the cluster owner.) +If you're using Linux, assume the identity of the EPAS cluster owner. This example assumes EPAS was installed in the default, compatibility-with-Oracle database mode, assigning `enterprisedb` as the cluster owner. (If installed in compatibility-with-PostgreSQL database mode, `postgres` is the cluster owner.) ```shell su - enterprisedb ``` -If prompted, enter the EDB Postgres Advanced Server cluster owner password. Then, set the path to include the location of the `pg_upgrade` executable: +If prompted, enter the EPAS cluster owner password. Then, set the path to include the location of the `pg_upgrade` executable: ```shell export PATH=$PATH:/usr/edb/as14/bin @@ -120,9 +120,9 @@ cd /tmp ## Step 5 for Windows only - Assume the identity of the cluster owner -If you're using Windows, open a terminal window, assume the identity of the EDB Postgres Advanced Server cluster owner, and set the path to the `pg_upgrade` executable. +If you're using Windows, open a terminal window, assume the identity of the EPAS cluster owner, and set the path to the `pg_upgrade` executable. -If the `--serviceaccount service_account_user` parameter was specified during the initial installation of EDB Postgres Advanced Server, then `service_account_user` is the EDB Postgres Advanced Server cluster owner. In that case, give this user with the `RUNAS` command: +If the `--serviceaccount service_account_user` parameter was specified during the initial installation of EPAS, then `service_account_user` is the EPAS cluster owner. In that case, give this user with the `RUNAS` command: ```sql RUNAS /USER:service_account_user "CMD.EXE" @@ -135,7 +135,7 @@ During the upgrade process, `pg_upgrade` writes a file to the current working di cd %TEMP% ``` -If you omitted the `--serviceaccount` parameter during the initial installation of EDB Postgres Advanced Server, then the default owner of the EDB Postgres Advanced Server service and the database cluster is `NT AUTHORITY\NetworkService`. +If you omitted the `--serviceaccount` parameter during the initial installation of EPAS, then the default owner of the EPAS service and the database cluster is `NT AUTHORITY\NetworkService`. When `NT AUTHORITY\NetworkService` is the service account user, the `RUNAS` command might not be usable. It prompts for a password, and the `NT AUTHORITY\NetworkService` account isn't assigned a password. Thus, there's typically a failure with an error message such as “Unable to acquire user password.” @@ -182,13 +182,13 @@ pg_upgrade.exe During the consistency checking process, `pg_upgrade` logs any discrepancies that it finds to a file located in the directory from which you invoked `pg_upgrade`. When the consistency check completes, review the file to identify any missing components or upgrade conflicts. Resolve any conflicts before invoking `pg_upgrade` to perform a version upgrade. -If `pg_upgrade` alerts you to a missing component, you can use StackBuilder Plus to add the component that contains the component. Before using StackBuilder Plus, restart the EDB Postgres Advanced Server service. Then, open StackBuilder Plus by selecting from the Start menu **EDB Postgres Advanced Server 15 > StackBuilder Plus**. Follow the onscreen advice of the StackBuilder Plus wizard to download and install the missing components. +If `pg_upgrade` alerts you to a missing component, you can use StackBuilder Plus to add the component that contains the component. Before using StackBuilder Plus, restart the EDB Postgres Advanced Server service. Then, open StackBuilder Plus by selecting from the Start menu **EDB Postgres Advanced Server *version* > StackBuilder Plus**. Follow the onscreen advice of the StackBuilder Plus wizard to download and install the missing components. After `pg_upgrade` confirms that the clusters are compatible, you can perform a version upgrade. ## Step 7 - Run pg_upgrade -After confirming that the clusters are compatible, you can invoke `pg_upgrade` to upgrade the old cluster to the new version of EDB Postgres Advanced Server. +After confirming that the clusters are compatible, you can invoke `pg_upgrade` to upgrade the old cluster to the new version of EPAS. On Linux: diff --git a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/04_upgrading_a_pgAgent_installation.mdx b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/04_upgrading_a_pgAgent_installation.mdx index 04f08483afb..2e79b5755df 100644 --- a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/04_upgrading_a_pgAgent_installation.mdx +++ b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/04_upgrading_a_pgAgent_installation.mdx @@ -5,7 +5,7 @@ redirects: - /epas/latest/epas_upgrade_guide/04_upgrading_an_installation_with_pg_upgrade/04_upgrading_a_pgAgent_installation/ --- -If your existing EDB Postgres Advanced Server installation uses pgAgent, you can use a script provided with the EDB Postgres Advanced Server installer to update pgAgent. The script is named `dbms_job.upgrade.script.sql` and is located in the `/share/contrib/` directory under your EDB Postgres Advanced Server installation. +If your existing EDB Postgres Advanced Server (EPAS) installation uses pgAgent, you can use a script provided with the EPAS installer to update pgAgent. The script is named `dbms_job.upgrade.script.sql` and is located in the `/share/contrib/` directory under your EPAS installation. If you're using `pg_upgrade` to upgrade your installation: diff --git a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/05_pg_upgrade_troubleshooting.mdx b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/05_pg_upgrade_troubleshooting.mdx index bc0848f006c..86cca251c5c 100644 --- a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/05_pg_upgrade_troubleshooting.mdx +++ b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/05_pg_upgrade_troubleshooting.mdx @@ -9,7 +9,7 @@ These troubleshooting tips address problems you might encounter when using `pg_u ## Upgrade Error - There seems to be a postmaster servicing the cluster -If `pg_upgrade` reports that a postmaster is servicing the cluster, stop all EDB Postgres Advanced Server services and try the upgrade again. +If `pg_upgrade` reports that a postmaster is servicing the cluster, stop all EDB Postgres Advanced Server (EPAS) services and try the upgrade again. ## Upgrade Error - fe_sendauth: no password supplied @@ -21,7 +21,7 @@ If `pg_upgrade` reports that the new cluster isn't empty, empty the new cluster. ## Upgrade Error - Failed to load library -If the original EDB Postgres Advanced Server cluster included libraries that aren't included in the EDB Postgres Advanced Server cluster, `pg_upgrade` alerts you to the missing component during the consistency check by writing an entry to the `loadable_libraries.txt` file in the directory from which you invoked `pg_upgrade`. Generally, for missing libraries that aren't part of a major component upgrade: +If the original EPAS cluster included libraries that aren't included in the EPAS cluster, `pg_upgrade` alerts you to the missing component during the consistency check by writing an entry to the `loadable_libraries.txt` file in the directory from which you invoked `pg_upgrade`. Generally, for missing libraries that aren't part of a major component upgrade: 1. Restart the EDB Postgres Advanced Server service. diff --git a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/how_pg_upgrade_works.mdx b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/how_pg_upgrade_works.mdx index c2e74ab7d77..3f12ce949ef 100644 --- a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/how_pg_upgrade_works.mdx +++ b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/how_pg_upgrade_works.mdx @@ -3,21 +3,21 @@ title: "How pg_upgrade works" description: "Describes how the upgrade utility works" --- -The `pg_upgrade` executable is distributed with EDB Postgres Advanced Server and is installed as part of the Database Server component. You don't need to further install or configure it. +The `pg_upgrade` executable is distributed with EDB Postgres Advanced Server (EPAS) and is installed as part of the Database Server component. You don't need to further install or configure it. -The `pg_upgrade` utility performs an in-place transfer of existing data between EDB Postgres Advanced Server and any later version. +The `pg_upgrade` utility performs an in-place transfer of existing data between EPAS and any later version. Before performing a version upgrade, `pg_upgrade` verifies that the old cluster and the new cluster are compatible. When `pg_upgrade` starts, it performs a compatibility check to ensure that all required executables are present and contain the expected version numbers. The verification process also checks the old and new `$PGDATA` directories to ensure that the expected files and subdirectories are in place. If the verification process succeeds, `pg_upgrade` starts the old `postmaster` and runs `pg_dumpall --schema-only` to capture the metadata contained in the old cluster. The script produced by `pg_dumpall` is used in later to re-create all user-defined objects in the new cluster. -The script produced by `pg_dumpall` re-creates only user-defined objects and not system-defined objects. The new cluster already contains the system-defined objects created by the latest version of EDB Postgres Advanced Server. +The script produced by `pg_dumpall` re-creates only user-defined objects and not system-defined objects. The new cluster already contains the system-defined objects created by the latest version of EPAS. After extracting the metadata from the old cluster, `pg_upgrade` performs the bookkeeping tasks required to sync the new cluster with the existing data. `pg_upgrade` runs the `pg_dumpall` script against the new cluster to create empty database objects of the same shape and type as those found in the old cluster. Then, `pg_upgrade` links or copies each table and index from the old cluster to the new cluster. -If you're upgrading to EDB Postgres Advanced Server and installed the `edb_dblink_oci` or `edb_dblink_libpq` extension, drop the extension before performing an upgrade. To drop the extension, connect to the server with the psql or PEM client, and invoke the commands: +If you're upgrading to EPAS and installed the `edb_dblink_oci` or `edb_dblink_libpq` extension, drop the extension before performing an upgrade. To drop the extension, connect to the server with the psql or PEM client, and invoke the commands: ```sql DROP EXTENSION edb_dblink_oci; diff --git a/product_docs/docs/epas/15/upgrading/06_using_stackbuilder_plus_to_perform_a_minor_version_update.mdx b/product_docs/docs/epas/15/upgrading/06_using_stackbuilder_plus_to_perform_a_minor_version_update.mdx index 228bff0b40c..e665c8561fa 100644 --- a/product_docs/docs/epas/15/upgrading/06_using_stackbuilder_plus_to_perform_a_minor_version_update.mdx +++ b/product_docs/docs/epas/15/upgrading/06_using_stackbuilder_plus_to_perform_a_minor_version_update.mdx @@ -8,17 +8,17 @@ redirects: !!! Note StackBuilder Plus is supported only on Windows systems. -The StackBuilder Plus utility provides a graphical interface that simplifies the process of updating, downloading, and installing modules that complement your EDB Postgres Advanced Server installation. When you install a module with StackBuilder Plus, StackBuilder Plus resolves any software dependencies. +The StackBuilder Plus utility provides a graphical interface that simplifies the process of updating, downloading, and installing modules that complement your EDB Postgres Advanced Server (EPAS) installation. When you install a module with StackBuilder Plus, StackBuilder Plus resolves any software dependencies. 1. To invoke StackBuilder Plus at any time after the installation has completed, select **Apps > StackBuilder Plus**. Enter your system password if prompted, and the StackBuilder Plus welcome window opens. ![The StackBuilder Plus welcome window](../images/the_stackBuilder_plus_welcome.png) -1. Select your EDB Postgres Advanced Server installation. +1. Select your EPAS installation. - StackBuilder Plus requires internet access. If your installation of EDB Postgres Advanced Server is behind a firewall (with restricted internet access), StackBuilder Plus can download program installers through a proxy server. The module provider determines if the module can be accessed through an HTTP proxy or an FTP proxy. Currently, all updates are transferred by an HTTP proxy, and the FTP proxy information isn't used. + StackBuilder Plus requires internet access. If your installation of EPAS is behind a firewall (with restricted internet access), StackBuilder Plus can download program installers through a proxy server. The module provider determines if the module can be accessed through an HTTP proxy or an FTP proxy. Currently, all updates are transferred by an HTTP proxy, and the FTP proxy information isn't used. -1. If the selected EDB Postgres Advanced Server installation has restricted Internet access, on the Welcome screen, select **Proxy Servers** to open the Proxy servers dialog box: +1. If the selected EPAS installation has restricted Internet access, on the Welcome screen, select **Proxy Servers** to open the Proxy servers dialog box: ![The Proxy servers dialog](../images/the_proxy_servers_dialog.png) @@ -28,7 +28,7 @@ The StackBuilder Plus utility provides a graphical interface that simplifies the The tree control on the StackBuilder Plus module selection window displays a node for each module category. -1. To add a component to the selected EDB Postgres Advanced Server installation or to upgrade a component, select the box to the left of the module name, and select **Next**. +1. To add a component to the selected EPAS installation or to upgrade a component, select the box to the left of the module name, and select **Next**. 1. If prompted, enter your email address and password on the StackBuilder Plus registration window. diff --git a/product_docs/docs/epas/15/upgrading/index.mdx b/product_docs/docs/epas/15/upgrading/index.mdx index 097888a1cff..29410d20337 100644 --- a/product_docs/docs/epas/15/upgrading/index.mdx +++ b/product_docs/docs/epas/15/upgrading/index.mdx @@ -6,8 +6,8 @@ redirects: - /epas/latest/epas_upgrade_guide/ --- -Upgrading EDB Postgres Advanced Server involves: +Upgrading EDB Postgres Advanced Server (EPAS) involves: -- `pg_upgrade` to upgrade from an earlier version of EDB Postgres Advanced Server to the latest version. +- `pg_upgrade` to upgrade from an earlier version of EPAS to the latest version. - `yum` to perform a minor version upgrade on a Linux host. - `StackBuilder Plus` to perform a minor version upgrade on a Windows host. From f5fc9b437d80562b8a8a09e93a8c3aeea4963b18 Mon Sep 17 00:00:00 2001 From: francoughlin Date: Mon, 31 Jul 2023 16:17:57 -0400 Subject: [PATCH 16/28] Additional restructuring and assorted edits Broke out some content into an additional topic and made assorted edits --- .../linux_install_details/index.mdx | 3 +- ...installing_epas_using_local_repository.mdx | 2 +- .../connecting_to_epas.mdx | 2 + .../starting_and_stopping_services.mdx | 2 + .../linux_install_details/rpm_packages.mdx | 43 ++----------------- .../updating_an_rpm_installation.mdx | 41 ++++++++++++++++++ 6 files changed, 51 insertions(+), 42 deletions(-) create mode 100644 product_docs/docs/epas/15/installing/linux_install_details/updating_an_rpm_installation.mdx diff --git a/product_docs/docs/epas/15/installing/linux_install_details/index.mdx b/product_docs/docs/epas/15/installing/linux_install_details/index.mdx index 49ee67b9d91..5758901d8cb 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/index.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/index.mdx @@ -6,8 +6,9 @@ redirects: navigation: - component_locations - rpm_packages +- updating_an_rpm_installation - installing_epas_using_local_repository - managing_an_advanced_server_installation --- -These additional details apply to Linux installations. +Additional use cases that apply to Linux installations. diff --git a/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx b/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx index 63d35e018c6..3c78b2d366c 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx @@ -7,7 +7,7 @@ redirects: - /epas/latest/epas_inst_linux/installing_epas_using_local_repository/ --- -You can create a local repository to act as a host for the EDB Postgres Advanced Server (EPAS) native packages if the server on which you want to install EPAS or supporting components can't directly access the EDB repository. This is a high-level listing of the steps required. Modify the process for your network. +You can create a local repository to act as a host for the EDB Postgres Advanced Server (EPAS) native packages if the server on which you want to install EPAS or the supporting components can't directly access the EDB repository. This topic is only a high-level listing of the steps required; you will need to modify the process for your network. To create and use a local repository, you must: diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx index 2a3cb9eb61a..cdc88a5a2be 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx @@ -5,6 +5,8 @@ navTitle: "Connecting to EPAS" `edb-psql` is a command line client application that allows you to execute SQL commands and view the results. To open the `edb-psql` client, the client must be in your search path. The executable resides in the `bin` directory under your EDB Postgres Advanced Server (EPAS) installation. +## Starting the client + Use the following command and options to start the `edb-psql` client: ```text diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_and_stopping_services.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_and_stopping_services.mdx index 527427e93f2..07b008d2139 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_and_stopping_services.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_and_stopping_services.mdx @@ -4,6 +4,8 @@ title: "Starting and stopping services" A service is a program that runs in the background and doesn't require user interaction. A service provides no user interface. You can configure a service to start at boot time or manually on demand. Services are best controlled using the platform-specific operating system service control utility. Many of the EDB Postgres Advanced Server (EPAS) supporting components are services. +## List of services + The following table lists the names of the services that control EPAS and services that control EPAS supporting components. | EDB Postgres Advanced Server component name | Linux service Name | Debian service name | diff --git a/product_docs/docs/epas/15/installing/linux_install_details/rpm_packages.mdx b/product_docs/docs/epas/15/installing/linux_install_details/rpm_packages.mdx index e4008ec993f..03659156850 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/rpm_packages.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/rpm_packages.mdx @@ -30,7 +30,8 @@ dnf search Where `package` is the search term that specifies the name (or partial name) of a package. -Note: The available package list is subject to change. +!!! Note + The available package list is subject to change. | Package name | Package installs | | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -163,42 +164,4 @@ apt list edb* | edb-jdbc | Includes the .jar files needed for Java programs to access an EPAS database. | | edb-migrationtoolkit | Installs Migration Toolkit, facilitating migration to an EPAS database from Oracle, PostgreSQL, MySQL, Sybase and SQL Server. | | edb-pgbouncer115 | PgBouncer, a lightweight connection pooler. This package requires the libevent package. | -| edb-efm40 | Installs EDB Failover Manager that adds fault tolerance to database clusters to minimize downtime when a primary database fails by keeping data online in high availability configurations. | - - -### Updating an RPM installation - -If you have an existing EPAS RPM installation, you can use `yum` or `dnf` to upgrade your repository configuration file and update to a more recent product version. To update the `edb.repo` file, assume superuser privileges and enter: - -- On RHEL or CentOS 7: - - ```text - yum upgrade edb-repo - ``` - -- On RHEL or Rocky Linux or AlmaLinux 8: - - ```text - dnf upgrade edb-repo - ``` - -`yum` or `dnf` updates the `edb.repo` file to enable access to the current EDB repository, configured to connect with the credentials specified in your `edb.repo` file. Then, you can use `yum` or `dnf` to upgrade all packages whose names include the expression `edb`: - -- On RHEL or CentOS 7: - - ```text - yum upgrade edb* - ``` - -- On RHEL or Rocky Linux or AlmaLinux 8: - - ```text - dnf upgrade edb* - ``` - -!!! Note - The `yum upgrade` or `dnf upgrade` commands perform an update only between minor releases. To update between major releases, use `pg_upgrade`. - -For more information about using yum commands and options, enter `yum --help` on your command line. - -For more information about using `dnf` commands and options, see the [`dnf` documentation](https://docs.fedoraproject.org/en-US/quick-docs/dnf/). \ No newline at end of file +| edb-efm40 | Installs EDB Failover Manager that adds fault tolerance to database clusters to minimize downtime when a primary database fails by keeping data online in high availability configurations. | \ No newline at end of file diff --git a/product_docs/docs/epas/15/installing/linux_install_details/updating_an_rpm_installation.mdx b/product_docs/docs/epas/15/installing/linux_install_details/updating_an_rpm_installation.mdx new file mode 100644 index 00000000000..04c014bc039 --- /dev/null +++ b/product_docs/docs/epas/15/installing/linux_install_details/updating_an_rpm_installation.mdx @@ -0,0 +1,41 @@ +--- +title: "Updating an RPM installation" +description: "Describes how to upgrade your repository configuration file and update to a more recent product version" +--- + +If you have an existing EPAS RPM installation, you can use `yum` or `dnf` to upgrade your repository configuration file and update to a more recent product version. + +To update the `edb.repo` file, assume superuser privileges and enter: + +- On RHEL or CentOS 7: + + ```text + yum upgrade edb-repo + ``` + +- On RHEL or Rocky Linux or AlmaLinux 8: + + ```text + dnf upgrade edb-repo + ``` + +`yum` or `dnf` updates the `edb.repo` file to enable access to the current EDB repository, configured to connect with the credentials specified in your `edb.repo` file. Then, you can use `yum` or `dnf` to upgrade all packages whose names include the expression `edb`: + +- On RHEL or CentOS 7: + + ```text + yum upgrade edb* + ``` + +- On RHEL or Rocky Linux or AlmaLinux 8: + + ```text + dnf upgrade edb* + ``` + +!!! Note + The `yum upgrade` or `dnf upgrade` commands perform an update only between minor releases. To update between major releases, use `pg_upgrade`. + +For more information about using yum commands and options, enter `yum --help` on your command line. + +For more information about using `dnf` commands and options, see the [`dnf` documentation](https://docs.fedoraproject.org/en-US/quick-docs/dnf/). \ No newline at end of file From 63d473581135a77b9a3d39891cd2fe442de914a2 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Tue, 1 Aug 2023 11:14:17 +0530 Subject: [PATCH 17/28] Update installing_epas_using_local_repository.mdx --- .../installing_epas_using_local_repository.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx b/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx index 3c78b2d366c..7e0999e7380 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx @@ -35,7 +35,7 @@ To create and use a local repository, you must: mkdir /srv/repos ``` -- Copy the RPM installation packages to your local repository. You can download the individual packages or use a tarball to populate the repository. The packages are available from the EDB repository at . +- Copy the RPM installation packages to your local repository. You can download the individual packages or use a tarball to populate the repository. The packages are available from the [EDB repository](https://repos.enterprisedb.com/). - Sync the RPM packages, and create the repository. From ce1e2d24fbe2f2edb998904c4beeaabe2ea3e122 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Tue, 1 Aug 2023 12:41:38 +0530 Subject: [PATCH 18/28] Update product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx --- .../reference_command_line_options.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx index 604654c9140..28131254f46 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx @@ -7,7 +7,7 @@ redirects: -You can optionally include the following parameters for an EDB Postgres Advanced Server (EPAS) installation on the command line or in a configuration file when invoking the EPASinstaller. +You can optionally include the following parameters for an EDB Postgres Advanced Server (EPAS) installation on the command line or in a configuration file when invoking the EPAS installer. `--create_samples { yes | no }` From c07716ea83dd7ee2aff16a4d123c1fc3f76089f4 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Tue, 1 Aug 2023 12:42:22 +0530 Subject: [PATCH 19/28] Update product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx --- .../reference_command_line_options.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx index 28131254f46..fa90ab2d408 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx @@ -31,7 +31,7 @@ Helps with troubleshooting installation problems. `debug_log` is the name of the `--disable-components component_list` -Specifies a list of EPAScomponents to exclude from the installation. By default, `component_list` contains '' (the empty string). `component_list` is a comma-separated list containing one or more of the following components: +Specifies a list of EPAS components to exclude from the installation. By default, `component_list` contains '' (the empty string). `component_list` is a comma-separated list containing one or more of the following components: - `dbserver` — EDB Postgres Advanced Server. From a5cd4beb10393ee74bd2b731a13733f30d1302e2 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Tue, 1 Aug 2023 12:44:27 +0530 Subject: [PATCH 20/28] Update product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx --- .../reference_command_line_options.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx index fa90ab2d408..d277f8f6151 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx @@ -39,7 +39,7 @@ Specifies a list of EPAS components to exclude from the installation. By default `--enable_acledit { 1 | 0 }` -The `--enable_acledit 1` option instructs the installer to grant permission to the user specified by the `--serviceaccount` option to access the EPASbinaries and `data` directory. By default, this option is disabled if `--enable_acledit 0` is specified or if the `--enable_acledit` option is completely omitted. +The `--enable_acledit 1` option instructs the installer to grant permission to the user specified by the `--serviceaccount` option to access the EPAS binaries and `data` directory. By default, this option is disabled if `--enable_acledit 0` is specified or if the `--enable_acledit` option is completely omitted. !!! Note Specifying this option is valid only when installing on Windows. Specify the `--enable_acledit 1` option when a discretionary access control list (DACL) needs to be set for allowing access to objects on which to install EDB Postgres Advanced Server. For information on a DACL, see [DACLs and ACEs](https://msdn.microsoft.com/en-us/library/windows/desktop/aa446597(v=vs.85).aspx) in the Microsoft documentation. From 5496401f0890291a1896465839f80776b0ea9ef4 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Tue, 1 Aug 2023 12:44:56 +0530 Subject: [PATCH 21/28] Update product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx --- .../reference_command_line_options.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx index d277f8f6151..8494120a817 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx @@ -52,7 +52,7 @@ Although this option is listed when you run the installer with the `--help` opti `--extract-only { yes | no }` -Include the `--extract-only` parameter to indicate that the installer should extract the EPASbinaries without performing a complete installation. Superuser privileges aren't required for the `--extract-only` option. The default value is `no`. +Include the `--extract-only` parameter to indicate that the installer should extract the EPAS binaries without performing a complete installation. Superuser privileges aren't required for the `--extract-only` option. The default value is `no`. `--help` From 5e6d231e9c010b68c4d67ca843fc64cf2383da07 Mon Sep 17 00:00:00 2001 From: Fran Coughlin <132373434+francoughlin@users.noreply.github.com> Date: Tue, 1 Aug 2023 06:55:00 -0400 Subject: [PATCH 22/28] Update product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx Good catch! Co-authored-by: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> --- .../connecting_to_epas.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx index cdc88a5a2be..ca701501566 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx @@ -10,7 +10,7 @@ navTitle: "Connecting to EPAS" Use the following command and options to start the `edb-psql` client: ```text -psql -d edb -U enterprisedb +edb-psql -d edb -U enterprisedb ``` Where: From 13d923b56b35220ce8b33ce784f3aba7eb22ac07 Mon Sep 17 00:00:00 2001 From: Fran Coughlin <132373434+francoughlin@users.noreply.github.com> Date: Tue, 1 Aug 2023 06:55:21 -0400 Subject: [PATCH 23/28] Update product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx Great suggestion Co-authored-by: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> --- .../modifying_the_data_directory_location.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx index d0565793994..bce065ead02 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx @@ -4,7 +4,7 @@ title: "Modifying the data directory location" ## On RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x -On a RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x host, the unit file is named `edb-as-15.service` and resides in `/usr/lib/systemd/system`. The unit file contains references to the location of the EDB Postgres Advanced Server (EPAS) `data` directory. Avoid making any modifications directly to the unit file because they might be overwritten during package upgrades. +On a RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x host, the unit file is named `edb-as-.service` and resides in `/usr/lib/systemd/system`. The unit file contains references to the location of the EDB Postgres Advanced Server (EPAS) `data` directory. Avoid making any modifications directly to the unit file because they might be overwritten during package upgrades. By default, data files reside under `/var/lib/edb/as15/data` directory. To use a data directory that resides in a non-default location: From c6deb162e7957433c12221c5cc1d4bcdd2d15183 Mon Sep 17 00:00:00 2001 From: francoughlin Date: Tue, 1 Aug 2023 10:48:49 -0400 Subject: [PATCH 24/28] Incorporated review comments, addressed acronyms Incorporated review comments, addressed acronyms, and tackled some version number genericizing (which really is a word!) --- .../epas_fundamentals/benefits_epas.mdx | 2 +- .../component_locations.mdx | 6 +- ...installing_epas_using_local_repository.mdx | 4 +- .../connecting_to_epas.mdx | 6 +- .../modifying_the_data_directory_location.mdx | 2 +- .../starting_and_stopping_services.mdx | 20 ++--- .../starting_multiple_postmasters.mdx | 6 +- .../linux_install_details/rpm_packages.mdx | 82 +++++++++---------- .../updating_an_rpm_installation.mdx | 2 +- .../uninstalling/linux_uninstall.mdx | 19 +++-- .../uninstalling/windows_uninstall.mdx | 9 +- .../index.mdx | 4 +- ...n_installation_with_limited_privileges.mdx | 16 ++-- .../performing_an_unattended_installation.mdx | 12 +-- .../reference_command_line_options.mdx | 38 ++++----- ...ng_a_graphical_installation_on_windows.mdx | 68 +++++++-------- .../setting_cluster_preferences.mdx | 2 +- .../using_stackbuilder_plus.mdx | 8 +- .../configuring_epas.mdx | 12 +-- ...ing_server_startup_behavior_on_windows.mdx | 2 +- .../starting_and_stopping_epas.mdx | 1 - ...sing_pg_ctl_to_control_advanced_server.mdx | 4 +- .../using_the_windows_services_applet.mdx | 12 +-- .../docs/epas/15/upgrading/03_limitations.mdx | 15 ++-- .../01_performing_an_upgrade/index.mdx | 10 +-- .../01_command_line_options_reference.mdx | 8 +- .../03_upgrading_to_advanced_server.mdx | 28 +++---- .../04_upgrading_a_pgAgent_installation.mdx | 2 +- .../05_pg_upgrade_troubleshooting.mdx | 4 +- .../how_pg_upgrade_works.mdx | 10 +-- ...plus_to_perform_a_minor_version_update.mdx | 10 +-- product_docs/docs/epas/15/upgrading/index.mdx | 4 +- 32 files changed, 216 insertions(+), 212 deletions(-) diff --git a/product_docs/docs/epas/15/fundamentals/epas_fundamentals/benefits_epas.mdx b/product_docs/docs/epas/15/fundamentals/epas_fundamentals/benefits_epas.mdx index cd7ddcf3888..9bde8de3fc0 100644 --- a/product_docs/docs/epas/15/fundamentals/epas_fundamentals/benefits_epas.mdx +++ b/product_docs/docs/epas/15/fundamentals/epas_fundamentals/benefits_epas.mdx @@ -3,7 +3,7 @@ title: "Benefits of EDB Postgres Advanced Server" description: "Describes the functionality included in EDB Postgres Advanced Server that bring value to your installation" --- -EDB Postgres Advanced Server is a standalone proprietary database server that adds extended functionality to the open-source PostgreSQL database. +EDB Postgres Advanced Server is a stand-alone proprietary database server that adds extended functionality to the open-source PostgreSQL database. EDB Postgres Advanced Server is designed to provide enterprise capabilities on top of the features present in community Postgres. These capabilities: diff --git a/product_docs/docs/epas/15/installing/linux_install_details/component_locations.mdx b/product_docs/docs/epas/15/installing/linux_install_details/component_locations.mdx index 46dc82f3e82..2619fc2125c 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/component_locations.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/component_locations.mdx @@ -5,14 +5,14 @@ redirects: - /epas/latest/epas_inst_linux/install_details/component_locations/ --- -The package managers for the various Linux variations install EDB Postgres Advanced Server (EPAS) components in different locations. If you need to access the components after installation, see: +The package managers for the various Linux variations install EDB Postgres Advanced Server components in different locations. If you need to access the components after installation, see: - [RHEL/OL/Rocky Linux/AlmaLinux/CentOS/SLES locations](#rhelolrocky-linuxalmalinuxcentossles-locations) - [Debian/Ubuntu locations](#debianubuntu-locations) ## RHEL/OL/Rocky Linux/AlmaLinux/CentOS/SLES Locations -The RPM installers place EPAS components in the directories listed in the table. +The RPM installers place EDB Postgres Advanced Server components in the directories listed in the table. | Component | Location | | --------------------------------- | ------------------------------------------ | @@ -37,7 +37,7 @@ The RPM installers place EPAS components in the directories listed in the table. ## Debian/Ubuntu Locations -The Debian package manager places EPAS and supporting components in the directories listed in the table. +The Debian package manager places EDB Postgres Advanced Server and supporting components in the directories listed in the table. | Component | Location | | -------------------------------- | --------------------------------------------------------------------------------------- | diff --git a/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx b/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx index 7e0999e7380..4da202e2cd3 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx @@ -7,7 +7,7 @@ redirects: - /epas/latest/epas_inst_linux/installing_epas_using_local_repository/ --- -You can create a local repository to act as a host for the EDB Postgres Advanced Server (EPAS) native packages if the server on which you want to install EPAS or the supporting components can't directly access the EDB repository. This topic is only a high-level listing of the steps required; you will need to modify the process for your network. +You can create a local repository to act as a host for the EDB Postgres Advanced Server native packages if the server on which you want to install EDB Postgres Advanced Server or the supporting components can't directly access the EDB repository. This topic is only a high-level listing of the steps required; you will need to modify the process for your network. To create and use a local repository, you must: @@ -56,7 +56,7 @@ To create and use a local repository, you must: gpgcheck=0 ``` -After specifying the location and connection information for your local repository, you can use `yum` or `dnf` commands to install EPAS and its supporting components on the isolated servers. For example: +After specifying the location and connection information for your local repository, you can use `yum` or `dnf` commands to install EDB Postgres Advanced Server and its supporting components on the isolated servers. For example: - On RHEL or CentOS 7: diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx index ca701501566..558fdc30d2d 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/connecting_to_epas.mdx @@ -1,9 +1,9 @@ --- title: "Connecting to EDB Postgres Advanced Server with edb-psql" -navTitle: "Connecting to EPAS" +navTitle: "Connecting to EDB Postgres Advanced Server" --- -`edb-psql` is a command line client application that allows you to execute SQL commands and view the results. To open the `edb-psql` client, the client must be in your search path. The executable resides in the `bin` directory under your EDB Postgres Advanced Server (EPAS) installation. +`edb-psql` is a command line client application that allows you to execute SQL commands and view the results. To open the `edb-psql` client, the client must be in your search path. The executable resides in the `bin` directory under your EDB Postgres Advanced Server installation. ## Starting the client @@ -19,7 +19,7 @@ Where: `-U` specifies the identity of the database user to use for the session. -`edb-psql` is a symbolic link to a binary called `psql`, a modified version of the PostgreSQL community `psql`, with added support for EPAS features. For more information about using the command line client, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/app-psql.html). +`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. For more information about using the command line client, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/app-psql.html). ## Managing authentication on a Debian or Ubuntu host diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx index bce065ead02..af74b4e1053 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx @@ -4,7 +4,7 @@ title: "Modifying the data directory location" ## On RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x -On a RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x host, the unit file is named `edb-as-.service` and resides in `/usr/lib/systemd/system`. The unit file contains references to the location of the EDB Postgres Advanced Server (EPAS) `data` directory. Avoid making any modifications directly to the unit file because they might be overwritten during package upgrades. +On a RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x host, the unit file is named `edb-as-.service` (where *xx* is the EDB Postgres Advanced Server version number) and resides in `/usr/lib/systemd/system`. The unit file contains references to the location of the EDB Postgres Advanced Server `data` directory. Avoid making any modifications directly to the unit file because they might be overwritten during package upgrades. By default, data files reside under `/var/lib/edb/as15/data` directory. To use a data directory that resides in a non-default location: diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_and_stopping_services.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_and_stopping_services.mdx index 07b008d2139..5a770380213 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_and_stopping_services.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_and_stopping_services.mdx @@ -2,11 +2,11 @@ title: "Starting and stopping services" --- -A service is a program that runs in the background and doesn't require user interaction. A service provides no user interface. You can configure a service to start at boot time or manually on demand. Services are best controlled using the platform-specific operating system service control utility. Many of the EDB Postgres Advanced Server (EPAS) supporting components are services. +A service is a program that runs in the background and doesn't require user interaction. A service provides no user interface. You can configure a service to start at boot time or manually on demand. Services are best controlled using the platform-specific operating system service control utility. Many of the EDB Postgres Advanced Server supporting components are services. ## List of services -The following table lists the names of the services that control EPAS and services that control EPAS supporting components. +The following table lists the names of the services that control EDB Postgres Advanced Server and services that control EDB Postgres Advanced Server supporting components. | EDB Postgres Advanced Server component name | Linux service Name | Debian service name | | ------------------------------ | ------------------------ | --------------------------------------- | @@ -17,11 +17,11 @@ The following table lists the names of the services that control EPAS and servic | Slony | edb-slony-replication-15 | edb-as15-slony-replication | | EFM | edb-efm-4.0 | edb-efm-4.0 | -You can use the Linux command line to control the EPAS database server and the services of EPAS's supporting components. The commands that control the EPAS service on a Linux platform are host specific. +You can use the Linux command line to control the EDB Postgres Advanced Server database server and the services of EDB Postgres Advanced Server's supporting components. The commands that control the EDB Postgres Advanced Server service on a Linux platform are host specific. ## Controlling a service on RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x -If your installation of EPAS resides on version 7.x | 8.x of RHEL and CentOS, you must use the `systemctl` command to control the EPAS service and supporting components. +If your installation of EDB Postgres Advanced Server resides on version 7.x | 8.x of RHEL and CentOS, you must use the `systemctl` command to control the EDB Postgres Advanced Server service and supporting components. The `systemctl` command must be in your search path and you must invoke it with superuser privileges. To use the command, open a command line, and enter: @@ -42,7 +42,7 @@ Where: ## Controlling a service on Debian 10.x or Ubuntu 18.04 | 20.04 -If your installation of EPAS resides on version 18.04 | 20.04 of Ubuntu, assume superuser privileges and invoke the following commands (using bundled scripts) to manage the service. Use the following commands to: +If your installation of EDB Postgres Advanced Server resides on version 18.04 | 20.04 of Ubuntu, assume superuser privileges and invoke the following commands (using bundled scripts) to manage the service. Use the following commands to: - Discover the current status of a service: @@ -78,17 +78,17 @@ If your installation of EPAS resides on version 18.04 | 20.04 of Ubuntu, assume You can use the `pg_ctl` utility to control an EDB Postgres Advanced Server service from the command line on any platform. `pg_ctl` allows you to: -- Start, stop, or restart the EPAS database server +- Start, stop, or restart the EDB Postgres Advanced Server database server - Reload the configuration parameters - Display the status of a running server -To invoke the utility, assume the identity of the cluster owner. In the home directory of EPAS, issue the command: +To invoke the utility, assume the identity of the cluster owner. In the home directory of EDB Postgres Advanced Server, issue the command: ```text ./bin/pg_ctl -D ``` -`data_directory` is the location of the data controlled by the EPAS cluster. +`data_directory` is the location of the data controlled by the EDB Postgres Advanced Server cluster. `action` specifies the action taken by the `pg_ctl` utility. Specify: @@ -102,11 +102,11 @@ For more information about using the `pg_ctl` utility or the command line option ### Choosing between pg_ctl and the service command -You can use the `pg_ctl` utility to manage the status of an EPAS cluster. However, it's important to note that `pg_ctl` doesn't alert the operating system service controller to changes in the status of a server. We recommend using the `service` command when possible. +You can use the `pg_ctl` utility to manage the status of an EDB Postgres Advanced Server cluster. However, it's important to note that `pg_ctl` doesn't alert the operating system service controller to changes in the status of a server. We recommend using the `service` command when possible. ## Configuring component services to autostart at system reboot -After installing, configuring, and starting the services of EPAS supporting components on a Linux system, you must manually configure your system to autostart the service when your system restarts. To configure a service to autostart on a Linux system, open a command line, assume superuser privileges, and enter the command. +After installing, configuring, and starting the services of EDB Postgres Advanced Server supporting components on a Linux system, you must manually configure your system to autostart the service when your system restarts. To configure a service to autostart on a Linux system, open a command line, assume superuser privileges, and enter the command. On a Redhat-compatible Linux system, enter: diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_multiple_postmasters.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_multiple_postmasters.mdx index 8b8183fbc41..36eaca8b3f2 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_multiple_postmasters.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/starting_multiple_postmasters.mdx @@ -2,13 +2,13 @@ title: "Starting multiple postmasters with different clusters" --- -You can configure EDB Postgres Advanced Server (EPAS) to use multiple postmasters, each with its own database cluster. The steps required are version specific to the Linux host. +You can configure EDB Postgres Advanced Server to use multiple postmasters, each with its own database cluster. The steps required are version specific to the Linux host. ## On RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x -The `edb-as15-server-core` RPM for version 7.x | 8.x contains a unit file that starts the EPAS instance. The file allows you to start multiple services, with unique `data` directories and monitor different ports. You need to have `root` access to invoke or modify the script. +The `edb-as15-server-core` RPM for version 7.x | 8.x contains a unit file that starts the EDB Postgres Advanced Server instance. The file allows you to start multiple services, with unique `data` directories and monitor different ports. You need to have `root` access to invoke or modify the script. -This example creates an EPAS installation with two instances. The secondary instance is named `secondary`. +This example creates an EDB Postgres Advanced Server installation with two instances. The secondary instance is named `secondary`. - Make a copy of the default file with the new name. As noted at the top of the file, all modifications must reside under `/etc`. You must pick a name that isn't already used in `/etc/systemd/system`. diff --git a/product_docs/docs/epas/15/installing/linux_install_details/rpm_packages.mdx b/product_docs/docs/epas/15/installing/linux_install_details/rpm_packages.mdx index 03659156850..06098d79b9a 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/rpm_packages.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/rpm_packages.mdx @@ -35,26 +35,26 @@ Where `package` is the search term that specifies the name (or partial name) of | Package name | Package installs | | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| edb-as15-server | Installs core components of the EDB Postgres Advanced Server (EPAS) database server. | -| edb-as15-server-client | Client programs and utilities that you can use to access and manage EPAS. | -| edb-as15-server-contrib | Installs contributed tools and utilities that are distributed with EPAS. Files for these modules are installed in:

Documentation: `/usr/edb/as15/share/doc`

Loadable modules: `/usr/edb/as15/lib`

Binaries: `/usr/edb/as15/bin` | -| edb-as15-server-core | Includes the programs needed to create the core functionality behind the EPAS database. | -| edb-as15-server-devel | Installs the header files and libraries needed to compile C or C++ applications that directly interact with an EPAS server and the ecpg or ecpgPlus C preprocessor. | +| edb-as15-server | Installs core components of the EDB Postgres Advanced Server database server. | +| edb-as15-server-client | Client programs and utilities that you can use to access and manage EDB Postgres Advanced Server. | +| edb-as15-server-contrib | Installs contributed tools and utilities that are distributed with EDB Postgres Advanced Server. Files for these modules are installed in:

Documentation: `/usr/edb/as15/share/doc`

Loadable modules: `/usr/edb/as15/lib`

Binaries: `/usr/edb/as15/bin` | +| edb-as15-server-core | Includes the programs needed to create the core functionality behind the EDB Postgres Advanced Server database. | +| edb-as15-server-devel | Installs the header files and libraries needed to compile C or C++ applications that directly interact with an EDB Postgres Advanced Server server and the ecpg or ecpgPlus C preprocessor. | | edb-as15-server-docs | Installs the readme file. | -| edb-as15-server-edb-modules | Installs supporting modules for EPAS. | -| edb-as15-server-indexadvisor | Installs EPAS's Index Advisor feature. The Index Advisor utility helps to determine the columns to index to improve performance in a given workload. | -| edb-as15-server-libs | Provides the essential shared libraries for any EPAS client program or interface. | -| edb-as15-server-llvmjit | Contains support for just-in-time (JIT) compiling parts of EPAS's queries. You need to install this package separately. | -| edb-as15-server-pldebugger | Implements an API for debugging PL/pgSQL functions on EPAS. | -| edb-as15-server-plperl | Installs the PL/Perl procedural language for EPAS. The `edb-as15-server-plperl` package depends on the platform-supplied version of Perl. | -| edb-as15-server-plpython3 | Installs the PL/Python procedural language for EPAS. The PL/Python2 support is no longer available in EPAS version 15 and later. | -| edb-as15-server-pltcl | Installs the PL/Tcl procedural language for EPAS. The `edb-as15-pltcl` package depends on the platform-supplied version of TCL. | -| edb-as15-server-sqlprofiler | Installs EPAS's SQL Profiler feature. SQL Profiler helps identify and optimize SQL code. | -| edb-as15-server-sqlprotect | Installs EPAS's SQL Protect feature. SQL Protect provides protection against SQL injection attacks. | +| edb-as15-server-edb-modules | Installs supporting modules for EDB Postgres Advanced Server. | +| edb-as15-server-indexadvisor | Installs EDB Postgres Advanced Server's Index Advisor feature. The Index Advisor utility helps to determine the columns to index to improve performance in a given workload. | +| edb-as15-server-libs | Provides the essential shared libraries for any EDB Postgres Advanced Server client program or interface. | +| edb-as15-server-llvmjit | Contains support for just-in-time (JIT) compiling parts of EDB Postgres Advanced Server's queries. You need to install this package separately. | +| edb-as15-server-pldebugger | Implements an API for debugging PL/pgSQL functions on EDB Postgres Advanced Server. | +| edb-as15-server-plperl | Installs the PL/Perl procedural language for EDB Postgres Advanced Server. The `edb-as15-server-plperl` package depends on the platform-supplied version of Perl. | +| edb-as15-server-plpython3 | Installs the PL/Python procedural language for EDB Postgres Advanced Server. The PL/Python2 support is no longer available in EDB Postgres Advanced Server version 15 and later. | +| edb-as15-server-pltcl | Installs the PL/Tcl procedural language for EDB Postgres Advanced Server. The `edb-as15-pltcl` package depends on the platform-supplied version of TCL. | +| edb-as15-server-sqlprofiler | Installs EDB Postgres Advanced Server's SQL Profiler feature. SQL Profiler helps identify and optimize SQL code. | +| edb-as15-server-sqlprotect | Installs EDB Postgres Advanced Server's SQL Protect feature. SQL Protect provides protection against SQL injection attacks. | | edb-as15-server-sslutils | Installs functionality that provides SSL support. | | edb-as15-server-cloneschema | Installs the EDB Clone Schema extension. For more information about EDB Clone Schema, see [EDB clone schema](../../database_administration/14_edb_clone_schema/). | | edb-as15-server-parallel-clone | Installs functionality that supports the EDB Clone Schema extension. | -| edb-as15-pgagent | Installs pgAgent: Installs pgAgent, a job scheduler for EPAS. Before installing this package, you must install EPEL repository. For detailed information about installing EPEL, see [Linux installation troubleshooting](../troubleshooting/linux_troubleshooting/installation_troubleshooting_linux/). | +| edb-as15-pgagent | Installs pgAgent: Installs pgAgent, a job scheduler for EDB Postgres Advanced Server. Before installing this package, you must install EPEL repository. For detailed information about installing EPEL, see [Linux installation troubleshooting](../troubleshooting/linux_troubleshooting/installation_troubleshooting_linux/). | | edb-as15-edbplus | The `edb-edbplus` package contains the files required to install the EDB\*Plus command line client. EDB\*Plus commands are compatible with Oracle's SQL\*Plus. | | edb-as15-pgsnmpd | Simple Network Management Protocol (SNMP) is a protocol that allows you to supervise an apparatus connected to the network. | | edb-as15-pgpool41-extensions | Creates pgPool extensions required by the server for use with pgpool. | @@ -70,16 +70,16 @@ Where `package` is the search term that specifies the name (or partial name) of | edb-as15-slony-replication-tools | Contains the Slony altperl tools and utilities that are useful when deploying Slony replication environments. Before installing this package, you must install EPEL repository. For detailed information about installing EPEL, see [Linux installation troubleshooting](../troubleshooting/linux_troubleshooting/installation_troubleshooting_linux/). | | edb-as15-libicu | Contains the supporting library files. | -The following table lists the packages for EPAS 15 supporting components. +The following table lists the packages for EDB Postgres Advanced Server supporting components. | Package name | Package installs | | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| edb-pgpool41 | Contains the pgPool-II installer. The pgpool-II utility package acts as a middleman between client applications and Server database servers. pgpool-II functionality is transparent to client applications; client applications connect to pgpool-II instead of directly to EPAS, and pgpool-II manages the connection. EDB supports the following pgpool-II features:
- Load balancing
- Connection pooling
- High availability
- Connection limits


pgpool-II runs as a service on Linux systems, and is not supported on Windows systems.
| -| edb-jdbc | The `edb-jdbc` package includes the .jar files needed for Java programs to access an EPAS database. | -| edb-migrationtoolkit | The `edb-migrationtoolkit` package installs Migration Toolkit, facilitating migration to an EPAS database from Oracle, PostgreSQL, MySQL, Sybase and SQL Server. | -| edb-oci | The `edb-oci` package installs the EDB Open Client library, allowing applications that use the Oracle Call Interface API to connect to an EPAS database. | +| edb-pgpool41 | Contains the pgPool-II installer. The pgpool-II utility package acts as a middleman between client applications and Server database servers. pgpool-II functionality is transparent to client applications; client applications connect to pgpool-II instead of directly to EDB Postgres Advanced Server, and pgpool-II manages the connection. EDB supports the following pgpool-II features:
- Load balancing
- Connection pooling
- High availability
- Connection limits


pgpool-II runs as a service on Linux systems, and is not supported on Windows systems.
| +| edb-jdbc | The `edb-jdbc` package includes the .jar files needed for Java programs to access an EDB Postgres Advanced Server database. | +| edb-migrationtoolkit | The `edb-migrationtoolkit` package installs Migration Toolkit, facilitating migration to an EDB Postgres Advanced Server database from Oracle, PostgreSQL, MySQL, Sybase and SQL Server. | +| edb-oci | The `edb-oci` package installs the EDB Open Client library, allowing applications that use the Oracle Call Interface API to connect to an EDB Postgres Advanced Server database. | | edb-oci-devel | Installs the OCI include files; install this package if you are developing C/C++ applications that require these files. | -| edb-odbc | Installs the driver needed for applications to access an EPAS system via ODBC. | +| edb-odbc | Installs the driver needed for applications to access an EDB Postgres Advanced Server system via ODBC. | | edb-odbc-devel | Installs the ODBC include files; install this package if you are developing C/C++ applications that require these files. | | edb-pgbouncer115 | Contains PgBouncer (a lightweight connection pooler). This package requires the libevent package. | | ppas-xdb | Contains the xDB installer; xDB provides asynchronous cross-database replication. | @@ -122,24 +122,24 @@ apt list edb* | Package name | Package installs | | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| edb-as15-server | Installs core components of the EPAS database server. | -| edb-as15-server-client | Includes client programs and utilities that you can use to access and manage EPAS. | -| edb-as15-server-core | Includes the programs needed to create the core functionality behind the EPAS database. | -| edb-as15-server-dev | Package that contains the header files and libraries needed to compile C or C++ applications that directly interact with an EPAS server and the ecpg or ecpgPlus C preprocessor. | +| edb-as15-server | Installs core components of the EDB Postgres Advanced Server database server. | +| edb-as15-server-client | Includes client programs and utilities that you can use to access and manage EDB Postgres Advanced Server. | +| edb-as15-server-core | Includes the programs needed to create the core functionality behind the EDB Postgres Advanced Server database. | +| edb-as15-server-dev | Package that contains the header files and libraries needed to compile C or C++ applications that directly interact with an EDB Postgres Advanced Server server and the ecpg or ecpgPlus C preprocessor. | | edb-as15-server-doc | Installs the readme file. | -| edb-as15-server-edb-modules | Installs supporting modules for EPAS. | -| edb-as15-server-indexadvisor | Installs EPAS's Index Advisor feature. The Index Advisor utility helps to determine the columns to index to improve performance in a given workload. | -| edb-as15-server-pldebugger | This package implements an API for debugging PL/pgSQL functions on EPAS. | -| edb-as15-server-plpython3 | Installs the PL/Python procedural language for EPAS. PL/Python2 support is no longer available from EPAS version 15 onwards. | -| edb-as15-server-pltcl | Installs the PL/Tcl procedural language for EPAS. The `edb-as15-pltcl` package depends on the platform-supplied version of TCL. | -| edb-as15-server-sqlprofiler | Installs EPAS's SQL Profiler feature. SQL Profiler helps identify and optimize SQL code. | -| edb-as15-server-sqlprotect | Installs EPAS's SQL Protect feature. SQL Protect provides protection against SQL injection attacks. | +| edb-as15-server-edb-modules | Installs supporting modules for EDB Postgres Advanced Server. | +| edb-as15-server-indexadvisor | Installs EDB Postgres Advanced Server's Index Advisor feature. The Index Advisor utility helps to determine the columns to index to improve performance in a given workload. | +| edb-as15-server-pldebugger | This package implements an API for debugging PL/pgSQL functions on EDB Postgres Advanced Server. | +| edb-as15-server-plpython3 | Installs the PL/Python procedural language for EDB Postgres Advanced Server. PL/Python2 support is no longer available from EDB Postgres Advanced Server version 15 onwards. | +| edb-as15-server-pltcl | Installs the PL/Tcl procedural language for EDB Postgres Advanced Server. The `edb-as15-pltcl` package depends on the platform-supplied version of TCL. | +| edb-as15-server-sqlprofiler | Installs EDB Postgres Advanced Server's SQL Profiler feature. SQL Profiler helps identify and optimize SQL code. | +| edb-as15-server-sqlprotect | Installs EDB Postgres Advanced Server's SQL Protect feature. SQL Protect provides protection against SQL injection attacks. | | edb-as15-server-sslutils | Installs functionality that provides SSL support. | | edb-as15-server-cloneschema | Installs the EDB Clone Schema extension. For more information about EDB Clone Schema, see the [EDB clone schema](../../database_administration/14_edb_clone_schema/). | | edb-as15-server-parallel-clone | Installs functionality that supports the EDB Clone Schema extension. | | edb-as15-edbplus | The `edb-edbplus` package contains the files required to install the EDB\*Plus command line client. EDB\*Plus commands are compatible with Oracle's SQL\*Plus. | | edb-as15-pgsnmpd | Simple Network Management Protocol (SNMP) is a protocol that allows you to supervise an apparatus connected to the network. | -| edb-as15-pgadmin4 | pgAdmin 4 provides a graphical management interface for EPAS and PostgreSQL databases. | +| edb-as15-pgadmin4 | pgAdmin 4 provides a graphical management interface for EDB Postgres Advanced Server and PostgreSQL databases. | | edb-as15-pgadmin-apache | Apache support module for pgAdmin 4. | | edb-as15-pgadmin4-common | pgAdmin 4 supporting files. | | edb-as15-pgadmin4-doc | pgAdmin 4 documentation module. | @@ -150,18 +150,18 @@ apt list edb* | edb-as15-postgis3-gui | Provides a GUI for POSTGIS. | | edb-as15-postgis-jdbc | Provides support for POSTGIS. | | edb-as15-postgis-scripts | Provides support for POSTGIS. | -| edb-as15-pgagent | Installs pgAgent, a job scheduler for EPAS. Before installing this package, you must install EPEL repository. For detailed information about installing EPEL, see [Linux installation troubleshooting](../troubleshooting/linux_troubleshooting/installation_troubleshooting_linux/). | +| edb-as15-pgagent | Installs pgAgent, a job scheduler for EDB Postgres Advanced Server. Before installing this package, you must install EPEL repository. For detailed information about installing EPEL, see [Linux installation troubleshooting](../troubleshooting/linux_troubleshooting/installation_troubleshooting_linux/). | | edb-as15-slony-replication | Installs the meta RPM for Slony-I. | | edb-as15-slony-replication-core | Contains core portions of Slony-I to build a primary-standby system that includes all features and capabilities needed to replicate large databases to a reasonably limited number of standby systems. | | edb-as15-slony-replication-docs | Contains the Slony project documentation in pdf form. | | edb-as15-slony-replication-tools | Contains the Slony altperl tools and utilities that are useful when deploying Slony replication environments. Before installing this package, you must install EPEL repository. For detailed information about installing EPEL, see [Linux installation troubleshooting](../troubleshooting/linux_troubleshooting/installation_troubleshooting_linux/). | -| edb-as15-hdfs-fdw | The Hadoop Data Adapter allows you to query and join data from Hadoop environments with your Postgres or EPAS instances. It's YARN Ready certified with HortonWorks and provides optimizations for performance with predicate pushdown support. | +| edb-as15-hdfs-fdw | The Hadoop Data Adapter allows you to query and join data from Hadoop environments with your Postgres or EDB Postgres Advanced Server instances. It's YARN Ready certified with HortonWorks and provides optimizations for performance with predicate pushdown support. | | edb-as15-hdfs-fdw-doc | Documentation for the Hadoop Data Adapter. | -| edb-as15-mongo-fdw | This EPAS extension implements a foreign data wrapper for MongoDB. | +| edb-as15-mongo-fdw | This EDB Postgres Advanced Server extension implements a foreign data wrapper for MongoDB. | | edb-as15-mongo-fdw-doc | Documentation for the foreign data wrapper for MongoDB. | -| edb-as15-mysql-fdw | This EPAS extension implements a foreign data wrapper for MySQL. | -| edb-pgpool41 | Contains the pgPool-II installer. The pgpool-II utility package acts as a middleman between client applications and Server database servers. pgpool-II functionality is transparent to client applications; client applications connect to pgpool-II instead of directly to EPAS, and pgpool-II manages the connection. EDB supports the following pgpool-II features:
- Load balancing
- Connection pooling
- High availability
- Connection limits


pgpool-II runs as a service on Linux systems, and is not supported on Windows systems.
| -| edb-jdbc | Includes the .jar files needed for Java programs to access an EPAS database. | -| edb-migrationtoolkit | Installs Migration Toolkit, facilitating migration to an EPAS database from Oracle, PostgreSQL, MySQL, Sybase and SQL Server. | +| edb-as15-mysql-fdw | This EDB Postgres Advanced Server extension implements a foreign data wrapper for MySQL. | +| edb-pgpool41 | Contains the pgPool-II installer. The pgpool-II utility package acts as a middleman between client applications and Server database servers. pgpool-II functionality is transparent to client applications; client applications connect to pgpool-II instead of directly to EDB Postgres Advanced Server, and pgpool-II manages the connection. EDB supports the following pgpool-II features:
- Load balancing
- Connection pooling
- High availability
- Connection limits


pgpool-II runs as a service on Linux systems, and is not supported on Windows systems.
| +| edb-jdbc | Includes the .jar files needed for Java programs to access an EDB Postgres Advanced Server database. | +| edb-migrationtoolkit | Installs Migration Toolkit, facilitating migration to an EDB Postgres Advanced Server database from Oracle, PostgreSQL, MySQL, Sybase and SQL Server. | | edb-pgbouncer115 | PgBouncer, a lightweight connection pooler. This package requires the libevent package. | | edb-efm40 | Installs EDB Failover Manager that adds fault tolerance to database clusters to minimize downtime when a primary database fails by keeping data online in high availability configurations. | \ No newline at end of file diff --git a/product_docs/docs/epas/15/installing/linux_install_details/updating_an_rpm_installation.mdx b/product_docs/docs/epas/15/installing/linux_install_details/updating_an_rpm_installation.mdx index 04c014bc039..5057e7c18ea 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/updating_an_rpm_installation.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/updating_an_rpm_installation.mdx @@ -3,7 +3,7 @@ title: "Updating an RPM installation" description: "Describes how to upgrade your repository configuration file and update to a more recent product version" --- -If you have an existing EPAS RPM installation, you can use `yum` or `dnf` to upgrade your repository configuration file and update to a more recent product version. +If you have an existing EDB Postgres Advanced Server RPM installation, you can use `yum` or `dnf` to upgrade your repository configuration file and update to a more recent product version. To update the `edb.repo` file, assume superuser privileges and enter: diff --git a/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx b/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx index ae1a9db04a0..9a69fdb9b80 100644 --- a/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx +++ b/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx @@ -11,11 +11,11 @@ legacyRedirects: --- !!! Note - After uninstalling EDB Postgres Advanced Server (EPAS), the cluster data files remain intact, and the service user persists. You can manually remove the cluster `data` and service user from the system. + After uninstalling EDB Postgres Advanced Server, the cluster data files remain intact, and the service user persists. You can manually remove the cluster `data` and service user from the system. ## Uninstalling on RHEL/OL/AlmaLinux/Rocky Linux -You can use variations of the `rpm`, `yum`, or `dnf` command to remove installed packages. Removing a package doesn't damage the EPAS `data` directory. +You can use variations of the `rpm`, `yum`, or `dnf` command to remove installed packages. Removing a package doesn't damage the EDB Postgres Advanced Server `data` directory. Include the `-e` option when invoking the `rpm` command to remove an installed package: @@ -46,30 +46,31 @@ Where `package_name` is the name of the package that you want to remove. !!! Note In RHEL or Rocky Linux or AlmaLinux 8, removing a package also removes all its dependencies that aren't required by other packages. To override this default behavior of RHEL or Rocky Linux or AlmaLinux 8, disable the `clean_requirements_on_remove` parameter in the `/etc/yum.conf` file. -To uninstall EPAS and its dependent packages, use the appropriate command. +To uninstall EDB Postgres Advanced Server and its dependent packages, use the appropriate command. - On RHEL or CentOS 7: ```text - yum remove edb-as15-server* + yum remove edb-as-server* ``` +Where <*xx*> represents the EDB Postgres Advanced Server version number. - On RHEL or Rocky Linux or AlmaLinux 8: ```text - dnf remove edb-as15-server* + dnf remove edb-as-server* ``` ## Uninstalling on Debian or Ubuntu -- To uninstall EPAS, invoke the following command. The configuration files and data directory remains intact. +- To uninstall EDB Postgres Advanced Server, invoke the following command. The configuration files and data directory remains intact. ```text - apt-get remove edb-as15-server* + apt-get remove edb-as-server* ``` -- To uninstall EPAS, configuration files, and data directory, invoke the following command: +- To uninstall EDB Postgres Advanced Server, configuration files, and data directory, invoke the following command: ```text - apt-get purge edb-as15-server* + apt-get purge edb-as-server* ``` diff --git a/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx b/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx index 692eae3fb3c..47c971af0b4 100644 --- a/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx +++ b/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx @@ -9,17 +9,18 @@ redirects: --- !!! Note - After uninstalling EDB Postgres Advanced Server (EPAS), the cluster data files remain intact, and the service user persists. You can manually remove the cluster data and service user from the system. + After uninstalling EDB Postgres Advanced Server, the cluster data files remain intact, and the service user persists. You can manually remove the cluster data and service user from the system. ## Using EDB Postgres Advanced Server uninstallers at the command line -The EPAS interactive installer creates an uninstaller that you can use to remove EPAS or components that reside on a Windows host. The uninstaller is created in `C:\Program Files\edb\as15`. +The EDB Postgres Advanced Server interactive installer creates an uninstaller that you can use to remove EDB Postgres Advanced Server or components that reside on a Windows host. The uninstaller is created in `C:\Program Files\edb\as15`. 1. Assume superuser privileges and, in the directory that contains the uninstaller, enter: ```text - uninstall-edb-as15-server.exe + uninstall-edb-as-server.exe ``` + Where <*xx*> represents the EDB Postgres Advanced Server version number. The uninstaller opens. @@ -29,7 +30,7 @@ The EPAS interactive installer creates an uninstaller that you can use to remove 1. Select **Next**. - If you selected components to remove that depend on EPAS, those components are removed first. + If you selected components to remove that depend on EDB Postgres Advanced Server, those components are removed first. ![Acknowledge that dependent components are removed first](../../images/acknowledging_components_removed.png) diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/index.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/index.mdx index 5d98e7a8bd6..8cea89ec70a 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/index.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/index.mdx @@ -14,9 +14,9 @@ navigation: -You can use the EDB Postgres Advanced Server (EPAS) interactive installer to install EPAS on Windows. The interactive installer is available from [Downloads page](https://www.enterprisedb.com/advanced-downloads) on the EDB website. +You can use the EDB Postgres Advanced Server interactive installer to install EDB Postgres Advanced Server on Windows. The interactive installer is available from [Downloads page](https://www.enterprisedb.com/advanced-downloads) on the EDB website. -You can invoke the graphical installer in different installation modes to perform an EPAS installation. +You can invoke the graphical installer in different installation modes to perform an EDB Postgres Advanced Server installation. During the installation, the graphical installer copies a number of temporary files to the location specified by the `TEMP` environment variable. You can optionally specify an alternate location for the temporary files by modifying the value of the `TEMP` environment variable on the command line: diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx index d6c716ad8bc..c8fd787ad0f 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx @@ -7,7 +7,7 @@ redirects: -To perform an abbreviated installation of EDB Postgres Advanced Server (EPAS) without access to administrative privileges, invoke the installer from the command line and include the `--extract-only` option. The `--extract-only` option extracts the binary files in an unaltered form, allowing you to experiment with a minimal installation of EPAS. +To perform an abbreviated installation of EDB Postgres Advanced Server without access to administrative privileges, invoke the installer from the command line and include the `--extract-only` option. The `--extract-only` option extracts the binary files in an unaltered form, allowing you to experiment with a minimal installation of EDB Postgres Advanced Server. If you invoke the installer with the `--extract-only` options, you can either manually create a cluster and start the service, or run the installation script. To manually create the cluster, you must: @@ -25,14 +25,16 @@ The installation script: - Configures the server to start at boot-time. - Establishes initial values for Dynatune (dynamic tuning) variables. -The scripted EPAS installation does not create menu shortcuts or provide access to EDB Postgres StackBuilder Plus, and no modifications are made to registry files. +The scripted EDB Postgres Advanced Server installation does not create menu shortcuts or provide access to EDB Postgres StackBuilder Plus, and no modifications are made to registry files. -To perform a limited installation and generate an installation script, download and unpack the EPAS installer. Navigate into the directory that contains the installer, and invoke the installer with the command: +To perform a limited installation and generate an installation script, download and unpack the EDB Postgres Advanced Server installer. Navigate into the directory that contains the installer, and invoke the installer with the command: ```text -edb-as14-server-14.x.x-x-windows.exe --extract-only yes +edb-asxx-server-xx.x.x-x-windows.exe --extract-only yes ``` +Where <*xx*> represents the EDB Postgres Advanced Server version number. + A dialog opens, prompting you to choose an installation language. Select a language for the installation from the drop-down listbox, and click `OK` to continue. The `Setup Wizard` opens. ![The Welcome window](../../../../images/advanced_server_installer_welcome.png) @@ -45,10 +47,10 @@ Click `Next` to continue.
Fig. 16: Specify an installation directory
-On Windows, the default EPAS installation directory is: +On Windows, the default EDB Postgres Advanced Server installation directory is: ```text -C:\Program Files\edb\as14 +C:\Program Files\edb\as<*xx*> ``` You can accept the default installation location and click `Next` to continue to the `Ready to Install` window, or optionally click the `File Browser` icon to choose an alternate installation directory. @@ -57,7 +59,7 @@ You can accept the default installation location and click `Next` to continue to
Fig. 17: The Setup wizard is ready to install EDB Postgres Advanced Server
-Click `Next` to proceed with the EPAS installation. During the installation, progress bars and popups mark the installation progress. The installer notifies you when the installation is complete. +Click `Next` to proceed with the EDB Postgres Advanced Server installation. During the installation, progress bars and popups mark the installation progress. The installer notifies you when the installation is complete. ![The EDB Postgres Advanced Server installation is complete](../../../../images/advanced_server_installation_completion.png) diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx index 9691d6a344d..4d1a1313f90 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx @@ -11,19 +11,21 @@ To specify that the installer should run without user interaction, include the ` - Command line options (specified when invoking the installer) - Parameters specified in an option file -- EDB Postgres Advanced Server (EPAS) installation defaults +- EDB Postgres Advanced Server installation defaults -You can embed the non-interactive EPAS installer within another application installer; during the installation process, a progress bar allows the user to view the progression of the installation. +You can embed the non-interactive EDB Postgres Advanced Server installer within another application installer; during the installation process, a progress bar allows the user to view the progression of the installation. -You must have administrative privileges to install EPAS using the `--mode unattended` option. If you are using the `--mode unattended` option to install EPAS with a client, the calling client must be invoked with superuser or administrative privileges. +You must have administrative privileges to install EDB Postgres Advanced Server using the `--mode unattended` option. If you are using the `--mode unattended` option to install EDB Postgres Advanced Server with a client, the calling client must be invoked with superuser or administrative privileges. To start the installer in unattended mode, navigate to the directory that contains the executable file, and enter: ```text -edb-as14-server-14.x.x-x-windows-x64.exe --mode unattended --superpassword +edb-asxx-server-xx.x.x-x-windows-x64.exe --mode unattended --superpassword database_superuser_password --servicepassword system_password ``` -When invoking the installer, include the `--servicepassword` option to specify an operating system password for the user installing EPAS. +Where <*xx*> represents the EDB Postgres Advanced Server version number. + +When invoking the installer, include the `--servicepassword` option to specify an operating system password for the user installing EDB Postgres Advanced Server. Use the `--superpassword` option to specify a password that conforms to the password security policies defined on the host; enforced password policies on your system may not accept the default password `(enterprisedb)`. diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx index 8494120a817..f94d05f37bd 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/reference_command_line_options.mdx @@ -7,7 +7,7 @@ redirects: -You can optionally include the following parameters for an EDB Postgres Advanced Server (EPAS) installation on the command line or in a configuration file when invoking the EPAS installer. +You can optionally include the following parameters for an EDB Postgres Advanced Server installation on the command line or in a configuration file when invoking the EDB Postgres Advanced Server installer. `--create_samples { yes | no }` @@ -31,7 +31,7 @@ Helps with troubleshooting installation problems. `debug_log` is the name of the `--disable-components component_list` -Specifies a list of EPAS components to exclude from the installation. By default, `component_list` contains '' (the empty string). `component_list` is a comma-separated list containing one or more of the following components: +Specifies a list of EDB Postgres Advanced Server components to exclude from the installation. By default, `component_list` contains '' (the empty string). `component_list` is a comma-separated list containing one or more of the following components: - `dbserver` — EDB Postgres Advanced Server. @@ -39,7 +39,7 @@ Specifies a list of EPAS components to exclude from the installation. By default `--enable_acledit { 1 | 0 }` -The `--enable_acledit 1` option instructs the installer to grant permission to the user specified by the `--serviceaccount` option to access the EPAS binaries and `data` directory. By default, this option is disabled if `--enable_acledit 0` is specified or if the `--enable_acledit` option is completely omitted. +The `--enable_acledit 1` option instructs the installer to grant permission to the user specified by the `--serviceaccount` option to access the EDB Postgres Advanced Server binaries and `data` directory. By default, this option is disabled if `--enable_acledit 0` is specified or if the `--enable_acledit` option is completely omitted. !!! Note Specifying this option is valid only when installing on Windows. Specify the `--enable_acledit 1` option when a discretionary access control list (DACL) needs to be set for allowing access to objects on which to install EDB Postgres Advanced Server. For information on a DACL, see [DACLs and ACEs](https://msdn.microsoft.com/en-us/library/windows/desktop/aa446597(v=vs.85).aspx) in the Microsoft documentation. @@ -52,7 +52,7 @@ Although this option is listed when you run the installer with the `--help` opti `--extract-only { yes | no }` -Include the `--extract-only` parameter to indicate that the installer should extract the EPAS binaries without performing a complete installation. Superuser privileges aren't required for the `--extract-only` option. The default value is `no`. +Include the `--extract-only` parameter to indicate that the installer should extract the EDB Postgres Advanced Server binaries without performing a complete installation. Superuser privileges aren't required for the `--extract-only` option. The default value is `no`. `--help` @@ -60,7 +60,7 @@ Displays a list of the optional parameters. `--installer-language { en | ja | zh_CN | zh_TW | ko }` -Specifies an installation language for EPAS. The default is `en`. +Specifies an installation language for EDB Postgres Advanced Server. The default is `en`. `en` specifies English. @@ -78,7 +78,7 @@ Specifies whether to install the Microsoft Visual C++ runtime libraries. Default `--locale locale` -Specifies the locale for the EPAS cluster. By default, the installer uses the locale detected by `initdb`. +Specifies the locale for the EDB Postgres Advanced Server cluster. By default, the installer uses the locale detected by `initdb`. `--mode { unattended }` @@ -90,7 +90,7 @@ Specifies the name of a file that contains the installation configuration parame `--prefix installation_dir/as14` -Specifies an installation directory for EPAS. The installer appends a version-specific subdirectory (that is, `as14`) to the specified directory. The default installation directory is: +Specifies an installation directory for EDB Postgres Advanced Server. The installer appends a version-specific subdirectory (that is, `as14`) to the specified directory. The default installation directory is: ```text C:\Program Files\edb\as14 @@ -98,19 +98,19 @@ C:\Program Files\edb\as14 `--serverport port_number` -Specifies a listener port number for EPAS. +Specifies a listener port number for EDB Postgres Advanced Server. -If you're installing EPAS in unattended mode and don't specify a value using the `--serverport` parameter, the installer uses port `5444` or the first available port after port `5444` as the default listener port. +If you're installing EDB Postgres Advanced Server in unattended mode and don't specify a value using the `--serverport` parameter, the installer uses port `5444` or the first available port after port `5444` as the default listener port. `--server_utilization {33 | 66 | 100}` -Specifies a value for the `edb_dynatune` configuration parameter. The `edb_dynatune` configuration parameter determines how EPAS allocates system resources. +Specifies a value for the `edb_dynatune` configuration parameter. The `edb_dynatune` configuration parameter determines how EDB Postgres Advanced Server allocates system resources. - A value of `33` is appropriate for a system used for development. A low value dedicates the least amount of the host machine’s resources to the database server. - A value of `66` is appropriate for an application server with a fixed number of applications. A midrange value dedicates a moderate amount of system resources to the database server. The default value is 66. -- A value of `100` is appropriate for a host machine that's dedicated to running EPAS. A high value dedicates most of the system resources to the database server. +- A value of `100` is appropriate for a host machine that's dedicated to running EDB Postgres Advanced Server. A high value dedicates most of the system resources to the database server. -When the installation is complete, you can adjust the value of `edb_dynatune` by editing the `postgresql.conf` file, located in the `data` directory of your EPAS installation. After editing the `postgresql.conf` file, you must restart the server for the changes to take effect. +When the installation is complete, you can adjust the value of `edb_dynatune` by editing the `postgresql.conf` file, located in the `data` directory of your EDB Postgres Advanced Server installation. After editing the `postgresql.conf` file, you must restart the server for the changes to take effect. `--serviceaccount user_account_name` @@ -121,14 +121,14 @@ Specifies the name of the user account that owns the server process. For security reasons, the `--serviceaccount` parameter must specify the name of an account that doesn't hold administrator privileges. -If you specify both the `--serviceaccount` option and the `--enable_acledit 1` option when invoking the installer, the database service and pgAgent uses the same service account. They therefore have the required permissions to access the EPAS binaries and `data` directory. +If you specify both the `--serviceaccount` option and the `--enable_acledit 1` option when invoking the installer, the database service and pgAgent uses the same service account. They therefore have the required permissions to access the EDB Postgres Advanced Server binaries and `data` directory. !!! Note If you don't include the `--serviceaccount` option when invoking the installer, the `NetworkService` account owns the database service, and the pgAgent service is owned by either `enterprisedb` or `postgres` (depending on the installation mode). `--servicename service_name` -Specifies the name of the EPAS service. The default is `edb-as-14`. +Specifies the name of the EDB Postgres Advanced Server service. The default is `edb-as-14`. `--servicepassword user_password` @@ -149,7 +149,7 @@ Specifies the database superuser password. If you're installing in non-interacti Specifies installer behavior during an unattended installation. -Include `--unattendedmodeui none` to specify for the installer not to display progress bars during the EPAS installation. +Include `--unattendedmodeui none` to specify for the installer not to display progress bars during the EDB Postgres Advanced Server installation. Include `--unattendedmodeui minimal` to specify for the installer to display progress bars during the installation process. This is the default behavior. @@ -163,11 +163,11 @@ Retrieves version information about the installer. Specifies an initial value for the `edb_dynatune_profile` configuration parameter. `edb_dynatune_profile` controls aspects of performance-tuning based on the type of work that the server performs. -- Specify `oltp` if the EPAS installation is used to support heavy online transaction processing workloads. +- Specify `oltp` if the EDB Postgres Advanced Server installation is used to support heavy online transaction processing workloads. - The default value is `oltp`. -- Specify `mixed` if EPAS provides a mix of transaction processing and data reporting. -- Specify `reporting` if EPAS is used for heavy data reporting. +- Specify `mixed` if EDB Postgres Advanced Server provides a mix of transaction processing and data reporting. +- Specify `reporting` if EDB Postgres Advanced Server is used for heavy data reporting. -After the installation is complete, you can adjust the value of `edb_dynatune_profile` by editing the `postgresql.conf` file, located in the `data` directory of your EPAS installation. After editing the `postgresql.conf` file, you must restart the server for the changes to take effect. +After the installation is complete, you can adjust the value of `edb_dynatune_profile` by editing the `postgresql.conf` file, located in the `data` directory of your EDB Postgres Advanced Server installation. After editing the `postgresql.conf` file, you must restart the server for the changes to take effect. For more information about `edb_dynatune` and other performance-related topics, see [Managing performance](../../../../managing_performance/). diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx index 3188d11db3e..3f4a3edb22c 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx @@ -7,12 +7,14 @@ redirects: -A graphical installation is a quick and easy way to install EDB Postgres Advanced Server (EPAS) on a Windows system. Use the wizard's dialogs to specify information about your system and system usage; when you have completed the dialogs, the installer performs an installation based on the selections made during the setup process. +A graphical installation is a quick and easy way to install EDB Postgres Advanced Server on a Windows system. Use the wizard's dialogs to specify information about your system and system usage; when you have completed the dialogs, the installer performs an installation based on the selections made during the setup process. -To invoke the wizard, you must have administrator privileges. Assume administrator privileges, and double-click the `edb-as15-server-15.x.x-x-windows-x64` executable file. +To invoke the wizard, you must have administrator privileges. Assume administrator privileges, and double-click the `edb-as<*xx*>-server-xx.x.x-x-windows-x64` executable file. + +Where <*xx*> represents the EDB Postgres Advanced Server version number. !!! Note - To install EPAS on some versions of Windows, you may be required to right click on the file icon and select `Run as Administrator` from the context menu to invoke the installer with `Administrator` privileges. + To install EDB Postgres Advanced Server on some versions of Windows, you may be required to right click on the file icon and select `Run as Administrator` from the context menu to invoke the installer with `Administrator` privileges. ![The EDB Postgres Advanced Server installer Welcome window](../../../images/advanced_server_installer_welcome.png) @@ -34,11 +36,12 @@ The `Installation Directory` window opens.
Fig. 3: The Installation Directory window
-By default, the EPAS installation directory is: +By default, the EDB Postgres Advanced Server installation directory is: ```text -C:\Program Files\edb\as15 +C:\Program Files\edb\as<*xx*> ``` +Where <*xx*> represents the EDB Postgres Advanced Server version number. You can accept the default installation location, and click `Next` to continue, or optionally click the `File Browser` icon to open the `Browse For Folder` dialog to choose an alternate installation directory. @@ -49,9 +52,9 @@ You can accept the default installation location, and click `Next` to continue,
Fig. 4: The Select Components window
-The `Select Components` window contains a list of optional components that you can install with the EPAS `Setup` wizard. You can omit a module from the EPAS installation by deselecting the box next to the components name. +The `Select Components` window contains a list of optional components that you can install with the EDB Postgres Advanced Server `Setup` wizard. You can omit a module from the EDB Postgres Advanced Server installation by deselecting the box next to the components name. -The `Setup` wizard can install the following components while installing EPAS: +The `Setup` wizard can install the following components while installing EDB Postgres Advanced Server: **EDB Postgres Advanced Server** @@ -59,7 +62,7 @@ Select the `EDB Postgres Advanced Server` option to install EDB Postgres Advance **StackBuilder Plus** -The `StackBuilder Plus` utility is a graphical tool that can update installed products, or download and add supporting modules (and the resulting dependencies) after your EPAS setup and installation completes. See [Using StackBuilder Plus](using_stackbuilder_plus/) for more information about StackBuilder Plus. +The `StackBuilder Plus` utility is a graphical tool that can update installed products, or download and add supporting modules (and the resulting dependencies) after your EDB Postgres Advanced Server setup and installation completes. See [Using StackBuilder Plus](using_stackbuilder_plus/) for more information about StackBuilder Plus. **Command Line Tools** @@ -82,19 +85,20 @@ After selecting the components you wish to install, click `Next` to open the `Ad
Fig. 5: The Additional Directories window
-By default, the EPAS `data` files are saved to: +By default, the EDB Postgres Advanced Server `data` files are saved to: ```text -C:\Program Files\edb\as15\data +C:\Program Files\edb<*xx*>\data ``` +Where <*xx*> represents the EDB Postgres Advanced Server version number. -The default location of the EPAS `Write-Ahead Log (WAL) Directory` is: +The default location of the EDB Postgres Advanced Server `Write-Ahead Log (WAL) Directory` is: ```text -C:\Program Files\edb\as15\data\pg_wal +C:\Program Files\edb\as<*xx*>\data\pg_wal ``` -EPAS uses write-ahead logs to promote transaction safety and speed transaction processing; when you make a change to a table, the change is stored in shared memory and a record of the change is written to the write-ahead log. When you perform a `COMMIT`, EPAS writes contents of the write-ahead log to disk. +EDB Postgres Advanced Server uses write-ahead logs to promote transaction safety and speed transaction processing; when you make a change to a table, the change is stored in shared memory and a record of the change is written to the write-ahead log. When you perform a `COMMIT`, EDB Postgres Advanced Server writes contents of the write-ahead log to disk. Accept the default file locations, or use the `File Browser` icon to select an alternate location; click `Next` to continue to the `EPAS Dialect` window. @@ -124,11 +128,11 @@ If you select `Compatible with Oracle`, the installation includes the following | `dbms_lob` | Provides the capability to manage on large objects. | | `dbms_output` | Provides the capability to send messages to a message buffer, or get messages from the message buffer. | | `dbms_pipe` | Provides the capability to send messages through a pipe within or between sessions connected to the same database cluster. | -| `dbms_rls` | Enables the implementation of Virtual Private Database on certain EPAS database objects. | +| `dbms_rls` | Enables the implementation of Virtual Private Database on certain EDB Postgres Advanced Server database objects. | | `dbms_sql` | Provides an application interface to the EDB dynamic SQL functionality. | | `dbms_utility` | Provides various utility programs. | | `dbms_aqadm` | Provides supporting procedures for Advanced Queueing functionality. | -| `dbms_aq` | Provides message queueing and processing for EPAS. | +| `dbms_aq` | Provides message queueing and processing for EDB Postgres Advanced Server. | | `dbms_profiler` | Collects and stores performance information about the PL/pgSQL and SPL statements that are executed during a performance profiling session. | | `dbms_random` | Provides a number of methods to generate random values. | | `dbms_redact` | Enables the redacting or masking of data that is returned by a query. | @@ -145,13 +149,13 @@ If you select `Compatible with Oracle`, the installation includes the following | `utl_url` | Provides a way to escape illegal and reserved characters within an URL. | | `utl_raw` | Provides a way to manipulate or retrieve the length of raw data types. | -This is not a comprehensive list of the compatibility features for Oracle included when EPAS is installed in `Compatible with Oracle` mode. For more information, see the [Database compatibility for Oracle developers built-in package](../../../reference/oracle_compatibility_reference/epas_compat_bip_guide/). +This is not a comprehensive list of the compatibility features for Oracle included when EDB Postgres Advanced Server is installed in `Compatible with Oracle` mode. For more information, see the [Database compatibility for Oracle developers built-in package](../../../reference/oracle_compatibility_reference/epas_compat_bip_guide/). -If you choose to install in `Compatible with Oracle` mode, the EPAS superuser name is `enterprisedb`. +If you choose to install in `Compatible with Oracle` mode, the EDB Postgres Advanced Server superuser name is `enterprisedb`. **Compatible with PostgreSQL** -If you select `Compatible with PostgreSQL`, EPAS exhibits compatibility with PostgreSQL version 15. If you choose to install in `Compatible with PostgreSQL` mode, the default EPAS superuser name is `postgres`. +If you select `Compatible with PostgreSQL`, EDB Postgres Advanced Server exhibits compatibility with PostgreSQL. If you choose to install in `Compatible with PostgreSQL` mode, the default EDB Postgres Advanced Server superuser name is `postgres`. For detailed information about PostgreSQL functionality, visit the official [PostgreSQL website](http://www.postgresql.org). @@ -161,7 +165,7 @@ After specifying a configuration mode, click `Next` to continue to the `Password
Fig. 7: The Password window
-EPAS uses the password specified on the `Password` window for the database superuser. The specified password must conform to any security policies existing on the EPAS host. +EDB Postgres Advanced Server uses the password specified on the `Password` window for the database superuser. The specified password must conform to any security policies existing on the EDB Postgres Advanced Server host. After you enter a password in the `Password` field, confirm the password in the `Retype Password` field, and click `Next` to continue. @@ -173,25 +177,25 @@ The `Additional Configuration` window opens. Use the fields on the `Additional Configuration` window to specify installation details: -- Use the `Port` field to specify the port number that EPAS should listen to for connection requests from client applications. The default is `5444`. -- If the `Locale` field is set to `[Default locale]`, EPAS uses the system locale as the working locale. Use the drop-down listbox next to `Locale` to specify an alternate locale for EPAS. +- Use the `Port` field to specify the port number that EDB Postgres Advanced Server should listen to for connection requests from client applications. The default is `5444`. +- If the `Locale` field is set to `[Default locale]`, EDB Postgres Advanced Server uses the system locale as the working locale. Use the drop-down listbox next to `Locale` to specify an alternate locale for EDB Postgres Advanced Server. - By default, the `Setup` wizard installs corresponding sample data for the server dialect specified by the compatibility mode `(Oracle` or `PostgreSQL)`. Clear the check box next to `Install sample tables and procedures` if you don't wish to have sample data installed. After verifying the information on the `Additional Configuration` window, click `Next` to open the `Dynatune Dynamic Tuning: Server Utilization` window. -The graphical `Setup` wizard facilitates performance tuning via the Dynatune Dynamic Tuning feature. Dynatune functionality allows EPAS to make optimal usage of the system resources available on the host machine on which it is installed. +The graphical `Setup` wizard facilitates performance tuning via the Dynatune Dynamic Tuning feature. Dynatune functionality allows EDB Postgres Advanced Server to make optimal usage of the system resources available on the host machine on which it is installed. ![The Dynatune Dynamic Tuning: Server Utilization window](../../../images/dynatune_dynamic_tuning_server_utilization.png)
Fig. 9: The Dynatune Dynamic Tuning: Server Utilization window
-The `edb_dynatune` configuration parameter determines how EPAS allocates system resources. Use the radio buttons on the `Server Utilization` window to set the initial value of the `edb_dynatune` configuration parameter: +The `edb_dynatune` configuration parameter determines how EDB Postgres Advanced Server allocates system resources. Use the radio buttons on the `Server Utilization` window to set the initial value of the `edb_dynatune` configuration parameter: - Select `Development` to set the value of `edb_dynatune` to `33`. A low value dedicates the least amount of the host machine’s resources to the database server. This is a good choice for a development machine. -- Select `General Purpose` to set the value of `edb_dynatune` to `66`. A mid-range value dedicates a moderate amount of system resources to the database server. This would be a good setting for an application server with a fixed number of applications running on the same host as EPAS. +- Select `General Purpose` to set the value of `edb_dynatune` to `66`. A mid-range value dedicates a moderate amount of system resources to the database server. This would be a good setting for an application server with a fixed number of applications running on the same host as EDB Postgres Advanced Server. - Select `Dedicated` to set the value of `edb_dynatune` to `100`. A high value dedicates most of the system resources to the database server. This is a good choice for a dedicated server host. -After the installation is complete, you can adjust the value of `edb_dynatune` by editing the `postgresql.conf` file, located in the `data` directory of your EPAS installation. After editing the `postgresql.conf` file, you must restart the server for your changes to take effect. +After the installation is complete, you can adjust the value of `edb_dynatune` by editing the `postgresql.conf` file, located in the `data` directory of your EDB Postgres Advanced Server installation. After editing the `postgresql.conf` file, you must restart the server for your changes to take effect. Select the appropriate setting for your system, and click `Next` to continue to the `Dynatune Dynamic Tuning: Workload Profile` window. @@ -201,17 +205,17 @@ Select the appropriate setting for your system, and click `Next` to continue to Use the radio buttons on the `Workload Profile` window to specify the initial value of the `edb_dynatune_profile` configuration parameter. The `edb_dynatune_profile` parameter controls performance-tuning aspects based on the type of work that the server performs. -- Select `Transaction Processing (OLTP systems)` to specify an `edb_dynatune_profile` value of `oltp`. Recommended when EPAS is supporting heavy online transaction processing. +- Select `Transaction Processing (OLTP systems)` to specify an `edb_dynatune_profile` value of `oltp`. Recommended when EDB Postgres Advanced Server is supporting heavy online transaction processing. - Select `General Purpose (OLTP and reporting workloads)` to specify an `edb_dynatune_profile` value of `mixed`. Recommended for servers that provide a mix of transaction processing and data reporting. - Select `Reporting (Complex queries or OLAP workloads)` to specify an `edb_dynatune_profile` value of `reporting`. Recommended for database servers used for heavy data reporting. -After the installation is complete, you can adjust the value of `edb_dynatune_profile` by editing the `postgresql.conf` file, located in the `data` directory of your EPAS installation. After editing the `postgresql.conf` file, you must restart the server for your changes to take effect. +After the installation is complete, you can adjust the value of `edb_dynatune_profile` by editing the `postgresql.conf` file, located in the `data` directory of your EDB Postgres Advanced Server installation. After editing the `postgresql.conf` file, you must restart the server for your changes to take effect. For more information about `edb_dynatune` and other performance-related topics, see the [Dynatune](../../../managing_performance/using_dynatune). Click `Next` to continue. -By default, EPAS is configured to start the service when the system boots. The `Pre Installation Summary` opens. +By default, EDB Postgres Advanced Server is configured to start the service when the system boots. The `Pre Installation Summary` opens. ![The Pre Installation Summary](../../../images/pre_installation_summary.png) @@ -219,7 +223,7 @@ By default, EPAS is configured to start the service when the system boots. The ` The `Pre Installation Summary` provides an overview of the options specified during the `Setup` process. Review the options before clicking `Next`; click `Back` to navigate back through the dialogs and update any options. -The `Ready to Install` window confirms that the installer has the information it needs about your configuration preferences to install EPAS. Click `Next` to continue. +The `Ready to Install` window confirms that the installer has the information it needs about your configuration preferences to install EDB Postgres Advanced Server. Click `Next` to continue. ![The Ready to Install window](../../../images/ready_to_install.png) @@ -231,12 +235,12 @@ The `Ready to Install` window confirms that the installer has the information it As each supporting module is unpacked and installed, the module’s installation is confirmed with a progress bar. -Before the `Setup` wizard completes the EPAS installation, it offers to `Launch StackBuilder Plus at exit?` +Before the `Setup` wizard completes the EDB Postgres Advanced Server installation, it offers to `Launch StackBuilder Plus at exit?` ![The Setup wizard offers to Launch StackBuilder Plus at exit](../../../images/setup_wizard.png)
Fig. 14: The Setup wizard offers to Launch StackBuilder Plus at exit
-You can clear the `StackBuilder Plus` check box and click `Finish` to complete the EPAS installation, or accept the default and proceed to StackBuilder Plus. +You can clear the `StackBuilder Plus` check box and click `Finish` to complete the EDB Postgres Advanced Server installation, or accept the default and proceed to StackBuilder Plus. -EDB Postgres StackBuilder Plus is included with the installation of EPAS and its core supporting components. StackBuilder Plus is a graphical tool that can update installed products, or download and add supporting modules (and the resulting dependencies) after your EPAS setup and installation completes. See [Using StackBuilder Plus](using_stackbuilder_plus/) for more information about StackBuilder Plus. +EDB Postgres StackBuilder Plus is included with the installation of EDB Postgres Advanced Server and its core supporting components. StackBuilder Plus is a graphical tool that can update installed products, or download and add supporting modules (and the resulting dependencies) after your EDB Postgres Advanced Server setup and installation completes. See [Using StackBuilder Plus](using_stackbuilder_plus/) for more information about StackBuilder Plus. diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/setting_cluster_preferences.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/setting_cluster_preferences.mdx index 644a15d627f..938e7d52e80 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/setting_cluster_preferences.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/setting_cluster_preferences.mdx @@ -11,7 +11,7 @@ SET INITDBOPTS= -k -E=UTF-8 If you specify values in `INITDBOPTS` that are also provided by the installer (such as the `–D` option, which specifies the installation directory), the value specified in the graphical installer supersedes the value if specified in `INITDBOPTS`. -For more information about using `initdb` cluster configuration options, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/app-initdb.html). In addition to the cluster configuration options documented in the PostgreSQL core documentation, EPAS supports the following `initdb` options: +For more information about using `initdb` cluster configuration options, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/app-initdb.html). In addition to the cluster configuration options documented in the PostgreSQL core documentation, EDB Postgres Advanced Server supports the following `initdb` options: `--no-redwood-compat` diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/using_stackbuilder_plus.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/using_stackbuilder_plus.mdx index c591ba9e9de..798c99b1ec4 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/using_stackbuilder_plus.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/using_stackbuilder_plus.mdx @@ -7,7 +7,7 @@ redirects: -The StackBuilder Plus utility provides a graphical interface that simplifies the process of updating, downloading, and installing modules that complement your EDB Postgres Advanced Server (EPAS) installation. When you install a module with StackBuilder Plus, StackBuilder Plus automatically resolves any software dependencies. +The StackBuilder Plus utility provides a graphical interface that simplifies the process of updating, downloading, and installing modules that complement your EDB Postgres Advanced Server installation. When you install a module with StackBuilder Plus, StackBuilder Plus automatically resolves any software dependencies. You can invoke StackBuilder Plus at any time after the installation has completed by selecting the `StackBuilder Plus` menu option from the `Apps` menu. Enter your system password (if prompted), and the StackBuilder Plus welcome window opens. @@ -15,11 +15,11 @@ You can invoke StackBuilder Plus at any time after the installation has complete
Fig. 19: The StackBuilder Plus welcome window
-Use the drop-down listbox on the welcome window to select your EPAS installation. +Use the drop-down listbox on the welcome window to select your EDB Postgres Advanced Server installation. -StackBuilder Plus requires Internet access; if your installation of EPAS resides behind a firewall (with restricted Internet access), StackBuilder Plus can download program installers through a proxy server. The module provider determines if the module can be accessed through an HTTP proxy or an FTP proxy; currently, all updates are transferred via an HTTP proxy and the FTP proxy information is not used. +StackBuilder Plus requires Internet access; if your installation of EDB Postgres Advanced Server resides behind a firewall (with restricted Internet access), StackBuilder Plus can download program installers through a proxy server. The module provider determines if the module can be accessed through an HTTP proxy or an FTP proxy; currently, all updates are transferred via an HTTP proxy and the FTP proxy information is not used. -If the selected EPAS installation has restricted Internet access, use the `Proxy Servers` on the `Welcome` window to open the `Proxy servers` dialog. +If the selected EDB Postgres Advanced Server installation has restricted Internet access, use the `Proxy Servers` on the `Welcome` window to open the `Proxy servers` dialog. ![The Proxy Servers dialog](../../../images/proxy_servers.png) diff --git a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/configuring_epas.mdx b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/configuring_epas.mdx index 444754c586d..ca3cc1cdaea 100644 --- a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/configuring_epas.mdx +++ b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/configuring_epas.mdx @@ -9,11 +9,11 @@ redirects: - /epas/latest/epas_inst_windows/managing_an_advanced_server_installation/configuring_epas/ --- -You can easily update parameters that determine the behavior of EDB Postgres Advanced Server (EPAS) and supporting components by modifying the following configuration files: +You can easily update parameters that determine the behavior of EDB Postgres Advanced Server and supporting components by modifying the following configuration files: -- The `postgresql.conf` file determines the initial values of EPAS configuration parameters. +- The `postgresql.conf` file determines the initial values of EDB Postgres Advanced Server configuration parameters. - The `pg_hba.conf` file specifies your preferences for network authentication and authorization. -- The `pg_ident.conf` file maps operating system identities (user names) to EPAS identities (roles) when using `ident`-based authentication. +- The `pg_ident.conf` file maps operating system identities (user names) to EDB Postgres Advanced Server identities (roles) when using `ident`-based authentication. For more information about Modifying the postgresql.conf file and Modifying the pg_hba.conf file, see [Setting parameters](../../../../database_administration/01_configuration_parameters/01_setting_new_parameters). @@ -27,7 +27,7 @@ You can use your editor of choice to open a configuration file, or on Windows na The graphical installer provides a script that simplifies the task of setting environment variables for Windows users. The script sets the environment variables for your current shell session; when your shell session ends, the environment variables are destroyed. You may wish to invoke `pgplus_env.bat` from your system-wide shell startup script, so that environment variables are automatically defined for each shell session. -The `pgplus_env` script is created during the EPAS installation process and reflects the choices made during installation. To invoke the script, open a command line and enter: +The `pgplus_env` script is created during the EDB Postgres Advanced Server installation process and reflects the choices made during installation. To invoke the script, open a command line and enter: ```text C:\Program Files\edb\as14\pgplus_env.bat @@ -64,7 +64,7 @@ PGLOCALEDIR=C:\Program Files\PostgreSQL\14\share\locale ## Connecting to EDB Postgres Advanced Server with edb-psql -`edb-psql` is a command line client application that allows you to execute SQL commands and view the results. To open the `edb-psql` client, the client must be in your search path. The executable resides in the `bin` directory, under your EPAS installation. +`edb-psql` is a command line client application that allows you to execute SQL commands and view the results. To open the `edb-psql` client, the client must be in your search path. The executable resides in the `bin` directory, under your EDB Postgres Advanced Server installation. Use the following command and options to start the `edb-psql` client: @@ -96,7 +96,7 @@ The client is distributed with the graphical installer. To open pgAdmin, select
Fig. 1: The pgAdmin 4 client Dashboard
-To connect to the EPAS database server, expand the `Servers` node of the `Browser` tree control, and right click on the `EDB Postgres Advanced Server` node. When the context menu opens, select `Connect Server`. The `Connect to Server` dialog opens. +To connect to the EDB Postgres Advanced Server database server, expand the `Servers` node of the `Browser` tree control, and right click on the `EDB Postgres Advanced Server` node. When the context menu opens, select `Connect Server`. The `Connect to Server` dialog opens. ![The Connect to Server dialog](../../../../images/connecting_server.png) diff --git a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/controlling_server_startup_behavior_on_windows.mdx b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/controlling_server_startup_behavior_on_windows.mdx index e1883df33bc..40ae8b0ee4f 100644 --- a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/controlling_server_startup_behavior_on_windows.mdx +++ b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/controlling_server_startup_behavior_on_windows.mdx @@ -7,7 +7,7 @@ redirects: You can use the Windows Services utility to control the startup behavior of the server. Right click on the name of the service you wish to update, and select `Properties` from the context menu to open the `Properties` dialog. -Use the drop-down listbox in the `Startup type` field to specify how the EDB Postgres Advanced Server (EPAS) service behaves when the host starts. +Use the drop-down listbox in the `Startup type` field to specify how the EDB Postgres Advanced Server service behaves when the host starts. ![Specifying EDB Postgres Advanced Server's startup behavior](../../../../images/advanced_server_startup.png) diff --git a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/starting_and_stopping_epas.mdx b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/starting_and_stopping_epas.mdx index a4ac43ce363..76f93369d27 100644 --- a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/starting_and_stopping_epas.mdx +++ b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/starting_and_stopping_epas.mdx @@ -1,6 +1,5 @@ --- title: "Starting and stopping EDB Postgres Advanced Server" -navTitle: "Starting and stopping EPAS" --- A service is a program that runs in the background and requires no user interaction (in fact, a service provides no user interface); a service can be configured to start at boot time, or manually on demand. Services are best controlled using the platform-specific operating system service control utility. Many of the EDB Postgres Advanced Server (EPAS) supporting components are services. diff --git a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_pg_ctl_to_control_advanced_server.mdx b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_pg_ctl_to_control_advanced_server.mdx index f3841544986..58124318575 100644 --- a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_pg_ctl_to_control_advanced_server.mdx +++ b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_pg_ctl_to_control_advanced_server.mdx @@ -7,7 +7,7 @@ redirects: -You can use the `pg_ctl` utility to control an EDB Postgres Advanced Server (EPAS) service from the command line on any platform. `pg_ctl` allows you to start, stop, or restart the EPAS database server, reload the configuration parameters, or display the status of a running server. To invoke the utility, assume the identity of the cluster owner, navigate into the home directory of EPAS, and issue the command: +You can use the `pg_ctl` utility to control an EDB Postgres Advanced Server service from the command line on any platform. `pg_ctl` allows you to start, stop, or restart the EDB Postgres Advanced Server database server, reload the configuration parameters, or display the status of a running server. To invoke the utility, assume the identity of the cluster owner, navigate into the home directory of EDB Postgres Advanced Server, and issue the command: ```text ./bin/pg_ctl -D data_directory action @@ -15,7 +15,7 @@ You can use the `pg_ctl` utility to control an EDB Postgres Advanced Server (EPA `data_directory` -`data_directory` is the location of the data controlled by the EPAS cluster. +`data_directory` is the location of the data controlled by the EDB Postgres Advanced Server cluster. `action` diff --git a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_the_windows_services_applet.mdx b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_the_windows_services_applet.mdx index d3ef4b30ef6..fe9b66ecce3 100644 --- a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_the_windows_services_applet.mdx +++ b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/using_the_windows_services_applet.mdx @@ -7,15 +7,15 @@ redirects: -The Windows operating system includes a graphical service controller that offers control of EDB Postgres Advanced Server (EPAS) and the services associated with EPAS components. The `Services` utility can be accessed through the `Administrative Tools` section of the Windows `Control Panel`. +The Windows operating system includes a graphical service controller that offers control of EDB Postgres Advanced Server and the services associated with EDB Postgres Advanced Server components. The `Services` utility can be accessed through the `Administrative Tools` section of the Windows `Control Panel`. ![The EDB Postgres Advanced Server service in the Windows Services window](../../../../images/advanced_server_services.png)
Fig. 1: The EDB Postgres Advanced Server service in the Windows Services window
-The `Services` window displays an alphabetized list of services; the `edb-as-14` service controls EPAS. +The `Services` window displays an alphabetized list of services; the `edb-as-14` service controls EDB Postgres Advanced Server. -- Use the `Stop the service` option to stop the instance of EPAS. Any user (or client application) connected to the EPAS instance is abruptly disconnected if you stop the service. -- Use the `Start the service` option to start the EPAS service. -- Use the `Pause the service` option to tell EPAS to reload the server configuration parameters without disrupting user sessions for many of the configuration parameters. See [Configuring EPAS](configuring_epas/) for more information about the parameters that can be updated with a server reload. -- Use the `Restart the service` option to stop and then start the EPAS. Any user sessions are terminated when you stop the service. This option is useful to reset server parameters that only take effect on server start. +- Use the `Stop the service` option to stop the instance of EDB Postgres Advanced Server. Any user (or client application) connected to the EDB Postgres Advanced Server instance is abruptly disconnected if you stop the service. +- Use the `Start the service` option to start the EDB Postgres Advanced Server service. +- Use the `Pause the service` option to tell EDB Postgres Advanced Server to reload the server configuration parameters without disrupting user sessions for many of the configuration parameters. See [Configuring EDB Postgres Advanced Server](configuring_epas/) for more information about the parameters that can be updated with a server reload. +- Use the `Restart the service` option to stop and then start the EDB Postgres Advanced Server. Any user sessions are terminated when you stop the service. This option is useful to reset server parameters that only take effect on server start. diff --git a/product_docs/docs/epas/15/upgrading/03_limitations.mdx b/product_docs/docs/epas/15/upgrading/03_limitations.mdx index 8f3416cf1d9..48bbe3db9b8 100644 --- a/product_docs/docs/epas/15/upgrading/03_limitations.mdx +++ b/product_docs/docs/epas/15/upgrading/03_limitations.mdx @@ -5,13 +5,13 @@ redirects: - /epas/latest/epas_upgrade_guide/03_limitations/ --- -The `pg_upgrade` executable is distributed with EDB Postgres Advanced Server (EPAS) and is installed as part of the Database Server component. You don't need to further install or configure it. The `pg_upgrade` utility performs an in-place transfer of existing data between EPAS and any later version. +The `pg_upgrade` executable is distributed with EDB Postgres Advanced Server and is installed as part of the Database Server component. You don't need to further install or configure it. The `pg_upgrade` utility performs an in-place transfer of existing data between EDB Postgres Advanced Server and any later version. Several factors determine if an in-place upgrade is practical: - The on-disk representation of user-defined tables must not change between the original version and the upgraded version. - The on-disk representation of data types must not change between the original version and the upgraded version. -- To upgrade between major versions of EPAS with `pg_upgrade`, both versions must share a common binary representation for each data type. Therefore, you can't use `pg_upgrade` to migrate from a 32-bit to a 64-bit Linux platform. +- To upgrade between major versions of EDB Postgres Advanced Server with `pg_upgrade`, both versions must share a common binary representation for each data type. Therefore, you can't use `pg_upgrade` to migrate from a 32-bit to a 64-bit Linux platform. Before performing a version upgrade, `pg_upgrade` verifies that the old cluster and the new cluster are compatible. @@ -22,13 +22,8 @@ If the upgrade involves a change in the on-disk representation of database objec 1. Run `initdb` to create a new cluster. 1. Import your old data. -Consider the following when upgrading EPAS: +Consider the following when upgrading EDB Postgres Advanced Server: - The `pg_upgrade` utility can't upgrade a partitioned table if a foreign key refers to the partitioned table. -- If you're upgrading from the **version 9.4 server or a lower version** of EPAS, and you use partitioned tables that include a `SUBPARTITION BY` clause, you must use `pg_dump` and `pg_restore` to upgrade an existing EPAS installation to a later version of EPAS. To upgrade, you must: - 1. Use `pg_dump` to preserve the content of the subpartitioned table. - 2. Drop the table from the EPAS 9.4 database or a lower version of EPAS database. - 3. Use `pg_upgrade` to upgrade the rest of the EPAS database to a more recent version. - 4. Use `pg_restore` to restore the subpartitioned table to the latest upgraded EPAS database. -- If you perform an upgrade of the EPAS installation, you must rebuild any hash-partitioned table on the upgraded server. -- If you're using an ODBC, JDBC, OCI, or .NET driver to connect to your database applications and upgrading to a new major version of EPAS, upgrade your driver to the latest version when upgrading EPAS. +- If you perform an upgrade of the EDB Postgres Advanced Server installation, you must rebuild any hash-partitioned table on the upgraded server. +- If you're using an ODBC, JDBC, OCI, or .NET driver to connect to your database applications and upgrading to a new major version of EDB Postgres Advanced Server, upgrade your driver to the latest version when upgrading EDB Postgres Advanced Server. diff --git a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/01_performing_an_upgrade/index.mdx b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/01_performing_an_upgrade/index.mdx index 5f368ced324..345b2ab8efd 100644 --- a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/01_performing_an_upgrade/index.mdx +++ b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/01_performing_an_upgrade/index.mdx @@ -5,23 +5,23 @@ redirects: - /epas/latest/epas_upgrade_guide/04_upgrading_an_installation_with_pg_upgrade/01_performing_an_upgrade/ --- -To upgrade an earlier version of EDB Postgres Advanced Server (EPAS) to the current version: +To upgrade an earlier version of EDB Postgres Advanced Server to the current version: -1. Install the current version of EPAS. The new installation must contain the same supporting server components as the old installation. +1. Install the current version of EDB Postgres Advanced Server. The new installation must contain the same supporting server components as the old installation. 1. Empty the target database or create a new target cluster with `initdb`. 1. To avoid authentication conflicts, place the `pg_hba.conf` file for both databases in `trust` authentication mode. -1. Shut down the old and new EPAS services. +1. Shut down the old and new EDB Postgres Advanced Server services. 1. Invoke the `pg_upgrade` utility. When `pg_upgrade` starts, it performs a compatibility check to ensure that all required executables are present and contain the expected version numbers. The verification process also checks the old and new `$PGDATA` directories to ensure that the expected files and subdirectories are in place. If the verification process succeeds, `pg_upgrade` starts the old `postmaster` and runs `pg_dumpall --schema-only` to capture the metadata contained in the old cluster. The script produced by `pg_dumpall` is used in later to re-create all user-defined objects in the new cluster. -The script produced by `pg_dumpall` re-creates only user-defined objects and not system-defined objects. The new cluster already contains the system-defined objects created by the latest version of EPAS. +The script produced by `pg_dumpall` re-creates only user-defined objects and not system-defined objects. The new cluster already contains the system-defined objects created by the latest version of EDB Postgres Advanced Server. After extracting the metadata from the old cluster, `pg_upgrade` performs the bookkeeping tasks required to sync the new cluster with the existing data. `pg_upgrade` runs the `pg_dumpall` script against the new cluster to create empty database objects of the same shape and type as those found in the old cluster. Then, `pg_upgrade` links or copies each table and index from the old cluster to the new cluster. -If you're upgrading to EPAS and installed the `edb_dblink_oci` or `edb_dblink_libpq` extension, drop the extension before performing an upgrade. To drop the extension, connect to the server with the psql or PEM client, and invoke the commands: +If you're upgrading to EDB Postgres Advanced Server and installed the `edb_dblink_oci` or `edb_dblink_libpq` extension, drop the extension before performing an upgrade. To drop the extension, connect to the server with the psql or PEM client, and invoke the commands: ```sql DROP EXTENSION edb_dblink_oci; diff --git a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/02_invoking_pg_upgrade/01_command_line_options_reference.mdx b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/02_invoking_pg_upgrade/01_command_line_options_reference.mdx index 478743ec329..adb0e2d782a 100644 --- a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/02_invoking_pg_upgrade/01_command_line_options_reference.mdx +++ b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/02_invoking_pg_upgrade/01_command_line_options_reference.mdx @@ -56,15 +56,15 @@ Use the `-O` or `--new-options` keyword to specify options to pass to the new `p `-p old_port_number` `--old-port old_port_number` -Include the `-p` or `--old-port` keyword to specify the port number of the EDB Postgres Advanced Server (EPAS) installation that you're upgrading. +Include the `-p` or `--old-port` keyword to specify the port number of the EDB Postgres Advanced Server installation that you're upgrading. `-P new_port_number` `--new-port new_port_number` -Include the `-P` or `--new-port` keyword to specify the port number of the new EPAS installation. +Include the `-P` or `--new-port` keyword to specify the port number of the new EDB Postgres Advanced Server installation. !!! Note - If the original EPAS installation is using port number `5444` when you invoke the EPAS installer, the installer recommends using listener port `5445` for the new installation of EPAS. + If the original EDB Postgres Advanced Server installation is using port number `5444` when you invoke the EDB Postgres Advanced Server installer, the installer recommends using listener port `5445` for the new installation of EDB Postgres Advanced Server. `-r` `--retain` @@ -74,7 +74,7 @@ During the upgrade process, `pg_upgrade` creates four append-only log files. Whe `-U user_name` `--username user_name` -Include the `-U` or `--username` keyword to specify the name of the EPAS database superuser. The same superuser must exist in both clusters. +Include the `-U` or `--username` keyword to specify the name of the EDB Postgres Advanced Server database superuser. The same superuser must exist in both clusters. `-v` `--verbose` diff --git a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/03_upgrading_to_advanced_server.mdx b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/03_upgrading_to_advanced_server.mdx index ab6cd3b2429..2717264162d 100644 --- a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/03_upgrading_to_advanced_server.mdx +++ b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/03_upgrading_to_advanced_server.mdx @@ -5,21 +5,21 @@ redirects: - /epas/latest/epas_upgrade_guide/04_upgrading_an_installation_with_pg_upgrade/03_upgrading_to_advanced_server/ --- -You can use `pg_upgrade` to upgrade from an existing installation of EDB Postgres Advanced Server (EPAS) into the cluster built by the EPAS installer or into an alternative cluster created using the `initdb` command. +You can use `pg_upgrade` to upgrade from an existing installation of EDB Postgres Advanced Server into the cluster built by the EDB Postgres Advanced Server installer or into an alternative cluster created using the `initdb` command. -The basic steps to perform an upgrade into an empty cluster created with the `initdb` command are the same as the steps to upgrade into the cluster created by the EPAS installer. However, you can omit Step 2 - Empty the edb database and substitute the location of the alternative cluster when specifying a target cluster for the upgrade. +The basic steps to perform an upgrade into an empty cluster created with the `initdb` command are the same as the steps to upgrade into the cluster created by the EDB Postgres Advanced Server installer. However, you can omit Step 2 - Empty the edb database and substitute the location of the alternative cluster when specifying a target cluster for the upgrade. If a problem occurs during the upgrade process, you can revert to the previous version. See [Reverting to the old cluster](06_reverting_to_the_old_cluster/#reverting_to_the_old_cluster) for detailed information about this process. -You must be an operating system superuser or Windows Administrator to perform an EPAS upgrade. +You must be an operating system superuser or Windows Administrator to perform an EDB Postgres Advanced Server upgrade. ## Step 1 - Install the new server -Install the new version of EDB Postgres Advanced Server, specifying the same non-server components that were installed during the previous EPAS installation. The new cluster and the old cluster must reside in different directories. +Install the new version of EDB Postgres Advanced Server, specifying the same non-server components that were installed during the previous EDB Postgres Advanced Server installation. The new cluster and the old cluster must reside in different directories. ## Step 2 - Empty the target database -The target cluster must not contain any data. You can create an empty cluster using the `initdb` command, or you can empty a database that was created during the installation of EPAS. If you installed EPAS in PostgreSQL mode, the installer creates a single database named `postgres`. Installing EPAS in Oracle mode creates a database named `postgres` and a database named `edb`. +The target cluster must not contain any data. You can create an empty cluster using the `initdb` command, or you can empty a database that was created during the installation of EDB Postgres Advanced Server. If you installed EDB Postgres Advanced Server in PostgreSQL mode, the installer creates a single database named `postgres`. Installing EDB Postgres Advanced Server in Oracle mode creates a database named `postgres` and a database named `edb`. The easiest way to empty the target database is to drop the database and then create a new database. Before invoking the `DROP DATABASE` command, you must disconnect any users and halt any services that are currently using the database. @@ -31,7 +31,7 @@ On Linux, open a terminal window, assume superuser privileges, and manually stop service edb-pgagent-14 stop ``` -After stopping any services that are currently connected to EPAS, you can use the EDB-PSQL command line client to drop and create a database. When the client opens, connect to the `template1` database as the database superuser. If prompted, provide authentication information. Then, use the following command to drop your database: +After stopping any services that are currently connected to EDB Postgres Advanced Server, you can use the EDB-PSQL command line client to drop and create a database. When the client opens, connect to the `template1` database as the database superuser. If prompted, provide authentication information. Then, use the following command to drop your database: ```sql DROP DATABASE ; @@ -49,7 +49,7 @@ CREATE DATABASE ; During the upgrade process, `pg_upgrade` connects to the old and new servers several times. To make the connection process easier, you can edit the `pg_hba.conf` file, setting the authentication mode to `trust`. To modify the `pg_hba.conf` file, from the Start menu, select **EDB Postgres > EDB Postgres Advanced Server > Expert Configuration**. Select **Edit pg_hba.conf** to open the `pg_hba.conf` file. -You must allow trust authentication for the previous EPAS installation and EPAS servers. Edit the `pg_hba.conf` file for both installations of EPAS as shown in the figure. +You must allow trust authentication for the previous EDB Postgres Advanced Server installation and EDB Postgres Advanced Server servers. Edit the `pg_hba.conf` file for both installations of EDB Postgres Advanced Server as shown in the figure. ![Configuring EDB Postgres Advanced Server to use trust authentication.](../../../images/configuring_advanced_server_to_use_trust_authentication.png) @@ -59,7 +59,7 @@ If the system is required to maintain `md5` authentication mode during the upgra ## Step 4 - Stop all component services and servers -Before you invoke `pg_upgrade`, you must stop any services that belong to the original EPAS installation, EPAS, or the supporting components. Stopping these services ensures that a service doesn't attempt to access either cluster during the upgrade process. +Before you invoke `pg_upgrade`, you must stop any services that belong to the original EDB Postgres Advanced Server installation, EDB Postgres Advanced Server, or the supporting components. Stopping these services ensures that a service doesn't attempt to access either cluster during the upgrade process. The services in the table are most likely to be running in your installation. @@ -100,13 +100,13 @@ Open a terminal window and manually stop each service at the command line. ## Step 5 for Linux only - Assume the identity of the cluster owner -If you're using Linux, assume the identity of the EPAS cluster owner. This example assumes EPAS was installed in the default, compatibility-with-Oracle database mode, assigning `enterprisedb` as the cluster owner. (If installed in compatibility-with-PostgreSQL database mode, `postgres` is the cluster owner.) +If you're using Linux, assume the identity of the EDB Postgres Advanced Server cluster owner. This example assumes EDB Postgres Advanced Server was installed in the default, compatibility-with-Oracle database mode, assigning `enterprisedb` as the cluster owner. (If installed in compatibility-with-PostgreSQL database mode, `postgres` is the cluster owner.) ```shell su - enterprisedb ``` -If prompted, enter the EPAS cluster owner password. Then, set the path to include the location of the `pg_upgrade` executable: +If prompted, enter the EDB Postgres Advanced Server cluster owner password. Then, set the path to include the location of the `pg_upgrade` executable: ```shell export PATH=$PATH:/usr/edb/as14/bin @@ -120,9 +120,9 @@ cd /tmp ## Step 5 for Windows only - Assume the identity of the cluster owner -If you're using Windows, open a terminal window, assume the identity of the EPAS cluster owner, and set the path to the `pg_upgrade` executable. +If you're using Windows, open a terminal window, assume the identity of the EDB Postgres Advanced Server cluster owner, and set the path to the `pg_upgrade` executable. -If the `--serviceaccount service_account_user` parameter was specified during the initial installation of EPAS, then `service_account_user` is the EPAS cluster owner. In that case, give this user with the `RUNAS` command: +If the `--serviceaccount service_account_user` parameter was specified during the initial installation of EDB Postgres Advanced Server, then `service_account_user` is the EDB Postgres Advanced Server cluster owner. In that case, give this user with the `RUNAS` command: ```sql RUNAS /USER:service_account_user "CMD.EXE" @@ -135,7 +135,7 @@ During the upgrade process, `pg_upgrade` writes a file to the current working di cd %TEMP% ``` -If you omitted the `--serviceaccount` parameter during the initial installation of EPAS, then the default owner of the EPAS service and the database cluster is `NT AUTHORITY\NetworkService`. +If you omitted the `--serviceaccount` parameter during the initial installation of EDB Postgres Advanced Server, then the default owner of the EDB Postgres Advanced Server service and the database cluster is `NT AUTHORITY\NetworkService`. When `NT AUTHORITY\NetworkService` is the service account user, the `RUNAS` command might not be usable. It prompts for a password, and the `NT AUTHORITY\NetworkService` account isn't assigned a password. Thus, there's typically a failure with an error message such as “Unable to acquire user password.” @@ -188,7 +188,7 @@ After `pg_upgrade` confirms that the clusters are compatible, you can perform a ## Step 7 - Run pg_upgrade -After confirming that the clusters are compatible, you can invoke `pg_upgrade` to upgrade the old cluster to the new version of EPAS. +After confirming that the clusters are compatible, you can invoke `pg_upgrade` to upgrade the old cluster to the new version of EDB Postgres Advanced Server. On Linux: diff --git a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/04_upgrading_a_pgAgent_installation.mdx b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/04_upgrading_a_pgAgent_installation.mdx index 2e79b5755df..04f08483afb 100644 --- a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/04_upgrading_a_pgAgent_installation.mdx +++ b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/04_upgrading_a_pgAgent_installation.mdx @@ -5,7 +5,7 @@ redirects: - /epas/latest/epas_upgrade_guide/04_upgrading_an_installation_with_pg_upgrade/04_upgrading_a_pgAgent_installation/ --- -If your existing EDB Postgres Advanced Server (EPAS) installation uses pgAgent, you can use a script provided with the EPAS installer to update pgAgent. The script is named `dbms_job.upgrade.script.sql` and is located in the `/share/contrib/` directory under your EPAS installation. +If your existing EDB Postgres Advanced Server installation uses pgAgent, you can use a script provided with the EDB Postgres Advanced Server installer to update pgAgent. The script is named `dbms_job.upgrade.script.sql` and is located in the `/share/contrib/` directory under your EDB Postgres Advanced Server installation. If you're using `pg_upgrade` to upgrade your installation: diff --git a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/05_pg_upgrade_troubleshooting.mdx b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/05_pg_upgrade_troubleshooting.mdx index 86cca251c5c..bc0848f006c 100644 --- a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/05_pg_upgrade_troubleshooting.mdx +++ b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/05_pg_upgrade_troubleshooting.mdx @@ -9,7 +9,7 @@ These troubleshooting tips address problems you might encounter when using `pg_u ## Upgrade Error - There seems to be a postmaster servicing the cluster -If `pg_upgrade` reports that a postmaster is servicing the cluster, stop all EDB Postgres Advanced Server (EPAS) services and try the upgrade again. +If `pg_upgrade` reports that a postmaster is servicing the cluster, stop all EDB Postgres Advanced Server services and try the upgrade again. ## Upgrade Error - fe_sendauth: no password supplied @@ -21,7 +21,7 @@ If `pg_upgrade` reports that the new cluster isn't empty, empty the new cluster. ## Upgrade Error - Failed to load library -If the original EPAS cluster included libraries that aren't included in the EPAS cluster, `pg_upgrade` alerts you to the missing component during the consistency check by writing an entry to the `loadable_libraries.txt` file in the directory from which you invoked `pg_upgrade`. Generally, for missing libraries that aren't part of a major component upgrade: +If the original EDB Postgres Advanced Server cluster included libraries that aren't included in the EDB Postgres Advanced Server cluster, `pg_upgrade` alerts you to the missing component during the consistency check by writing an entry to the `loadable_libraries.txt` file in the directory from which you invoked `pg_upgrade`. Generally, for missing libraries that aren't part of a major component upgrade: 1. Restart the EDB Postgres Advanced Server service. diff --git a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/how_pg_upgrade_works.mdx b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/how_pg_upgrade_works.mdx index 3f12ce949ef..0e770a29418 100644 --- a/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/how_pg_upgrade_works.mdx +++ b/product_docs/docs/epas/15/upgrading/04_upgrading_an_installation_with_pg_upgrade/how_pg_upgrade_works.mdx @@ -1,23 +1,23 @@ --- -title: "How pg_upgrade works" +title: "About pg_upgrade" description: "Describes how the upgrade utility works" --- -The `pg_upgrade` executable is distributed with EDB Postgres Advanced Server (EPAS) and is installed as part of the Database Server component. You don't need to further install or configure it. +The `pg_upgrade` executable is distributed with EDB Postgres Advanced Server and is installed as part of the Database Server component. You don't need to further install or configure it. -The `pg_upgrade` utility performs an in-place transfer of existing data between EPAS and any later version. +The `pg_upgrade` utility performs an in-place transfer of existing data between EDB Postgres Advanced Server and any later version. Before performing a version upgrade, `pg_upgrade` verifies that the old cluster and the new cluster are compatible. When `pg_upgrade` starts, it performs a compatibility check to ensure that all required executables are present and contain the expected version numbers. The verification process also checks the old and new `$PGDATA` directories to ensure that the expected files and subdirectories are in place. If the verification process succeeds, `pg_upgrade` starts the old `postmaster` and runs `pg_dumpall --schema-only` to capture the metadata contained in the old cluster. The script produced by `pg_dumpall` is used in later to re-create all user-defined objects in the new cluster. -The script produced by `pg_dumpall` re-creates only user-defined objects and not system-defined objects. The new cluster already contains the system-defined objects created by the latest version of EPAS. +The script produced by `pg_dumpall` re-creates only user-defined objects and not system-defined objects. The new cluster already contains the system-defined objects created by the latest version of EDB Postgres Advanced Server. After extracting the metadata from the old cluster, `pg_upgrade` performs the bookkeeping tasks required to sync the new cluster with the existing data. `pg_upgrade` runs the `pg_dumpall` script against the new cluster to create empty database objects of the same shape and type as those found in the old cluster. Then, `pg_upgrade` links or copies each table and index from the old cluster to the new cluster. -If you're upgrading to EPAS and installed the `edb_dblink_oci` or `edb_dblink_libpq` extension, drop the extension before performing an upgrade. To drop the extension, connect to the server with the psql or PEM client, and invoke the commands: +If you're upgrading to EDB Postgres Advanced Server and installed the `edb_dblink_oci` or `edb_dblink_libpq` extension, drop the extension before performing an upgrade. To drop the extension, connect to the server with the psql or PEM client, and invoke the commands: ```sql DROP EXTENSION edb_dblink_oci; diff --git a/product_docs/docs/epas/15/upgrading/06_using_stackbuilder_plus_to_perform_a_minor_version_update.mdx b/product_docs/docs/epas/15/upgrading/06_using_stackbuilder_plus_to_perform_a_minor_version_update.mdx index e665c8561fa..228bff0b40c 100644 --- a/product_docs/docs/epas/15/upgrading/06_using_stackbuilder_plus_to_perform_a_minor_version_update.mdx +++ b/product_docs/docs/epas/15/upgrading/06_using_stackbuilder_plus_to_perform_a_minor_version_update.mdx @@ -8,17 +8,17 @@ redirects: !!! Note StackBuilder Plus is supported only on Windows systems. -The StackBuilder Plus utility provides a graphical interface that simplifies the process of updating, downloading, and installing modules that complement your EDB Postgres Advanced Server (EPAS) installation. When you install a module with StackBuilder Plus, StackBuilder Plus resolves any software dependencies. +The StackBuilder Plus utility provides a graphical interface that simplifies the process of updating, downloading, and installing modules that complement your EDB Postgres Advanced Server installation. When you install a module with StackBuilder Plus, StackBuilder Plus resolves any software dependencies. 1. To invoke StackBuilder Plus at any time after the installation has completed, select **Apps > StackBuilder Plus**. Enter your system password if prompted, and the StackBuilder Plus welcome window opens. ![The StackBuilder Plus welcome window](../images/the_stackBuilder_plus_welcome.png) -1. Select your EPAS installation. +1. Select your EDB Postgres Advanced Server installation. - StackBuilder Plus requires internet access. If your installation of EPAS is behind a firewall (with restricted internet access), StackBuilder Plus can download program installers through a proxy server. The module provider determines if the module can be accessed through an HTTP proxy or an FTP proxy. Currently, all updates are transferred by an HTTP proxy, and the FTP proxy information isn't used. + StackBuilder Plus requires internet access. If your installation of EDB Postgres Advanced Server is behind a firewall (with restricted internet access), StackBuilder Plus can download program installers through a proxy server. The module provider determines if the module can be accessed through an HTTP proxy or an FTP proxy. Currently, all updates are transferred by an HTTP proxy, and the FTP proxy information isn't used. -1. If the selected EPAS installation has restricted Internet access, on the Welcome screen, select **Proxy Servers** to open the Proxy servers dialog box: +1. If the selected EDB Postgres Advanced Server installation has restricted Internet access, on the Welcome screen, select **Proxy Servers** to open the Proxy servers dialog box: ![The Proxy servers dialog](../images/the_proxy_servers_dialog.png) @@ -28,7 +28,7 @@ The StackBuilder Plus utility provides a graphical interface that simplifies the The tree control on the StackBuilder Plus module selection window displays a node for each module category. -1. To add a component to the selected EPAS installation or to upgrade a component, select the box to the left of the module name, and select **Next**. +1. To add a component to the selected EDB Postgres Advanced Server installation or to upgrade a component, select the box to the left of the module name, and select **Next**. 1. If prompted, enter your email address and password on the StackBuilder Plus registration window. diff --git a/product_docs/docs/epas/15/upgrading/index.mdx b/product_docs/docs/epas/15/upgrading/index.mdx index 29410d20337..097888a1cff 100644 --- a/product_docs/docs/epas/15/upgrading/index.mdx +++ b/product_docs/docs/epas/15/upgrading/index.mdx @@ -6,8 +6,8 @@ redirects: - /epas/latest/epas_upgrade_guide/ --- -Upgrading EDB Postgres Advanced Server (EPAS) involves: +Upgrading EDB Postgres Advanced Server involves: -- `pg_upgrade` to upgrade from an earlier version of EPAS to the latest version. +- `pg_upgrade` to upgrade from an earlier version of EDB Postgres Advanced Server to the latest version. - `yum` to perform a minor version upgrade on a Linux host. - `StackBuilder Plus` to perform a minor version upgrade on a Windows host. From 2786c0dd87620133ef6a7e86daa9e3e763b4d395 Mon Sep 17 00:00:00 2001 From: francoughlin Date: Tue, 8 Aug 2023 12:58:28 -0400 Subject: [PATCH 25/28] Updates based on review Review comments --- .../configuring_a_package_installation.mdx | 2 +- .../modifying_the_data_directory_location.mdx | 4 ++-- .../15/installing/uninstalling/linux_uninstall.mdx | 2 +- .../15/installing/uninstalling/windows_uninstall.mdx | 2 +- ...forming_an_installation_with_limited_privileges.mdx | 2 +- .../performing_an_unattended_installation.mdx | 2 +- .../performing_a_graphical_installation_on_windows.mdx | 10 +++++----- .../starting_and_stopping_epas.mdx | 6 +++--- 8 files changed, 15 insertions(+), 15 deletions(-) diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/configuring_a_package_installation.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/configuring_a_package_installation.mdx index 50c064b4b02..9a9185a2df4 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/configuring_a_package_installation.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/configuring_a_package_installation.mdx @@ -6,7 +6,7 @@ The packages that install the database server component create a unit file on ve ## Creating a database cluster and starting the service -The PostgreSQL `initdb` command creates a database cluster. When installing EDB Postgres Advanced Server (EPAS) with an RPM package, the `initdb` executable is in `/usr/edb/asx.x/bin`. After installing EPAS, you must manually configure the service and invoke `initdb` to create your cluster. When invoking `initdb`, you can: +The PostgreSQL `initdb` command creates a database cluster. When installing EDB Postgres Advanced Server with an RPM package, the `initdb` executable is in `/usr/edb/asx.x/bin`. After installing EDB Postgres Advanced Server, you must manually configure the service and invoke `initdb` to create your cluster. When invoking `initdb`, you can: - Specify environment options on the command line. - Include the `systemd` service manager on RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x and use a service configuration file to configure the environment. diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx index af74b4e1053..b6cd5b7fd3f 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/modifying_the_data_directory_location.mdx @@ -4,7 +4,7 @@ title: "Modifying the data directory location" ## On RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x -On a RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x host, the unit file is named `edb-as-.service` (where *xx* is the EDB Postgres Advanced Server version number) and resides in `/usr/lib/systemd/system`. The unit file contains references to the location of the EDB Postgres Advanced Server `data` directory. Avoid making any modifications directly to the unit file because they might be overwritten during package upgrades. +On a RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x host, the unit file is named `edb-as-.service` (where *xx* is the EDB Postgres Advanced Server version) and resides in `/usr/lib/systemd/system`. The unit file contains references to the location of the EDB Postgres Advanced Server `data` directory. Avoid making any modifications directly to the unit file because they might be overwritten during package upgrades. By default, data files reside under `/var/lib/edb/as15/data` directory. To use a data directory that resides in a non-default location: @@ -41,7 +41,7 @@ By default, data files reside under `/var/lib/edb/as15/data` directory. To use a systemctl daemon-reload ``` -- Start the EPAS service with the following command: +- Start the EDB Postgres Advanced Server service with the following command: ```text systemctl start edb-as-15 diff --git a/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx b/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx index 9a69fdb9b80..5e100e66ff0 100644 --- a/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx +++ b/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx @@ -53,7 +53,7 @@ To uninstall EDB Postgres Advanced Server and its dependent packages, use the ap ```text yum remove edb-as-server* ``` -Where <*xx*> represents the EDB Postgres Advanced Server version number. +Where `<*xx*>` represents the EDB Postgres Advanced Server version. - On RHEL or Rocky Linux or AlmaLinux 8: diff --git a/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx b/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx index 47c971af0b4..063372f9800 100644 --- a/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx +++ b/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx @@ -20,7 +20,7 @@ The EDB Postgres Advanced Server interactive installer creates an uninstaller th ```text uninstall-edb-as-server.exe ``` - Where <*xx*> represents the EDB Postgres Advanced Server version number. + Where `<*xx*>` represents the EDB Postgres Advanced Server version. The uninstaller opens. diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx index c8fd787ad0f..6a41de0c900 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx @@ -33,7 +33,7 @@ To perform a limited installation and generate an installation script, download edb-asxx-server-xx.x.x-x-windows.exe --extract-only yes ``` -Where <*xx*> represents the EDB Postgres Advanced Server version number. +Where `<*xx*>` represents the EDB Postgres Advanced Server version. A dialog opens, prompting you to choose an installation language. Select a language for the installation from the drop-down listbox, and click `OK` to continue. The `Setup Wizard` opens. diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx index 4d1a1313f90..e979a7e3c65 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx @@ -24,7 +24,7 @@ edb-asxx-server-xx.x.x-x-windows-x64.exe --mode unattended --superpassword database_superuser_password --servicepassword system_password ``` -Where <*xx*> represents the EDB Postgres Advanced Server version number. +Where `<*xx*>` represents the EDB Postgres Advanced Server version. When invoking the installer, include the `--servicepassword` option to specify an operating system password for the user installing EDB Postgres Advanced Server. diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx index 3f4a3edb22c..8afbc85483a 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx @@ -11,7 +11,7 @@ A graphical installation is a quick and easy way to install EDB Postgres Advance To invoke the wizard, you must have administrator privileges. Assume administrator privileges, and double-click the `edb-as<*xx*>-server-xx.x.x-x-windows-x64` executable file. -Where <*xx*> represents the EDB Postgres Advanced Server version number. +Where `<*xx*>` represents the EDB Postgres Advanced Server version. !!! Note To install EDB Postgres Advanced Server on some versions of Windows, you may be required to right click on the file icon and select `Run as Administrator` from the context menu to invoke the installer with `Administrator` privileges. @@ -41,7 +41,7 @@ By default, the EDB Postgres Advanced Server installation directory is: ```text C:\Program Files\edb\as<*xx*> ``` -Where <*xx*> represents the EDB Postgres Advanced Server version number. +Where `<*xx*>` represents the EDB Postgres Advanced Server version. You can accept the default installation location, and click `Next` to continue, or optionally click the `File Browser` icon to open the `Browse For Folder` dialog to choose an alternate installation directory. @@ -90,7 +90,7 @@ By default, the EDB Postgres Advanced Server `data` files are saved to: ```text C:\Program Files\edb<*xx*>\data ``` -Where <*xx*> represents the EDB Postgres Advanced Server version number. +Where `<*xx*>` represents the EDB Postgres Advanced Server version. The default location of the EDB Postgres Advanced Server `Write-Ahead Log (WAL) Directory` is: @@ -106,9 +106,9 @@ Accept the default file locations, or use the `File Browser` icon to select an a
Fig. 6: The EDB Postgres Advanced Server Dialect window
-Use the drop-down listbox on the `EDB Postgres Advanced Server Dialect` window to choose a server dialect. The server dialect specifies the compatibility features supported by EPAS. +Use the drop-down listbox on the `EDB Postgres Advanced Server Dialect` window to choose a server dialect. The server dialect specifies the compatibility features supported by EDB Postgres Advanced Server. -By default, EPAS installs in `Compatible with Oracle` mode; you can choose between `Compatible with Oracle` and `Compatible with PostgreSQL` installation modes. +By default, EDB Postgres Advanced Server installs in `Compatible with Oracle` mode; you can choose between `Compatible with Oracle` and `Compatible with PostgreSQL` installation modes. **Compatible with Oracle** diff --git a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/starting_and_stopping_epas.mdx b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/starting_and_stopping_epas.mdx index 76f93369d27..afba2f44ac5 100644 --- a/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/starting_and_stopping_epas.mdx +++ b/product_docs/docs/epas/15/installing/windows/managing_an_advanced_server_installation/starting_and_stopping_epas.mdx @@ -2,9 +2,9 @@ title: "Starting and stopping EDB Postgres Advanced Server" --- -A service is a program that runs in the background and requires no user interaction (in fact, a service provides no user interface); a service can be configured to start at boot time, or manually on demand. Services are best controlled using the platform-specific operating system service control utility. Many of the EDB Postgres Advanced Server (EPAS) supporting components are services. +A service is a program that runs in the background and requires no user interaction (in fact, a service provides no user interface); a service can be configured to start at boot time, or manually on demand. Services are best controlled using the platform-specific operating system service control utility. Many of the EDB Postgres Advanced Server supporting components are services. -The following table lists the names of the services that control EPAS and services that control EPAS supporting components: +The following table lists the names of the services that control EDB Postgres Advanced Server and services that control EDB Postgres Advanced Server (EPAS) supporting components: | EPAS component name | Windows service name | | ------------------------------ | ------------------------------------------------ | @@ -13,4 +13,4 @@ The following table lists the names of the services that control EPAS and servic | PgBouncer | edb-pgbouncer-1.14 | | Slony | edb-slony-replication-14 | -You can use the command line or the Windows Services applet to control EPAS's database server and the services of EPAS's supporting components on a Windows host. +You can use the command line or the Windows Services applet to control EDB Postgres Advanced Server's database server and the services of EDB Postgres Advanced Server's supporting components on a Windows host. From e982c51a3711c551b35b5c8af1cd0397085aba3c Mon Sep 17 00:00:00 2001 From: francoughlin Date: Tue, 8 Aug 2023 14:58:34 -0400 Subject: [PATCH 26/28] Edits from Betsy --- .../installing_epas_using_local_repository.mdx | 2 +- .../managing_an_advanced_server_installation/index.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx b/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx index 4da202e2cd3..d13b9442b2c 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/installing_epas_using_local_repository.mdx @@ -7,7 +7,7 @@ redirects: - /epas/latest/epas_inst_linux/installing_epas_using_local_repository/ --- -You can create a local repository to act as a host for the EDB Postgres Advanced Server native packages if the server on which you want to install EDB Postgres Advanced Server or the supporting components can't directly access the EDB repository. This topic is only a high-level listing of the steps required; you will need to modify the process for your network. +You can create a local repository to act as a host for the EDB Postgres Advanced Server native packages if the server on which you want to install EDB Postgres Advanced Server or the supporting components can't directly access the EDB repository. For your network, modify this process from these high-level steps. To create and use a local repository, you must: diff --git a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/index.mdx b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/index.mdx index df815b67bd4..0f3cfff1f01 100644 --- a/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/index.mdx +++ b/product_docs/docs/epas/15/installing/linux_install_details/managing_an_advanced_server_installation/index.mdx @@ -9,4 +9,4 @@ redirects: - /epas/latest/epas_inst_linux/managing_an_advanced_server_installation/ --- - The commands and paths shown in the following topics assume that you performed an installation using the native packages, unless otherwise noted. + Unless otherwise noted, all commands and paths assume that you performed an installation using the native packages. From 162191d6bfc09891c474e72d099b1e08e91d1280 Mon Sep 17 00:00:00 2001 From: francoughlin Date: Tue, 8 Aug 2023 15:39:08 -0400 Subject: [PATCH 27/28] Formatting fixes for version numbers --- .../15/installing/uninstalling/linux_uninstall.mdx | 2 +- .../installing/uninstalling/windows_uninstall.mdx | 2 +- ...ing_an_installation_with_limited_privileges.mdx | 4 ++-- .../performing_an_unattended_installation.mdx | 2 +- ...forming_a_graphical_installation_on_windows.mdx | 14 +++++++------- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx b/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx index 5e100e66ff0..e22fabeed21 100644 --- a/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx +++ b/product_docs/docs/epas/15/installing/uninstalling/linux_uninstall.mdx @@ -53,7 +53,7 @@ To uninstall EDB Postgres Advanced Server and its dependent packages, use the ap ```text yum remove edb-as-server* ``` -Where `<*xx*>` represents the EDB Postgres Advanced Server version. +Where `` represents the EDB Postgres Advanced Server version. - On RHEL or Rocky Linux or AlmaLinux 8: diff --git a/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx b/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx index 063372f9800..bcf06331502 100644 --- a/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx +++ b/product_docs/docs/epas/15/installing/uninstalling/windows_uninstall.mdx @@ -20,7 +20,7 @@ The EDB Postgres Advanced Server interactive installer creates an uninstaller th ```text uninstall-edb-as-server.exe ``` - Where `<*xx*>` represents the EDB Postgres Advanced Server version. + Where `` represents the EDB Postgres Advanced Server version. The uninstaller opens. diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx index 6a41de0c900..7265b3cae3c 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_installation_with_limited_privileges.mdx @@ -33,7 +33,7 @@ To perform a limited installation and generate an installation script, download edb-asxx-server-xx.x.x-x-windows.exe --extract-only yes ``` -Where `<*xx*>` represents the EDB Postgres Advanced Server version. +Where `` represents the EDB Postgres Advanced Server version. A dialog opens, prompting you to choose an installation language. Select a language for the installation from the drop-down listbox, and click `OK` to continue. The `Setup Wizard` opens. @@ -50,7 +50,7 @@ Click `Next` to continue. On Windows, the default EDB Postgres Advanced Server installation directory is: ```text -C:\Program Files\edb\as<*xx*> +C:\Program Files\edb\as ``` You can accept the default installation location and click `Next` to continue to the `Ready to Install` window, or optionally click the `File Browser` icon to choose an alternate installation directory. diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx index e979a7e3c65..b2675e940ec 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/invoking_the_graphical_installer_from_the_command_line/performing_an_unattended_installation.mdx @@ -24,7 +24,7 @@ edb-asxx-server-xx.x.x-x-windows-x64.exe --mode unattended --superpassword database_superuser_password --servicepassword system_password ``` -Where `<*xx*>` represents the EDB Postgres Advanced Server version. +Where `` represents the EDB Postgres Advanced Server version. When invoking the installer, include the `--servicepassword` option to specify an operating system password for the user installing EDB Postgres Advanced Server. diff --git a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx index 8afbc85483a..06dc0da5bff 100644 --- a/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx +++ b/product_docs/docs/epas/15/installing/windows/installing_advanced_server_with_the_interactive_installer/performing_a_graphical_installation_on_windows.mdx @@ -9,9 +9,9 @@ redirects: A graphical installation is a quick and easy way to install EDB Postgres Advanced Server on a Windows system. Use the wizard's dialogs to specify information about your system and system usage; when you have completed the dialogs, the installer performs an installation based on the selections made during the setup process. -To invoke the wizard, you must have administrator privileges. Assume administrator privileges, and double-click the `edb-as<*xx*>-server-xx.x.x-x-windows-x64` executable file. +To invoke the wizard, you must have administrator privileges. Assume administrator privileges, and double-click the `edb-as-server-xx.x.x-x-windows-x64` executable file. -Where `<*xx*>` represents the EDB Postgres Advanced Server version. +Where `` represents the EDB Postgres Advanced Server version. !!! Note To install EDB Postgres Advanced Server on some versions of Windows, you may be required to right click on the file icon and select `Run as Administrator` from the context menu to invoke the installer with `Administrator` privileges. @@ -39,9 +39,9 @@ The `Installation Directory` window opens. By default, the EDB Postgres Advanced Server installation directory is: ```text -C:\Program Files\edb\as<*xx*> +C:\Program Files\edb\as ``` -Where `<*xx*>` represents the EDB Postgres Advanced Server version. +Where `` represents the EDB Postgres Advanced Server version. You can accept the default installation location, and click `Next` to continue, or optionally click the `File Browser` icon to open the `Browse For Folder` dialog to choose an alternate installation directory. @@ -88,14 +88,14 @@ After selecting the components you wish to install, click `Next` to open the `Ad By default, the EDB Postgres Advanced Server `data` files are saved to: ```text -C:\Program Files\edb<*xx*>\data +C:\Program Files\edb\data ``` -Where `<*xx*>` represents the EDB Postgres Advanced Server version. +Where `` represents the EDB Postgres Advanced Server version. The default location of the EDB Postgres Advanced Server `Write-Ahead Log (WAL) Directory` is: ```text -C:\Program Files\edb\as<*xx*>\data\pg_wal +C:\Program Files\edb\as\data\pg_wal ``` EDB Postgres Advanced Server uses write-ahead logs to promote transaction safety and speed transaction processing; when you make a change to a table, the change is stored in shared memory and a record of the change is written to the write-ahead log. When you perform a `COMMIT`, EDB Postgres Advanced Server writes contents of the write-ahead log to disk. From 7320ab5e579ffac758f5afb314cd95618c3153ad Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Wed, 9 Aug 2023 08:06:29 +0100 Subject: [PATCH 28/28] dirty links change to make link to index work Signed-off-by: Dj Walker-Morgan --- product_docs/docs/pgd/5/routing/installing_proxy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pgd/5/routing/installing_proxy.mdx b/product_docs/docs/pgd/5/routing/installing_proxy.mdx index 83877054e3a..c7eb9a0c779 100644 --- a/product_docs/docs/pgd/5/routing/installing_proxy.mdx +++ b/product_docs/docs/pgd/5/routing/installing_proxy.mdx @@ -82,7 +82,7 @@ The API can be enabled by adding the config `cluster.proxy.http.enable: true`. W To enable HTTPS set the config parameter `cluster.proxy.http.secure: true`. If it is set to `true`, the `cert_file` and `key_file` must also be set. -The `cluster.proxy.endpoint` is an endpoint used by the proxy to connect to the current write leader as part of its checks. When `cluster.proxy.http.enable` is `true`, `cluster.proxy.endpoint` must also be set. It could be same as BDR node [routing_dsn](index#configuration) where host will be `listen_address` and port will be `listen_port` [proxy options](index#configuration). If required, user can add additional connection string parameters in this endpoint, like `sslmode`, `sslrootcert`, `user`, etc. +The `cluster.proxy.endpoint` is an endpoint used by the proxy to connect to the current write leader as part of its checks. When `cluster.proxy.http.enable` is `true`, `cluster.proxy.endpoint` must also be set. It could be same as BDR node [routing_dsn](../routing#configuration) where host will be `listen_address` and port will be `listen_port` [proxy options](../routing#configuration). If required, user can add additional connection string parameters in this endpoint, like `sslmode`, `sslrootcert`, `user`, etc. #### PGD Proxy user