diff --git a/gatsby-config.js b/gatsby-config.js index 1e66cb8cd86..b1af5c55ff1 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -5,6 +5,8 @@ const gracefulFs = require("graceful-fs"); const algoliaTransformer = require("./src/constants/algolia-indexing.js"); +const { replacePathVersion } = require("./src/constants/gatsby-utils.js"); + const ANSI_BLUE = "\033[34m"; const ANSI_GREEN = "\033[32m"; const ANSI_STOP = "\033[0m"; @@ -201,8 +203,14 @@ module.exports = { allSitePage: { nodes: allPages }, allMdx: { nodes: allMdxNodes }, }) => { + const knownPaths = new Set(allPages.map((p) => p.path)); const mapPathToTime = allMdxNodes.reduce((acc, node) => { - acc[node.fields.path] = { lastmod: node.fields.mtime }; + if (knownPaths.has(node.fields.path)) + acc[node.fields.path] = { lastmod: node.fields.mtime }; + else + acc[replacePathVersion(node.fields.path)] = { + lastmod: node.fields.mtime, + }; return acc; }, {}); diff --git a/product_docs/docs/epas/14/epas_guide/01_introduction/02_conventions.mdx b/product_docs/docs/epas/14/epas_guide/01_introduction/02_conventions.mdx index 83d61767657..e1c4df678d2 100644 --- a/product_docs/docs/epas/14/epas_guide/01_introduction/02_conventions.mdx +++ b/product_docs/docs/epas/14/epas_guide/01_introduction/02_conventions.mdx @@ -4,12 +4,13 @@ title: "Conventions used" -The following is a list of conventions used throughout this document. - -- This guide applies to both Linux and Windows systems. Directory paths are presented in the Linux format with forward slashes. When working on Windows systems, start the directory path with the drive letter followed by a colon and substitute back slashes for forward slashes. -- Some of the information in this document may apply interchangeably to the PostgreSQL and EDB Postgres Advanced Server database systems. The term *EDB Postgres Advanced Server* is used to refer to EDB Postgres Advanced Server. The term *Postgres* is used to generically refer to both PostgreSQL and EDB Postgres Advanced Server. When a distinction needs to be made between these two database systems, the specific names, PostgreSQL or EDB Postgres Advanced Server are used. -- The installation directory path of the PostgreSQL or EDB Postgres Advanced Server products is referred to as *POSTGRES_INSTALL_HOME*. - - For PostgreSQL Linux installations, this defaults to `/opt/PostgreSQL/x.x` for version 10 and earlier. For later versions, use the PostgreSQL community packages. - - For EDB Postgres Advanced Server Linux installations accomplished using the interactive installer for version 10 and earlier, this defaults to `/opt/edb/asx.x`. - - For EDB Postgres Advanced Server Linux installations accomplished using an RPM package, this defaults to `/usr/edb/asxx`. - - For EDB Postgres Advanced Server Windows installations, this defaults to `C:\Program Files\edb\asxx`. The product version number is represented by `x.x` or by `xx` for version 10 and later. +This information applies to both Linux and Windows systems. Directory paths are presented in the Linux format with forward slashes. When working on Windows systems, start the directory path with the drive letter followed by a colon and substitute back slashes for forward slashes. + +Some of this information might apply interchangeably to the PostgreSQL and EDB Postgres Advanced Server database systems. The term *EDB Postgres Advanced Server* is used to refer to EDB Postgres Advanced Server. The term *Postgres* is used to generically refer to both PostgreSQL and EDB Postgres Advanced Server. When a distinction needs to be made between these two database systems, the specific names—PostgreSQL or EDB Postgres Advanced Server—are used. + +The installation directory path of the PostgreSQL or EDB Postgres Advanced Server products is referred to as *POSTGRES_INSTALL_HOME*. + +- For PostgreSQL Linux installations, the default is `/opt/PostgreSQL/x.x` for version 10 and earlier. For later versions, use the PostgreSQL community packages. +- For EDB Postgres Advanced Server Linux installations performed using the interactive installer for version 10 and earlier, the default is `/opt/edb/asx.x`. +- For EDB Postgres Advanced Server Linux installations performed using an RPM package, the default is `/usr/edb/asxx`. +- For EDB Postgres Advanced Server Windows installations, the default is `C:\Program Files\edb\asxx`. The product version number is represented by `x.x` or by `xx` for version 10 and later. diff --git a/product_docs/docs/epas/14/epas_guide/01_introduction/03_examples_used.mdx b/product_docs/docs/epas/14/epas_guide/01_introduction/03_examples_used.mdx index 395ad05db04..863acec3fd4 100644 --- a/product_docs/docs/epas/14/epas_guide/01_introduction/03_examples_used.mdx +++ b/product_docs/docs/epas/14/epas_guide/01_introduction/03_examples_used.mdx @@ -8,28 +8,22 @@ legacyRedirectsGenerated: -The examples in this guide are shown in the type and background illustrated below. +The examples use the sample tables `dept`, `emp`, and `jobhist`, whcih are created and loaded when EDB Postgres Advanced Server is installed. -Examples and output from examples are shown in fixed-width, white font on a black background. - -The examples use the sample tables, `dept, emp`, and `jobhist`, created and loaded when EDB Postgres Advanced Server is installed. - -The tables and programs in the sample database can be re-created at any time by executing the following script: +You can re-create the tables and programs in the sample database at any time by executing the following script: ```text /usr/edb/asxx/share/pg-sample.sql ``` -where `xx` is the EDB Postgres Advanced Server version number. - -In addition there is a script in the same directory containing the database objects created using syntax compatible with Oracle databases. This script file is `edb-sample.sql`. +Where `xx` is the EDB Postgres Advanced Server version number. -The script: +In addition, a script in the same directory contains the database objects created using syntax compatible with Oracle databases. This script file is `edb-sample.sql`. The script: - Creates the sample tables and programs in the currently connected database. - Grants all permissions on the tables to the `PUBLIC` group. -The tables and programs are created in the first schema of the search path in which the current user has permission to create tables and procedures. You can display the search path by issuing the command: +The tables and programs are created in the first schema of the search path in which the current user has permission to create tables and procedures. You can display the search path using the command: ```text SHOW SEARCH_PATH; @@ -45,7 +39,7 @@ Each employee has an identification number, name, hire date, salary, and manager The sample company is regionally diverse, so it tracks the locations of its departments. Each company employee is assigned to a department. Each department is identified by a unique department number and a short name. Each department is associated with one location. All department-related information is stored in the `dept` table. -The company also tracks information about jobs held by the employees. Some employees have been with the company for a long time and have held different positions, received raises, switched departments, etc. When a change in employee status occurs, the company records the end date of the former position. A new job record is added with the start date and the new job title, department, salary, and the reason for the status change. All employee history is maintained in the `jobhist` table. +The company also tracks information about jobs held by the employees. Some employees have been with the company for a long time and have held different positions, received raises, switched departments, and so on. When a change in employee status occurs, the company records the end date of the former position. A new job record is added with the start date and the new job title, department, salary, and the reason for the status change. All employee history is maintained in the `jobhist` table. The following is the `pg-sample.sql` script: diff --git a/product_docs/docs/epas/14/epas_guide/01_introduction/index.mdx b/product_docs/docs/epas/14/epas_guide/01_introduction/index.mdx index 280ae284df1..182d57f2a54 100644 --- a/product_docs/docs/epas/14/epas_guide/01_introduction/index.mdx +++ b/product_docs/docs/epas/14/epas_guide/01_introduction/index.mdx @@ -16,7 +16,7 @@ See the [release notes](../../epas_rel_notes) for the features added in EDB Post ## Hard limits -The following table describes various hard limits of PostgreSQL. However, practical limits such as performance limitations or available disk space may apply before absolute hard limits are reached. +The following table describes various hard limits of PostgreSQL. However, practical limits such as performance limitations or available disk space might apply before absolute hard limits are reached. | Item | Upper limit | Comment | | ------------------------ | --------------------------------------------------------------------- | ---------------------------------------------------------------------- | @@ -33,6 +33,6 @@ The following table describes various hard limits of PostgreSQL. However, practi | `partition keys` | 32 | can be increased by recompiling PostgreSQL | !!! Note - - The maximum number of columns for a table is further reduced as the tuple being stored must fit in a single 8192-byte heap page. For example, excluding the tuple header, a tuple made up of 1600 `int` columns would consume 6400 bytes and could be stored in a heap page, but a tuple of 1600 `bigint` columns would consume 12800 bytes and would therefore not fit inside a heap page. Variable-length fields of types such as `text`, `varchar`, and `char` can have their values stored out of line in the table's `TOAST` table when the values are large enough to require it. Only an 18-byte pointer must remain inside the tuple in the table's heap. For shorter length variable-length fields, either a 4-byte or 1-byte field header is used and the value is stored inside the heap tuple. + - The maximum number of columns for a table is further reduced as the tuple being stored must fit in a single 8192-byte heap page. For example, excluding the tuple header, a tuple made up of 1600 `int` columns consumes 6400 bytes and can be stored in a heap page. But a tuple of 1600 `bigint` columns consumes 12800 bytes and therefore doesn't fit inside a heap page. Variable-length fields of types such as `text`, `varchar`, and `char` can have their values stored out of line in the table's `TOAST` table when the values are large enough to require it. Only an 18-byte pointer must remain inside the tuple in the table's heap. For shorter length variable-length fields, either a 4-byte or 1-byte field header is used, and the value is stored inside the heap tuple. - - Columns that have been dropped from the table also contribute to the maximum column limit. Moreover, although the dropped column values for newly created tuples are internally marked as null in the tuple's null bitmap, the null bitmap also occupies space. + - Columns that were dropped from the table also contribute to the maximum column limit. Moreover, although the dropped column values for newly created tuples are internally marked as null in the tuple's null bitmap, the null bitmap also occupies space. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/01_setting_new_parameters.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/01_setting_new_parameters.mdx index 34cde544787..ff9e9c1971c 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/01_setting_new_parameters.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/01_setting_new_parameters.mdx @@ -10,11 +10,9 @@ legacyRedirectsGenerated: -This section provides an overview of how configuration parameters are specified and set. +Set each configuration parameter using a name/value pair. Parameter names are not case sensitive. The parameter name is typically separated from its value by an optional equals sign (`=`). -Each configuration parameter is set using a `name/value` pair. Parameter names are case-insensitive. The parameter name is typically separated from its value by an optional equals sign `(=)`. - -The following is an example of some configuration parameter settings in the `postgresql.conf` file: +This an example shows some configuration parameter settings in the `postgresql.conf` file: ```text # This is a comment @@ -26,45 +24,41 @@ shared_buffers = 128MB Parameter values are specified as one of five types: -- Boolean. Acceptable values can be written as `on, off, true, false, yes, no, 1, 0`, or any unambiguous prefix of these. +- Boolean. Acceptable values are `on`, `off`, `true`, `false`, `yes`, `no`, `1`, `0`, or any unambiguous prefix of these. - Integer. Number without a fractional part. - Floating point. Number with an optional fractional part separated by a decimal point. -- String. Text value. Enclose in single quotes if the value is not 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 case-insensitive. +- 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. Default units can be found by referencing the system view `pg_settings.unit`. A different unit can be specified 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 explicitly. Valid memory units are `kB` (kilobytes), `MB` (megabytes), and `GB` (gigabytes). Valid time units are `ms` (milliseconds), `s` (seconds), `min` (minutes), `h` (hours), and `d` (days). The multiplier for memory units is 1024. -The configuration parameter settings can be established in a number of different ways: +You can set the configuration parameter settings in a number of different ways: -- There is a number of parameter settings that are established when the EDB Postgres Advanced Server database product is built. These are read-only parameters, and their values cannot be changed. There are also a couple of parameters that are permanently set for each database when the database is created. These parameters are read-only as well and cannot be subsequently changed for the database. +- 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. -- 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. Some of these initial parameter settings can be overridden as discussed in the following bullet points. 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 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. - 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. -- Parameter settings can be modified 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, a new session must be started 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 following section of the PostgreSQL Core Documentation 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: -- The SQL commands `ALTER DATABASE`, `ALTER ROLE`, or `ALTER ROLE IN DATABASE` can be used to modify certain parameter settings. The modified parameter settings take effect for new sessions after the command is executed. `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 methods discussed in the second and third bullet points. Parameter settings established using the `ALTER DATABASE`, `ALTER ROLE`, or `ALTER ROLE IN DATABASE` commands can only be changed by: +- 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: - a) re-issuing these commands with a different parameter value, or + - Reissuing these commands with a different parameter value. - b) 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 established by the methods set forth in the prior bullet points. See the “SQL Commands” section of Chapter VI “Reference” in the *PostgreSQL Core Documentation* for the exact syntax of these SQL commands: + - 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. - - -- Changes can be made for certain parameter settings for the duration of individual sessions using the `PGOPTIONS` environment variable or by using the `SET` command within the `EDB-PSQL` or `PSQL` command line terminal programs. Parameter settings made in this manner override settings established using any of the methods described by the second, third, and fourth bullet points, but only for the duration of the 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 regards to auditing, authentication, encryption, and other behaviors. On Linux and Windows host, 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 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. -Within the `postgresql.conf` file, some parameters contain comments that indicate `change requires restart`. To view a list of the parameters that require a server restart, execute the following query at the psql command line: +In the `postgresql.conf` file, some parameters contain comments that indicate `change requires restart`. To view a list of the parameters that require a server restart, execute the following query at the psql command line: ```text SELECT name FROM pg_settings WHERE context = 'postmaster'; @@ -74,19 +68,17 @@ SELECT name FROM pg_settings WHERE context = 'postmaster'; ## Modifying the pg_hba.conf file -Appropriate authentication methods provide protection and security. Entries in the `pg_hba.conf` file specify the authentication method or methods that the server uses when authenticating connecting clients. Before connecting to the server, you may be required to modify the authentication properties specified in the `pg_hba.conf` file. - -When you invoke the `initdb` utility to create a cluster, `initdb` creates a `pg_hba.conf` file for that cluster that specifies the type of authentication required from connecting clients. To modify the `pg_hba.conf` file, open the file with your choice of editor. After modifying the authentication settings in the `pg_hba.conf` file, restart the server and apply the changes. +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. -For more information about authentication and modifying the `pg_hba.conf` file, see the PostgreSQL Core Documentation at: +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 a connection request is received, the server 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. +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. -A record specifies a connection type, database name, user name, a client IP address, and the authentication method to authorize a connection upon matching these parameters in the `pg_hba.conf` file. Once the connection to a server is authorized, you can see the matched line number and the authentication record from the `pg_hba.conf` file. +A record specifies a connection type, database name, user name, client IP address, and the authentication method to authorize a connection upon matching these parameters in the `pg_hba.conf` file. Once the connection to a server is authorized, you can see the matched line number and the authentication record from the `pg_hba.conf` file. -The following example shows a log detail for a valid `pg_hba.conf` entry upon successful authentication. +This example shows a log detail for a valid `pg_hba.conf` entry after successful authentication: ```text 2020-05-08 10:42:17 IST LOG: connection received: host=[local] diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/02_summary_of_configuration_parameters.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/02_summary_of_configuration_parameters.mdx index 5b06d82ef4f..5d95235547a 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/02_summary_of_configuration_parameters.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/02_summary_of_configuration_parameters.mdx @@ -8,42 +8,47 @@ legacyRedirectsGenerated: -This section contains a summary table listing all EDB Postgres Advanced Server configuration parameters along with a number of key attributes of the parameters. +This summary table list all EDB Postgres Advanced Server configuration parameters along with a number of key attributes of the parameters. These attributes are described by the following columns of the summary table: - Parameter. Configuration parameter name. -- Scope of effect. Scope of effect of the configuration parameter setting. +- Scope of effect. Scope of effect of the configuration parameter setting: - - `Cluster` – Setting affects the entire database cluster (that is, all databases managed by the database server instance). - - `Database` – Setting can vary by database and is established when the database is created. Applies to a small number of parameters related to locale settings. - - `Session` – Setting can vary down to the granularity of individual sessions. + - `Cluster`. Setting affects the entire database cluster, that is, all databases managed by the database server instance. + - `Database`. Setting can vary by database and is established when the database is created. Applies to a small number of parameters related to locale settings. + - `Session`. Setting can vary down to the granularity of individual sessions. - In other words, different settings can be made for the following entities whereby the latter settings in this list override prior ones: a) the entire database cluster, b) specific databases in the database cluster, c) specific roles, d) specific roles when connected to specific databases, e) a specific session. + In other words, different settings can be made for the following entities in which the latter settings in this list override prior ones: + + - The entire database cluster + - Specific databases in the database cluster + - Specific roles + - Specific roles when connected to specific databases + - A specific session -- **When takes effect. When a changed parameter setting takes effect. +- When takes effect. When a changed parameter setting takes effect. - - `Preset` – Established when the EDB Postgres Advanced Server product is built or a particular database is created. This is a read-only parameter and cannot be changed. - - `Restart` – Database server must be restarted. - - `Reload` – Configuration file must be reloaded (or the database server can be restarted). - - `Immediate` – Immediately effective in a session if the `PGOPTIONS` environment variable or the `SET` command is used to change the setting in the current session. Effective in new sessions if `ALTER DATABASE`, `ALTER ROLE`, or `ALTER ROLE IN DATABASE` commands are used to change the setting. + - `Preset`. Established when the EDB Postgres Advanced Server product is built or a particular database is created. This is a read-only parameter and can't be changed. + - `Restart`. You must restart the database server. + - `Reload`. You must reload configuration file or restart the database server. + - `Immediate`. Immediately effective in a session if the `PGOPTIONS` environment variable or the `SET` command is used to change the setting in the current session. Effective in new sessions if `ALTER DATABASE`, `ALTER ROLE`, or `ALTER ROLE IN DATABASE` commands are used to change the setting. -- **Authorized user. Type of operating system account or database role that must be used to put the parameter setting into effect. +- Authorized user. Type of operating system account or database role that must be used to put the parameter setting into effect. - - `EPAS service account` – EDB Postgres Advanced Server service account (`enterprisedb` for an installation compatible with Oracle databases, `postgres` for a PostgreSQL compatible mode installation). - - `Superuser` – Database role with superuser privileges. - - `User` – Any database role with permissions on the affected database object (the database or role to be altered with the `ALTER` command). - - `n/a` – Parameter setting cannot be changed by any user. + - `EPAS service account`. EDB Postgres Advanced Server service account (`enterprisedb` for an installation compatible with Oracle databases, `postgres` for a PostgreSQL compatible mode installation). + - `Superuser`. Database role with superuser privileges. + - `User`. Any database role with permissions on the affected database object, that is, the database or role to alter with the `ALTER` command. + - `n/a` – No user can change the aarameter setting. - Description. Brief description of the configuration parameter. -- EPAS only. ‘X’ – Configuration parameter is applicable to EDB Postgres Advanced Server only. No entry in this column indicates the configuration parameter applies to PostgreSQL as well. +- EPAS only. Configuration parameter appllies to EDB Postgres Advanced Server only. No entry in this column indicates the configuration parameter applies to PostgreSQL as well. !!! Note - There are a number of parameters that should never be altered. These are designated as “**Note: For internal use only**” in the Description column. + A number of parameters can never be altered. These are designated as **Note: For internal use only** in the Description column. -The following table shows the summary of configuration parameters: | Parameter | Scope of effect | When takes effect | Authorized

user | Description | EPAS only | | ----------------------------------------- | --------------- | -------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | @@ -52,7 +57,7 @@ The following table shows the summary of configuration parameters: | `archive_command` | Cluster | Reload | EPAS service account | Sets the shell command called to archive a WAL file. | | | `archive_mode` | Cluster | Restart | EPAS service account | Allows archiving of WAL files using `archive_command`. | | | `archive_timeout` | Cluster | Reload | EPAS service account | Forces a switch to the next xlog file if a new file has not been started within N seconds. | | -| `array_nulls` | Session | Immediate | User | Enable input of NULL elements in arrays. | | +| `array_nulls` | Session | Immediate | User | Enables input of NULL elements in arrays. | | | `authentication_timeout` | Cluster | Reload | EPAS service account | Sets the maximum allowed time to complete client authentication. | | | `autovacuum` | Cluster | Reload | EPAS service account | Starts the autovacuum subprocess. | | | `autovacuum_analyze_scale_factor` | Cluster | Reload | EPAS service account | Number of tuple inserts, updates, or deletes prior to analyze as a fraction of `reltuples`. | | @@ -74,9 +79,9 @@ The following table shows the summary of configuration parameters: | `bonjour` | Cluster | Restart | EPAS service account | Enables advertising the server via Bonjour. | | | `bonjour_name` | Cluster | Restart | EPAS service account | Sets the Bonjour service name. | | | `bytea_output` | Session | Immediate | User | Sets the output format for `bytea`. | | -| `check_function_bodies` | Session | Immediate | User | Check function bodies during `CREATE FUNCTION`. | | +| `check_function_bodies` | Session | Immediate | User | Checks function bodies during `CREATE FUNCTION`. | | | `checkpoint_completion_target` | Cluster | Reload | EPAS service account | Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval. | | -| `checkpoint_segments` | Deprecated | Deprecated | Deprecated | Specifying a value for the parameter prevents the server from starting. | | +| `checkpoint_segments` | Deprecated | Deprecated | Deprecated | Specifies a value for the parameter prevents the server from starting. | | | `checkpoint_timeout` | Cluster | Reload | EPAS service account | Sets the maximum time between automatic WAL checkpoints. | | | `checkpoint_warning` | Cluster | Reload | EPAS service account | Enables warnings if checkpoint segments are filled more frequently than this. | | | `client_encoding` | Session | Immediate | User | Sets the client's character set encoding. | | @@ -103,29 +108,29 @@ The following table shows the summary of configuration parameters: | `debug_print_parse` | Session | Immediate | User | Logs each query's parse tree. | | | `debug_print_plan` | Session | Immediate | User | Logs each query's execution plan. | | | `debug_print_rewritten` | Session | Immediate | User | Logs each query's rewritten parse tree. | | -| `default_heap_fillfactor` | Session | Immediate | User | Create new tables with this heap fillfactor by default. | X | +| `default_heap_fillfactor` | Session | Immediate | User | Creates new tables with this heap fill factor by default. | X | | `default_statistics_target` | Session | Immediate | User | Sets the default statistics target. | | | `default_tablespace` | Session | Immediate | User | Sets the default tablespace to create tables and indexes in. | | | `default_text_search_config` | Session | Immediate | User | Sets default text search configuration. | | | `default_transaction_deferrable` | Session | Immediate | User | Sets the default deferrable status of new transactions. | | | `default_transaction_isolation` | Session | Immediate | User | Sets the transaction isolation level of each new transaction. | | | `default_transaction_read_only` | Session | Immediate | User | Sets the default read-only status of new transactions. | | -| `default_with_oids` | Session | Immediate | User | Create new tables with OIDs by default. | | -| `default_with_rowids` | Session | Immediate | User | Create new tables with ROWID support (ROWIDs with indexes) by default. | X | +| `default_with_oids` | Session | Immediate | User | Creates new tables with OIDs by default. | | +| `default_with_rowids` | Session | Immediate | User | Creates new tables with ROWID support (ROWIDs with indexes) by default. | X | | `dynamic_library_path` | Session | Immediate | Superuser | Sets the path for dynamically loadable modules. | | | `dynamic_shared_memory_type` | Cluster | Restart | EPAS service account | Selects the dynamic shared memory implementation used. | | -| `edb_audit` | Cluster | Reload | EPAS service account | Enable EDB Auditing to create audit reports in XML or CSV format. | X | -| `edb_audit_archiver` | Cluster | Restart | EPAS service account | Enable audit log archiver process. | X | +| `edb_audit` | Cluster | Reload | EPAS service account | Enables EDB Auditing to create audit reports in XML or CSV format. | X | +| `edb_audit_archiver` | Cluster | Restart | EPAS service account | Enables audit log archiver process. | X | | `edb_audit_archiver_timeout` | Cluster | Reload | EPAS service account | Checks the audit log files based on the `edb_audit_archiver_timeout` parameter. | X | | `edb_audit_archiver_filename_prefix` | Cluster | Reload | EPAS service account | Determines audit log files with `edb_audit_archiver_filename_prefix` in `edb_audit_directory` are eligible for compression and/or expiration; the parameter must align with `edb_audit_filename`. | X | | `edb_audit_archiver_compress_time_limit` | Cluster | Reload | EPAS service account | Shows time in seconds after which the audit logs are eligible for compression. | X | | `edb_audit_archiver_compress_size_limit` | Cluster | Reload | EPAS service account | Shows total size in megabytes after which the audit logs are eligible for compression. | X | -| `edb_audit_archiver_compress_command` | Cluster | Reload | EPAS service account | The command to compress the audit log files. | X | -| `edb_audit_archiver_compress_suffix` | Cluster | Reload | EPAS service account | Determines suffix for an already compressed log file; the parameter must align with `edb_audit_archiver_compress_command`. | X | +| `edb_audit_archiver_compress_command` | Cluster | Reload | EPAS service account | Compresses the audit log files. | X | +| `edb_audit_archiver_compress_suffix` | Cluster | Reload | EPAS service account | Determines suffix for an already compressed log file. The parameter must align with `edb_audit_archiver_compress_command`. | X | | `edb_audit_archiver_expire_time_limit` | Cluster | Reload | EPAS service account | Shows time in seconds after which the audit logs are eligible for expiration. | X | | `edb_audit_archiver_expire_size_limit` | Cluster | Reload | EPAS service account | Shows total size in megabytes after which the audit logs are eligible for expiration. | X | -| `edb_audit_archiver_expire_command` | Cluster | Reload | EPAS service account | The command to execute on an expired audit log before removing it. | X | -| `edb_audit_archiver_sort_file` | Cluster | Reload | EPAS service account | Identifies the oldest log file and sort them alphabetically or based on `mtime`. | X | +| `edb_audit_archiver_expire_command` | Cluster | Reload | EPAS service account | Execute on an expired audit log before removing it. | X | +| `edb_audit_archiver_sort_file` | Cluster | Reload | EPAS service account | Identifies the oldest log file and sorts them alphabetically or based on `mtime`. | X | | `edb_audit_connect` | Cluster | Reload | EPAS service account | Audits each successful connection. | X | | `edb_audit_destination` | Cluster | Reload | EPAS service account | Sets `edb_audit_directory` or syslog as the destination directory for audit files. The syslog setting is only valid for a Linux system. | X | | `edb_audit_directory` | Cluster | Reload | EPAS service account | Sets the destination directory for audit files. | X | @@ -135,10 +140,10 @@ The following table shows the summary of configuration parameters: | `edb_audit_rotation_seconds` | Cluster | Reload | EPAS service account | Automatic log file rotation occurs after N seconds. | X | | `edb_audit_rotation_size` | Cluster | Reload | EPAS service account | Automatic log file rotation occurs after N Megabytes. | X | | `edb_audit_statement` | Cluster | Reload | EPAS service account | Sets the type of statements to audit. | X | -| `edb_audit_tag` | Session | Immediate | User | Specify a tag to be included in the audit log. | X | -| `edb_connectby_order` | Session | Immediate | User | Sort results of `CONNECT BY` queries with no `ORDER BY` to depth-first order. Note: For internal use only. | X | +| `edb_audit_tag` | Session | Immediate | User | Specifies a tag to include in the audit log. | X | +| `edb_connectby_order` | Session | Immediate | User | Sorts results of `CONNECT BY` queries with no `ORDER BY` to depth-first order. Note: For internal use only. | X | | `edb_custom_plan_tries` | Session | Immediate | User | Specifies the number of custom execution plans considered by the planner before the planner selects a generic execution plan. | X | -| `edb_data_redaction` | Session | Immediate | User | Enable data redaction. | X | +| `edb_data_redaction` | Session | Immediate | User | Enables data redaction. | X | | `edb_dynatune` | Cluster | Restart | EPAS service account | Sets the edb utilization percentage. | X | | `edb_dynatune_profile` | Cluster | Restart | EPAS service account | Sets the workload profile for dynatune. | X | | `edb_enable_pruning` | Session | Immediate | User | Enables the planner to early-prune partitioned tables. | X | @@ -147,8 +152,8 @@ The following table shows the summary of configuration parameters: | `edb_max_spins_per_delay` | Cluster | Restart | EPAS service account | Specifies the number of times a session spins while waiting for a lock. | X | | `edb_redwood_date` | Session | Immediate | User | Determines whether `DATE` should behave like a `TIMESTAMP` or not. | X | | `edb_redwood_greatest_least` | Session | Immediate | User | Determines how `GREATEST` and `LEAST` functions should handle NULL parameters. | X | -| `edb_redwood_raw_names` | Session | Immediate | User | Return the unmodified name stored in the PostgreSQL system catalogs from Redwood interfaces. | X | -| `edb_redwood_strings` | Session | Immediate | User | Treat `NULL` as an empty string when concatenated with a text value. | X | +| `edb_redwood_raw_names` | Session | Immediate | User | Returns the unmodified name stored in the PostgreSQL system catalogs from Redwood interfaces. | X | +| `edb_redwood_strings` | Session | Immediate | User | Treats `NULL` as an empty string when concatenated with a text value. | X | | `edb_resource_group` | Session | Immediate | User | Specifies the resource group to be used by the current process. | X | | `edb_sql_protect.enabled` | Cluster | Reload | EPAS service account | Defines whether SQL/Protect should track queries or not. | X | | `edb_sql_protect.level` | Cluster | Reload | EPAS service account | Defines the behavior of SQL/Protect when an event is found. | X | @@ -156,8 +161,8 @@ The following table shows the summary of configuration parameters: | `edb_sql_protect.max_protected_roles` | Cluster | Restart | EPAS service account | Sets the maximum number of roles protected by SQL/Protect. | X | | `edb_sql_protect.max_queries_to_save` | Cluster | Restart | EPAS service account | Sets the maximum number of offending queries to save by SQL/Protect. | X | | `edb_stmt_level_tx` | Session | Immediate | User | Allows continuing on errors instead of requiring a transaction abort. | X | -| `edb_wait_states.directory` | Cluster | Restart | EPAS service account | The EDB wait states logs are stored in this directory. | X | -| `edb_wait_states.retention_period` | Cluster | Reload | EPAS service account | EDB wait state log files are automatically deleted after retention period. | X | +| `edb_wait_states.directory` | Cluster | Restart | EPAS service account | Stores the EDB wait states logs in this directory. | X | +| `edb_wait_states.retention_period` | Cluster | Reload | EPAS service account | Deletes EDB wait state log files after retention period. | X | | `edb_wait_states.sampling_interval` | Cluster | Reload | EPAS service account | The interval between two EDB wait state sampling cycles. | X | | `edbldr.empty_csv_field` | Session | Immediate | Superuser | Specifies how EDB\*Loader handles empty strings. | X | | `effective_cache_size` | Session | Immediate | User | Sets the planner's assumption about the size of the disk cache. | | @@ -165,7 +170,7 @@ The following table shows the summary of configuration parameters: | `enable_bitmapscan` | Session | Immediate | User | Enables the planner's use of bitmap-scan plans. | | | `enable_hashagg` | Session | Immediate | User | Enables the planner's use of hashed aggregation plans. | | | `enable_hashjoin` | Session | Immediate | User | Enables the planner's use of hash join plans. | | -| `enable_hints` | Session | Immediate | User | Enable optimizer hints in SQL statements. | X | +| `enable_hints` | Session | Immediate | User | Enables optimizer hints in SQL statements. | X | | `enable_indexonlyscan` | Session | Immediate | User | Enables the planner’s use of index-only-scan plans. | | | `enable_indexscan` | Session | Immediate | User | Enables the planner's use of index-scan plans. | | | `enable_material` | Session | Immediate | User | Enables the planner's use of materialization. | | @@ -174,9 +179,9 @@ The following table shows the summary of configuration parameters: | `enable_seqscan` | Session | Immediate | User | Enables the planner's use of sequential-scan plans. | | | `enable_sort` | Session | Immediate | User | Enables the planner's use of explicit sort steps. | | | `enable_tidscan` | Session | Immediate | User | Enables the planner's use of TID scan plans. | | -| `escape_string_warning` | Session | Immediate | User | Warn about backslash escapes in ordinary string literals. | | +| `escape_string_warning` | Session | Immediate | User | Warns about backslash escapes in ordinary string literals. | | | `event_source` | Cluster | Restart | EPAS service account | Sets the application name used to identify PostgreSQL messages in the event log. | | -| `exit_on_error` | Session | Immediate | User | Terminate session on any error. | | +| `exit_on_error` | Session | Immediate | User | Terminates session on any error. | | | `external_pid_file` | Cluster | Restart | EPAS service account | Writes the postmaster PID to the specified file. | | | `extra_float_digits` | Session | Immediate | User | Sets the number of digits displayed for floating-point values. | | | `from_collapse_limit` | Session | Immediate | User | Sets the `FROM`-list size beyond which subqueries are not collapsed. | | @@ -193,12 +198,12 @@ The following table shows the summary of configuration parameters: | `hba_file` | Cluster | Restart | EPAS service account | Sets the server's "hba" configuration file. | | | `hot_standby` | Cluster | Restart | EPAS service account | Allows connections and queries during recovery. | | | `hot_standby_feedback` | Cluster | Reload | EPAS service account | Allows feedback from a hot standby to the primary that avoids query conflicts. | | -| `huge_pages` | Cluster | Restart | EPAS service account | Use of huge pages on Linux. | | +| `huge_pages` | Cluster | Restart | EPAS service account | Uses huge pages on Linux. | | | `icu_short_form` | Database | Preset | n/a | Shows the ICU collation order configuration. | X | | `ident_file` | Cluster | Restart | EPAS service account | Sets the server's "ident" configuration file. | | | `ignore_checksum_failure` | Session | Immediate | Superuser | Continues processing after a checksum failure. | | | `ignore_system_indexes` | Cluster/Session | Reload/Immediate | EPAS service account/User | Disables reading from system indexes. (Can also be set with `PGOPTIONS` at session start.) | | -| `index_advisor.enabled` | Session | Immediate | User | Enable Index Advisor plugin. | X | +| `index_advisor.enabled` | Session | Immediate | User | Enables Index Advisor plugin. | X | | `integer_datetimes` | Cluster | Preset | n/a | Datetimes are integer based. | | | `intervalStyle` | Session | Immediate | User | Sets the display format for interval values. | | | `join_collapse_limit` | Session | Immediate | User | Sets the `FROM`-list size beyond which `JOIN` constructs are not flattened. | | @@ -237,10 +242,10 @@ The following table shows the summary of configuration parameters: | `log_rotation_size` | Cluster | Reload | EPAS service account | Automatic log file rotation occurs after N kilobytes. | | | `log_statement` | Session | Immediate | Superuser | Sets the type of statements logged. | | | `log_statement_stats` | Session | Immediate | Superuser | Writes cumulative performance statistics to the server log. | | -| `log_temp_files` | Session | Immediate | Superuser | Log the use of temporary files larger than this number of kilobytes. | | +| `log_temp_files` | Session | Immediate | Superuser | Logs the use of temporary files larger than this number of kilobytes. | | | `log_timezone` | Cluster | Reload | EPAS service account | Sets the time zone to use in log messages. | | -| `log_truncate_on_rotation` | Cluster | Reload | EPAS service account | Truncate existing log files of same name during log rotation. | | -| `logging_collector` | Cluster | Restart | EPAS service account | Start a subprocess to capture stderr output and/or csv logs into log files. | | +| `log_truncate_on_rotation` | Cluster | Reload | EPAS service account | Truncates existing log files of same name during log rotation. | | +| `logging_collector` | Cluster | Restart | EPAS service account | Starts a subprocess to capture stderr output and/or csv logs into log files. | | | `maintenance_work_mem` | Session | Immediate | User | Sets the maximum memory to be used for maintenance operations. | | | `max_connections` | Cluster | Restart | EPAS service account | Sets the maximum number of concurrent connections. | | | `max_files_per_process` | Cluster | Restart | EPAS service account | Sets the maximum number of simultaneously open files for each server process. | | @@ -262,18 +267,18 @@ The following table shows the summary of configuration parameters: | `odbc_lib_path` | Cluster | Restart | EPAS service account | Sets the path for ODBC library. | X | | `optimizer_mode` | Session | Immediate | User | Default optimizer mode. | X | | `oracle_home` | Cluster | Restart | EPAS service account | Sets the path for the Oracle home directory. | X | -| `password_encryption` | Session | Immediate | User | Encrypt passwords. | | +| `password_encryption` | Session | Immediate | User | Encrypts passwords. | | | `pg_prewarm.autoprewarm` | Cluster | Restart | EPAS service account | Enables the `autoprewarm` background worker. | X | | `pg_prewarm.autoprewarm_interval` | Cluster | Reload | EPAS service account | Sets the minimum number of seconds after which `autoprewarm` dumps shared buffers. | X | | `port` | Cluster | Restart | EPAS service account | Sets the TCP port on which the server listens. | | | `post_auth_delay` | Cluster/Session | Reload/Immediate | EPAS service account/User | Waits N seconds on connection startup after authentication. (Can also be set with `PGOPTIONS` at session start.) | | | `pre_auth_delay` | Cluster | Reload | EPAS service account | Waits N seconds on connection startup before authentication. | | | `qreplace_function` | Session | Immediate | Superuser | The function to be used by Query Replace feature. Note: For internal use only. | X | -| `query_rewrite_enabled` | Session | Immediate | User | Child table scans are skipped if their constraints guarantee that no rows match the query. | X | +| `query_rewrite_enabled` | Session | Immediate | User | Skils dhild table scans if their constraints guarantee that no rows match the query. | X | | `query_rewrite_integrity` | Session | Immediate | Superuser | Sets the degree to which query rewriting must be enforced. | X | -| `quote_all_identifiers` | Session | Immediate | User | When generating SQL fragments, quote all identifiers. | | +| `quote_all_identifiers` | Session | Immediate | User | When generating SQL fragments, quotes all identifiers. | | | `random_page_cost` | Session | Immediate | User | Sets the planner's estimate of the cost of a nonsequentially fetched disk page. | | -| `restart_after_crash` | Cluster | Reload | EPAS service account | Reinitialize server after backend crash. | | +| `restart_after_crash` | Cluster | Reload | EPAS service account | Reinitializes server after backend crash. | | | `search_path` | Session | Immediate | User | Sets the schema search order for names that are not schema-qualified. | | | `segment_size` | Cluster | Preset | n/a | Shows the number of pages per disk file. | | | `seq_page_cost` | Session | Immediate | User | Sets the planner's estimate of the cost of a sequentially fetched disk page. | | @@ -292,15 +297,15 @@ The following table shows the summary of configuration parameters: | `ssl_crl_file` | Cluster | Reload | EPAS service account | Location of the SSL certificate revocation list file. | | | `ssl_ecdh_curve` | Cluster | Reload | EPAS service account | Sets the curve to use for ECDH. | | | `ssl_key_file` | Cluster | Reload | EPAS service account | Location of the SSL server private key file. | | -| `ssl_prefer_server_ciphers` | Cluster | Reload | EPAS service account | Give priority to server ciphersuite order. | | -| `ssl_renegotiation_limit` | Session | Immediate | User | Set the amount of traffic to send and receive before renegotiating the encryption keys. | | +| `ssl_prefer_server_ciphers` | Cluster | Reload | EPAS service account | Gives priority to server ciphersuite order. | | +| `ssl_renegotiation_limit` | Session | Immediate | User | Sets the amount of traffic to send and receive before renegotiating the encryption keys. | | | `standard_conforming_strings` | Session | Immediate | User | Causes '...' strings to treat backslashes literally. | | | `statement_timeout` | Session | Immediate | User | Sets the maximum allowed duration of any statement. | | | `stats_temp_directory` | Cluster | Reload | EPAS service account | Writes temporary statistics files to the specified directory. | | | `superuser_reserved_connections` | Cluster | Restart | EPAS service account | Sets the number of connection slots reserved for superusers. | | -| `synchronize_seqscans` | Session | Immediate | User | Enable synchronized sequential scans. | | +| `synchronize_seqscans` | Session | Immediate | User | Enables synchronized sequential scans. | | | `synchronous_commit` | Session | Immediate | User | Sets immediate fsync at commit. | | -| `synchronous_standby_names` | Cluster | Reload | EPAS service account | List of names of potential synchronous standbys. | | +| `synchronous_standby_names` | Cluster | Reload | EPAS service account | Lists names of potential synchronous standbys. | | | `syslog_facility` | Cluster | Reload | EPAS service account | Sets the syslog "facility" to be used when syslog enabled. | | | `syslog_ident` | Cluster | Reload | EPAS service account | Sets the program name used to identify PostgreSQL messages in syslog. | | | `tcp_keepalives_count` | Session | Immediate | User | Maximum number of TCP keepalive retransmits. | | @@ -312,16 +317,16 @@ The following table shows the summary of configuration parameters: | `timed_statistics` | Session | Immediate | User | Enables the recording of timed statistics. | X | | `timezone` | Session | Immediate | User | Sets the time zone for displaying and interpreting time stamps. | | | `timezone_abbreviations` | Session | Immediate | User | Selects a file of time zone abbreviations. | | -| `trace_hints` | Session | Immediate | User | Emit debug info about hints being honored. | X | +| `trace_hints` | Session | Immediate | User | Emits debug info about hints being honored. | X | | `trace_notify` | Session | Immediate | User | Generates debugging output for `LISTEN` and `NOTIFY`. | | | `trace_recovery_messages` | Cluster | Reload | EPAS service account | Enables logging of recovery-related debugging information. | | -| `trace_sort` | Session | Immediate | User | Emit information about resource usage in sorting. | | +| `trace_sort` | Session | Immediate | User | Emits information about resource usage in sorting. | | | `track_activities` | Session | Immediate | Superuser | Collects information about executing commands. | | | `track_activity_query_size` | Cluster | Restart | EPAS service account | Sets the size reserved for `pg_stat_activity.current_query`, in bytes. | | | `track_counts` | Session | Immediate | Superuser | Collects statistics on database activity. | | | `track_functions` | Session | Immediate | Superuser | Collects function-level statistics on database activity. | | | `track_io_timing` | Session | Immediate | Superuser | Collects timing statistics for database I/O activity. | | -| `transaction_deferrable` | Session | Immediate | User | Whether to defer a read-only serializable transaction until it can be executed with no possible serialization failures. | | +| `transaction_deferrable` | Session | Immediate | User | Specifies whether to defer a read-only serializable transaction until it can be executed with no possible serialization failures. | | | `transaction_isolation` | Session | Immediate | User | Sets the current transaction's isolation level. | | | `transaction_read_only` | Session | Immediate | User | Sets the current transaction's read-only status. | | | `transform_null_equals` | Session | Immediate | User | Treats `"expr=NULL"` as `"expr IS NULL"`. | | diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/01_shared_buffers.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/01_shared_buffers.mdx index c7276bb0a8c..f58e27261fe 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/01_shared_buffers.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/01_shared_buffers.mdx @@ -16,10 +16,10 @@ title: "shared_buffers" **Required authorization to activate:** EPAS service account -Sets the amount of memory the database server uses for shared memory buffers. The default is typically 32 megabytes (`32MB`), but might be less if your kernel settings don't support it (as determined during `initdb`). This setting must be at least 128 kilobytes. (Non-default values of `BLCKSZ` change the minimum.) However, settings significantly higher than the minimum are usually needed for good performance. +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. -If you have a dedicated database server with 1GB or more of RAM, a reasonable starting value for `shared_buffers` is 25% of the memory in your system. There are some workloads where even large settings for `shared_buffers` are effective, but because EDB Postgres Advanced Server also relies on the operating system cache, it is unlikely that an allocation of more than 40% of RAM to `shared_buffers` works better than a smaller amount. +If you have a dedicated database server with 1GB or more of RAM, a reasonable starting value for `shared_buffers` is 25% of the memory in your system. For some workloads, even large settings for `shared_buffers` are effective. However, because EDB Postgres Advanced Server also relies on the operating system cache, allocating more than 40% of RAM to `shared_buffers` isn't likely to work better than a smaller amount. -On systems with less than 1GB of RAM, a smaller percentage of RAM is appropriate, so as to leave adequate space for the operating system (15% of memory is more typical in these situations). Also, on Windows, large values for `shared_buffers` aren't as effective. You may find better results keeping the setting relatively low and using the operating system cache more instead. The useful range for `shared_buffers` on Windows systems is generally from 64MB to 512MB. +On systems with less than 1GB of RAM, a smaller percentage of RAM is appropriate to leave space for the operating system. Fifteen percent of memory is more typical in these situations. Also, on Windows, large values for `shared_buffers` aren't as effective. You might have better results keeping the setting relatively low and using the operating system cache more instead. The useful range for `shared_buffers` on Windows systems is generally from 64MB to 512MB. -Increasing this parameter might cause EDB Postgres Advanced Server to request more System V shared memory than your operating system's default configuration allows. See the section `Shared Memory and Semaphores` in the *PostgreSQL Core Documentation* for information on how to adjust those parameters, if necessary. +Increasing this parameter might cause EDB Postgres Advanced Server to request more System V shared memory than your operating system's default configuration allows. See [Shared Memory and Semaphores](https://www.postgresql.org/docs/15/kernel-resources.html#SYSVIPC) in the PostgreSQL core documentation for information on how to adjust those parameters. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/02_work_mem.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/02_work_mem.mdx index 5aa46eee36e..ef18e27ea93 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/02_work_mem.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/02_work_mem.mdx @@ -16,6 +16,10 @@ title: "work_mem" **Required authorization to activate:** Session user -Specifies the amount of memory to be used by internal sort operations and hash tables before writing to temporary disk files. The value defaults to one megabyte (`1MB`). Note that for a complex query, several sort or hash operations might be running in parallel; each operation is allowed to use as much memory as this value specifies before it starts to write data into temporary files. Also, several running sessions could be doing such operations concurrently. Therefore, the total memory used could be many times the value of `work_mem`; it is necessary to keep this fact in mind when choosing the value. Sort operations are used for `ORDER BY`, `DISTINCT`, and merge joins. Hash tables are used in hash joins, hash-based aggregation, and hash-based processing of `IN` subqueries. +Specifies the amount of memory for internal sort operations and hash tables to use before writing to temporary disk files. + +For a complex query, several sort or hash operations might run in parallel. Each operation is allowed to use as much memory as this value specifies before it starts to write data into temporary files. Also, several running sessions might perform such operations concurrently. Therefore, the total memory used might be many times the value of `work_mem`. Keep this information in mind when choosing the value. + +Sort operations are used for `ORDER BY`, `DISTINCT`, and merge joins. Hash tables are used in hash joins, hash-based aggregation, and hash-based processing of `IN` subqueries. Reasonable values are typically between 4MB and 64MB, depending on the size of your machine, how many concurrent connections you expect (determined by `max_connections`), and the complexity of your queries. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/03_maintenance_work_mem.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/03_maintenance_work_mem.mdx index 9112b67935e..08d43e5435e 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/03_maintenance_work_mem.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/03_maintenance_work_mem.mdx @@ -16,8 +16,8 @@ title: "maintenance_work_mem" **Required authorization to activate:** Session user -Specifies the maximum amount of memory to be used by maintenance operations, such as `VACUUM`, `CREATE INDEX`, and `ALTER TABLE ADD FOREIGN KEY`. It defaults to 16 megabytes (`16MB`). Since only one of these operations can be executed at a time by a database session, and an installation normally doesn't have many of them running concurrently, it's safe to set this value significantly larger than `work_mem`. Larger settings might improve performance for vacuuming and for restoring database dumps. +Specifies the maximum amount of memory used by maintenance operations such as `VACUUM`, `CREATE INDEX`, and `ALTER TABLE ADD FOREIGN KEY`. It defaults to 16MB. Since a database session can execute only one of these operations at a time, and an installation normally doesn't have many of them running concurrently, it's safe to set this value significantly larger than `work_mem`. Larger settings might improve performance for vacuuming and for restoring database dumps. -Note that when autovacuum runs, up to `autovacuum_max_workers` times this memory may be allocated, so be careful not to set the default value too high. +When autovacuum runs, you can allocate up to `autovacuum_max_workers` times, so be careful not to set the default value too high. -A good rule of thumb is to set this to about 5% of system memory, but not more than about 512MB. Larger values won't necessarily improve performance. +A good rule of thumb is to set this to about 5% of system memory but not more than about 512MB. Larger values don't necessarily improve performance. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/04_wal_buffers.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/04_wal_buffers.mdx index 71cfefb5bc8..e4b90b02e84 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/04_wal_buffers.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/04_wal_buffers.mdx @@ -16,8 +16,8 @@ title: "wal_buffers" **Required authorization to activate:** EPAS service account -The amount of memory used in shared memory for WAL data. The default is 64 kilobytes (`64kB`). The setting need only be large enough to hold the amount of WAL data generated by one typical transaction, since the data is written out to disk at every transaction commit. +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. -Increasing this parameter might cause EDB Postgres Advanced Server to request more System V shared memory than your operating system's default configuration allows. See the section “Shared Memory and Semaphores” in the *PostgreSQL Core Documentation* for information on how to adjust those parameters, if necessary. +Increasing this parameter might cause EDB Postgres Advanced Server to request more System V shared memory than your operating system's default configuration allows. See [Shared Memory and Semaphores](https://www.postgresql.org/docs/15/kernel-resources.html#SYSVIPC) in the PostgreSQL core documentation for information on how to adjust those parameters. -Although even this very small setting does not always cause a problem, there are situations where it can result in extra `fsync` calls, and degrade overall system throughput. Increasing this value to 1MB or so can alleviate this problem. On very busy systems, an even higher value may be needed, up to a maximum of about 16MB. Like `shared_buffers`, this parameter increases EDB Postgres Advanced Server’s initial shared memory allocation, so if increasing it causes an EDB Postgres Advanced Server start failure, increase the operating system limit. +Although even this very small setting doesn't always cause a problem, in some situations it can result in extra `fsync` calls and degrade overall system throughput. Increasing this value to about 1MB can address this problem. On very busy systems, you might need an even higher value, up to a maximum of about 16MB. Like `shared_buffers`, this parameter increases EDB Postgres Advanced Server’s initial shared memory allocation. If increasing it causes an EDB Postgres Advanced Server start failure, increase the operating system limit. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/05_checkpoint_segments.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/05_checkpoint_segments.mdx index 51cb25c0620..c9d61207d6f 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/05_checkpoint_segments.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/05_checkpoint_segments.mdx @@ -4,4 +4,4 @@ title: "checkpoint_segments" -Now deprecated; this parameter is not supported by EDB Postgres Advanced Server. +Deprecated. This parameter isn't supported by EDB Postgres Advanced Server. diff --git a/product_docs/docs/epas/14/epas_guide/03_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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/06_checkpoint_completion_target.mdx index 7b301f6238e..d09acc16171 100644 --- a/product_docs/docs/epas/14/epas_guide/03_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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/06_checkpoint_completion_target.mdx @@ -16,6 +16,6 @@ title: "checkpoint_completion_target" **Required authorization to activate:** EPAS service account -Specifies the target of checkpoint completion as a fraction of total time between checkpoints. This spreads out the checkpoint writes while the system starts working towards the next checkpoint. +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. -The default of 0.5 means aim to finish the checkpoint writes when 50% of the next checkpoint is ready. A value of 0.9 means aim to finish the checkpoint writes when 90% of the next checkpoint is done, thus throttling the checkpoint writes over a larger amount of time and avoiding spikes of performance bottlenecking. +The default of 0.5 aims to finish the checkpoint writes when 50% of the next checkpoint is ready. A value of 0.9 aims to finish the checkpoint writes when 90% of the next checkpoint is done. This value throttles the checkpoint writes over a larger amount of time and avoids spikes of performance bottlenecking. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/07_checkpoint_timeout.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/07_checkpoint_timeout.mdx index 239414ef048..5aee4428d9e 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/07_checkpoint_timeout.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/07_checkpoint_timeout.mdx @@ -16,8 +16,8 @@ title: "checkpoint_timeout" **Required authorization to activate:** EPAS service account -Maximum time between automatic WAL checkpoints, in seconds. The default is five minutes (`5min`). Increasing this parameter can increase the amount of time needed for crash recovery. +Maximum time between automatic WAL checkpoints, in seconds. Increasing this parameter can increase the amount of time needed for crash recovery. Increasing `checkpoint_timeout` to a larger value, such as 15 minutes, can reduce the I/O load on your system, especially when using large values for `shared_buffers`. -The downside of making the aforementioned adjustments to the checkpoint parameters is that your system uses a modest amount of additional disk space and takes longer to recover in the event of a crash. However, for most users, this is a small price to pay for a significant performance improvement. +The downside of making these adjustments to the checkpoint parameters is that your system uses a modest amount of additional disk space and takes longer to recover in the event of a crash. However, for most users, this is worth it for a significant performance improvement. diff --git a/product_docs/docs/epas/14/epas_guide/03_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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/08_max_wal_size.mdx index 91dc3c148e8..aabc5395abd 100644 --- a/product_docs/docs/epas/14/epas_guide/03_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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/08_max_wal_size.mdx @@ -16,6 +16,6 @@ title: "max_wal_size" **Required authorization to activate:** EPAS service account -`max_wal_size` specifies the maximum size that the WAL reaches between automatic WAL checkpoints. This is a soft limit; WAL size can exceed `max_wal_size` under special circumstances (when under a heavy load, a failing archive_command, or a high `wal_keep_segments` setting). +`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. -Increasing this parameter can increase the amount of time needed for crash recovery. This parameter can only be set in the `postgresql.conf` file or on the server command line. +Increasing this parameter can increase the amount of time needed for crash recovery. You can set this parameter in the `postgresql.conf` file or on the server command line. diff --git a/product_docs/docs/epas/14/epas_guide/03_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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/09_min_wal_size.mdx index 2969fd2497b..781426952a9 100644 --- a/product_docs/docs/epas/14/epas_guide/03_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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/09_min_wal_size.mdx @@ -16,4 +16,4 @@ title: "min_wal_size" **Required authorization to activate:** EPAS 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 ensures that enough WAL space is reserved to handle spikes in WAL usage (like when running large batch jobs). This parameter can only be set in the `postgresql.conf` file or on the server command line. +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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/10_bgwriter_delay.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/10_bgwriter_delay.mdx index 883f7eb168a..4d501abaf53 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/10_bgwriter_delay.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/10_bgwriter_delay.mdx @@ -16,8 +16,8 @@ title: "bgwriter_delay" **Required authorization to activate:** EPAS 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 (controllable by the `bgwriter_lru_maxpages` and `bgwriter_lru_multiplier` parameters). It then sleeps for `bgwriter_delay` milliseconds, and repeats. +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. -The default value is 200 milliseconds (200ms). Note that on many systems, the effective resolution of sleep delays is 10 milliseconds; setting `bgwriter_delay` to a value that is not a multiple of 10 might have the same results as setting it to the next higher multiple of 10. +On many systems, the effective resolution of sleep delays is 10ms. Setting `bgwriter_delay` to a value that isn't a multiple of 10 might have the same results as setting it to the next higher multiple of 10. -Typically, when tuning `bgwriter_delay`, it should be reduced from its default value. This parameter is rarely increased, except perhaps to save on power consumption on a system with very low utilization. +Typically, when tuning `bgwriter_delay`, you reduce it from its default value. This parameter is rarely increased. Saving on power consumption on a system with very low use is one case when you might increase the value. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/11_seq_page_cost.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/11_seq_page_cost.mdx index 7b8777102f6..91b6d3f4c4b 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/11_seq_page_cost.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/11_seq_page_cost.mdx @@ -16,6 +16,6 @@ title: "seq_page_cost" **Required authorization to activate:** Session user -Sets the planner's estimate of the cost of a disk page fetch that is part of a series of sequential fetches. The default is 1.0. This value can be overridden for a particular tablespace by setting the tablespace parameter of the same name. (Refer to the `ALTER TABLESPACE` command in the *PostgreSQL Core Documentation*). +Sets the planner's estimate of the cost of a disk page fetch that's part of a series of sequential fetches. You can override this value for a particular tablespace by setting the tablespace parameter of the same name. See [`ALTER TABLESPACE`](https://www.postgresql.org/docs/current/sql-altertablespace.html) in the PostgreSQL core documentation. -The default value assumes very little caching, so it's frequently a good idea to reduce it. Even if your database is significantly larger than physical memory, you might want to try setting this parameter to less than 1 (rather than its default value of 1) to see whether you get better query plans that way. If your database fits entirely within memory, you can lower this value much more, perhaps to 0.1. +The default value assumes very little caching, so it's often a good idea to reduce it. Even if your database is significantly larger than physical memory, you might want to try setting this parameter to something lower than the default value of 1 to see if you get better query plans that way. If your database fits entirely in memory, you can lower this value much more, for example, to 0.1. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/12_random_page_cost.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/12_random_page_cost.mdx index 43e2904988c..3a6b84a5013 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/12_random_page_cost.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/12_random_page_cost.mdx @@ -16,10 +16,10 @@ title: "random_page_cost" **Required authorization to activate:** Session user -Sets the planner's estimate of the cost of a non-sequentially-fetched disk page. The default is 4.0. This value can be overridden for a particular tablespace by setting the tablespace parameter of the same name. (Refer to the `ALTER TABLESPACE` command in the *PostgreSQL Core Documentation*). +Sets the planner's estimate of the cost of a nonsequentially fetched disk page. You can override the default for a particular tablespace by setting the tablespace parameter of the same name. See [`ALTER TABLESPACE`](https://www.postgresql.org/docs/current/sql-altertablespace.html) in the PostgreSQL core documentation. -Reducing this value relative to `seq_page_cost` causes the system to prefer index scans; raising it makes index scans look relatively more expensive. You can raise or lower both values together to change the importance of disk I/O costs relative to CPU costs, which are described by the `cpu_tuple_cost` and `cpu_index_tuple_cost` parameters. +Reducing this value relative to `seq_page_cost` causes the system to prefer index scans. Raising it makes index scans look relatively more expensive. You can raise or lower both values together to change the importance of disk I/O costs relative to CPU costs, which are described by the `cpu_tuple_cost` and `cpu_index_tuple_cost` parameters. -The default value assumes very little caching, so it's frequently a good idea to reduce it. Even if your database is significantly larger than physical memory, you might want to try setting this parameter to 2 (rather than its default of 4) to see whether you get better query plans that way. If your database fits entirely within memory, you can lower this value much more, perhaps to 0.1. +The default value assumes very little caching, so it's often a good idea to reduce it. Even if your database is significantly larger than physical memory, you might want to try setting this parameter to 2 (that is, lower than the default) to see whether you get better query plans that way. If your database fits entirely in memory, you can lower this value much more, for example, to 0.1. -Although the system allows it, never set `random_page_cost` less than `seq_page_cost`. However, setting them equal (or very close to equal) makes sense if the database fits mostly or entirely within memory, since in that case there is no penalty for touching pages out of sequence. Also, in a heavily-cached database you should lower both values relative to the CPU parameters, since the cost of fetching a page already in RAM is much smaller than it would normally be. +Although the system allows it, never set `random_page_cost` less than `seq_page_cost`. However, setting them equal or very close to equal makes sense if the database fits mostly or entirely in memory, since in that case there's no penalty for touching pages out of sequence. Also, in a heavily cached database, lower both values relative to the CPU parameters, since the cost of fetching a page already in RAM is much smaller than it normally is. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/13_effective_cache_size.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/13_effective_cache_size.mdx index 073f612334c..0627bbc5cf1 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/13_effective_cache_size.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/13_effective_cache_size.mdx @@ -16,6 +16,10 @@ title: "effective_cache_size" **Required authorization to activate:** Session user -Sets the planner's assumption about the effective size of the disk cache that is available to a single query. This is factored into estimates of the cost of using an index; a higher value makes it more likely index scans are used, a lower value makes it more likely sequential scans are used. When setting this parameter you should consider both EDB Postgres Advanced Server’s shared buffers and the portion of the kernel's disk cache that are used for EDB Postgres Advanced Server data files. Also, take into account the expected number of concurrent queries on different tables, since they have to share the available space. This parameter has no effect on the size of shared memory allocated by EDB Postgres Advanced Server, nor does it reserve kernel disk cache; it is used only for estimation purposes. The default is 128 megabytes (`128MB`). +Sets the planner's assumption about the effective size of the disk cache that's available to a single query. This assumption is factored into estimates of the cost of using an index. A higher value makes it more likely index scans are used. A lower value makes it more likely sequential scans are used. -If this parameter is set too low, the planner may decide not to use an index even when it would be beneficial to do so. Setting `effective_cache_size` to 50% of physical memory is a normal, conservative setting. A more aggressive setting would be approximately 75% of physical memory. +When setting this parameter, consider both EDB Postgres Advanced Server’s shared buffers and the portion of the kernel's disk cache that are used for EDB Postgres Advanced Server data files. Also, consider the expected number of concurrent queries on different tables, since they have to share the available space. + +This parameter doesn't affect the size of shared memory allocated by EDB Postgres Advanced Server, and it doesn't reserve kernel disk cache. Use it only for estimating. + +If this parameter is set too low, the planner might decide not to use an index even when it's helpful to do so. Setting `effective_cache_size` to 50% of physical memory is a normal, conservative setting. A more aggressive setting is approximately 75% of physical memory. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/14_synchronous_commit.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/14_synchronous_commit.mdx index 1cb125af35d..0855f6c0bd8 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/14_synchronous_commit.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/14_synchronous_commit.mdx @@ -16,10 +16,10 @@ title: "synchronous_commit" **Required authorization to activate:** Session user -Specifies whether transaction commit waits for WAL records to be written to disk before the command returns a `success` indication to the client. The default, and safe, setting is on. When off, there can be a delay between when success is reported to the client and when the transaction is really guaranteed to be safe against a server crash. (The maximum delay is three times `wal_writer_delay`.) +Specifies whether a transaction commit waits for WAL records to be written to disk before the command returns a `success` indication to the client. The safe setting is on, which is the default. When off, there can be a delay between when success is reported to the client and when the transaction is really guaranteed to be safe against a server crash. (The maximum delay is three times `wal_writer_delay`.) -Unlike `fsync`, setting this parameter to off does not create any risk of database inconsistency: an operating system or database crash might result in some recent allegedly-committed transactions being lost, but the database state is the same as if those transactions had been aborted cleanly. +Unlike `fsync`, setting this parameter to off does not create any risk of database inconsistency. An operating system or database crash might result in some recent "allegedly committed" transactions being lost. However, the database state is the same as if those transactions aborted cleanly. -So, turning `synchronous_commit` off can be a useful alternative when performance is more important than exact certainty about the durability of a transaction. See the section `Asynchronous Commit` in the *PostgreSQL Core Documentation* for information. +So, turning `synchronous_commit` off can be a useful alternative when performance is more important than exact certainty about the durability of a transaction. See [`Asynchronous Commit`](https://www.postgresql.org/docs/current/wal-async-commit.html) in the PostgreSQL core documentation for information. -This parameter can be changed at any time; the behavior for any one transaction is determined by the setting in effect when it commits. It is therefore possible, and useful, to have some transactions commit synchronously and others asynchronously. For example, to make a single multistatement transaction commit asynchronously when the default is the opposite, issue `SET LOCAL synchronous_commit TO OFF` within the transaction. +You can change this parameter at any time. The behavior for any one transaction is determined by the setting in effect when it commits. It's therefore possible and useful to have some transactions commit synchronously and others asynchronously. For example, to make a single multistatement transaction commit asynchronously when the default is the opposite, issue `SET LOCAL synchronous_commit TO OFF` in the transaction. diff --git a/product_docs/docs/epas/14/epas_guide/03_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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/15_edb_max_spins_per_delay.mdx index 5cd95893747..6dca614889e 100644 --- a/product_docs/docs/epas/14/epas_guide/03_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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/15_edb_max_spins_per_delay.mdx @@ -16,6 +16,6 @@ title: "edb_max_spins_per_delay" **Required authorization to activate:** EPAS service account -Use `edb_max_spins_per_delay` to specify the maximum number of times that a session spins while waiting for a spin-lock. If a lock is not acquired, the session sleeps. If you don't specify an alternative value for `edb_max_spins_per_delay`, the server enforces the default value of `1000`. +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. -This may be useful for systems that use `NUMA` (non-uniform memory access) architecture. +This parameter can be useful for systems that use non-uniform memory access (NUMA) architecture. diff --git a/product_docs/docs/epas/14/epas_guide/03_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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/16_pg_prewarm.autoprewarm.mdx index 95dde85d797..8df26be42f3 100644 --- a/product_docs/docs/epas/14/epas_guide/03_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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/16_pg_prewarm.autoprewarm.mdx @@ -16,20 +16,22 @@ title: "pg_prewarm.autoprewarm" **Required authorization to activate:** EPAS service account -This parameter controls whether or not the database server should run `autoprewarm`, which is a background worker process that automatically 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. +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. -The advantage is that it shortens the warm up times after the server has been restarted by loading the data that has been dumped to disk before shutdown. +The advantage to this parameter is that it shortens the warmup times after the server restarts by loading the data that was dumped to disk before shutdown. -If `pg_prewarm.autoprewarm` is set to on, the `autoprewarm` worker is enabled. If the parameter is set to off, `autoprewarm` is disabled. The parameter is on by default. +Set `pg_prewarm.autoprewarm` to on to enable the `autoprewarm` worker. Set it to off to disable `autoprewarm`. -Before `autoprewarm` can be used, you must add `$libdir/pg_prewarm` to the libraries listed in the `shared_preload_libraries` configuration parameter of the `postgresql.conf` file as shown by the following example: +Before you can use `autoprewarm`, you must add `$libdir/pg_prewarm` to the libraries listed in the `shared_preload_libraries` configuration parameter of the `postgresql.conf` file, as this example shows: ```text shared_preload_libraries = '$libdir/dbms_pipe,$libdir/edb_gen,$libdir/dbms_aq,$libdir/pg_prewarm' ``` -After modifying the `shared_preload_libraries` parameter, restart the database server after which the `autoprewarm` background worker is launched immediately after the server has reached a consistent state. +After modifying the `shared_preload_libraries` parameter, restart the database server. After the restart, the `autoprewarm` background worker launches immediately after the server reaches a consistent state. -The `autoprewarm` process starts loading blocks that were previously recorded in `$PGDATA/autoprewarm.blocks` until there is no free buffer space left in the buffer pool. In this manner, any new blocks that were loaded either by the recovery process or by the querying clients, are not replaced. +The `autoprewarm` process starts loading blocks that were previously recorded in `$PGDATA/autoprewarm.blocks` until no free buffer space is left in the buffer pool. In this manner, any new blocks that were loaded either by the recovery process or by the querying clients aren't replaced. -Once the `autoprewarm` process has finished loading buffers from disk, it periodically dumps shared buffers to disk at the interval specified by the `pg_prewarm.autoprewarm_interval` parameter. See the [pg_prewarm.autoprewarm_interval](17_pg_prewarm.autoprewarm_interval/#pg_prewarm_autoprewarm_interval) for information on the `autoprewarm` background worker. Upon the next server restart, the `autoprewarm` process prewarms shared buffers with the blocks that were last dumped to disk. +Once the `autoprewarm` process finishes loading buffers from disk, it periodically dumps shared buffers to disk at the interval specified by the `pg_prewarm.autoprewarm_interval` parameter. At the next server restart, the `autoprewarm` process prewarms shared buffers with the blocks that were last dumped to disk. + +See [pg_prewarm.autoprewarm_interval](17_pg_prewarm.autoprewarm_interval/#pg_prewarm_autoprewarm_interval) for information on the `autoprewarm` background worker. diff --git a/product_docs/docs/epas/14/epas_guide/03_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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/17_pg_prewarm.autoprewarm_interval.mdx index 44ba925eedf..cb8d49a196d 100644 --- a/product_docs/docs/epas/14/epas_guide/03_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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/17_pg_prewarm.autoprewarm_interval.mdx @@ -16,6 +16,6 @@ title: "pg_prewarm.autoprewarm_interval" **Required authorization to activate:** EPAS service account -This is the minimum number of seconds after which the `autoprewarm` background worker dumps shared buffers to disk. The default is 300 seconds. If set to 0, shared buffers are not dumped at regular intervals, but only when the server is shut down. +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. See the [pg_prewarm.autoprewarm](16_pg_prewarm.autoprewarm/#pg_prewarm_autoprewarm) for information on the `autoprewarm` background worker. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/index.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/index.mdx index 172a9014d20..7d32ead5e88 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/index.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/01_top_performance_related_parameters/index.mdx @@ -8,7 +8,7 @@ legacyRedirectsGenerated: -This section discusses the configuration parameters that have the most immediate impact on performance. +These configuration parameters have the most immediate impact on performance.
diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/02_resource_usage_memory.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/02_resource_usage_memory.mdx index c13b2670058..fd71d2d3ccc 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/02_resource_usage_memory.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/02_resource_usage_memory.mdx @@ -8,7 +8,7 @@ legacyRedirectsGenerated: -The configuration parameters in this section control resource usage pertaining to memory. +These configuration parameters control resource use pertaining to memory. ## edb_dynatune @@ -24,19 +24,19 @@ The configuration parameters in this section control resource usage pertaining t **Required authorization to activate:** EPAS service account -Determines how much of the host system’s resources are to be used by the database server based upon the host machine’s total available resources and the intended usage of the host machine. +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. -When EDB Postgres Advanced Server is initially installed, the `edb_dynatune` parameter is set in accordance with the selected usage of the host machine on which it was installed (i.e., development machine, mixed use machine, or dedicated server). For most purposes, there is no need for the database administrator to adjust the various configuration parameters in the `postgresql.conf` file in order to improve performance. +When you first install EDB Postgres Advanced Server, you set `edb_dynatune` according to the use of the host machine on which it was installed, that is, development machine, mixed-use machine, or dedicated server. For most purposes, the database administrator doesn't need to adjust the various configuration parameters in the `postgresql.conf` file to improve performance. -The `edb_dynatune` parameter can be set to any integer value between 0 and 100, inclusive. A value of 0, turns off the dynamic tuning feature thereby leaving the database server resource usage totally under the control of the other configuration parameters in the `postgresql.conf` file. +You can set the `edb_dynatune` parameter to any integer value from 0 to 100. A value of 0 turns off the dynamic tuning feature, which leaves the database server resource use under the control of the other configuration parameters in the `postgresql.conf` file. -A low non-zero, value (e.g., 1 - 33) dedicates the least amount of the host machine’s resources to the database server. This setting would be used for a development machine where many other applications are being used. +A low, non-zero value, for example, 1 to 33, dedicates the least amount of the host machine’s resources to the database server. These values are suitable for a development machine where many other applications are being used. -A value in the range of 34 - 66 dedicates a moderate amount of resources to the database server. This setting might be used for a dedicated application server that may have a fixed number of other applications running on the same machine as EDB Postgres Advanced Server. +A value in the range of 34 to 66 dedicates a moderate amount of resources to the database server. This setting might be used for a dedicated application server that has a fixed number of other applications running on the same machine as EDB Postgres Advanced Server. -The highest values (e.g., 67 - 100) dedicate most of the server’s resources to the database server. This setting would be used for a host machine that is totally dedicated to running EDB Postgres Advanced Server. +The highest values of 67 to 100 dedicate most of the server’s resources to the database server. Use settings in this range for a host machine that's dedicated to running EDB Postgres Advanced Server. -Once a value of `edb_dynatune` is selected, database server performance can be further fine-tuned by adjusting the other configuration parameters in the `postgresql.conf` file. Any adjusted setting overrides the corresponding value chosen by `edb_dynatune`. You can change the value of a parameter by un-commenting the configuration parameter, specifying the desired value, and restarting the database server. +After you select a value for `edb_dynatune`, you can further fine-tune database server performance by adjusting the other configuration parameters in the `postgresql.conf` file. Any adjusted setting overrides the corresponding value chosen by `edb_dynatune`. To change the value of a parameter, uncomment the configuration parameter, specify the desired value, and restart the database server. ## edb_dynatune_profile @@ -52,10 +52,10 @@ Once a value of `edb_dynatune` is selected, database server performance can be f **Required authorization to activate:** EPAS service account -This parameter is used to control tuning aspects based upon the expected workload profile on the database server. +Controls tuning aspects based on the expected workload profile on the database server. The following are the possible values: -- `oltp.` Recommended when the database server is processing heavy online transaction processing workloads. -- `reporting.` Recommended for database servers used for heavy data reporting. -- `mixed.` Recommended for servers that provide a mix of transaction processing and data reporting. +- `oltp`. Recommended when the database server is processing heavy online transaction processing workloads. +- `reporting`. Recommended for database servers used for heavy data reporting. +- `mixed`. Recommended for servers that provide a mix of transaction processing and data reporting. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/03_resource_usage_edb_resource_manager.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/03_resource_usage_edb_resource_manager.mdx index eaefe18534f..6f808119030 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/03_resource_usage_edb_resource_manager.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/03_resource_usage_edb_resource_manager.mdx @@ -4,7 +4,7 @@ title: "Resource usage/EDB Resource Manager" -The configuration parameters in this section control resource usage through EDB Resource Manager. +These configuration parameters control resource use through EDB Resource Manager. ## edb_max_resource_groups @@ -20,9 +20,9 @@ The configuration parameters in this section control resource usage through EDB **Required authorization to activate:** EPAS service account -This parameter controls the maximum number of resource groups that can be used simultaneously by EDB Resource Manager. More resource groups can be created than the value specified by `edb_max_resource_groups`, however, the number of resource groups in active use by processes in these groups cannot exceed this value. +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. -Parameter `edb_max_resource_groups` should be set comfortably larger than the number of groups you expect to maintain so as not to run out. +Set this parameter large enough to handle the number of groups you expect to maintain. ## edb_resource_group @@ -38,6 +38,6 @@ Parameter `edb_max_resource_groups` should be set comfortably larger than the nu **Required authorization to activate:** Session user -Set the `edb_resource_group` parameter to the name of the resource group to which the current session is to be controlled by EDB Resource Manager according to the group’s resource type settings. +The name of the resource group for EDB Resource Manager to control in the current session according to the group’s resource type settings. -If the parameter is not set, then the current session does not utilize EDB Resource Manager. +If you don't set this parameter, then the current session doesn't use EDB Resource Manager. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/04_query_tuning.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/04_query_tuning.mdx index 2a8a1901ddf..8ae9d15ab21 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/04_query_tuning.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/04_query_tuning.mdx @@ -8,7 +8,7 @@ legacyRedirectsGenerated: -This section describes the configuration parameters used for optimizer hints. +These configuration parameters are used for optimizer hints. ## enable_hints @@ -24,4 +24,4 @@ This section describes the configuration parameters used for optimizer hints. **Required authorization to activate:** Session user -Optimizer hints embedded in SQL commands are utilized when `enable_hints` is on. Optimizer hints are ignored when this parameter is off. +Enables optimizer hints embedded in SQL commands. Optimizer hints are ignored when this parameter is off. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/05_query_tuning_planner_method_configuration.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/05_query_tuning_planner_method_configuration.mdx index a9d3cef4b72..8273300afbe 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/05_query_tuning_planner_method_configuration.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/05_query_tuning_planner_method_configuration.mdx @@ -4,7 +4,7 @@ title: "Query tuning/planner method configuration" -This section describes the configuration parameters used for planner method configuration. +These configuration parameters are used for planner method configuration. ## edb_enable_pruning @@ -20,10 +20,10 @@ This section describes the configuration parameters used for planner method conf **Required authorization to activate:** Session user -When set to `TRUE`, `edb_enable_pruning` allows the query planner to early-prune partitioned tables. `Early-pruning` means that the query planner can `prune` (i.e., ignore) partitions that would not be searched in a query `before` generating query plans. This helps improve performance time as it eliminates the generation of query plans of partitions that would not be searched. +Allows the query planner to *early prune* partitioned tables. Early pruning means that the query planner can "prune" (that is, ignore) partitions that aren't searched in a query before generating query plans. This setting helps improve performance because it prevents generating query plans of partitions that aren't searched. -Conversely, `late-pruning` means that the query planner prunes partitions `after` generating query plans for each partition. (The `constraint_exclusion` configuration parameter controls late-pruning.) +Conversely, *late pruning* means that the query planner prunes partitions after generating query plans for each partition. The `constraint_exclusion` configuration parameter controls late pruning. -The ability to early-prune depends upon the nature of the query in the `WHERE` clause. Early-pruning can be utilized in only simple queries with constraints of the type `WHERE column = literal` (e.g., `WHERE deptno = 10)`. +The ability to early prune depends on the nature of the query in the `WHERE` clause. You can use early pruning in only simple queries with constraints like `WHERE column = literal`, for example, `WHERE deptno = 10`. -Early-pruning is not used for more complex queries such as `WHERE column = expression` (e.g., `WHERE deptno = 10 + 5)`. +Don't use early pruning for more complex queries such as `WHERE column = expression`, for example, `WHERE deptno = 10 + 5`. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/06_reporting_and_logging_what_to_log.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/06_reporting_and_logging_what_to_log.mdx index f9f696b38d5..4663bc29c9a 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/06_reporting_and_logging_what_to_log.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/06_reporting_and_logging_what_to_log.mdx @@ -8,7 +8,7 @@ legacyRedirectsGenerated: -The configuration parameters in this section control reporting and logging. +These configuration parameters control reporting and logging. ## trace_hints @@ -24,14 +24,14 @@ The configuration parameters in this section control reporting and logging. **Required Aauthorization to activate:** Session user -Use with the optimizer hints feature to provide more detailed information regarding whether or not a hint was used by the planner. Set the `client_min_messages` and `trace_hints` configuration parameters as follows: +Use with the optimizer hints feature to provide more detailed information about whether the planner used a hint. Set the `client_min_messages` and `trace_hints` configuration parameters as follows: ```text SET client_min_messages TO info; SET trace_hints TO true; ``` -The `SELECT` command with the `NO_INDEX` hint shown below illustrates the additional information produced when the aforementioned configuration parameters are set. +This example shows how the `SELECT` command with the `NO_INDEX` hint displays the added information produced when you set those configuration parameters: ```text EXPLAIN SELECT /*+ NO_INDEX(accounts accounts_pkey) */ * FROM accounts @@ -68,4 +68,6 @@ Seq Scan on accounts (cost=0.00..14461.10 rows=1 width=97) **Required authorization to activate:** Superuser -Bulk processing logs the resulting statements into both the EDB Postgres Advanced Server log file and the EDB Audit log file. However, logging each and every statement in bulk processing is costly. This can be controlled by the `edb_log_every_bulk_value` configuration parameter. When set to `true`, each and every statement in bulk processing is logged. During bulk execution, when `edb_log_every_bulk_value` is set to `false`, a log message is recorded once per bulk processing along with the number of rows processed. In addition, the duration is emitted once per bulk processing. Default is set to `false`. +Bulk processing logs the resulting statements into both the EDB Postgres Advanced Server log file and the EDB Audit log file. However, logging every statement in bulk processing is costly. You can control the bulk processing statements that are logged with the `edb_log_every_bulk_value` configuration parameter. + +When this parameter is set to `true`, every statement in bulk processing is logged. During bulk execution, when `edb_log_every_bulk_value` is set to `false`, a log message is recorded once per bulk processing along with the number of rows processed. The duration is emitted once per bulk processing. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/01_edb_audit.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/01_edb_audit.mdx index 0eb54b892da..dd7f6e0cb6e 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/01_edb_audit.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/01_edb_audit.mdx @@ -16,4 +16,4 @@ title: "edb_audit" **Required authorization to activate:** EPAS service account -Enables or disables database auditing. The values `xml` or `csv` enable database auditing. These values represent the file format in which auditing information is captured. `none` disables database auditing and is also the default. +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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/02_edb_audit_directory.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/02_edb_audit_directory.mdx index d7195bc2c3a..b2528c0f11a 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/02_edb_audit_directory.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/02_edb_audit_directory.mdx @@ -16,4 +16,4 @@ title: "edb_audit_directory" **Required authorization to activate:** EPAS service account -Specifies the directory where the audit log files are created. The path of the directory can be absolute or relative to the EDB Postgres Advanced Server `data` directory. +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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/03_edb_audit_filename.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/03_edb_audit_filename.mdx index df344f415c0..a3bdfe86150 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/03_edb_audit_filename.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/03_edb_audit_filename.mdx @@ -16,4 +16,4 @@ title: "edb_audit_filename" **Required authorization to activate:** EPAS 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, `%Y, %m` etc., are replaced by the appropriate current values according to the system date and time. +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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/05_edb_audit_rotation_size.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/05_edb_audit_rotation_size.mdx index f22d16d4e5b..8691baf5b51 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/05_edb_audit_rotation_size.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/05_edb_audit_rotation_size.mdx @@ -16,4 +16,4 @@ title: "edb_audit_rotation_size" **Required authorization to activate:** EPAS service account -Specifies a file size threshold in megabytes when file rotation is forced to occur. The default value is 0MB. If the parameter is commented out or set to 0, rotation of the file on a size basis doesn't occur. +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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/06_edb_audit_rotation_seconds.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/06_edb_audit_rotation_seconds.mdx index 6a77dc80999..77b5e0ffdb8 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/06_edb_audit_rotation_seconds.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/06_edb_audit_rotation_seconds.mdx @@ -16,4 +16,4 @@ title: "edb_audit_rotation_seconds" **Required authorization to activate:** EPAS service account -Specifies the rotation time in seconds when a new log file should be created. To disable this feature, set this parameter to 0. +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/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/09_edb_audit_statement.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/09_edb_audit_statement.mdx index e19faaa4be8..8cc0534326c 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/09_edb_audit_statement.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/09_edb_audit_statement.mdx @@ -16,5 +16,15 @@ title: "edb_audit_statement" **Required authorization to activate:** EPAS service account -This configuration parameter is used to specify auditing of different categories of SQL statements as well as those statements related to specific SQL commands. To log errors, set the parameter value to `error`. To audit all DDL statements such as `CREATE TABLE`, `ALTER TABLE`, etc., set the parameter value to `ddl`. To audit specific types of DDL statements, the parameter values can include those specific SQL commands (`create`, `drop`, or `alter`). In addition, the object type may be specified following the command such as `create table`, `create view`, `drop role`, etc. All modification statements such as `INSERT`, `UPDATE`, `DELETE` or `TRUNCATE` can be audited by setting `edb_audit_statement` to `dml`. To audit specific types of DML statements, the parameter values can include the specific SQL commands, `insert`, `update`, `delete`, or `truncate`. Include parameter values `select`, `grant`, `revoke`, or `rollback` to audit statements regarding those SQL commands. To audit `SET` statements, include the parameter value to `SET`. Setting the value to `all` audits every statement while `none` disables this feature. -The per-object level auditing audits the operations permitted by object privileges, such as `SELECT`, `UPDATE`, `DELETE`, and `INSERT` statements, including `(@)` and excluding `(-)` groups on a given table. To audit a specific type of object, specify the name of the object group to be audited. The `edb_audit_statement` parameter can include those specific SQL commands (`select`, `update`, `delete`, or `insert`) associated with a group name with `(@)` include and `(-)` exclude symbol. +Specifies auditing of different categories of SQL statements as well as statements related to specific SQL commands. + +- To log errors, set the parameter value to `error`. +- To audit all DDL statements, such as `CREATE TABLE` and `ALTER TABLE`, set the parameter value to `ddl`. +- To audit specific types of DDL statements, the parameter values can include those specific SQL commands (`create`, `drop`, or `alter`). In addition, you can specify the object type following the command, such as `create table`, `create view`, and `drop role`. +- To audit all modification statements, such as `INSERT`, `UPDATE`, `DELETE`, or `TRUNCATE`, set `edb_audit_statement` to `dml`. +- To audit specific types of DML statements, the parameter values can include the specific SQL commands `insert`, `update`, `delete`, or `truncate`. Include parameter values `select`, `grant`, `revoke`, or `rollback` to audit statements regarding those SQL commands. +- To audit `SET` statements, include the parameter value `SET`. +- To audit every statement, set the value to `all`. +- To disable this feature, set the value to `none`. + +The per-object level auditing audits the operations permitted by object privileges, such as `SELECT`, `UPDATE`, `DELETE`, and `INSERT` statements, including `(@)` and excluding `(-)` groups on a given table. To audit a specific type of object, specify the name of the object group to audit. The `edb_audit_statement` parameter can include the specific SQL commands (`select`, `update`, `delete`, or `insert`) associated with a group name with `(@)` include and `(-)` exclude symbol. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/10_edb_audit_tag.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/10_edb_audit_tag.mdx index bbb2cabfd36..98fd85146a5 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/10_edb_audit_tag.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/10_edb_audit_tag.mdx @@ -14,4 +14,4 @@ title: "edb_audit_tag" **Required authorization to activate:** User -Use `edb_audit_tag` to specify a string value to include in the audit log when the `edb_audit` parameter is set to `csv` or `xml`. +Specifies a string value to include in the audit log when the `edb_audit` parameter is set to `csv` or `xml`. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/11_edb_audit_destination.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/11_edb_audit_destination.mdx index d4a0f4548a5..7b0098c3c2a 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/11_edb_audit_destination.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/11_edb_audit_destination.mdx @@ -16,9 +16,9 @@ title: "edb_audit_destination" **Required authorization to activate:** EPAS service account -Specifies whether the audit log information is to be recorded 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` (the default setting). +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`. -Set to `syslog` to use the syslog process and its location as configured in the `/etc/syslog.conf` file. The `syslog` setting is valid only for EDB Postgres Advanced Server running on a Linux host, and is not supported on Windows systems. +Set to `syslog` to use the syslog process and its location as configured in the `/etc/syslog.conf` file. The `syslog` setting is valid only for EDB Postgres Advanced Server running on a Linux host. It isn't supported on Windows systems. !!! Note - In recent Linux versions, `syslog` has been replaced by `rsyslog` and the configuration file is in `/etc/rsyslog.conf`. + In recent Linux versions, `syslog` was replaced with `rsyslog`, and the configuration file is in `/etc/rsyslog.conf`. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/12_edb_log_every_bulk_value.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/12_edb_log_every_bulk_value.mdx index 56d2f5e45d1..04c0a54df66 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/12_edb_log_every_bulk_value.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/12_edb_log_every_bulk_value.mdx @@ -4,4 +4,4 @@ title: "edb_log_every_bulk_value" -For information on `edb_log_every_bulk_value`, see the [edb_log_every_bulk_value](../06_reporting_and_logging_what_to_log/#edb_log_every_bulk_value_1). +For information on `edb_log_every_bulk_value`, see [edb_log_every_bulk_value](../06_reporting_and_logging_what_to_log/#edb_log_every_bulk_value_1). diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/index.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/index.mdx index 1e65db9f926..b47cd5b0c15 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/index.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/07_auditing_settings/index.mdx @@ -4,7 +4,7 @@ title: "Auditing settings" -This section describes configuration parameters used by the EDB Postgres Advanced Server database auditing feature. +These configuration parameters are for use with the EDB Postgres Advanced Server database auditing feature.
diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/08_ccd_locale_and_formatting.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/08_ccd_locale_and_formatting.mdx index fb490e0ec75..42c613de499 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/08_ccd_locale_and_formatting.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/08_ccd_locale_and_formatting.mdx @@ -8,7 +8,7 @@ legacyRedirectsGenerated: -This section describes configuration parameters affecting locale and formatting. +These configuration parameters affect locale and formatting. ## icu_short_form @@ -24,8 +24,11 @@ This section describes configuration parameters affecting locale and formatting. **Required authorization to activate:** n/a -The configuration parameter `icu_short_form` is a parameter containing the default ICU short form name assigned to a database or to the EDB Postgres Advanced Server instance. See [Unicode Collation Algorithm](../../06_unicode_collation_algorithm/#unicode_collation_algorithm) for general information about the ICU short form and the Unicode Collation Algorithm. +Contains the default ICU short-form name assigned to a database or to the EDB Postgres Advanced Server instance. See [Unicode collation algorithm](../../06_unicode_collation_algorithm/#unicode_collation_algorithm) for general information about the ICU short form and the Unicode collation algorithm. -This configuration parameter is set either when the `CREATE DATABASE` command is used with the `ICU_SHORT_FORM` parameter in which case the specified short form name is set and appears in the `icu_short_form` configuration parameter when connected to this database, or when an EDB Postgres Advanced Server instance is created with the `initdb` command used with the `--icu_short_form` option in which case the specified short form name is set and appears in the `icu_short_form` configuration parameter when connected to a database in that EDB Postgres Advanced Server instance, and the database does not override it with its own `ICU_SHORT_FORM` parameter with a different short form. +Set this configuration parameter either when: -Once established in the manner described, the `icu_short_form` configuration parameter cannot be changed. +- Using the `CREATE DATABASE` command with the `ICU_SHORT_FORM` parameter. In this case, set the specified short-form name. It appears in the `icu_short_form` configuration parameter when connected to this database. +- Creating an EDB Postgres Advanced Server instance with the `initdb` command used with the `--icu_short_form` option. In this case, set the specified short-form name. It appears in the `icu_short_form` configuration parameter when connected to a database in that EDB Postgres Advanced Server instance. The database doesn't override it with its own `ICU_SHORT_FORM` parameter and a different short form. + +Once you set this parameter, you can't change it. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/09_ccd_statement_behaviour.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/09_ccd_statement_behaviour.mdx index f8ec5731c53..6acc0481da2 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/09_ccd_statement_behaviour.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/09_ccd_statement_behaviour.mdx @@ -4,7 +4,7 @@ title: "Client connection defaults/statement behavior" -This section describes configuration parameters affecting statement behavior. +These configuration parameters affect statement behavior. ## default_heap_fillfactor @@ -20,9 +20,11 @@ This section describes configuration parameters affecting statement behavior. **Required authorization to activate:** Session user -Sets the fillfactor for a table when the `FILLFACTOR` storage parameter is omitted from a `CREATE TABLE` command. +Sets the fill factor for a table when the `FILLFACTOR` storage parameter is omitted from a `CREATE TABLE` command. -The fillfactor for a table is a percentage between 10 and 100. 100 (complete packing) is the default. When a smaller `fillfactor` is specified, `INSERT` operations pack table pages only to the indicated percentage; the remaining space on each page is reserved for updating rows on that page. This gives `UPDATE` a chance to place the updated copy of a row on the same page as the original, which is more efficient than placing it on a different page. For a table whose entries are never updated, complete packing is the best choice, but in heavily updated tables smaller fillfactors are appropriate. +The fill factor for a table is a percentage from 10 to 100, where 100 is complete packing. When you specify a smaller fill factor, `INSERT` operations pack table pages only to the indicated percentage. The remaining space on each page is reserved for updating rows on that page. This approach gives `UPDATE` a chance to place the updated copy of a row on the same page as the original, which is more efficient than placing it on a different page. + +For a table whose entries are never updated, complete packing is the best choice. In heavily updated tables, use smaller fill factors. ## edb_data_redaction @@ -40,14 +42,14 @@ The fillfactor for a table is a percentage between 10 and 100. 100 (complete pac Data redaction is the support of policies to limit the exposure of certain sensitive data to certain users by altering the displayed information. -The default setting is `TRUE` so the data redaction is applied to all users except for superusers and the table owner: +When set to `TRUE`, the data redaction is applied to all users except for superusers and the table owner: - Superusers and table owner bypass data redaction. - All other users get the redaction policy applied and see the reformatted data. -If the parameter is disabled by setting it to `FALSE`, then the following occurs: +When set to `FALSE`, the following occurs: - Superusers and table owner still bypass data redaction. - All other users get an error. -For information on data redaction, see the *EDB Postgres Advanced Server Security Features Guide*. +For information on data redaction, see [EDB Postgres Advanced Server Security Features](/epas/latest/epas_security_guide/). diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/10_ccd_other_defaults.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/10_ccd_other_defaults.mdx index 9344ae7e25e..5c5eb40eb2e 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/10_ccd_other_defaults.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/10_ccd_other_defaults.mdx @@ -4,7 +4,7 @@ title: "Client connection defaults/other defaults" -The parameters in this section set other miscellaneous client connection defaults. +These parameters set miscellaneous client connection defaults. ## oracle_home @@ -20,26 +20,26 @@ The parameters in this section set other miscellaneous client connection default **Required authorization to activate:** EPAS service account -Before creating a link to an Oracle server, you must direct 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. +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. -Alternatively, you can also set the value of the `oracle_home` configuration parameter in the `postgresql.conf` file. The value specified in the `oracle_home` configuration parameter will override the `LD_LIBRARY_PATH` environment variable in Linux and `PATH` environment variable in Windows. +Alternatively, you can set the value of the `oracle_home` configuration parameter in the `postgresql.conf` file. The value specified in the `oracle_home` configuration parameter overrides the `LD_LIBRARY_PATH` environment variable in Linux and `PATH` environment variable in Windows. !!! Note - The `oracle_home` configuration parameter should provide the correct path to the Oracle client i.e. `OCI` library. + The `oracle_home` configuration parameter must provide the correct path to the Oracle client, that is,`OCI` library. -To set the `oracle_home` configuration parameter in the `postgresql.conf` file, edit the file, adding the following line: +To set the `oracle_home` configuration parameter in the `postgresql.conf` file, add the following line: ```text -oracle_home = 'lib_directory' +oracle_home = '' ``` -Substitute the name of the `oracle_home` path to the Oracle client installation directory that contains `libclntsh.so` in Linux and `oci.dll` in Windows for `lib_directory`. +<lib_directory> is the name of the `oracle_home` path to the Oracle client installation directory that contains `libclntsh.so` in Linux and `oci.dll` in Windows. -After setting the `oracle_home` configuration parameter, you must restart the server for the changes to take effect. Restart the server, +After setting the `oracle_home` configuration parameter, you must restart the server for the changes to take effect. Restart the server: -- on Linux, using the `systemctl` command or `pg_ctl` services. +- On Linux, using the `systemctl` command or `pg_ctl` services -- on Windows, from the Windows Services console. +- On Windows, from the Windows Services console ## odbc_lib_path @@ -56,8 +56,8 @@ After setting the `oracle_home` configuration parameter, you must restart the se **Required authorization to activate:** EPAS service account -If you are using an ODBC driver manager, and if it is installed in a non-standard location, you specify the location by setting the `odbc_lib_path` configuration parameter in the `postgresql.conf` file: +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: `odbc_lib_path = 'complete_path_to_libodbc.so'` -The configuration file must include the complete pathname to the driver manager shared library (typically `libodbc.so`). +The configuration file must include the complete pathname to the driver manager shared library, which is typically `libodbc.so`. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/11_compatibility_options.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/11_compatibility_options.mdx index 914e95ba600..e668fbac7e3 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/11_compatibility_options.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/11_compatibility_options.mdx @@ -8,7 +8,7 @@ legacyRedirectsGenerated: -The configuration parameters described in this section control various database compatibility features. +These configuration parameters control various database compatibility features. ## edb_redwood_date @@ -24,11 +24,15 @@ The configuration parameters described in this section control various database **Required authorization to activate:** Session user -When `DATE` appears as the data type of a column in the commands, it is translated to `TIMESTAMP` at the time the table definition is stored in the database if the configuration parameter `edb_redwood_date` is set to `TRUE`. Thus, a time component is also stored in the column along with the date. +Translates `DATE` to `TIMESTAMP` when `DATE` appears as the data type of a column in the commands and the table definition is stored in the database. A time component is stored in the column along with the date. -If `edb_redwood_date` is set to `FALSE` the column’s data type in a `CREATE TABLE` or `ALTER TABLE` command remains as a native PostgreSQL `DATE` data type and is stored as such in the database. The PostgreSQL `DATE` data type stores only the date without a time component in the column. +If `edb_redwood_date` is set to `FALSE`, the column’s data type in a `CREATE TABLE` or `ALTER TABLE` command remains as a native PostgreSQL `DATE` data type and is stored as such in the database. The PostgreSQL `DATE` data type stores only the date without a time component in the column. -Regardless of the setting of `edb_redwood_date`, when `DATE` appears as a data type in any other context such as the data type of a variable in an SPL declaration section, or the data type of a formal parameter in an SPL procedure or SPL function, or the return type of an SPL function, it is always internally translated to a `TIMESTAMP` and thus, can handle a time component if present. +Regardless of the setting of `edb_redwood_date`, when `DATE` appears as a data type in any other context, it's always internally translated to a `TIMESTAMP`. It can thus handle a time component if present. Examples of these contexts include: + +- The data type of a variable in an SPL declaration section +- The data type of a formal parameter in an SPL procedure or SPL function +- The return type of an SPL function ## edb_redwood_greatest_least @@ -59,7 +63,7 @@ greatest (1 row) ``` -When `edb_redwood_greatest_least` is set to `FALSE`, null parameters are ignored except when all parameters are null in which case null is returned by the functions. +When `edb_redwood_greatest_least` is set to `FALSE`, null parameters are ignored except when all parameters are null. In that case, the functions return null. ```text SET edb_redwood_greatest_least TO off; @@ -94,11 +98,11 @@ greatest **Required authorization to activate:** Session user -When `edb_redwood_raw_names` is set to its default value of `FALSE`, database object names such as table names, column names, trigger names, program names, user names, etc. appear in uppercase letters when viewed from Redwood catalogs (that is, system catalogs prefixed by `ALL_`, `DBA_`, or `USER_`). In addition, quotation marks enclose names that were created with enclosing quotation marks. +When `edb_redwood_raw_names` is set to `FALSE`, database object names such as table names, column names, trigger names, program names, and user names appear in uppercase letters when viewed from Redwood catalogs (that is, system catalogs prefixed by `ALL_`, `DBA_`, or `USER_`). In addition, quotation marks enclose names that were created with enclosing quotation marks. -When `edb_redwood_raw_names` is set to `TRUE`, the database object names are displayed exactly as they are stored in the PostgreSQL system catalogs when viewed from the Redwood catalogs. Thus, names created without enclosing quotation marks appear in lowercase as expected in PostgreSQL. Names created with enclosing quotation marks appear exactly as they were created, but without the quotation marks. +When `edb_redwood_raw_names` is set to `TRUE`, the database object names are displayed as they're stored in the PostgreSQL system catalogs when viewed from the Redwood catalogs. Names created without quotation marks around them appear in lower case as expected in PostgreSQL. Names created enclosed by quotation marks appear as they were created but without the quotation marks. -For example, the following user name is created, and then a session is started with that user. +For example, the following user name is created, and then a session is started with that user: ```text CREATE USER reduser IDENTIFIED BY password; @@ -107,7 +111,7 @@ Password for user reduser: You are now connected to database "edb" as user "reduser". ``` -When connected to the database as reduser, the following tables are created. +When connected to the database as `reduser`, the following tables are created: ```text CREATE TABLE all_lower (col INTEGER); @@ -115,7 +119,7 @@ CREATE TABLE ALL_UPPER (COL INTEGER); CREATE TABLE "Mixed_Case" ("Col" INTEGER); ``` -When viewed from the Redwood catalog, `USER_TABLES`, with `edb_redwood_raw_names` set to the default value `FALSE`, the names appear in uppercase except for the `Mixed_Case` name, which appears as created and also with enclosing quotation marks. +When viewed from the Redwood catalog `USER_TABLES`, with `edb_redwood_raw_names` set to the default value `FALSE`, the names appear in upper case. The exception is the `Mixed_Case` name, which appears as created and also enclosed by quotation marks. ```text edb=> SELECT * FROM USER_TABLES; @@ -127,7 +131,7 @@ edb=> SELECT * FROM USER_TABLES; (3 rows) ``` -When viewed with `edb_redwood_raw_names` set to `TRUE`, the names appear in lowercase except for the `Mixed_Case` name, which appears as created, but now without the enclosing quotation marks. +When viewed with `edb_redwood_raw_names` set to `TRUE`, the names appear in lower case except for the `Mixed_Case` name, which appears as created but without quotation marks. ```text edb=> SET edb_redwood_raw_names TO true; @@ -141,7 +145,7 @@ reduser | Mixed_Case | | VALID | N (3 rows) ``` -These names now match the case when viewed from the PostgreSQL `pg_tables` catalog. +These names now match the case when viewed from the PostgreSQL `pg_tables` catalog: ```text edb=> SELECT schemaname, tablename, tableowner FROM pg_tables WHERE @@ -168,11 +172,9 @@ reduser | Mixed_Case | reduser **Required authorization to activate:** Session user -If the `edb_redwood_strings` parameter is set to `TRUE`, when a string is concatenated with a null variable or null column, the result is the original string. If `edb_redwood_strings` is set to `FALSE`, the native PostgreSQL behavior is maintained, which is the concatenation of a string with a null variable or null column gives a null result. - -The following example illustrates the difference. +If the `edb_redwood_strings` parameter is set to `TRUE`, when a string is concatenated with a null variable or null column, the result is the original string. If `edb_redwood_strings` is set to `FALSE`, the native PostgreSQL behavior is maintained, which is the concatenation of a string with a null variable or null column that gives a null result. -The sample application contains a table of employees. This table has a column named `comm` that is null for most employees. The following query is run with `edb_redwood_string` set to `FALSE`. The concatenation of a null column with non-empty strings produces a final result of null, so only employees that have a commission appear in the query result. The output line for all other employees is null. +This example shows the difference. The sample application contains a table of employees. This table has a column named `comm` that's null for most employees. The following query is run with `edb_redwood_string` set to `FALSE`. Concatenating a null column with non-empty strings produces a final result of null, so only employees that have a commission appear in the query result. The output line for all other employees is null. ```text SET edb_redwood_strings TO off; @@ -197,7 +199,7 @@ TO_CHAR(comm,'99,999.99') "EMPLOYEE COMPENSATION" FROM emp; (14 rows) ``` -The following is the same query executed when `edb_redwood_strings` is set to `TRUE`. Here, the value of a null column is treated as an empty string. The concatenation of an empty string with a non-empty string produces the non-empty string. +The following is the same query executed when `edb_redwood_strings` is set to `TRUE`. Here, the value of a null column is treated as an empty string. Concatenating an empty string with a non-empty string produces the non-empty string. ```text SET edb_redwood_strings TO on; @@ -240,16 +242,16 @@ TO_CHAR(comm,'99,999.99') "EMPLOYEE COMPENSATION" FROM emp; **Required authorization to activate:** Session user -The term `statement level transaction isolation` describes the behavior whereby when a runtime error occurs in a SQL command, all the updates on the database caused by that single command are rolled back. For example, if a single `UPDATE` command successfully updates five rows, but an attempt to update a sixth row results in an exception, the updates to all six rows made by this `UPDATE` command are rolled back. The effects of prior SQL commands that have not yet been committed or rolled back are pending until a `COMMIT` or `ROLLBACK` command is executed. +The term *statement-level transaction isolation* describes the behavior in which a runtime error occurs in a SQL command, and all the updates on the database caused by that single command are rolled back. For example, if a single `UPDATE` command successfully updates five rows, but an attempt to update a sixth row results in an exception, the updates to all six rows made by this `UPDATE` command are rolled back. The effects of prior SQL commands that haven't yet been committed or rolled back are pending until a `COMMIT` or `ROLLBACK` command is executed. -In EDB Postgres Advanced Server, if an exception occurs while executing a SQL command, all the updates on the database since the start of the transaction are rolled back. In addition, the transaction is left in an aborted state and either a `COMMIT` or `ROLLBACK` command must be issued before another transaction can be started. +In EDB Postgres Advanced Server, if an exception occurs while executing a SQL command, all the updates on the database since the start of the transaction are rolled back. In addition, the transaction is left in an aborted state, and either a `COMMIT` or `ROLLBACK` command must be issued before another transaction can start. -If `edb_stmt_level_tx` is set to `TRUE`, then an exception doesn't automatically roll back prior uncommitted database updates. If `edb_stmt_level_tx` is set to `FALSE`, then an exception rolls back uncommitted database updates. +If `edb_stmt_level_tx` is set to `TRUE`, then an exception doesn't roll back prior uncommitted database updates. If `edb_stmt_level_tx` is set to `FALSE`, then an exception rolls back uncommitted database updates. !!! Note - Use `edb_stmt_level_tx` set to `TRUE` only when absolutely necessary, as this may cause a negative performance impact. + Use `edb_stmt_level_tx` set to `TRUE` only when necessary, as it can have have a negative performance impact. -The following example run in PSQL shows that when `edb_stmt_level_tx` is `FALSE`, the abort of the second `INSERT` command also rolls back the first `INSERT` command. Note that in PSQL, the command `\set AUTOCOMMIT off` must be issued, otherwise every statement commits automatically defeating the purpose of this demonstration of the effect of `edb_stmt_level_tx`. +This example, run in PSQL, shows that when `edb_stmt_level_tx` is `FALSE`, the abort of the second `INSERT` command also rolls back the first `INSERT` command. In PSQL, you must issue the command `\set AUTOCOMMIT off`. Otherwise every statement commits automatically, which doesn't show the effect of `edb_stmt_level_tx`. ```text \set AUTOCOMMIT off @@ -269,7 +271,7 @@ empno | ename | deptno (0 rows) ``` -In the following example, with `edb_stmt_level_tx` set to `TRUE`, the first `INSERT` command has not been rolled back after the error on the second `INSERT` command. At this point, the first INSERT command can either be committed or rolled back. +In this example, with `edb_stmt_level_tx` set to `TRUE`, the first `INSERT` command wasn't rolled back after the error on the second `INSERT` command. At this point, the first INSERT command can either be committed or rolled back. ```text \set AUTOCOMMIT off @@ -291,7 +293,7 @@ empno | ename | deptno COMMIT; ``` -A `ROLLBACK` command could have been issued instead of the `COMMIT` command in which case the insert of employee number `9001` would have been rolled back as well. +If a `ROLLBACK` command is issued instead of the `COMMIT` command, the insert of employee number `9001` is rolled back as well. ## db_dialect @@ -307,9 +309,9 @@ A `ROLLBACK` command could have been issued instead of the `COMMIT` command in w **Required authorization to activate:** Session user -In addition to the native PostgreSQL system catalog, `pg_catalog`, EDB Postgres Advanced Server contains an extended catalog view. This is the `sys` catalog for the expanded catalog view. The `db_dialect` parameter controls the order in which these catalogs are searched for name resolution. +In addition to the native PostgreSQL system catalog `pg_catalog`, EDB Postgres Advanced Server contains an extended catalog view. This is the `sys` catalog for the expanded catalog view. The `db_dialect` parameter controls the order in which these catalogs are searched for name resolution. -When set to `postgres`, the namespace precedence is `pg_catalog` then `sys`, giving the PostgreSQL catalog the highest precedence. When set to `redwood`, the namespace precedence is `sys` then `pg_catalog`, giving the expanded catalog views the highest precedence. +When set to `postgres`, the namespace precedence is `pg_catalog` and then `sys`, giving the PostgreSQL catalog the highest precedence. When set to `redwood`, the namespace precedence is `sys` and then `pg_catalog`, giving the expanded catalog views the highest precedence. ## default_with_rowids @@ -325,17 +327,17 @@ When set to `postgres`, the namespace precedence is `pg_catalog` then `sys`, giv **Required authorization to activate:** Session user -When set to `on`, `CREATE TABLE` includes a `ROWID` column in newly created tables, which can then be referenced in SQL commands. In earlier versions of EDB Postgres Advanced Server `ROWIDs` were mapped to `OIDs`, but from EDB Postgres Advanced Server version 12 onwards, the `ROWID` is an auto-incrementing value based on a sequence that starts with 1 and assigned to each row of a table created with `ROWIDs` option. By default, a unique index is created on a `ROWID` column. +When set to `on`, `CREATE TABLE` includes a `ROWID` column in newly created tables, which you can then reference in SQL commands. In earlier versions of EDB Postgres Advanced Server, `ROWIDs` were mapped to `OIDs`. With EDB Postgres Advanced Server version 12 and later, the `ROWID` is an autoincrementing value based on a sequence that starts with 1. It's assigned to each row of a table created with the `ROWIDs` option. By default, a unique index is created on a `ROWID` column. The `ALTER` and `DROP` operations are restricted on a `ROWID` column. -To restore a database with `ROWIDs` from EDB Postgres Advanced Server 11 or an earlier version, you must perform the following: +To restore a database with `ROWIDs` with EDB Postgres Advanced Server 11 or an earlier version, you must perform the following: -- pg_dump: If a table includes `OIDs` then specify `--convert-oids-to-rowids` to dump a database. Otherwise, ignore the `OIDs` to continue table creation on EDB Postgres Advanced Server version 12 onwards. -- pg_upgrade: Errors out. But if a table includes `OIDs` or `ROWIDs`, then you must perform the following steps: - 1. Take a dump of the tables by specifying `--convert-oids-to-rowids` option. - 2. Drop the tables and then perform the upgrade. - 3. Restore the dump after the upgrade is successful into a new cluster that contains the dumped tables into a target database. +- `pg_dump`: If a table includes `OIDs` then specify `--convert-oids-to-rowids` to dump a database. Otherwise, ignore the `OIDs` to continue table creation on EDB Postgres Advanced Server version 12 and later. +- `pg_upgrade`: Errors out. But if a table includes `OIDs` or `ROWIDs`, then you must perform the following: + 1. Take a dump of the tables by specifying the `--convert-oids-to-rowids` option. + 2. Drop the tables, and then perform the upgrade. + 3. After the upgrade is successful, restore the dump into a new cluster that contains the dumped tables into a target database. ## optimizer_mode @@ -353,15 +355,15 @@ To restore a database with `ROWIDs` from EDB Postgres Advanced Server 11 or an e Sets the default optimization mode for analyzing optimizer hints. -The following table shows the possible values: +The following table shows the possible values. | Hint | Description | | ----------------- | ---------------------------------------------------------------------------------------------------------------------- | | `ALL_ROWS` | Optimizes for retrieval of all rows of the result set. | -| `CHOOSE` | Does no default optimization based on assumed number of rows to be retrieved from the result set. This is the default. | +| `CHOOSE` | Does no default optimization based on assumed number of rows to retrieve from the result set. This is the default. | | `FIRST_ROWS` | Optimizes for retrieval of only the first row of the result set. | | `FIRST_ROWS_10` | Optimizes for retrieval of the first 10 rows of the results set. | | `FIRST_ROWS_100` | Optimizes for retrieval of the first 100 rows of the result set. | | `FIRST_ROWS_1000` | Optimizes for retrieval of the first 1000 rows of the result set. | -These optimization modes are based upon the assumption that the client submitting the SQL command is interested in viewing only the first `n` rows of the result set and then abandons the remainder of the result set. Resources allocated to the query are adjusted as such. +These optimization modes are based on the assumption that the client submitting the SQL command is interested in viewing only the first `n` rows of the result set and then abandons the rest of the result set. Resources allocated to the query are adjusted as such. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/12_customized_options.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/12_customized_options.mdx index 2130cbbe22a..a02046c155e 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/12_customized_options.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/12_customized_options.mdx @@ -8,11 +8,9 @@ legacyRedirectsGenerated: -In previous releases of EDB Postgres Advanced Server, the `custom_variable_classes` was required by those parameters not normally known to be added by add-on modules (such as procedural languages). - ## custom_variable_classes -The `custom_variable_classes` parameter is deprecated in EDB Postgres Advanced Server 9.2; parameters that previously depended on this parameter no longer require its support. +The `custom_variable_classes` parameter was deprecated in EDB Postgres Advanced Server 9.2. Parameters that previously depended on this parameter no longer require its support. In previous releases of EDB Postgres Advanced Server, `custom_variable_classes` was required by parameters not normally known to be added by add-on modules, such as procedural languages. ## dbms_alert.max_alerts @@ -32,7 +30,7 @@ Specifies the maximum number of concurrent alerts allowed on a system using the ## dbms_pipe.total_message_buffer -Parameter Type: Integer +**Parameter type:** Integer **Default value:** 30 Kb @@ -60,9 +58,9 @@ Specifies the total size of the buffer used for the `DBMS_PIPE` package. **Required authorization to activate:** Session user -Provides the capability to temporarily suspend Index Advisor in an EDB-PSQL or PSQL session. The Index Advisor plugin, `index_advisor`, must be loaded in the EDB-PSQL or PSQL session in order to use the `index_advisor.enabled` configuration parameter. +Temporarily suspends Index Advisor in an EDB-PSQL or PSQL session. To use this configuration parameter, the Index Advisor plugin `index_advisor` must be loaded in the EDB-PSQL or PSQL session. -The Index Advisor plugin can be loaded as shown by the following example: +You can load the Index Advisor plugin as follows: ```text $ psql -d edb -U enterprisedb @@ -74,7 +72,7 @@ edb=# LOAD 'index_advisor'; LOAD ``` -Use the `SET` command to change the parameter setting to control whether or not Index Advisor generates an alternative query plan as shown by the following example: +Use the `SET` command to change the parameter setting to control whether Index Advisor generates an alternative query plan: ```text edb=# SET index_advisor.enabled TO off; @@ -116,7 +114,7 @@ edb=# EXPLAIN SELECT * FROM t WHERE a < 10000; **Required authorization to activate:** EPAS service account -Controls whether or not 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 are ready to begin monitoring with SQL/Protect set this parameter to on. +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`. ## edb_sql_protect.level @@ -134,13 +132,13 @@ Controls whether or not SQL/Protect is actively monitoring protected roles by an Sets the action taken by SQL/Protect when a SQL statement is issued by a protected role. -The `edb_sql_protect.level` configuration parameter can be set to one of the following values to use either learn mode, passive mode, or active mode: +You can set this parameter to one of the following values to use learn mode, passive mode, or active mode: -- **learn.** Tracks the activities of protected roles and records the relations used by the roles. This is used when initially configuring SQL/Protect so the expected behaviors of the protected applications are learned. -- **passive.** Issues warnings if protected roles are breaking the defined rules, but does not stop any SQL statements from executing. This is the next step after SQL/Protect has learned the expected behavior of the protected roles. This essentially behaves in intrusion detection mode and can be run in production when properly monitored. -- **active.** Stops all invalid statements for a protected role. This behaves as a SQL firewall preventing dangerous queries from running. This is particularly effective against early penetration testing when the attacker is trying to determine the vulnerability point and the type of database behind the application. Not only does SQL/Protect close those vulnerability points, but it tracks the blocked queries allowing administrators to be alerted before the attacker finds an alternate method of penetrating the system. +- `learn`. Tracks the activities of protected roles and records the relations used by the roles. Use this value when initially configuring SQL/Protect so the expected behaviors of the protected applications are learned. +- `passive`. Issues warnings if protected roles are breaking the defined rules but doesn't stop any SQL statements from executing. This is the next step after SQL/Protect learns the expected behavior of the protected roles. This essentially behaves in intrusion detection mode. You can run it in production if you monitor it. +- `active`. Stops all invalid statements for a protected role. This behavior acts as a SQL firewall that prevents dangerous queries from running. This is particularly effective against early penetration testing when the attacker is trying to determine the vulnerability point and the type of database behind the application. Not only does SQL/Protect close those vulnerability points, it tracks the blocked queries. This behavior can alert administrators before the attacker finds an alternative method of penetrating the system. -If you are using SQL/Protect for the first time, set `edb_sql_protect.level` to `learn`. +If you're using SQL/Protect for the first time, set `edb_sql_protect.level` to `learn`. ## edb_sql_protect.max_protected_relations @@ -166,11 +164,11 @@ If the server is started when `edb_sql_protect.max_protected_relations` is set t 2014-07-18 16:04:12 EDT HINT: Value exceeds integer range. ``` -The database server starts successfully, but with `edb_sql_protect.max_protected_relations` set to the default value of 1024. +The database server starts successfully but with `edb_sql_protect.max_protected_relations` set to the default value of 1024. -Though the upper range for the parameter is listed as the maximum value for an integer data type, the practical setting depends on how much shared memory is available and the parameter value used during database server startup. +Although the upper range for the parameter is listed as the maximum value for an integer data type, the practical setting depends on how much shared memory is available and the parameter value used during database server startup. -As long as the space required can be reserved in shared memory, the value is acceptable. If the value is such that the space in shared memory cannot be reserved, the database server startup fails with an error message such as the following: +As long as the space required can be reserved in shared memory, the value is acceptable. If the value is such that the space in shared memory can't be reserved, the database server startup fails with an error message like the following: ```text 2014-07-18 15:22:17 EDT FATAL: could not map anonymous shared memory: @@ -182,7 +180,7 @@ bytes), reduce PostgreSQL's shared memory usage, perhaps by reducing shared_buffers or max_connections. ``` -In such cases, reduce the parameter value until the database server can be started successfully. +In this case, reduce the parameter value until you can start the database server successfully. ## edb_sql_protect.max_protected_roles @@ -210,11 +208,11 @@ If the database server is started when `edb_sql_protect.max_protected_roles` is 2014-07-18 16:04:12 EDT HINT: Value exceeds integer range. ``` -The database server starts successfully, but with `edb_sql_protect.max_protected_roles` set to the default value of 64. +The database server starts successfully but with `edb_sql_protect.max_protected_roles` set to the default value of 64. -Though the upper range for the parameter is listed as the maximum value for an integer data type, the practical setting depends on how much shared memory is available and the parameter value used during database server startup. +Although the upper range for the parameter is listed as the maximum value for an integer data type, the practical setting depends on how much shared memory is available and the parameter value used during database server startup. -As long as the space required can be reserved in shared memory, the value is acceptable. If the value is such that the space in shared memory cannot be reserved, the database server startup fails with an error message such as the following: +As long as the space required can be reserved in shared memory, the value is acceptable. If the value is such that the space in shared memory can't be reserved, the database server startup fails with an error message such as the following: ```text 2014-07-18 15:22:17 EDT FATAL: could not map anonymous shared memory: @@ -226,7 +224,7 @@ bytes), reduce PostgreSQL's shared memory usage, perhaps by reducing shared_buffers or max_connections. ``` -In such cases, reduce the parameter value until the database server can be started successfully. +In this cases, reduce the parameter value until you can start the database server successfully. ## edb_sql_protect.max_queries_to_save @@ -242,9 +240,9 @@ In such cases, reduce the parameter value until the database server can be start **Required authorization to activate:** EPAS service account -Sets the maximum number of offending queries to save in view `edb_sql_protect_queries`. +Sets the maximum number of offending queries to save in the view `edb_sql_protect_queries`. -Every query that is saved consumes space in shared memory. The space for the maximum possible queries that can be saved is reserved during database server startup. +Every saved query consumes space in shared memory. The space for the maximum possible queries that can be saved is reserved during database server startup. If the database server is started when `edb_sql_protect.max_queries_to_save` is set to a value outside of the valid range (for example, a value of 10), then a warning message is logged in the database server log file: @@ -253,11 +251,11 @@ If the database server is started when `edb_sql_protect.max_queries_to_save` is parameter "edb_sql_protect.max_queries_to_save" (100 .. 2147483647) ``` -The database server starts successfully, but with `edb_sql_protect.max_queries_to_save` set to the default value of 5000. +The database server starts successfully but with `edb_sql_protect.max_queries_to_save` set to the default value of 5000. -Though the upper range for the parameter is listed as the maximum value for an integer data type, the practical setting depends on how much shared memory is available and the parameter value used during database server startup. +Although the upper range for the parameter is listed as the maximum value for an integer data type, the practical setting depends on how much shared memory is available and the parameter value used during database server startup. -As long as the space required can be reserved in shared memory, the value is acceptable. If the value is such that the space in shared memory cannot be reserved, the database server startup fails with an error message such as the following: +As long as the space required can be reserved in shared memory, the value is acceptable. If the value is such that the space in shared memory can't be reserved, the database server startup fails with an error message like the following: ```text 2014-07-18 15:22:17 EDT FATAL: could not map anonymous shared memory: @@ -269,7 +267,7 @@ bytes), reduce PostgreSQL's shared memory usage, perhaps by reducing shared_buffers or max_connections. ``` -In such cases, reduce the parameter value until the database server can be started successfully. +In this case, reduce the parameter value until you can start the database server successfully. ## edb_wait_states.directory @@ -285,7 +283,7 @@ In such cases, reduce the parameter value until the database server can be start **Required authorization to activate:** EPAS service account -Sets the directory path where the EDB wait states log files are stored. The specified path should be a full, absolute path and not a relative path. However, the default setting is `edb_wait_states`, which makes `$PGDATA/edb_wait_states` the default directory location. For information on EDB wait states see `EDB Wait States` under [Performance Analysis and Tuning](../../../13_performance_analysis_and_tuning/#performance_analysis_and_tuning). +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. For information on EDB wait states, see `EDB wait states` under [Performance analysis and tuning](../../../13_performance_analysis_and_tuning/#performance_analysis_and_tuning). ## edb_wait_states.retention_period @@ -301,7 +299,7 @@ Sets the directory path where the EDB wait states log files are stored. The spec **Required authorization to activate:** EPAS service account -Sets the period of time after which the log files for EDB wait states are deleted. The default is 604800 seconds, which is 7 days. For information on EDB wait states see `EDB Wait States` under [Performance Analysis and Tuning](../../../13_performance_analysis_and_tuning/#performance_analysis_and_tuning). +Sets the time to wait before deleting the log files for EDB wait states. The default is 604,800 seconds, which is 7 days. For information on EDB wait states, see `EDB wait dtates` under [Performance analysis and tuning](../../../13_performance_analysis_and_tuning/#performance_analysis_and_tuning). ## edb_wait_states.sampling_interval @@ -317,7 +315,7 @@ Sets the period of time after which the log files for EDB wait states are delete **Required authorization to activate:** EPAS service account -Sets the timing interval between two sampling cycles for EDB wait states. The default setting is 1 second. For information on EDB wait states see `EDB Wait States` under [Performance Analysis and Tuning](../../../13_performance_analysis_and_tuning/#performance_analysis_and_tuning). +Sets the timing interval between two sampling cycles for EDB wait states. The default setting is 1 second. For information on EDB wait states, see `EDB wait states` under [Performance analysis and tuning](../../../13_performance_analysis_and_tuning/#performance_analysis_and_tuning). ## edbldr.empty_csv_field @@ -333,17 +331,15 @@ Sets the timing interval between two sampling cycles for EDB wait states. The de **Required authorization to activate:** Session user -Use the `edbldr.empty_csv_field` parameter to specify how EDB\*Loader treats an empty string. The valid values for the `edbldr.empty_csv_field` parameter are: +Use the `edbldr.empty_csv_field` parameter to specify how EDB\*Loader treats an empty string. The table shows the valid values for the `edbldr.empty_csv_field` parameter. | Parameter setting | EDB\*Loader behavior | | ------------------- | ----------------------------------------------------------------------------------------------------------------- | | `NULL` | An empty field is treated as `NULL`. | | `empty_string` | An empty field is treated as a string of length zero. | -| `pgsql` | An empty field is treated as a `NULL` if it does not contain quotes and as an empty string if it contains quotes. | - -For more information about the `edbldr.empty_csv_field` parameter in EDB\*Loader, see the *Database Compatibility for Oracle Developers Tools and Utilities Guide* at the EDB website: +| `pgsql` | An empty field is treated as a `NULL` if it doesn't contain quotes and as an empty string if it contains quotes. | -[https://www.enterprisedb.com/docs](/epas/latest/epas_compat_tools_guide/) +For more information about the `edbldr.empty_csv_field` parameter in EDB\*Loader, see the [Database Compatibility for Oracle Developers: Tools and Utilities](/epas/latest/epas_compat_tools_guide/). ## utl_encode.uudecode_redwood @@ -361,7 +357,7 @@ For more information about the `edbldr.empty_csv_field` parameter in EDB\*Loader When set to `TRUE`, EDB Postgres Advanced Server’s `UTL_ENCODE.UUDECODE` function can decode uuencoded data that was created by the Oracle implementation of the `UTL_ENCODE.UUENCODE` function. -When set to the default setting of `FALSE`, EDB Postgres Advanced Server’s `UTL_ENCODE.UUDECODE` function can decode uuencoded data created by EDB Postgres Advanced Server’s `UTL_ENCODE.UUENCODE` function. +When set to `FALSE`, EDB Postgres Advanced Server’s `UTL_ENCODE.UUDECODE` function can decode uuencoded data created by EDB Postgres Advanced Server’s `UTL_ENCODE.UUENCODE` function. ## utl_file.umask @@ -377,14 +373,14 @@ When set to the default setting of `FALSE`, EDB Postgres Advanced Server’s `UT **Required authorization to activate:** Session user -The `utl_file.umask` parameter sets the *file mode creation mask* or simply, the *mask*, in a manner similar to the Linux `umask` command. This is for usage only within the EDB Postgres Advanced Server `UTL_FILE` package. +The `utl_file.umask` parameter sets the *file mode creation mask* in a manner similar to the Linux `umask` command. This is for use only within the EDB Postgres Advanced Server `UTL_FILE` package. !!! Note - The `utl_file.umask` parameter is not supported on Windows systems. + The `utl_file.umask` parameter isn't supported on Windows systems. -The value specified for `utl_file.umask` is a 3 or 4-character octal string that would be valid for the Linux `umask` command. The setting determines the permissions on files created by the `UTL_FILE` functions and procedures. (Refer to any information source regarding Linux or Unix systems for information on file permissions and the usage of the `umask` command.) +The value specified for `utl_file.umask` is a three- or four-character octal string that's valid for the Linux `umask` command. The setting determines the permissions on files created by the `UTL_FILE` functions and procedures. -The following shows the results of the default `utl_file.umask` setting of 0077. Note that all permissions are denied on users belonging to the `enterprisedb` group as well as all other users. Only user `enterprisedb` has read and write permissions on the file. +The following shows the results of the default `utl_file.umask` setting of 0077. All permissions are denied on users belonging to the `enterprisedb` group as well as all other users. Only the user `enterprisedb` has read and write permissions on the file. ```text -rw------- 1 enterprisedb enterprisedb 21 Jul 24 16:08 utlfile diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/13_ungrouped.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/13_ungrouped.mdx index f775de2c5ed..5e0b42fe39d 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/13_ungrouped.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/13_ungrouped.mdx @@ -8,7 +8,7 @@ legacyRedirectsGenerated: -Configuration parameters in this section apply to EDB Postgres Advanced Server only and are for a specific, limited purpose. +These configuration parameters apply only to EDB Postgres Advanced Server and are for a specific, limited purpose. ## nls_length_semantics @@ -24,16 +24,14 @@ Configuration parameters in this section apply to EDB Postgres Advanced Server o **Required authorization to activate:** Superuser -This parameter has no effect in EDB Postgres Advanced Server. - -For example, the form of the `ALTER SESSION` command is accepted in EDB Postgres Advanced Server without throwing a syntax error, but does not alter the session environment: +This parameter has no effect in EDB Postgres Advanced Server. For example, this form of the `ALTER SESSION` command is accepted in EDB Postgres Advanced Server without throwing a syntax error. However, it doesn't alter the session environment. ```text ALTER SESSION SET nls_length_semantics = char; ``` !!! Note - Since the setting of this parameter has no effect on the server environment, it does not appear in the system view `pg_settings`. + Since setting this parameter has no effect on the server environment, it doesn't appear in the system view `pg_settings`. ## query_rewrite_enabled @@ -49,16 +47,14 @@ ALTER SESSION SET nls_length_semantics = char; **Required authorization to activate:** Session user -This parameter has no effect in EDB Postgres Advanced Server. - -For example, the following form of the `ALTER SESSION` command is accepted in EDB Postgres Advanced Server without throwing a syntax error, but does not alter the session environment: +This parameter has no effect in EDB Postgres Advanced Server. For example, this form of the `ALTER SESSION` command is accepted in EDB Postgres Advanced Server without throwing a syntax error. However, it doesn't alter the session environment. ```text ALTER SESSION SET query_rewrite_enabled = force; ``` !!! Note - Since the setting of this parameter has no effect on the server environment, it does not appear in the system view `pg_settings`. + Since setting this parameter has no effect on the server environment, it doesn't appear in the system view `pg_settings`. ## query_rewrite_integrity @@ -74,16 +70,14 @@ ALTER SESSION SET query_rewrite_enabled = force; **Required authorization to activate:** Superuser -This parameter has no effect in EDB Postgres Advanced Server. - -For example, the following form of the `ALTER SESSION` command is accepted in EDB Postgres Advanced Server without throwing a syntax error, but does not alter the session environment: +This parameter has no effect in EDB Postgres Advanced Server. For example, this form of the `ALTER SESSION` command is accepted in EDB Postgres Advanced Server without throwing a syntax error. However, it doesn't alter the session environment. ```text ALTER SESSION SET query_rewrite_integrity = stale_tolerated; ``` !!! Note - Since the setting of this parameter has no effect on the server environment, it does not appear in the system view `pg_settings`. + Since setting this parameter has no effect on the server environment, it doesn't appear in the system view `pg_settings`. ## timed_statistics @@ -99,7 +93,7 @@ ALTER SESSION SET query_rewrite_integrity = stale_tolerated; **Required authorization to activate:** Session user -Controls the collection of timing data for the Dynamic Runtime Instrumentation Tools Architecture (DRITA) feature. When set to on, timing data is collected. +Controls collecting timing data for the Dynamic Runtime Instrumentation Tools Architecture (DRITA) feature. When set to `on`, timing data is collected. !!! Note - When EDB Postgres Advanced Server is installed, the `postgresql.conf` file contains an explicit entry setting `timed_statistics` to off. If this entry is commented out letting `timed_statistics` to default, and the configuration file is reloaded, timed statistics collection would be turned on. + When EDB Postgres Advanced Server is installed, the `postgresql.conf` file contains an explicit entry that setts `timed_statistics` to `off`. If this entry is commented out and the configuration file is reloaded, timed statistics collection uses the default value, which is `on`. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/14_audit_archiver.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/14_audit_archiver.mdx index bd9fd54a163..2c8c5eb9915 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/14_audit_archiver.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/14_audit_archiver.mdx @@ -4,7 +4,7 @@ title: "Audit archiver" -This section describes configuration parameters 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. ## edb_audit_archiver @@ -36,7 +36,7 @@ Enables or disables database audit archiving. **Required authorization to activate:** EPAS service account -Enforces a timeout in seconds when a database attempts to archive a log file. The valid range is between 30 seconds and one day. +Enforces a timeout in seconds when a database attempts to archive a log file. ## edb_audit_archiver_filename_prefix @@ -52,7 +52,7 @@ Enforces a timeout in seconds when a database attempts to archive a log file. Th **Required authorization to activate:** EPAS 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 default value for `edb_audit_archiver_filename_prefix` is `audit-`. The audit files with `edb_audit_archiver_filename_prefix` in the `edb_audit_directory` are eligible for compression and/or expiration. +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. ## edb_audit_archiver_compress_time_limit @@ -68,7 +68,10 @@ Specifies the file name of an audit log file that needs to be archived; the file **Required authorization to activate:** EPAS service account -Specifies the time in seconds after which audit logs are eligible for compression. The possible values to set this parameter are: `0` = compression starts as soon as the log file is not a current file, `-1` = compression of the log file on a timely basis does not occur. +Specifies the time in seconds after which audit logs are eligible for compression. The possible values to set this parameter are: + +- `0`. Compression starts as soon as the log file isn't a current file. +- `-1`. Compression of the log file on a timely basis doesn't occur. ## edb_audit_archiver_compress_size_limit @@ -84,7 +87,7 @@ Specifies the time in seconds after which audit logs are eligible for compressio **Required authorization to activate:** EPAS service account -Specifies a file size threshold in megabytes, after which audit logs are eligible for compression. If the parameter is set to -1, compression of the log file on a size basis does not occur. +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. ## edb_audit_archiver_compress_command @@ -116,7 +119,7 @@ Specifies the command to execute compressing of the audit log files. The default **Required authorization to activate:** EPAS 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`. +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`. ## edb_audit_archiver_expire_time_limit @@ -132,7 +135,10 @@ Specifies the file name of an already compressed log file; the file name must al **Required authorization to activate:** EPAS service account -Specifies the time in seconds after which audit logs are eligible for expiration. The possible values to set this parameter are: `0` = expiration starts as soon as the log file is not a current file, `-1` = expiration of the log file on a timely basis does not occur. +Specifies the time in seconds after which audit logs are eligible to expire. The possible values to set this parameter are: + +- `0`. Expiration starts as soon as the log file isn't a current file. +- `-1`. Expiration of the log file on a timely basis doesn't occur. ## edb_audit_archiver_expire_size_limit @@ -148,7 +154,7 @@ Specifies the time in seconds after which audit logs are eligible for expiration **Required authorization to activate:** EPAS service account -Specifies a file size threshold in megabytes, after which audit logs are eligible for expiration. If the parameter is set to -1, the expiration of a log file on the size basis does not occur. +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. ## edb_audit_archiver_expire_command @@ -180,5 +186,7 @@ Specifies the command to execute on an expired audit log file before removal. **Required authorization to activate:** EPAS service account -Identifies the oldest log file to be sorted alphabetically or based on `mtime`. `mtime` indicates sorting of files based on file modification time; `alphabetic` indicates sorting of files alphabetically based on the file name. +Identifies the oldest log file to sort alphabetically or based on `mtime`. +- `mtime` sorts files based on file modification time. +- `alphabetic` sorts files alphabetically based on the file name. diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/index.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/index.mdx index 3a5bdc08936..6144ff9f845 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/index.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/03_configuration_parameters_by_functionality/index.mdx @@ -8,16 +8,17 @@ legacyRedirectsGenerated: -This section provides more detail for certain groups of configuration parameters. +The description of each group of parameters includes this list of attributes: -The section heading for each parameter is followed by a list of attributes: - -- Parameter ype. Type of values the parameter can accept. See [Setting configuration parameters](../01_setting_new_parameters/#setting_configuration_parameters) section for a discussion of parameter type values. -- Default Value. Default setting if a value is not explicitly set in the configuration file. -- Range. Permitted range of values. -- Minimum scope of effect. Smallest scope for which a distinct setting can be made. Generally, the minimal scope of a distinct setting is either the entire `cluster` (the setting is the same for all databases and sessions thereof, in the cluster), or `per session` (the setting may vary by role, database, or individual session). (This attribute has the same meaning as the `Scope of Effect` column in the table of [Summary of Configuration Parameters](../02_summary_of_configuration_parameters/#summary_of_configuration_parameters)). -- `When Value Changes Take Effect.` Least invasive action required to activate a change to a parameter’s value. All parameter setting changes made in the configuration file can be put into effect with a restart of the database server; however certain parameters require a database server `restart`. Some parameter setting changes can be put into effect with a `reload` of the configuration file without stopping the database server. Finally, other parameter setting changes can be put into effect with some client side action whose result is `immediate`. (This attribute has the same meaning as the `When Takes Effect` column in the table of [Summary of Configuration Parameters](../02_summary_of_configuration_parameters/#summary_of_configuration_parameters)). -- `Required Authorization to Activate.` The type of user authorization to activate a change to a parameter’s setting. If a database server restart or a configuration file reload is required, then the user must be a EPAS service account (`enterprisedb` or `postgres` depending upon the EDB Postgres Advanced Server compatibility installation mode). (This attribute has the same meaning as the `Authorized User` column in the table of [Summary of Configuration Parameters](../02_summary_of_configuration_parameters/#summary_of_configuration_parameters)). +- **Parameter type.** Type of values the parameter can accept. See [Setting configuration parameters](../01_setting_new_parameters/#setting_configuration_parameters) for a discussion of parameter type values. +- **Default value.** Default setting if a value isn't explicitly set in the configuration file. +- **Range.** Allowed range of values. +- **Minimum scope of effect.** Smallest scope for which a distinct setting can be made. Generally, the minimal scope of a distinct setting is either: + - The entire cluster, meaning the setting is the same for all databases in the cluster and its sessions + - `per session`, which means the setting might vary by role, database, or individual session. + This attribute has the same meaning as the `Scope of effect` column in the table of [Summary of configuration parameters](../02_summary_of_configuration_parameters/#summary_of_configuration_parameters). +- **When value changes take effect.** Least invasive action required to activate a change to a parameter’s value. All parameter setting changes made in the configuration file can be put into effect by restarting the database server. However, certain parameters require a database server `restart`. Some parameter setting changes can be put into effect with a `reload` of the configuration file without stopping the database server. Finally, other parameter setting changes can be put into effect with some client-side action whose result is `immediate`. This attribute has the same meaning as the `When takes effect` column in the table of [Summary of configuration parameters](../02_summary_of_configuration_parameters/#summary_of_configuration_parameters). +- **Required authorization to activate.** The type of user authorization to activate a change to a parameter’s setting. If a database server restart or a configuration file reload is required, then the user must be an EDB Postgres Advanced Server service account (`enterprisedb` or `postgres`, depending on the EDB Postgres Advanced Server compatibility installation mode). This attribute has the same meaning as the `Authorized user` column in the table of [Summary of configuration parameters](../02_summary_of_configuration_parameters/#summary_of_configuration_parameters).
diff --git a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/index.mdx b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/index.mdx index fa4e7246ca3..5f83df05f7d 100644 --- a/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/index.mdx +++ b/product_docs/docs/epas/14/epas_guide/03_database_administration/01_configuration_parameters/index.mdx @@ -8,13 +8,11 @@ legacyRedirectsGenerated: -This section describes the database server configuration parameters of EDB Postgres Advanced Server. These 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, locale and formatting settings, and so on. +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 EDB Postgres Advanced Server are noted in the [Summary of Configuration Parameters](02_summary_of_configuration_parameters/#summary_of_configuration_parameters). +Configuration parameters that apply only to EDB Postgres Advanced Server are noted in the [Summary of configuration parameters](02_summary_of_configuration_parameters/#summary_of_configuration_parameters). -Additional information about configuration parameters can be found in the PostgreSQL Core Documentation available at: - - +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/pgbouncer/1.17/index.mdx b/product_docs/docs/pgbouncer/1.17/index.mdx index 9e34af72b98..1e95ef262f5 100644 --- a/product_docs/docs/pgbouncer/1.17/index.mdx +++ b/product_docs/docs/pgbouncer/1.17/index.mdx @@ -6,6 +6,7 @@ navigation: - pgbouncer_rel_notes - supported_platforms - installing + - upgrading - 02_configuration_and_usage legacyRedirectsGenerated: # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. diff --git a/product_docs/docs/pgbouncer/1.17/installing/index.mdx b/product_docs/docs/pgbouncer/1.17/installing/index.mdx index 7f3889c24fe..e0c5c014eda 100644 --- a/product_docs/docs/pgbouncer/1.17/installing/index.mdx +++ b/product_docs/docs/pgbouncer/1.17/installing/index.mdx @@ -11,7 +11,6 @@ navigation: - linux_x86_64 - linux_ppc64le - windows -- upgrading --- diff --git a/product_docs/docs/pgbouncer/1.17/installing/upgrading.mdx b/product_docs/docs/pgbouncer/1.17/installing/upgrading.mdx deleted file mode 100644 index 89f55e87d9e..00000000000 --- a/product_docs/docs/pgbouncer/1.17/installing/upgrading.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Upgrading -redirects: - - /pgbouncer/latest/01a_upgrading/ ---- - -You can upgrade to a patch release with a simple in place upgrade. A minor release upgrade such as upgrading from 1.15 to 1.16 requires additional steps. - -To upgrade to a new minor release: - -1. Stop the service for the currently installed version. -2. Install the new release. - - For Rocky Linux/AlmaLinux 8 on x86_64: - ```shell - dnf -y upgrade edb-pgbouncer - ``` - - For RHEL/CentOS 7 on ppc64le: - ```shell - yum -y upgrade edb-pgbouncer - ``` - - For SLES: - ```shell - zypper -n update edb-pgbouncer - ``` - - For Ubuntu/Debian: - ```shell - apt-get -y upgrade edb-pgbouncer - ``` - - Where <xx> is the EDB PgBouncer minor version you want to upgrade to. - -3. If you have any custom configurations in the `edb-pgbouncer.ini` and `userlist.txt` files for the previously installed version, copy them from the versions of those files where the customization were made and paste them to the corresponding files for the release you just installed. - diff --git a/product_docs/docs/pgbouncer/1.17/upgrading.mdx b/product_docs/docs/pgbouncer/1.17/upgrading.mdx new file mode 100644 index 00000000000..4aa3f006d4b --- /dev/null +++ b/product_docs/docs/pgbouncer/1.17/upgrading.mdx @@ -0,0 +1,41 @@ +--- +title: Upgrading +redirects: + - /pgbouncer/latest/01a_upgrading/ + - /pgbouncer/latest/installing/upgrading +--- + +You can upgrade to a patch release with a simple in place upgrade. A minor release upgrade, such as upgrading from 1.15 to 1.16, requires additional steps. + +## Upgrading a minor release + +To upgrade to a new minor release: + +1. Install the new version of EDB PgBouncer. For instructions, see [Installing](installing). + +1. If you have any custom configurations in the `edb-pgbouncer.ini` and `userlist.txt` files for the previously installed version, copy them from the versions of those files where the customization were made and paste them to the corresponding files for the release you just installed. + +1. Stop the previous version. + +1. Start and enable the new version. + +1. Test the new version to make sure it's running. + +1. After successfully deploying the new version, remove the previous version with the following command: + + ```shell + remove edb-pgbouncer + ``` + + Where: + + - `` is the package manager used with your operating system: + + | Package manager | Operating system | + | ---------------- | ---------------- | + | dnf | RHEL 8 and derivatives | + | yum | RHEL 7 and derivatives, CentOS 7 | + | zypper | SLES | + | apt-get | Debian and derivatives | + + - `` is the previous version. \ No newline at end of file