Summary of configuration parameters v16
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 and a brief description of the configuration parameter. Parameters for use only with EDB Postgres Advanced Server (EPAS) are denoted by (EPAS only).
Scope — 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.
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
In 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 can't be changed.Restart
— You must restart the database server.Reload
— You must reload configuration file or restart the database server.Immediately
— Immediately effective in a session if thePGOPTIONS
environment variable or theSET
command is used to change the setting in the current session. Effective in new sessions ifALTER DATABASE
,ALTER ROLE
, orALTER ROLE IN DATABASE
commands are used to change the setting.
Used by — Type of operating system account or database role that must be used to put the parameter setting into effect.
EPAS account
— The 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 theALTER
command.n/a
— No user can change the parameter setting.
Note
Some parameters can never be altered. These are designated as Note: For internal use only in the description.
Parameter | Scope | In effect | Used by |
---|---|---|---|
allow_system_table_mods — Allows modifications of the structure of system tables. | Cluster | Restart | EPAS account |
application_name — Sets the application name to be reported in statistics and logs. | Session | Immediately | User |
archive_command — Sets the shell command called to archive a WAL file. | Cluster | Reload | EPAS account |
archive_mode — Allows archiving of WAL files using archive_command . | Cluster | Restart | EPAS account |
archive_timeout — Forces a switch to the next xlog file if a new file has not been started within N seconds. | Cluster | Reload | EPAS account |
array_nulls — Enables input of NULL elements in arrays. | Session | Immediately | User |
authentication_timeout — Sets the maximum allowed time to complete client authentication. | Cluster | Reload | EPAS account |
autovacuum — Starts the autovacuum subprocess. | Cluster | Reload | EPAS account |
autovacuum_analyze_scale_factor — Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples . | Cluster | Reload | EPAS account |
autovacuum_analyze_threshold — Minimum number of tuple inserts, updates, or deletes prior to analyze. | Cluster | Reload | EPAS account |
autovacuum_freeze_max_age — Age at which to autovacuum a table to prevent transaction ID wraparound. | Cluster | Restart | EPAS account |
autovacuum_max_workers — Sets the maximum number of simultaneously running autovacuum worker processes. | Cluster | Restart | EPAS account |
autovacuum_multixact_freeze_max_age — Multixact age at which to autovacuum a table to prevent multixact wraparound. | Cluster | Restart | EPAS account |
autovacuum_naptime — Time to sleep between autovacuum runs. | Cluster | Reload | EPAS account |
autovacuum_vacuum_cost_delay — Vacuum cost delay in milliseconds, for autovacuum. | Cluster | Reload | EPAS account |
autovacuum_vacuum_cost_limit — Vacuum cost amount available before napping, for autovacuum. | Cluster | Reload | EPAS account |
autovacuum_vacuum_scale_factor — Number of tuple updates or deletes prior to vacuum as a fraction of reltuples . | Cluster | Reload | EPAS account |
autovacuum_vacuum_threshold — Minimum number of tuple updates or deletes prior to vacuum. | Cluster | Reload | EPAS account |
autovacuum_work_mem — Sets the maximum memory to be used by each autovacuum worker process. | Cluster | Reload | EPAS account |
backslash_quote — Sets whether "\'" is allowed in string literals. | Session | Immediately | User |
bgwriter_delay — Background writer sleep time between rounds. | Cluster | Reload | EPAS account |
bgwriter_lru_maxpages — Background writer maximum number of LRU pages to flush per round. | Cluster | Reload | EPAS account |
bgwriter_lru_multiplier — Multiple of the average buffer usage to free per round. | Cluster | Reload | EPAS account |
block_size — Shows the size of a disk block. | Cluster | Preset | n/a |
bonjour — Enables advertising the server via Bonjour. | Cluster | Restart | EPAS account |
bonjour_name — Sets the Bonjour service name. | Cluster | Restart | EPAS account |
bytea_output — Sets the output format for bytea . | Session | Immediately | User |
check_function_bodies — Checks function bodies during CREATE FUNCTION . | Session | Immediately | User |
checkpoint_completion_target — Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval. | Cluster | Reload | EPAS account |
checkpoint_segments (Deprecated) — Specifies a value for the parameter prevents the server from starting. | - | ||
checkpoint_timeout — Sets the maximum time between automatic WAL checkpoints. | Cluster | Reload | EPAS account |
checkpoint_warning — Enables warnings if checkpoint segments are filled more frequently than this. | Cluster | Reload | EPAS account |
client_encoding — Sets the client's character set encoding. | Session | Immediately | User |
client_min_messages — Sets the message levels that are sent to the client. | Session | Immediately | User |
commit_delay — Sets the delay in microseconds between transaction commit and flushing WAL to disk. | Session | Immediately | Superuser |
commit_siblings — Sets the minimum concurrent open transactions before performing commit_delay . | Session | Immediately | User |
config_file — Sets the server's main configuration file. | Cluster | Restart | EPAS account |
constraint_exclusion — Enables the planner to use constraints to optimize queries. | Session | Immediately | User |
cpu_index_tuple_cost — Sets the planner's estimate of the cost of processing each index entry during an index scan. | Session | Immediately | User |
cpu_operator_cost — Sets the planner's estimate of the cost of processing each operator or function call. | Session | Immediately | User |
cpu_tuple_cost — Sets the planner's estimate of the cost of processing each tuple (row). | Session | Immediately | User |
cursor_tuple_fraction — Sets the planner's estimate of the fraction of a cursor's rows to retrieve. | Session | Immediately | User |
custom_variable_classes (EPAS only) — Deprecated in EDB Postgres Advanced Server 9.2. | Cluster | Reload | EPAS account |
data_checksums — Shows whether data checksums are turned on for this cluster. | Cluster | Preset | n/a |
data_directory — Sets the server's data directory. | Cluster | Restart | EPAS account |
datestyle — Sets the display format for date and time values. | Session | Immediately | User |
db_dialect (EPAS only) — Sets the precedence of built-in namespaces. | Session | Immediately | User |
dbms_alert.max_alerts (EPAS only) — Sets maximum number of alerts. | Cluster | Restart | EPAS account |
dbms_pipe.total_message_buffer (EPAS only) — Specifies the total size of the buffer used for the DBMS_PIPE package. | Cluster | Restart | EPAS account |
db_user_namespace — Enables per-database user names. | Cluster | Reload | EPAS account |
deadlock_timeout — Sets the time to wait on a lock before checking for deadlock. | Session | Immediately | Superuser |
debug_assertions — Turns on various assertion checks. (Not supported in EPAS builds.) | Cluster | Preset | n/a |
debug_pretty_print — Indents parse and plan tree displays. | Session | Immediately | User |
debug_print_parse — Logs each query's parse tree. | Session | Immediately | User |
debug_print_plan — Logs each query's execution plan. | Session | Immediately | User |
debug_print_rewritten — Logs each query's rewritten parse tree. | Session | Immediately | User |
default_heap_fillfactor (EPAS only) — Creates new tables with this heap fill factor by default. | Session | Immediately | User |
default_statistics_target — Sets the default statistics target. | Session | Immediately | User |
default_tablespace — Sets the default tablespace to create tables and indexes in. | Session | Immediately | User |
default_text_search_config — Sets default text search configuration. | User | ||
default_transaction_deferrable — Sets the default deferrable status of new transactions. | Session | Immediately | User |
default_transaction_isolation — Sets the transaction isolation level of each new transaction. | Session | Immediately | User |
default_transaction_read_only — Sets the default read-only status of new transactions. | Session | Immediately | User |
default_with_oids — Creates new tables with OIDs by default. | Session | Immediately | User |
default_with_rowids (EPAS only) — Creates new tables with ROWID support (ROWIDs with indexes) by default. | Session | Immediately | User |
dynamic_library_path — Sets the path for dynamically loadable modules. | Session | Immediately | Superuser |
dynamic_shared_memory_type — Selects the dynamic shared memory implementation used. | Cluster | Restart | EPAS account |
edb_audit (EPAS only) — Enables EDB Auditing to create audit reports in XML or CSV format. | Cluster | Reload | EPAS account |
edb_audit_archiver (EPAS only) — Enables audit log archiver process. | Cluster | Restart | EPAS account |
edb_audit_archiver_timeout (EPAS only) — Checks the audit log files based on the edb_audit_archiver_timeout parameter. | Cluster | Reload | EPAS account |
edb_audit_archiver_filename_prefix (EPAS only) — 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 . | Cluster | Reload | EPAS account |
edb_audit_archiver_compress_time_limit (EPAS only) — Shows time in seconds after which the audit logs are eligible for compression. | Cluster | Reload | EPAS account |
edb_audit_archiver_compress_size_limit (EPAS only) — Shows total size in megabytes after which the audit logs are eligible for compression. | Cluster | Reload | EPAS account |
edb_audit_archiver_compress_command (EPAS only) — Compresses the audit log files. | Cluster | Reload | EPAS account |
edb_audit_archiver_compress_suffix (EPAS only) — Determines suffix for an already compressed log file. The parameter must align with edb_audit_archiver_compress_command . | Cluster | Reload | EPAS account |
edb_audit_archiver_expire_time_limit (EPAS only) — Shows time in seconds after which the audit logs are eligible for expiration. | Cluster | Reload | EPAS account |
edb_audit_archiver_expire_size_limit (EPAS only) — Shows total size in megabytes after which the audit logs are eligible for expiration. | Cluster | Reload | EPAS account |
edb_audit_archiver_expire_command (EPAS only) — Execute on an expired audit log before removing it. | Cluster | Reload | EPAS account |
edb_audit_archiver_sort_file (EPAS only) — Identifies the oldest log file and sorts them alphabetically or based on mtime . | Cluster | Reload | EPAS account |
edb_audit_connect (EPAS only) — Audits each successful connection. | Cluster | Reload | EPAS account |
edb_audit_destination (EPAS only) — Sets edb_audit_directory or syslog as the destination directory for audit files. The syslog setting is only valid for a Linux system. | Cluster | Reload | EPAS account |
edb_audit_directory (EPAS only) — Sets the destination directory for audit files. | Cluster | Reload | EPAS account |
edb_audit_disconnect (EPAS only) — Audits end of a session. | Cluster | Reload | EPAS account |
edb_audit_filename (EPAS only) — Sets the file name pattern for audit files. | Cluster | Reload | EPAS account |
edb_audit_rotation_day (EPAS only) — Automatic rotation of log files based on day of week. | Cluster | Reload | EPAS account |
edb_audit_rotation_seconds (EPAS only) — Automatic log file rotation occurs after N seconds. | Cluster | Reload | EPAS account |
edb_audit_rotation_size (EPAS only) — Automatic log file rotation occurs after N Megabytes. | Cluster | Reload | EPAS account |
edb_audit_statement (EPAS only) — Sets the type of statements to audit. | Cluster | Reload | EPAS account |
edb_audit_tag (EPAS only) — Specifies a tag to include in the audit log. | Session | Immediately | User |
edb_connectby_order (EPAS only) — Sorts results of CONNECT BY queries with no ORDER BY to depth-first order. Note: For internal use only. | Session | Immediately | User |
edb_data_redaction (EPAS only) — Enables data redaction. | Session | Immediately | User |
edb_dynatune (EPAS only) — Sets the edb utilization percentage. | Cluster | Restart | EPAS account |
edb_dynatune_profile (EPAS only) — Sets the workload profile for dynatune. | Cluster | Restart | EPAS account |
edb_enable_pruning (EPAS only) — Enables the planner to early-prune partitioned tables. | Session | Immediately | User |
edb_log_every_bulk_value (EPAS only) — Sets the statements logged for bulk processing. | Session | Immediately | Superuser |
edb_max_resource_groups (EPAS only) — Specifies the maximum number of resource groups for simultaneous use. | Cluster | Restart | EPAS account |
edb_max_spins_per_delay (EPAS only) — Specifies the number of times a session spins while waiting for a lock. | Cluster | Restart | EPAS account |
edb_redwood_date (EPAS only) — Determines whether DATE should behave like a TIMESTAMP or not. | Session | Immediately | User |
edb_redwood_greatest_least (EPAS only) — Determines how GREATEST and LEAST functions should handle NULL parameters. | Session | Immediately | User |
edb_redwood_raw_names (EPAS only) — Returns the unmodified name stored in the PostgreSQL system catalogs from Redwood interfaces. | Session | Immediately | User |
edb_redwood_strings (EPAS only) — Treats NULL as an empty string when concatenated with a text value. | Session | Immediately | User |
edb_resource_group (EPAS only) — Specifies the resource group to be used by the current process. | Session | Immediately | User |
edb_sql_protect.enabled (EPAS only) — Defines whether SQL/Protect should track queries or not. | Cluster | Reload | EPAS account |
edb_sql_protect.level (EPAS only) — Defines the behavior of SQL/Protect when an event is found. | Cluster | Reload | EPAS account |
edb_sql_protect.max_protected_relations (EPAS only) — Sets the maximum number of relations protected by SQL/Protect per role. | Cluster | Restart | EPAS account |
edb_sql_protect.max_protected_roles (EPAS only) — Sets the maximum number of roles protected by SQL/Protect. | Cluster | Restart | EPAS account |
edb_sql_protect.max_queries_to_save (EPAS only) — Sets the maximum number of offending queries to save by SQL/Protect. | Cluster | Restart | EPAS account |
edb_stmt_level_tx (EPAS only) — Allows continuing on errors instead of requiring a transaction abort. | Session | Immediately | User |
edb_wait_states.directory (EPAS only) — Stores the EDB wait states logs in this directory. | Cluster | Restart | EPAS account |
edb_wait_states.retention_period (EPAS only) |