anon.algorithm
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The hash method used for pseudonymizing functions. |
| Data type |
string |
| Default value |
sha256 |
| Allowed values |
sha256 |
| Parameter type |
read-only |
| Documentation |
anon.algorithm |
anon.k_anonymity_provider
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The security label provider used for k-anonymity. |
| Data type |
string |
| Default value |
k_anonymity |
| Allowed values |
k_anonymity |
| Parameter type |
read-only |
| Documentation |
anon.k_anonymity_provider |
anon.masking_policies
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Define multiple masking policies (NOT IMPLEMENTED YET). |
| Data type |
string |
| Default value |
anon |
| Allowed values |
anon |
| Parameter type |
read-only |
| Documentation |
anon.masking_policies |
anon.maskschema
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The schema where the dynamic masking views are stored. |
| Data type |
string |
| Default value |
mask |
| Allowed values |
mask |
| Parameter type |
read-only |
| Documentation |
anon.maskschema |
anon.privacy_by_default
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Mask all columns with NULL (or the default value for NOT NULL columns). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
anon.privacy_by_default |
anon.restrict_to_trusted_schemas
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Masking filters must be in a trusted schema. Activate this option to prevent non-superuser from using their own masking filters. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
anon.restrict_to_trusted_schemas |
anon.salt
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The salt value used for the pseudonymizing functions. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
anon.salt |
anon.sourceschema
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The schema where the table are masked by the dynamic masking engine. |
| Data type |
string |
| Default value |
public |
| Allowed values |
public |
| Parameter type |
read-only |
| Documentation |
anon.sourceschema |
anon.strict_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A masking rule cannot change a column data type, unless you disable this. Disabling the mode is not recommended. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
anon.strict_mode |
anon.transparent_dynamic_masking
| Attribute |
Value |
| Category |
Customized Options |
| Description |
New masking engine (EXPERIMENTAL). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
anon.transparent_dynamic_masking |
auto_explain.log_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN ANALYZE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_analyze |
auto_explain.log_buffers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log buffers usage. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_buffers |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
EXPLAIN format to be used for plan logging. |
| Data type |
enumeration |
| Default value |
text |
| Allowed values |
text,xml,json,yaml |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_format |
auto_explain.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log level for the plan. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,debug,info,notice,warning,log |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_level |
auto_explain.log_min_duration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the minimum execution time above which plans will be logged. Zero prints all plans. -1 turns this feature off. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_min_duration |
auto_explain.log_nested_statements
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log nested statements. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_nested_statements |
auto_explain.log_parameter_max_length
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum length of query parameters to log. Zero logs no query parameters, -1 logs them in full. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_parameter_max_length |
auto_explain.log_settings
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log modified configuration parameters affecting query planning. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_settings |
auto_explain.log_timing
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Collect timing data, not just row counts. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_timing |
auto_explain.log_triggers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Include trigger statistics in plans. This has no effect unless log_analyze is also set. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_triggers |
auto_explain.log_verbose
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN VERBOSE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_verbose |
auto_explain.log_wal
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log WAL usage. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_wal |
auto_explain.sample_rate
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Fraction of queries to process. |
| Data type |
numeric |
| Default value |
1.0 |
| Allowed values |
0.0-1.0 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.sample_rate |
azure.accepted_password_auth_method
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Accepted password authentication method. |
| Data type |
set |
| Default value |
md5,scram-sha-256 |
| Allowed values |
md5,scram-sha-256 |
| Parameter type |
dynamic |
| Documentation |
azure.accepted_password_auth_method |
azure_cdc.change_batch_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Buffer size, in megabytes, for change batches. These buffers are used to temporarily store CDC changes before they are written to disk. |
| Data type |
integer |
| Default value |
16 |
| Allowed values |
1-100 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.change_batch_export_timeout
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum time, in seconds, to wait before a batch of changes is ready to be exported. |
| Data type |
integer |
| Default value |
30 |
| Allowed values |
10-60 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.max_fabric_mirrors
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of parallel fabric mirrors that can be run at the same time. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
1-6 |
| Parameter type |
static |
| Documentation |
|
azure_cdc.max_snapshot_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of workers launched for snapshot export. Each worker exports one table at a time. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
0-100 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.onelake_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Buffer size, in megabytes, for upload to Onelake. Onelake uploads files in chunks, buffering the data in memory up to this limit. |
| Data type |
integer |
| Default value |
100 |
| Allowed values |
1-1024 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.parquet_compression
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Compression algorithm to use for parquet files. Determines the compression algorithm to use for parquet files. Supported values are 'uncompressed', 'snappy', 'gzip', and 'zstd'. |
| Data type |
enumeration |
| Default value |
zstd |
| Allowed values |
uncompressed,snappy,gzip,zstd |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.snapshot_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum size (in MB) of the initial snapshot buffer. Per table, up to this much data is buffered before sent to Fabric. Keep in mind that azure_cdc.snapshot_buffer_size*azure_cdc.max_snapshot_workers is the total memory buffer used during initial snapshot. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
10-4000 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.snapshot_export_timeout
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum time, in minutes, to wait before reporting an error when exporting a snapshot of a database. |
| Data type |
integer |
| Default value |
180 |
| Allowed values |
0-1440 |
| Parameter type |
dynamic |
| Documentation |
|
azure.enable_temp_tablespaces_on_local_ssd
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Create temp tablespace on ephemeral disk. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
azure.extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which extensions are allowed to be created in the server. |
| Data type |
set |
| Default value |
|
| Allowed values |
address_standardizer,address_standardizer_data_us,amcheck,anon,azure_ai,azure_storage,bloom,btree_gin,btree_gist,citext,cube,dblink,dict_int,dict_xsyn,earthdistance,fuzzystrmatch,hll,hstore,hypopg,intagg,intarray,isn,lo,login_hook,ltree,oracle_fdw,orafce,pageinspect,pg_buffercache,pg_cron,pg_diskann,pg_freespacemap,pg_hint_plan,pg_partman,pg_prewarm,pg_repack,pg_squeeze,pg_stat_statements,pg_trgm,pg_visibility,pgaudit,pgcrypto,pglogical,pgrowlocks,pgstattuple,plpgsql,plv8,postgis,postgis_raster,postgis_sfcgal,postgis_tiger_geocoder,postgis_topology,postgres_fdw,postgres_protobuf,semver,session_variable,sslinfo,tablefunc,tdigest,tds_fdw,timescaledb,topn,tsm_system_rows,tsm_system_time,unaccent,uuid-ossp,vector |
| Parameter type |
dynamic |
| Documentation |
azure.extensions |
azure.fabric_mirror_enabled
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the flag indicating if mirroring is enabled on server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure.fabric_mirror_enabled |
azure.migration_copy_with_binary
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will enable the use of the binary format for copying data during migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_copy_with_binary |
azure.migration_skip_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the analyze phase (vacuumdb --analyze-only) during the migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_analyze |
azure.migration_skip_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of extensions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_extensions |
azure.migration_skip_large_objects
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of large objects such as BLOBs. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_large_objects |
azure.migration_skip_role_user
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will exclude user roles from the migration process. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
azure.migration_skip_role_user |
azure.migration_table_split_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set, this parameter specifies the size at which tables will be partitioned during migration. |
| Data type |
integer |
| Default value |
20480 |
| Allowed values |
1-204800 |
| Parameter type |
dynamic |
| Documentation |
azure.migration_table_split_size |
azure.service_principal_id
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A unique identifier for a service principal in Azure, used to grant permissions and access to resources within a tenant. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
|
azure.service_principal_tenant_id
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A unique identifier for the tenant in which a service principal is created, ensuring the necessary permissions and access to resources within that tenant. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
|
azure.single_to_flex_migration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies if this is a server created for migrating from Azure Database for PostgreSQL Single Server to Flexible Server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
|
azure_storage.allow_network_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allows accessing Azure Storage Blob service from azure_storage extension. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure_storage.allow_network_access |
azure_storage.blob_block_size_mb
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Size of blob block, in megabytes, for PUT blob operations. |
| Data type |
integer |
| Default value |
Depends on resources (vCores, RAM, or disk space) allocated to the server. |
| Allowed values |
1024 |
| Parameter type |
read-only |
| Documentation |
azure_storage.blob_block_size_mb |
Azure-specific notes
The default value for the azure_storage.blob_block_size_mb server parameter is calculated when you provision the instance of Azure Database for PostgreSQL flexible server, based on the product name that you select for its compute. Any subsequent changes of product selection to the compute that supports the flexible server won't have any effect on the default value for the azure_storage.blob_block_size_mb server parameter of that instance.
As of today, if you change the product assigned to an instance, you won't be able to adjust the value of azure_storage.blob_block_size_mb parameter because the parameter is declared as read-only.
The formula used to compute the value of azure_storage.blob_block_size_mb is MIN(3072, MAX(128, memoryGiB * 32)).
Based on the previous formula, the following table lists the values this server parameter would be set to depending on the amount of memory provisioned:
| Memory size |
azure_storage.blob_block_size_mb |
| 2 GiB |
128 MiB |
| 4 GiB |
128 MiB |
| 8 GiB |
256 MiB |
| 16 GiB |
512 MiB |
| 32 GiB |
1024 MiB |
| 48 GiB |
1536 MiB |
| 64 GiB |
2048 MiB |
| 80 GiB |
2560 MiB |
| 128 GiB |
3072 MiB |
| 160 GiB |
3072 MiB |
| 192 GiB |
3072 MiB |
| 256 GiB |
3072 MiB |
| 384 GiB |
3072 MiB |
| 432 GiB |
3072 MiB |
| 672 GiB |
3072 MiB |
azure_storage.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log level used by the azure_storage extension. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,debug,log,info,notice,warning,error |
| Parameter type |
dynamic |
| Documentation |
azure_storage.log_level |
azure_storage.public_account_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allows all users to access data in storage accounts for which there are no credentials, and the storage account access is configured as public. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure_storage.public_account_access |
connection_throttle.bucket_limit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max login tokens per bucket. |
| Data type |
integer |
| Default value |
2000 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables temporary connection throttling per IP for too many login failures. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.factor_bias
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The factor bias for calculating number of tokens for an IP's bucket. |
| Data type |
numeric |
| Default value |
0.8 |
| Allowed values |
0.0-0.9 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.hash_entries_max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max number of entries in the login failures hash table. |
| Data type |
integer |
| Default value |
500 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.reset_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between resetting the login bucket. |
| Data type |
integer |
| Default value |
120 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.restore_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Factor to increase number of tokens by for IPs with low failure rate. |
| Data type |
numeric |
| Default value |
2 |
| Allowed values |
1.0-100.0 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.update_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between updating the login bucket. |
| Data type |
integer |
| Default value |
20 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
cron.database_name
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the database in which pg_cron metadata is kept. |
| Data type |
string |
| Default value |
postgres |
| Allowed values |
[A-Za-z0-9_]+ |
| Parameter type |
static |
| Documentation |
cron.database_name |
cron.enable_superuser_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allow jobs to be scheduled as superuser. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
cron.enable_superuser_jobs |
cron.host
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Hostname to connect to postgres. This setting has no effect when background workers are used. |
| Data type |
string |
| Default value |
localhost |
| Allowed values |
localhost |
| Parameter type |
read-only |
| Documentation |
cron.host |
cron.launch_active_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Launch jobs that are defined as active. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
cron.launch_active_jobs |
cron.log_min_messages
| Attribute |
Value |
| Category |
Customized Options |
| Description |
log_min_messages for the launcher bgworker. |
| Data type |
enumeration |
| Default value |
warning |
| Allowed values |
warning |
| Parameter type |
read-only |
| Documentation |
cron.log_min_messages |
cron.log_run
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all jobs runs into the job_run_details table. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_run |
cron.log_statement
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all cron statements prior to execution. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_statement |
cron.max_running_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of jobs that can run concurrently. This value is limited by max_connections. |
| Data type |
integer |
| Default value |
32 |
| Allowed values |
0-5000 |
| Parameter type |
static |
| Documentation |
cron.max_running_jobs |
cron.timezone
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specify timezone used for cron schedule. |
| Data type |
enumeration |
| Default value |
GMT |
| Allowed values |
GMT |
| Parameter type |
read-only |
| Documentation |
cron.timezone |
cron.use_background_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use background workers instead of client sessions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
cron.use_background_workers |
duckdb.max_memory
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum memory DuckDB can use (e.g., 1GB). |
| Data type |
integer |
| Default value |
1024 |
| Allowed values |
1024-688128 |
| Parameter type |
static |
| Documentation |
duckdb.max_memory |
duckdb.max_workers_per_postgres_scan
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of PostgreSQL workers used for a single Postgres scan. |
| Data type |
integer |
| Default value |
2 |
| Allowed values |
0-1024 |
| Parameter type |
static |
| Documentation |
duckdb.max_workers_per_postgres_scan |
duckdb.memory_limit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum memory DuckDB can use (e.g., 1GB), alias for duckdb.max_memory |
| Data type |
integer |
| Default value |
1024 |
| Allowed values |
1024-688128 |
| Parameter type |
static |
| Documentation |
duckdb.memory_limit |
duckdb.threads
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of DuckDB threads per Postgres backend. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-96 |
| Parameter type |
static |
| Documentation |
duckdb.threads |
duckdb.worker_threads
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of DuckDB threads per Postgres backend, alias for duckdb.threads. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-96 |
| Parameter type |
static |
| Documentation |
duckdb.worker_threads |
enable_group_by_reordering
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables reordering of GROUP BY keys. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
enable_group_by_reordering |
huge_pages_status
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Indicates the status of huge pages. |
| Data type |
enumeration |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
huge_pages_status |
index_tuning.analysis_interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the frequency at which each index optimization session is triggered when index_tuning.mode is set to 'REPORT'. |
| Data type |
integer |
| Default value |
720 |
| Allowed values |
60-10080 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.analysis_interval |
index_tuning.max_columns_per_index
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of columns that can be part of the index key for any recommended index. |
| Data type |
integer |
| Default value |
2 |
| Allowed values |
1-10 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_columns_per_index |
index_tuning.max_index_count
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of indexes that can be recommended for each database during one optimization session. |
| Data type |
integer |
| Default value |
10 |
| Allowed values |
1-25 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_index_count |
index_tuning.max_indexes_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of indexes that can be recommended for each table. |
| Data type |
integer |
| Default value |
10 |
| Allowed values |
1-25 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_indexes_per_table |
index_tuning.max_queries_per_database
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of slowest queries per database for which indexes can be recommended. |
| Data type |
integer |
| Default value |
25 |
| Allowed values |
5-100 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_queries_per_database |
index_tuning.max_regression_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Acceptable regression introduced by a recommended index on any of the queries analyzed during one optimization session. |
| Data type |
numeric |
| Default value |
0.1 |
| Allowed values |
0.05-0.2 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_regression_factor |
index_tuning.max_total_size_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum total size, in percentage of total disk space, that all recommended indexes for any given database can use. |
| Data type |
numeric |
| Default value |
0.1 |
| Allowed values |
0-1.0 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_total_size_factor |
index_tuning.min_improvement_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Cost improvement that a recommended index must provide to at least one of the queries analyzed during one optimization session. |
| Data type |
numeric |
| Default value |
0.2 |
| Allowed values |
0-20.0 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.min_improvement_factor |
index_tuning.mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Configures index optimization as disabled ('OFF') or enabled to only emit recommendation. Requires Query Store to be enabled by setting pg_qs.query_capture_mode to 'TOP' or 'ALL'. |
| Data type |
enumeration |
| Default value |
off |
| Allowed values |
off,report |
| Parameter type |
dynamic |
| Documentation |
index_tuning.mode |
index_tuning.unused_dml_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of daily average DML operations affecting the table, so that their unused indexes are considered for dropping. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
0-9999999 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_dml_per_table |
index_tuning.unused_min_period
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of days the index has not been used, based on system statistics, so that it is considered for dropping. |
| Data type |
integer |
| Default value |
35 |
| Allowed values |
30-720 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_min_period |
index_tuning.unused_reads_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of daily average read operations affecting the table, so that their unused indexes are considered for dropping. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
0-9999999 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_reads_per_table |
io_combine_limit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Limit on the size of data reads and writes. |
| Data type |
integer |
| Default value |
16 |
| Allowed values |
16 |
| Parameter type |
read-only |
| Documentation |
io_combine_limit |
logfiles.download_enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables or disables server logs functionality. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
logfiles.download_enable |
logfiles.retention_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for server logs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
1-7 |
| Parameter type |
dynamic |
| Documentation |
logfiles.retention_days |
max_notify_queue_pages
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of allocated pages for NOTIFY / LISTEN queue. |
| Data type |
integer |
| Default value |
1048576 |
| Allowed values |
1048576 |
| Parameter type |
read-only |
| Documentation |
max_notify_queue_pages |
pgaadauth.enable_group_sync
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables synchronization of Entra ID group members. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
pgaudit.log
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which classes of statements will be logged by session audit logging. |
| Data type |
set |
| Default value |
none |
| Allowed values |
none,read,write,function,role,ddl,misc,all |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log |
pgaudit.log_catalog
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_catalog |
pgaudit.log_client
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether audit messages should be visible to client. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_client |
pgaudit.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the log level that will be used for log entries. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,log |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_level |
pgaudit.log_parameter
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that audit logging should include the parameters that were passed with the statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_parameter |
pgaudit.log_parameter_max_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies, in bytes, the maximum length of variable-length parameters to log. If 0 (the default), parameters are not checked for size. If set, when the size of the parameter is longer than the setting, the value in the audit log is replaced with a placeholder. Note that for character types, the length is in bytes for the parameter's encoding, not characters. |
| Data type |
integer |
| Default value |
0 |
| Allowed values |
0-1073741823 |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_parameter_max_size |
pgaudit.log_relation
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether session audit logging should create a separate log entry for each relation referenced in a SELECT or DML statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_relation |
pgaudit.log_rows
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the rows retrieved or affected by a statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pgaudit.log_rows |
pgaudit.log_statement
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the statement text and parameters. Depending on requirements, the full statement text might not be required in the audit log. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_statement |
pgaudit.log_statement_once
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_statement_once |
pgaudit.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the master role to use for object audit logging. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pgaudit.role |
pg_hint_plan.debug_print
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Logs results of hint parsing. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.debug_print |
pg_hint_plan.enable_hint
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Force planner to use plans specified in the hint comment preceding to the query. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.enable_hint |
pg_hint_plan.enable_hint_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Let pg_hint_plan look up the hint table. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.enable_hint_table |
pg_hint_plan.message_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Message level of debug messages. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
log |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.message_level |
pg_hint_plan.parse_messages
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Message level of parse errors. |
| Data type |
enumeration |
| Default value |
info |
| Allowed values |
info |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.parse_messages |
pglogical.batch_inserts
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use batch insert mechanism if possible. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.batch_inserts |
pglogical.conflict_log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the log level for reporting detected conflicts when the pglogical.conflict_resolution is set to anything else than error. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_log_level |
pglogical.conflict_resolution
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the resolution method for any detected conflicts between local data and incoming changes. |
| Data type |
enumeration |
| Default value |
apply_remote |
| Allowed values |
error,apply_remote,keep_local,last_update_wins,first_update_wins |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_resolution |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
connection options to add to all peer node connections. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pglogical.extra_connection_options |
pglogical.synchronous_commit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
pglogical specific synchronous commit value. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pglogical.synchronous_commit |
pglogical.temp_directory
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Directory to store dumps for local restore. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pglogical.temp_directory |
pglogical.use_spi
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use SPI interface to form actual SQL (INSERT, UPDATE, DELETE) statements to apply incoming changes instead of using internal low level interface. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.use_spi |
pgms_stats.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
|
pgms_wait_sampling.history_period
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type |
integer |
| Default value |
100 |
| Allowed values |
1-600000 |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
all,none |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.query_capture_mode |
pg_partman_bgw.analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_analyze argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.analyze |
pg_partman_bgw.dbname
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Required. The database(s) that run_maintenance() will run on. If more than one, use a comma separated list. If not set, BGW will do nothing. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z0-9_,-]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.dbname |
pg_partman_bgw.interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of seconds between calls to run_maintenance(). |
| Data type |
integer |
| Default value |
3600 |
| Allowed values |
1-315360000 |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.interval |
pg_partman_bgw.jobmon
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_jobmon argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.jobmon |
pg_partman_bgw.maintenance_wait
| Attribute |
Value |
| Category |
Customized Options |
| Description |
How long to wait between each partition set when running maintenance (in seconds). |
| Data type |
integer |
| Default value |
0 |
| Allowed values |
0 |
| Parameter type |
read-only |
| Documentation |
pg_partman_bgw.maintenance_wait |
pg_partman_bgw.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The role that run_maintenance() will run as. Default is postgres. Only a single role name is allowed. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.role |
pg_prewarm.autoprewarm
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Starts the autoprewarm worker. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_prewarm.autoprewarm |
pg_prewarm.autoprewarm_interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the interval between dumps of shared buffers. If set to zero, time-based dumping is disabled. |
| Data type |
integer |
| Default value |
300 |
| Allowed values |
300 |
| Parameter type |
read-only |
| Documentation |
pg_prewarm.autoprewarm_interval |
pg_qs.interval_length_minutes
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type |
integer |
| Default value |
15 |
| Allowed values |
1-30 |
| Parameter type |
static |
| Documentation |
pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_qs.is_enabled_fs |
pg_qs.max_plan_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type |
integer |
| Default value |
7500 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type |
integer |
| Default value |
6000 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Whether and when to capture query positional parameters. |
| Data type |
enumeration |
| Default value |
capture_parameterless_only |
| Allowed values |
capture_parameterless_only,capture_first_sample |
| Parameter type |
dynamic |
| Documentation |
pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets query capture mode for query store. None disables any capturing. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
7 |
| Allowed values |
1-30 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Turns saving query plans on or off for pg_qs |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_qs. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.track_utility |
pg_stat_statements.max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of statements tracked by pg_stat_statements. |
| Data type |
integer |
| Default value |
5000 |
| Allowed values |
100-2147483647 |
| Parameter type |
static |
| Documentation |
pg_stat_statements.max |
pg_stat_statements.save
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Save pg_stat_statements statistics across server shutdowns. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.save |
pg_stat_statements.track
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls which statements are counted by pg_stat_statements. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track |
pg_stat_statements.track_planning
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether planning duration is tracked by pg_stat_statements. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track_planning |
pg_stat_statements.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_stat_statements. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track_utility |
postgis.gdal_enabled_drivers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls postgis GDAL enabled driver settings. |
| Data type |
enumeration |
| Default value |
DISABLE_ALL |
| Allowed values |
DISABLE_ALL,ENABLE_ALL |
| Parameter type |
dynamic |
| Documentation |
postgis.gdal_enabled_drivers |
squeeze.max_xlock_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum time the processed table may be locked exclusively. The source table is locked exclusively during the final stage of processing. If the lock time should exceed this value, the lock is released and the final stage is retried a few more times. |
| Data type |
integer |
| Default value |
0 |
| Allowed values |
0 |
| Parameter type |
read-only |
| Documentation |
squeeze.max_xlock_time |
squeeze.worker_autostart
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Names of databases for which background workers start automatically. Comma-separated list for of databases which squeeze worker starts as soon as the cluster startup has completed. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
squeeze.worker_autostart |
squeeze.worker_role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Role that background workers use to connect to database. If background worker was launched automatically on cluster startup, it uses this role to initiate database connection(s). |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
squeeze.worker_role |
squeeze.workers_per_database
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of squeeze worker processes launched for each database. |
| Data type |
integer |
| Default value |
1 |
| Allowed values |
1 |
| Parameter type |
read-only |
| Documentation |
squeeze.workers_per_database |
summarize_wal
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Starts the WAL summarizer process to enable incremental backup. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
summarize_wal |
synchronized_standby_slots
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Lists streaming replication standby server replication slot names that logical WAL sender processes will wait for. Logical WAL sender processes will send decoded changes to output plugins only after the specified replication slots have confirmed receiving WAL. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
synchronized_standby_slots |
sync_replication_slots
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables physical standby to synchronize logical failover slots from the primary server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
sync_replication_slots |
timescaledb.bgw_launcher_poll_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Launcher timeout value in milliseconds. Configure the time the launcher waits to look for new TimescaleDB instances. |
| Data type |
integer |
| Default value |
60000 |
| Allowed values |
60000 |
| Parameter type |
read-only |
| Documentation |
timescaledb.bgw_launcher_poll_time |
timescaledb.disable_load
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable the loading of the actual extension. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
timescaledb.disable_load |
timescaledb.max_background_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum background worker processes allocated to TimescaleDB. Max background worker processes allocated to TimescaleDB - set to at least 1 + number of databases in Postgres instance to use background workers. |
| Data type |
integer |
| Default value |
16 |
| Allowed values |
16 |
| Parameter type |
read-only |
| Documentation |
timescaledb.max_background_workers |
timescaledb_osm.disable_load
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable the loading of the actual extension. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
timescaledb_osm.disable_load |
trace_connection_negotiation
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Logs details of pre-authentication connection handshake. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
trace_connection_negotiation |
wal_summary_keep_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time for which WAL summary files should be kept. |
| Data type |
integer |
| Default value |
14400 |
| Allowed values |
14400 |
| Parameter type |
read-only |
| Documentation |
wal_summary_keep_time |
age.enable_containment
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use @> operator to transform MATCH's filter. Otherwise, use -> operator. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
age.enable_containment |
anon.algorithm
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The hash method used for pseudonymizing functions. |
| Data type |
string |
| Default value |
sha256 |
| Allowed values |
sha256 |
| Parameter type |
read-only |
| Documentation |
anon.algorithm |
anon.k_anonymity_provider
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The security label provider used for k-anonymity. |
| Data type |
string |
| Default value |
k_anonymity |
| Allowed values |
k_anonymity |
| Parameter type |
read-only |
| Documentation |
anon.k_anonymity_provider |
anon.masking_policies
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Define multiple masking policies (NOT IMPLEMENTED YET). |
| Data type |
string |
| Default value |
anon |
| Allowed values |
anon |
| Parameter type |
read-only |
| Documentation |
anon.masking_policies |
anon.maskschema
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The schema where the dynamic masking views are stored. |
| Data type |
string |
| Default value |
mask |
| Allowed values |
mask |
| Parameter type |
read-only |
| Documentation |
anon.maskschema |
anon.privacy_by_default
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Mask all columns with NULL (or the default value for NOT NULL columns). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
anon.privacy_by_default |
anon.restrict_to_trusted_schemas
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Masking filters must be in a trusted schema. Activate this option to prevent non-superuser from using their own masking filters. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
anon.restrict_to_trusted_schemas |
anon.salt
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The salt value used for the pseudonymizing functions. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
anon.salt |
anon.sourceschema
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The schema where the table are masked by the dynamic masking engine. |
| Data type |
string |
| Default value |
public |
| Allowed values |
public |
| Parameter type |
read-only |
| Documentation |
anon.sourceschema |
anon.strict_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A masking rule cannot change a column data type, unless you disable this. Disabling the mode is not recommended. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
anon.strict_mode |
anon.transparent_dynamic_masking
| Attribute |
Value |
| Category |
Customized Options |
| Description |
New masking engine (EXPERIMENTAL). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
anon.transparent_dynamic_masking |
auto_explain.log_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN ANALYZE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_analyze |
auto_explain.log_buffers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log buffers usage. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_buffers |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
EXPLAIN format to be used for plan logging. |
| Data type |
enumeration |
| Default value |
text |
| Allowed values |
text,xml,json,yaml |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_format |
auto_explain.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log level for the plan. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,debug,info,notice,warning,log |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_level |
auto_explain.log_min_duration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the minimum execution time above which plans will be logged. Zero prints all plans. -1 turns this feature off. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_min_duration |
auto_explain.log_nested_statements
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log nested statements. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_nested_statements |
auto_explain.log_parameter_max_length
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum length of query parameters to log. Zero logs no query parameters, -1 logs them in full. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_parameter_max_length |
auto_explain.log_settings
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log modified configuration parameters affecting query planning. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_settings |
auto_explain.log_timing
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Collect timing data, not just row counts. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_timing |
auto_explain.log_triggers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Include trigger statistics in plans. This has no effect unless log_analyze is also set. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_triggers |
auto_explain.log_verbose
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN VERBOSE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_verbose |
auto_explain.log_wal
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log WAL usage. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_wal |
auto_explain.sample_rate
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Fraction of queries to process. |
| Data type |
numeric |
| Default value |
1.0 |
| Allowed values |
0.0-1.0 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.sample_rate |
azure.accepted_password_auth_method
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Accepted password authentication method. |
| Data type |
set |
| Default value |
md5,scram-sha-256 |
| Allowed values |
md5,scram-sha-256 |
| Parameter type |
dynamic |
| Documentation |
azure.accepted_password_auth_method |
azure_cdc.change_batch_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Buffer size, in megabytes, for change batches. These buffers are used to temporarily store CDC changes before they are written to disk. |
| Data type |
integer |
| Default value |
16 |
| Allowed values |
1-100 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.change_batch_export_timeout
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum time, in seconds, to wait before a batch of changes is ready to be exported. |
| Data type |
integer |
| Default value |
30 |
| Allowed values |
10-60 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.max_fabric_mirrors
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of parallel fabric mirrors that can be run at the same time. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
1-6 |
| Parameter type |
static |
| Documentation |
|
azure_cdc.max_snapshot_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of workers launched for snapshot export. Each worker exports one table at a time. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
0-100 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.onelake_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Buffer size, in megabytes, for upload to Onelake. Onelake uploads files in chunks, buffering the data in memory up to this limit. |
| Data type |
integer |
| Default value |
100 |
| Allowed values |
1-1024 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.parquet_compression
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Compression algorithm to use for parquet files. Determines the compression algorithm to use for parquet files. Supported values are 'uncompressed', 'snappy', 'gzip', and 'zstd'. |
| Data type |
enumeration |
| Default value |
zstd |
| Allowed values |
uncompressed,snappy,gzip,zstd |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.snapshot_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum size (in MB) of the initial snapshot buffer. Per table, up to this much data is buffered before sent to Fabric. Keep in mind that azure_cdc.snapshot_buffer_size*azure_cdc.max_snapshot_workers is the total memory buffer used during initial snapshot. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
10-4000 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.snapshot_export_timeout
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum time, in minutes, to wait before reporting an error when exporting a snapshot of a database. |
| Data type |
integer |
| Default value |
180 |
| Allowed values |
0-1440 |
| Parameter type |
dynamic |
| Documentation |
|
azure.enable_temp_tablespaces_on_local_ssd
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Create temp tablespace on ephemeral disk. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
azure.extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which extensions are allowed to be created in the server. |
| Data type |
set |
| Default value |
|
| Allowed values |
address_standardizer,address_standardizer_data_us,age,amcheck,anon,azure_ai,azure_storage,bloom,btree_gin,btree_gist,citext,cube,dblink,dict_int,dict_xsyn,earthdistance,fuzzystrmatch,hll,hstore,hypopg,intagg,intarray,isn,lo,login_hook,ltree,oracle_fdw,orafce,pageinspect,pg_buffercache,pg_cron,pg_diskann,pg_freespacemap,pg_hint_plan,pg_partman,pg_prewarm,pg_repack,pg_squeeze,pg_stat_statements,pg_trgm,pg_visibility,pgaudit,pgcrypto,pglogical,pgrowlocks,pgstattuple,plpgsql,plv8,postgis,postgis_raster,postgis_sfcgal,postgis_tiger_geocoder,postgis_topology,postgres_fdw,postgres_protobuf,semver,session_variable,sslinfo,tablefunc,tdigest,tds_fdw,timescaledb,topn,tsm_system_rows,tsm_system_time,unaccent,uuid-ossp,vector |
| Parameter type |
dynamic |
| Documentation |
azure.extensions |
azure.fabric_mirror_enabled
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sepcifies the flag indicating if mirroring is enabled on server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
azure.migration_copy_with_binary
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will enable the use of the binary format for copying data during migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_copy_with_binary |
azure.migration_skip_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the analyze phase (vacuumdb --analyze-only) during the migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_analyze |
azure.migration_skip_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of extensions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_extensions |
azure.migration_skip_large_objects
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of large objects such as BLOBs. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_large_objects |
azure.migration_skip_role_user
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will exclude user roles from the migration process. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
azure.migration_skip_role_user |
azure.migration_table_split_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set, this parameter specifies the size at which tables will be partitioned during migration. |
| Data type |
integer |
| Default value |
20480 |
| Allowed values |
1-204800 |
| Parameter type |
dynamic |
| Documentation |
azure.migration_table_split_size |
azure.service_principal_id
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A unique identifier for a service principal in Azure, used to grant permissions and access to resources within a tenant. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
|
azure.service_principal_tenant_id
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A unique identifier for the tenant in which a service principal is created, ensuring the necessary permissions and access to resources within that tenant. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
|
azure.single_to_flex_migration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies if this is a server created for migrating from Azure Database for PostgreSQL Single Server to Flexible Server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
|
azure_storage.allow_network_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allows accessing Azure Storage Blob service from azure_storage extension. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure_storage.allow_network_access |
azure_storage.blob_block_size_mb
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Size of blob block, in megabytes, for PUT blob operations. |
| Data type |
integer |
| Default value |
Depends on resources (vCores, RAM, or disk space) allocated to the server. |
| Allowed values |
1024 |
| Parameter type |
read-only |
| Documentation |
azure_storage.blob_block_size_mb |
Azure-specific notes
The default value for the azure_storage.blob_block_size_mb server parameter is calculated when you provision the instance of Azure Database for PostgreSQL flexible server, based on the product name that you select for its compute. Any subsequent changes of product selection to the compute that supports the flexible server won't have any effect on the default value for the azure_storage.blob_block_size_mb server parameter of that instance.
As of today, if you change the product assigned to an instance, you won't be able to adjust the value of azure_storage.blob_block_size_mb parameter because the parameter is declared as read-only.
The formula used to compute the value of azure_storage.blob_block_size_mb is MIN(3072, MAX(128, memoryGiB * 32)).
Based on the previous formula, the following table lists the values this server parameter would be set to depending on the amount of memory provisioned:
| Memory size |
azure_storage.blob_block_size_mb |
| 2 GiB |
128 MiB |
| 4 GiB |
128 MiB |
| 8 GiB |
256 MiB |
| 16 GiB |
512 MiB |
| 32 GiB |
1024 MiB |
| 48 GiB |
1536 MiB |
| 64 GiB |
2048 MiB |
| 80 GiB |
2560 MiB |
| 128 GiB |
3072 MiB |
| 160 GiB |
3072 MiB |
| 192 GiB |
3072 MiB |
| 256 GiB |
3072 MiB |
| 384 GiB |
3072 MiB |
| 432 GiB |
3072 MiB |
| 672 GiB |
3072 MiB |
azure_storage.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log level used by the azure_storage extension. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,debug,log,info,notice,warning,error |
| Parameter type |
dynamic |
| Documentation |
azure_storage.log_level |
azure_storage.public_account_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allows all users to access data in storage accounts for which there are no credentials, and the storage account access is configured as public. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure_storage.public_account_access |
connection_throttle.bucket_limit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max login tokens per bucket. |
| Data type |
integer |
| Default value |
2000 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables temporary connection throttling per IP for too many login failures. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.factor_bias
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The factor bias for calculating number of tokens for an IP's bucket. |
| Data type |
numeric |
| Default value |
0.8 |
| Allowed values |
0.0-0.9 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.hash_entries_max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max number of entries in the login failures hash table. |
| Data type |
integer |
| Default value |
500 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.reset_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between resetting the login bucket. |
| Data type |
integer |
| Default value |
120 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.restore_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Factor to increase number of tokens by for IPs with low failure rate. |
| Data type |
numeric |
| Default value |
2 |
| Allowed values |
1.0-100.0 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.update_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between updating the login bucket. |
| Data type |
integer |
| Default value |
20 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
cron.database_name
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the database in which pg_cron metadata is kept. |
| Data type |
string |
| Default value |
postgres |
| Allowed values |
[A-Za-z0-9_]+ |
| Parameter type |
static |
| Documentation |
cron.database_name |
cron.enable_superuser_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allow jobs to be scheduled as superuser. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
cron.enable_superuser_jobs |
cron.host
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Hostname to connect to postgres. This setting has no effect when background workers are used. |
| Data type |
string |
| Default value |
/tmp |
| Allowed values |
/tmp |
| Parameter type |
read-only |
| Documentation |
cron.host |
cron.launch_active_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Launch jobs that are defined as active. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
cron.launch_active_jobs |
cron.log_min_messages
| Attribute |
Value |
| Category |
Customized Options |
| Description |
log_min_messages for the launcher bgworker. |
| Data type |
enumeration |
| Default value |
warning |
| Allowed values |
warning |
| Parameter type |
read-only |
| Documentation |
cron.log_min_messages |
cron.log_run
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all jobs runs into the job_run_details table. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_run |
cron.log_statement
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all cron statements prior to execution. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_statement |
cron.max_running_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of jobs that can run concurrently. This value is limited by max_connections. |
| Data type |
integer |
| Default value |
32 |
| Allowed values |
0-5000 |
| Parameter type |
static |
| Documentation |
cron.max_running_jobs |
cron.timezone
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specify timezone used for cron schedule. |
| Data type |
enumeration |
| Default value |
GMT |
| Allowed values |
GMT |
| Parameter type |
read-only |
| Documentation |
cron.timezone |
cron.use_background_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use background workers instead of client sessions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
cron.use_background_workers |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable installing community extensions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
duckdb.allow_community_extensions |
duckdb.allow_unsigned_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allow DuckDB to load extensions with invalid or missing signatures. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
duckdb.allow_unsigned_extensions |
duckdb.autoinstall_known_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Whether known extensions are allowed to be automatically installed when a DuckDB query depends on them. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
duckdb.autoinstall_known_extensions |
duckdb.autoload_known_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Whether known extensions are allowed to be automatically loaded when a DuckDB query depends on them. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
duckdb.autoload_known_extensions |
duckdb.disabled_filesystems
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable specific file systems preventing access (e.g., LocalFileSystem). |
| Data type |
string |
| Default value |
LocalFileSystem, S3FileSystem |
| Allowed values |
LocalFileSystem, S3FileSystem |
| Parameter type |
read-only |
| Documentation |
duckdb.disabled_filesystems |
duckdb.enable_external_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allow the DuckDB to access external state. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
duckdb.enable_external_access |
duckdb.force_execution
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Force queries to use DuckDB execution. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
duckdb.force_execution |
duckdb.max_memory
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum memory DuckDB can use (e.g., 1GB). |
| Data type |
integer |
| Default value |
1024 |
| Allowed values |
1024-688128 |
| Parameter type |
static |
| Documentation |
duckdb.max_memory |
duckdb.max_workers_per_postgres_scan
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of PostgreSQL workers used for a single Postgres scan. |
| Data type |
integer |
| Default value |
2 |
| Allowed values |
0-1024 |
| Parameter type |
static |
| Documentation |
duckdb.max_workers_per_postgres_scan |
duckdb.memory_limit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum memory DuckDB can use (e.g., 1GB), alias for duckdb.max_memory |
| Data type |
integer |
| Default value |
1024 |
| Allowed values |
1024-688128 |
| Parameter type |
static |
| Documentation |
duckdb.memory_limit |
duckdb.postgres_role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Which postgres role should be allowed to use DuckDB execution, use the secrets and create MotherDuck tables. Defaults to superusers only. |
| Data type |
string |
| Default value |
azure_pg_duckdb_admin |
| Allowed values |
azure_pg_duckdb_admin |
| Parameter type |
read-only |
| Documentation |
duckdb.postgres_role |
duckdb.threads
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of DuckDB threads per Postgres backend. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-96 |
| Parameter type |
static |
| Documentation |
duckdb.threads |
duckdb.worker_threads
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of DuckDB threads per Postgres backend, alias for duckdb.threads. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-96 |
| Parameter type |
static |
| Documentation |
duckdb.worker_threads |
index_tuning.analysis_interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the frequency at which each index optimization session is triggered when index_tuning.mode is set to 'REPORT'. |
| Data type |
integer |
| Default value |
720 |
| Allowed values |
60-10080 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.analysis_interval |
index_tuning.max_columns_per_index
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of columns that can be part of the index key for any recommended index. |
| Data type |
integer |
| Default value |
2 |
| Allowed values |
1-10 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_columns_per_index |
index_tuning.max_index_count
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of indexes that can be recommended for each database during one optimization session. |
| Data type |
integer |
| Default value |
10 |
| Allowed values |
1-25 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_index_count |
index_tuning.max_indexes_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of indexes that can be recommended for each table. |
| Data type |
integer |
| Default value |
10 |
| Allowed values |
1-25 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_indexes_per_table |
index_tuning.max_queries_per_database
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of slowest queries per database for which indexes can be recommended. |
| Data type |
integer |
| Default value |
25 |
| Allowed values |
5-100 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_queries_per_database |
index_tuning.max_regression_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Acceptable regression introduced by a recommended index on any of the queries analyzed during one optimization session. |
| Data type |
numeric |
| Default value |
0.1 |
| Allowed values |
0.05-0.2 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_regression_factor |
index_tuning.max_total_size_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum total size, in percentage of total disk space, that all recommended indexes for any given database can use. |
| Data type |
numeric |
| Default value |
0.1 |
| Allowed values |
0-1.0 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_total_size_factor |
index_tuning.min_improvement_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Cost improvement that a recommended index must provide to at least one of the queries analyzed during one optimization session. |
| Data type |
numeric |
| Default value |
0.2 |
| Allowed values |
0-20.0 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.min_improvement_factor |
index_tuning.mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Configures index optimization as disabled ('OFF') or enabled to only emit recommendation. Requires Query Store to be enabled by setting pg_qs.query_capture_mode to 'TOP' or 'ALL'. |
| Data type |
enumeration |
| Default value |
off |
| Allowed values |
off,report |
| Parameter type |
dynamic |
| Documentation |
index_tuning.mode |
index_tuning.unused_dml_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of daily average DML operations affecting the table, so that their unused indexes are considered for dropping. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
0-9999999 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_dml_per_table |
index_tuning.unused_min_period
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of days the index has not been used, based on system statistics, so that it is considered for dropping. |
| Data type |
integer |
| Default value |
35 |
| Allowed values |
30-720 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_min_period |
index_tuning.unused_reads_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of daily average read operations affecting the table, so that their unused indexes are considered for dropping. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
0-9999999 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_reads_per_table |
logfiles.download_enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables or disables server logs functionality. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
logfiles.download_enable |
logfiles.retention_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for server logs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
1-7 |
| Parameter type |
dynamic |
| Documentation |
logfiles.retention_days |
pgaadauth.enable_group_sync
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables synchronization of Entra ID group members. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
pgaudit.log
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which classes of statements will be logged by session audit logging. |
| Data type |
set |
| Default value |
none |
| Allowed values |
none,read,write,function,role,ddl,misc,all |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log |
pgaudit.log_catalog
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_catalog |
pgaudit.log_client
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether audit messages should be visible to client. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_client |
pgaudit.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the log level that will be used for log entries. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,log |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_level |
pgaudit.log_parameter
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that audit logging should include the parameters that were passed with the statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_parameter |
pgaudit.log_parameter_max_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies, in bytes, the maximum length of variable-length parameters to log. If 0 (the default), parameters are not checked for size. If set, when the size of the parameter is longer than the setting, the value in the audit log is replaced with a placeholder. Note that for character types, the length is in bytes for the parameter's encoding, not characters. |
| Data type |
integer |
| Default value |
0 |
| Allowed values |
0-1073741823 |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_parameter_max_size |
pgaudit.log_relation
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether session audit logging should create a separate log entry for each relation referenced in a SELECT or DML statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_relation |
pgaudit.log_rows
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the rows retrieved or affected by a statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pgaudit.log_rows |
pgaudit.log_statement
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the statement text and parameters. Depending on requirements, the full statement text might not be required in the audit log. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_statement |
pgaudit.log_statement_once
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_statement_once |
pgaudit.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the master role to use for object audit logging. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pgaudit.role |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
whether to drop extra slots on standby that don't match pg_failover_slots.synchronize_slot_names. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.drop_extra_slots |
pg_failover_slots.primary_dsn
| Attribute |
Value |
| Category |
Customized Options |
| Description |
connection string to the primary server for synchronization logical slots on standby. if empty, uses the defaults to primary_conninfo. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.primary_dsn |
pg_failover_slots.standby_slot_names
| Attribute |
Value |
| Category |
Customized Options |
| Description |
list of names of slot that must confirm changes before they're sent by the decoding plugin. List of physical replication slots that must confirm durable flush of a given lsn before commits up to that lsn may be replicated to logical peers by the output plugin. Imposes ordering of physical replication before logical replication. |
| Data type |
string |
| Default value |
azure_standby_, wal_replica_ |
| Allowed values |
azure_standby_, wal_replica_ |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.standby_slot_names |
pg_failover_slots.standby_slots_min_confirmed
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of slots from pg_failover_slots.standby_slot_names that must confirm lsn. Modifies behaviour of pg_failover_slots.standby_slot_names so to allow logical replication of a transaction after at least pg_failover_slots.standby_slots_min_confirmed physical peers have confirmed the transaction as durably flushed. The value -1 (default) means all entries in pg_failover_slots.standby_slot_namesmust confirm the write. The value 0 causes pg_failover_slots.standby_slots_min_confirmedto be effectively ignored. |
| Data type |
integer |
| Default value |
1 |
| Allowed values |
1 |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.standby_slots_min_confirmed |
pg_failover_slots.synchronize_slot_names
| Attribute |
Value |
| Category |
Customized Options |
| Description |
list of slots to synchronize from primary to physical standby. |
| Data type |
string |
| Default value |
name_like:%% |
| Allowed values |
name_like:%% |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.synchronize_slot_names |
pg_failover_slots.version
| Attribute |
Value |
| Category |
Customized Options |
| Description |
pg_failover_slots module version. |
| Data type |
string |
| Default value |
1.0.1 |
| Allowed values |
1.0.1 |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.version |
pg_failover_slots.wait_for_inactive_slots
| Attribute |
Value |
| Category |
Customized Options |
| Description |
whether to wait for an inactive replication slots on primary to catchup with standby. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.wait_for_inactive_slots |
pg_hint_plan.debug_print
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Logs results of hint parsing. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.debug_print |
pg_hint_plan.enable_hint
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Force planner to use plans specified in the hint comment preceding to the query. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.enable_hint |
pg_hint_plan.enable_hint_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Let pg_hint_plan look up the hint table. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.enable_hint_table |
pg_hint_plan.hints_anywhere
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Read hints from anywhere in a query. This option lets pg_hint_plan ignore syntax so be cautious for false reads. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.hints_anywhere |
pg_hint_plan.message_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Message level of debug messages. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
log |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.message_level |
pg_hint_plan.parse_messages
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Message level of parse errors. |
| Data type |
enumeration |
| Default value |
info |
| Allowed values |
info |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.parse_messages |
pglogical.batch_inserts
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use batch insert mechanism if possible. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.batch_inserts |
pglogical.conflict_log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the log level for reporting detected conflicts when the pglogical.conflict_resolution is set to anything else than error. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_log_level |
pglogical.conflict_resolution
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the resolution method for any detected conflicts between local data and incoming changes. |
| Data type |
enumeration |
| Default value |
apply_remote |
| Allowed values |
error,apply_remote,keep_local,last_update_wins,first_update_wins |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_resolution |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
connection options to add to all peer node connections. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pglogical.extra_connection_options |
pglogical.synchronous_commit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
pglogical specific synchronous commit value. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pglogical.synchronous_commit |
pglogical.temp_directory
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Directory to store dumps for local restore. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pglogical.temp_directory |
pglogical.use_spi
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use SPI interface to form actual SQL (INSERT, UPDATE, DELETE) statements to apply incoming changes instead of using internal low level interface. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.use_spi |
pgms_stats.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
|
pgms_wait_sampling.history_period
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type |
integer |
| Default value |
100 |
| Allowed values |
1-600000 |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
all,none |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.query_capture_mode |
pg_partman_bgw.analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_analyze argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.analyze |
pg_partman_bgw.dbname
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Required. The database(s) that run_maintenance() will run on. If more than one, use a comma separated list. If not set, BGW will do nothing. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z0-9_,-]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.dbname |
pg_partman_bgw.interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of seconds between calls to run_maintenance(). |
| Data type |
integer |
| Default value |
3600 |
| Allowed values |
1-315360000 |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.interval |
pg_partman_bgw.jobmon
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_jobmon argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.jobmon |
pg_partman_bgw.maintenance_wait
| Attribute |
Value |
| Category |
Customized Options |
| Description |
How long to wait between each partition set when running maintenance (in seconds). |
| Data type |
integer |
| Default value |
0 |
| Allowed values |
0 |
| Parameter type |
read-only |
| Documentation |
pg_partman_bgw.maintenance_wait |
pg_partman_bgw.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The role that run_maintenance() will run as. Default is postgres. Only a single role name is allowed. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.role |
pg_prewarm.autoprewarm
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Starts the autoprewarm worker. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_prewarm.autoprewarm |
pg_prewarm.autoprewarm_interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the interval between dumps of shared buffers. If set to zero, time-based dumping is disabled. |
| Data type |
integer |
| Default value |
300 |
| Allowed values |
300 |
| Parameter type |
read-only |
| Documentation |
pg_prewarm.autoprewarm_interval |
pg_qs.interval_length_minutes
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type |
integer |
| Default value |
15 |
| Allowed values |
1-30 |
| Parameter type |
static |
| Documentation |
pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_qs.is_enabled_fs |
pg_qs.max_plan_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type |
integer |
| Default value |
7500 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type |
integer |
| Default value |
6000 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Whether and when to capture query positional parameters. |
| Data type |
enumeration |
| Default value |
capture_parameterless_only |
| Allowed values |
capture_parameterless_only,capture_first_sample |
| Parameter type |
dynamic |
| Documentation |
pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets query capture mode for query store. None disables any capturing. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
7 |
| Allowed values |
1-30 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Turns saving query plans on or off for pg_qs |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_qs. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.track_utility |
pg_stat_statements.max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of statements tracked by pg_stat_statements. |
| Data type |
integer |
| Default value |
5000 |
| Allowed values |
100-2147483647 |
| Parameter type |
static |
| Documentation |
pg_stat_statements.max |
pg_stat_statements.save
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Save pg_stat_statements statistics across server shutdowns. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.save |
pg_stat_statements.track
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls which statements are counted by pg_stat_statements. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track |
pg_stat_statements.track_planning
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether planning duration is tracked by pg_stat_statements. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track_planning |
pg_stat_statements.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_stat_statements. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track_utility |
postgis.gdal_enabled_drivers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls postgis GDAL enabled driver settings. |
| Data type |
enumeration |
| Default value |
DISABLE_ALL |
| Allowed values |
DISABLE_ALL,ENABLE_ALL |
| Parameter type |
dynamic |
| Documentation |
postgis.gdal_enabled_drivers |
squeeze.max_xlock_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum time the processed table may be locked exclusively. The source table is locked exclusively during the final stage of processing. If the lock time should exceed this value, the lock is released and the final stage is retried a few more times. |
| Data type |
integer |
| Default value |
0 |
| Allowed values |
0 |
| Parameter type |
read-only |
| Documentation |
squeeze.max_xlock_time |
squeeze.worker_autostart
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Names of databases for which background workers start automatically. Comma-separated list for of databases which squeeze worker starts as soon as the cluster startup has completed. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
squeeze.worker_autostart |
squeeze.worker_role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Role that background workers use to connect to database. If background worker was launched automatically on cluster startup, it uses this role to initiate database connection(s). |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
squeeze.worker_role |
squeeze.workers_per_database
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of squeeze worker processes launched for each database. |
| Data type |
integer |
| Default value |
1 |
| Allowed values |
1 |
| Parameter type |
read-only |
| Documentation |
squeeze.workers_per_database |
timescaledb.bgw_launcher_poll_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Launcher timeout value in milliseconds. Configure the time the launcher waits to look for new TimescaleDB instances. |
| Data type |
integer |
| Default value |
60000 |
| Allowed values |
60000 |
| Parameter type |
read-only |
| Documentation |
timescaledb.bgw_launcher_poll_time |
timescaledb.disable_load
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable the loading of the actual extension. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
timescaledb.disable_load |
timescaledb.max_background_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum background worker processes allocated to TimescaleDB. Max background worker processes allocated to TimescaleDB - set to at least 1 + number of databases in Postgres instance to use background workers. |
| Data type |
integer |
| Default value |
16 |
| Allowed values |
16 |
| Parameter type |
read-only |
| Documentation |
timescaledb.max_background_workers |
timescaledb_osm.disable_load
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable the loading of the actual extension. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
timescaledb_osm.disable_load |
age.enable_containment
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use @> operator to transform MATCH's filter. Otherwise, use -> operator. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
age.enable_containment |
anon.algorithm
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The hash method used for pseudonymizing functions. |
| Data type |
string |
| Default value |
sha256 |
| Allowed values |
sha256 |
| Parameter type |
read-only |
| Documentation |
anon.algorithm |
anon.k_anonymity_provider
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The security label provider used for k-anonymity. |
| Data type |
string |
| Default value |
k_anonymity |
| Allowed values |
k_anonymity |
| Parameter type |
read-only |
| Documentation |
anon.k_anonymity_provider |
anon.masking_policies
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Define multiple masking policies (NOT IMPLEMENTED YET). |
| Data type |
string |
| Default value |
anon |
| Allowed values |
anon |
| Parameter type |
read-only |
| Documentation |
anon.masking_policies |
anon.maskschema
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The schema where the dynamic masking views are stored. |
| Data type |
string |
| Default value |
mask |
| Allowed values |
mask |
| Parameter type |
read-only |
| Documentation |
anon.maskschema |
anon.privacy_by_default
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Mask all columns with NULL (or the default value for NOT NULL columns). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
anon.privacy_by_default |
anon.restrict_to_trusted_schemas
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Masking filters must be in a trusted schema. Activate this option to prevent non-superuser from using their own masking filters. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
anon.restrict_to_trusted_schemas |
anon.salt
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The salt value used for the pseudonymizing functions. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
anon.salt |
anon.sourceschema
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The schema where the table are masked by the dynamic masking engine. |
| Data type |
string |
| Default value |
public |
| Allowed values |
public |
| Parameter type |
read-only |
| Documentation |
anon.sourceschema |
anon.strict_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A masking rule cannot change a column data type, unless you disable this. Disabling the mode is not recommended. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
anon.strict_mode |
anon.transparent_dynamic_masking
| Attribute |
Value |
| Category |
Customized Options |
| Description |
New masking engine (EXPERIMENTAL). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
anon.transparent_dynamic_masking |
auto_explain.log_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN ANALYZE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_analyze |
auto_explain.log_buffers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log buffers usage. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_buffers |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
EXPLAIN format to be used for plan logging. |
| Data type |
enumeration |
| Default value |
text |
| Allowed values |
text,xml,json,yaml |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_format |
auto_explain.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log level for the plan. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,debug,info,notice,warning,log |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_level |
auto_explain.log_min_duration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the minimum execution time above which plans will be logged. Zero prints all plans. -1 turns this feature off. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_min_duration |
auto_explain.log_nested_statements
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log nested statements. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_nested_statements |
auto_explain.log_settings
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log modified configuration parameters affecting query planning. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_settings |
auto_explain.log_timing
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Collect timing data, not just row counts. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_timing |
auto_explain.log_triggers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Include trigger statistics in plans. This has no effect unless log_analyze is also set. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_triggers |
auto_explain.log_verbose
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN VERBOSE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_verbose |
auto_explain.log_wal
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log WAL usage. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_wal |
auto_explain.sample_rate
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Fraction of queries to process. |
| Data type |
numeric |
| Default value |
1.0 |
| Allowed values |
0.0-1.0 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.sample_rate |
azure.accepted_password_auth_method
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Accepted password authentication method. |
| Data type |
set |
| Default value |
md5,scram-sha-256 |
| Allowed values |
md5,scram-sha-256 |
| Parameter type |
dynamic |
| Documentation |
azure.accepted_password_auth_method |
azure_cdc.change_batch_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Buffer size, in megabytes, for change batches. These buffers are used to temporarily store CDC changes before they are written to disk. |
| Data type |
integer |
| Default value |
16 |
| Allowed values |
1-100 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.change_batch_export_timeout
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum time, in seconds, to wait before a batch of changes is ready to be exported. |
| Data type |
integer |
| Default value |
30 |
| Allowed values |
10-60 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.max_fabric_mirrors
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of parallel fabric mirrors that can be run at the same time. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
1-6 |
| Parameter type |
static |
| Documentation |
|
azure_cdc.max_snapshot_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of workers launched for snapshot export. Each worker exports one table at a time. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
0-100 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.onelake_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Buffer size, in megabytes, for upload to Onelake. Onelake uploads files in chunks, buffering the data in memory up to this limit. |
| Data type |
integer |
| Default value |
100 |
| Allowed values |
1-1024 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.parquet_compression
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Compression algorithm to use for parquet files. Determines the compression algorithm to use for parquet files. Supported values are 'uncompressed', 'snappy', 'gzip', and 'zstd'. |
| Data type |
enumeration |
| Default value |
zstd |
| Allowed values |
uncompressed,snappy,gzip,zstd |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.snapshot_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum size (in MB) of the initial snapshot buffer. Per table, up to this much data is buffered before sent to Fabric. Keep in mind that azure_cdc.snapshot_buffer_size*azure_cdc.max_snapshot_workers is the total memory buffer used during initial snapshot. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
10-4000 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.snapshot_export_timeout
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum time, in minutes, to wait before reporting an error when exporting a snapshot of a database. |
| Data type |
integer |
| Default value |
180 |
| Allowed values |
0-1440 |
| Parameter type |
dynamic |
| Documentation |
|
azure.enable_temp_tablespaces_on_local_ssd
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Create temp tablespace on ephemeral disk. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
azure.extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which extensions are allowed to be created in the server. |
| Data type |
set |
| Default value |
|
| Allowed values |
address_standardizer,address_standardizer_data_us,age,amcheck,anon,azure_ai,azure_storage,bloom,btree_gin,btree_gist,citext,cube,dblink,dict_int,dict_xsyn,earthdistance,fuzzystrmatch,hll,hstore,hypopg,intagg,intarray,isn,lo,login_hook,ltree,oracle_fdw,orafce,pageinspect,pg_buffercache,pg_cron,pg_diskann,pg_freespacemap,pg_hint_plan,pg_partman,pg_prewarm,pg_repack,pg_squeeze,pg_stat_statements,pg_trgm,pg_visibility,pgaudit,pgcrypto,pglogical,pgrouting,pgrowlocks,pgstattuple,plpgsql,plv8,postgis,postgis_raster,postgis_sfcgal,postgis_tiger_geocoder,postgis_topology,postgres_fdw,postgres_protobuf,semver,session_variable,sslinfo,tablefunc,tdigest,tds_fdw,timescaledb,topn,tsm_system_rows,tsm_system_time,unaccent,uuid-ossp,vector |
| Parameter type |
dynamic |
| Documentation |
azure.extensions |
azure.fabric_mirror_enabled
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sepcifies the flag indicating if mirroring is enabled on server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
azure.migration_copy_with_binary
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will enable the use of the binary format for copying data during migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_copy_with_binary |
azure.migration_skip_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the analyze phase (vacuumdb --analyze-only) during the migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_analyze |
azure.migration_skip_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of extensions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_extensions |
azure.migration_skip_large_objects
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of large objects such as BLOBs. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_large_objects |
azure.migration_skip_role_user
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will exclude user roles from the migration process. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_role_user |
azure.migration_table_split_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set, this parameter specifies the size at which tables will be partitioned during migration. |
| Data type |
integer |
| Default value |
20480 |
| Allowed values |
1-204800 |
| Parameter type |
dynamic |
| Documentation |
azure.migration_table_split_size |
azure.service_principal_id
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A unique identifier for a service principal in Azure, used to grant permissions and access to resources within a tenant. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
|
azure.service_principal_tenant_id
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A unique identifier for the tenant in which a service principal is created, ensuring the necessary permissions and access to resources within that tenant. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
|
azure.single_to_flex_migration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies if this is a server created for migrating from Azure Database for PostgreSQL Single Server to Flexible Server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
|
azure_storage.allow_network_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allows accessing Azure Storage Blob service from azure_storage extension. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure_storage.allow_network_access |
azure_storage.blob_block_size_mb
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Size of blob block, in megabytes, for PUT blob operations. |
| Data type |
integer |
| Default value |
Depends on resources (vCores, RAM, or disk space) allocated to the server. |
| Allowed values |
1024 |
| Parameter type |
read-only |
| Documentation |
azure_storage.blob_block_size_mb |
Azure-specific notes
The default value for the azure_storage.blob_block_size_mb server parameter is calculated when you provision the instance of Azure Database for PostgreSQL flexible server, based on the product name that you select for its compute. Any subsequent changes of product selection to the compute that supports the flexible server won't have any effect on the default value for the azure_storage.blob_block_size_mb server parameter of that instance.
As of today, if you change the product assigned to an instance, you won't be able to adjust the value of azure_storage.blob_block_size_mb parameter because the parameter is declared as read-only.
The formula used to compute the value of azure_storage.blob_block_size_mb is MIN(3072, MAX(128, memoryGiB * 32)).
Based on the previous formula, the following table lists the values this server parameter would be set to depending on the amount of memory provisioned:
| Memory size |
azure_storage.blob_block_size_mb |
| 2 GiB |
128 MiB |
| 4 GiB |
128 MiB |
| 8 GiB |
256 MiB |
| 16 GiB |
512 MiB |
| 32 GiB |
1024 MiB |
| 48 GiB |
1536 MiB |
| 64 GiB |
2048 MiB |
| 80 GiB |
2560 MiB |
| 128 GiB |
3072 MiB |
| 160 GiB |
3072 MiB |
| 192 GiB |
3072 MiB |
| 256 GiB |
3072 MiB |
| 384 GiB |
3072 MiB |
| 432 GiB |
3072 MiB |
| 672 GiB |
3072 MiB |
azure_storage.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log level used by the azure_storage extension. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,debug,log,info,notice,warning,error |
| Parameter type |
dynamic |
| Documentation |
azure_storage.log_level |
azure_storage.public_account_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allows all users to access data in storage accounts for which there are no credentials, and the storage account access is configured as public. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure_storage.public_account_access |
connection_throttle.bucket_limit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max login tokens per bucket. |
| Data type |
integer |
| Default value |
2000 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables temporary connection throttling per IP for too many login failures. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.factor_bias
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The factor bias for calculating number of tokens for an IP's bucket. |
| Data type |
numeric |
| Default value |
0.8 |
| Allowed values |
0.0-0.9 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.hash_entries_max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max number of entries in the login failures hash table. |
| Data type |
integer |
| Default value |
500 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.reset_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between resetting the login bucket. |
| Data type |
integer |
| Default value |
120 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.restore_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Factor to increase number of tokens by for IPs with low failure rate. |
| Data type |
numeric |
| Default value |
2 |
| Allowed values |
1.0-100.0 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.update_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between updating the login bucket. |
| Data type |
integer |
| Default value |
20 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
cron.database_name
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the database in which pg_cron metadata is kept. |
| Data type |
string |
| Default value |
postgres |
| Allowed values |
[A-Za-z0-9_]+ |
| Parameter type |
static |
| Documentation |
cron.database_name |
cron.enable_superuser_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allow jobs to be scheduled as superuser. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
cron.enable_superuser_jobs |
cron.host
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Hostname to connect to postgres. This setting has no effect when background workers are used. |
| Data type |
string |
| Default value |
/tmp |
| Allowed values |
/tmp |
| Parameter type |
read-only |
| Documentation |
cron.host |
cron.launch_active_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Launch jobs that are defined as active. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
cron.launch_active_jobs |
cron.log_min_messages
| Attribute |
Value |
| Category |
Customized Options |
| Description |
log_min_messages for the launcher bgworker. |
| Data type |
enumeration |
| Default value |
warning |
| Allowed values |
warning |
| Parameter type |
read-only |
| Documentation |
cron.log_min_messages |
cron.log_run
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all jobs runs into the job_run_details table. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_run |
cron.log_statement
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all cron statements prior to execution. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_statement |
cron.max_running_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of jobs that can run concurrently. This value is limited by max_connections. |
| Data type |
integer |
| Default value |
32 |
| Allowed values |
0-5000 |
| Parameter type |
static |
| Documentation |
cron.max_running_jobs |
cron.timezone
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specify timezone used for cron schedule. |
| Data type |
enumeration |
| Default value |
GMT |
| Allowed values |
GMT |
| Parameter type |
read-only |
| Documentation |
cron.timezone |
cron.use_background_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use background workers instead of client sessions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
cron.use_background_workers |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable installing community extensions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
duckdb.allow_community_extensions |
duckdb.allow_unsigned_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allow DuckDB to load extensions with invalid or missing signatures. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
duckdb.allow_unsigned_extensions |
duckdb.autoinstall_known_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Whether known extensions are allowed to be automatically installed when a DuckDB query depends on them. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
duckdb.autoinstall_known_extensions |
duckdb.autoload_known_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Whether known extensions are allowed to be automatically loaded when a DuckDB query depends on them. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
duckdb.autoload_known_extensions |
duckdb.disabled_filesystems
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable specific file systems preventing access (e.g., LocalFileSystem). |
| Data type |
string |
| Default value |
LocalFileSystem, S3FileSystem |
| Allowed values |
LocalFileSystem, S3FileSystem |
| Parameter type |
read-only |
| Documentation |
duckdb.disabled_filesystems |
duckdb.enable_external_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allow the DuckDB to access external state. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
duckdb.enable_external_access |
duckdb.force_execution
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Force queries to use DuckDB execution. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
duckdb.force_execution |
duckdb.max_memory
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum memory DuckDB can use (e.g., 1GB). |
| Data type |
integer |
| Default value |
1024 |
| Allowed values |
1024-688128 |
| Parameter type |
static |
| Documentation |
duckdb.max_memory |
duckdb.max_workers_per_postgres_scan
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of PostgreSQL workers used for a single Postgres scan. |
| Data type |
integer |
| Default value |
2 |
| Allowed values |
0-1024 |
| Parameter type |
static |
| Documentation |
duckdb.max_workers_per_postgres_scan |
duckdb.memory_limit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum memory DuckDB can use (e.g., 1GB), alias for duckdb.max_memory |
| Data type |
integer |
| Default value |
1024 |
| Allowed values |
1024-688128 |
| Parameter type |
static |
| Documentation |
duckdb.memory_limit |
duckdb.postgres_role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Which postgres role should be allowed to use DuckDB execution, use the secrets and create MotherDuck tables. Defaults to superusers only. |
| Data type |
string |
| Default value |
azure_pg_duckdb_admin |
| Allowed values |
azure_pg_duckdb_admin |
| Parameter type |
read-only |
| Documentation |
duckdb.postgres_role |
duckdb.threads
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of DuckDB threads per Postgres backend. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-96 |
| Parameter type |
static |
| Documentation |
duckdb.threads |
duckdb.worker_threads
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of DuckDB threads per Postgres backend, alias for duckdb.threads. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-96 |
| Parameter type |
static |
| Documentation |
duckdb.worker_threads |
index_tuning.analysis_interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the frequency at which each index optimization session is triggered when index_tuning.mode is set to 'REPORT'. |
| Data type |
integer |
| Default value |
720 |
| Allowed values |
60-10080 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.analysis_interval |
index_tuning.max_columns_per_index
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of columns that can be part of the index key for any recommended index. |
| Data type |
integer |
| Default value |
2 |
| Allowed values |
1-10 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_columns_per_index |
index_tuning.max_index_count
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of indexes that can be recommended for each database during one optimization session. |
| Data type |
integer |
| Default value |
10 |
| Allowed values |
1-25 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_index_count |
index_tuning.max_indexes_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of indexes that can be recommended for each table. |
| Data type |
integer |
| Default value |
10 |
| Allowed values |
1-25 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_indexes_per_table |
index_tuning.max_queries_per_database
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of slowest queries per database for which indexes can be recommended. |
| Data type |
integer |
| Default value |
25 |
| Allowed values |
5-100 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_queries_per_database |
index_tuning.max_regression_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Acceptable regression introduced by a recommended index on any of the queries analyzed during one optimization session. |
| Data type |
numeric |
| Default value |
0.1 |
| Allowed values |
0.05-0.2 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_regression_factor |
index_tuning.max_total_size_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum total size, in percentage of total disk space, that all recommended indexes for any given database can use. |
| Data type |
numeric |
| Default value |
0.1 |
| Allowed values |
0-1.0 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_total_size_factor |
index_tuning.min_improvement_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Cost improvement that a recommended index must provide to at least one of the queries analyzed during one optimization session. |
| Data type |
numeric |
| Default value |
0.2 |
| Allowed values |
0-20.0 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.min_improvement_factor |
index_tuning.mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Configures index optimization as disabled ('OFF') or enabled to only emit recommendation. Requires Query Store to be enabled by setting pg_qs.query_capture_mode to 'TOP' or 'ALL'. |
| Data type |
enumeration |
| Default value |
off |
| Allowed values |
off,report |
| Parameter type |
dynamic |
| Documentation |
index_tuning.mode |
index_tuning.unused_dml_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of daily average DML operations affecting the table, so that their unused indexes are considered for dropping. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
0-9999999 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_dml_per_table |
index_tuning.unused_min_period
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of days the index has not been used, based on system statistics, so that it is considered for dropping. |
| Data type |
integer |
| Default value |
35 |
| Allowed values |
30-720 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_min_period |
index_tuning.unused_reads_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of daily average read operations affecting the table, so that their unused indexes are considered for dropping. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
0-9999999 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_reads_per_table |
logfiles.download_enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables or disables server logs functionality. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
logfiles.download_enable |
logfiles.retention_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for server logs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
1-7 |
| Parameter type |
dynamic |
| Documentation |
logfiles.retention_days |
pgaadauth.enable_group_sync
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables synchronization of Entra ID group members. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
pgaudit.log
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which classes of statements will be logged by session audit logging. |
| Data type |
set |
| Default value |
none |
| Allowed values |
none,read,write,function,role,ddl,misc,all |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log |
pgaudit.log_catalog
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_catalog |
pgaudit.log_client
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether audit messages should be visible to client. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_client |
pgaudit.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the log level that will be used for log entries. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,log |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_level |
pgaudit.log_parameter
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that audit logging should include the parameters that were passed with the statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_parameter |
pgaudit.log_relation
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether session audit logging should create a separate log entry for each relation referenced in a SELECT or DML statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_relation |
pgaudit.log_rows
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the rows retrieved or affected by a statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pgaudit.log_rows |
pgaudit.log_statement
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the statement text and parameters. Depending on requirements, the full statement text might not be required in the audit log. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_statement |
pgaudit.log_statement_once
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_statement_once |
pgaudit.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the master role to use for object audit logging. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pgaudit.role |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
whether to drop extra slots on standby that don't match pg_failover_slots.synchronize_slot_names. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.drop_extra_slots |
pg_failover_slots.primary_dsn
| Attribute |
Value |
| Category |
Customized Options |
| Description |
connection string to the primary server for synchronization logical slots on standby. if empty, uses the defaults to primary_conninfo. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.primary_dsn |
pg_failover_slots.standby_slot_names
| Attribute |
Value |
| Category |
Customized Options |
| Description |
list of names of slot that must confirm changes before they're sent by the decoding plugin. List of physical replication slots that must confirm durable flush of a given lsn before commits up to that lsn may be replicated to logical peers by the output plugin. Imposes ordering of physical replication before logical replication. |
| Data type |
string |
| Default value |
azure_standby_, wal_replica_ |
| Allowed values |
azure_standby_, wal_replica_ |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.standby_slot_names |
pg_failover_slots.standby_slots_min_confirmed
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of slots from pg_failover_slots.standby_slot_names that must confirm lsn. Modifies behaviour of pg_failover_slots.standby_slot_names so to allow logical replication of a transaction after at least pg_failover_slots.standby_slots_min_confirmed physical peers have confirmed the transaction as durably flushed. The value -1 (default) means all entries in pg_failover_slots.standby_slot_namesmust confirm the write. The value 0 causes pg_failover_slots.standby_slots_min_confirmedto be effectively ignored. |
| Data type |
integer |
| Default value |
1 |
| Allowed values |
1 |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.standby_slots_min_confirmed |
pg_failover_slots.synchronize_slot_names
| Attribute |
Value |
| Category |
Customized Options |
| Description |
list of slots to synchronize from primary to physical standby. |
| Data type |
string |
| Default value |
name_like:%% |
| Allowed values |
name_like:%% |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.synchronize_slot_names |
pg_failover_slots.version
| Attribute |
Value |
| Category |
Customized Options |
| Description |
pg_failover_slots module version. |
| Data type |
string |
| Default value |
1.0.1 |
| Allowed values |
1.0.1 |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.version |
pg_failover_slots.wait_for_inactive_slots
| Attribute |
Value |
| Category |
Customized Options |
| Description |
whether to wait for an inactive replication slots on primary to catchup with standby. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.wait_for_inactive_slots |
pg_hint_plan.debug_print
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Logs results of hint parsing. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.debug_print |
pg_hint_plan.enable_hint
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Force planner to use plans specified in the hint comment preceding to the query. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.enable_hint |
pg_hint_plan.enable_hint_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Let pg_hint_plan look up the hint table. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.enable_hint_table |
pg_hint_plan.hints_anywhere
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Read hints from anywhere in a query. This option lets pg_hint_plan ignore syntax so be cautious for false reads. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.hints_anywhere |
pg_hint_plan.message_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Message level of debug messages. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
log |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.message_level |
pg_hint_plan.parse_messages
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Message level of parse errors. |
| Data type |
enumeration |
| Default value |
info |
| Allowed values |
info |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.parse_messages |
pglogical.batch_inserts
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use batch insert mechanism if possible. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.batch_inserts |
pglogical.conflict_log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the log level for reporting detected conflicts when the pglogical.conflict_resolution is set to anything else than error. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_log_level |
pglogical.conflict_resolution
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the resolution method for any detected conflicts between local data and incoming changes. |
| Data type |
enumeration |
| Default value |
apply_remote |
| Allowed values |
error,apply_remote,keep_local,last_update_wins,first_update_wins |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_resolution |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
connection options to add to all peer node connections. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pglogical.extra_connection_options |
pglogical.synchronous_commit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
pglogical specific synchronous commit value. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pglogical.synchronous_commit |
pglogical.temp_directory
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Directory to store dumps for local restore. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pglogical.temp_directory |
pglogical.use_spi
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use SPI interface to form actual SQL (INSERT, UPDATE, DELETE) statements to apply incoming changes instead of using internal low level interface. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.use_spi |
pgms_stats.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
|
pgms_wait_sampling.history_period
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type |
integer |
| Default value |
100 |
| Allowed values |
1-600000 |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
all,none |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.query_capture_mode |
pg_partman_bgw.analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_analyze argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.analyze |
pg_partman_bgw.dbname
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Required. The database(s) that run_maintenance() will run on. If more than one, use a comma separated list. If not set, BGW will do nothing. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z0-9_,-]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.dbname |
pg_partman_bgw.interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of seconds between calls to run_maintenance(). |
| Data type |
integer |
| Default value |
3600 |
| Allowed values |
1-315360000 |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.interval |
pg_partman_bgw.jobmon
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_jobmon argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.jobmon |
pg_partman_bgw.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The role that run_maintenance() will run as. Default is postgres. Only a single role name is allowed. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.role |
pg_prewarm.autoprewarm
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Starts the autoprewarm worker. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_prewarm.autoprewarm |
pg_prewarm.autoprewarm_interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the interval between dumps of shared buffers. If set to zero, time-based dumping is disabled. |
| Data type |
integer |
| Default value |
300 |
| Allowed values |
300 |
| Parameter type |
read-only |
| Documentation |
pg_prewarm.autoprewarm_interval |
pg_qs.interval_length_minutes
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type |
integer |
| Default value |
15 |
| Allowed values |
1-30 |
| Parameter type |
static |
| Documentation |
pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_qs.is_enabled_fs |
pg_qs.max_plan_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type |
integer |
| Default value |
7500 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type |
integer |
| Default value |
6000 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Whether and when to capture query positional parameters. |
| Data type |
enumeration |
| Default value |
capture_parameterless_only |
| Allowed values |
capture_parameterless_only,capture_first_sample |
| Parameter type |
dynamic |
| Documentation |
pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets query capture mode for query store. None disables any capturing. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
7 |
| Allowed values |
1-30 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Turns saving query plans on or off for pg_qs |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_qs. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.track_utility |
pg_stat_statements.max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of statements tracked by pg_stat_statements. |
| Data type |
integer |
| Default value |
5000 |
| Allowed values |
100-2147483647 |
| Parameter type |
static |
| Documentation |
pg_stat_statements.max |
pg_stat_statements.save
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Save pg_stat_statements statistics across server shutdowns. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.save |
pg_stat_statements.track
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls which statements are counted by pg_stat_statements. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track |
pg_stat_statements.track_planning
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether planning duration is tracked by pg_stat_statements. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track_planning |
pg_stat_statements.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_stat_statements. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track_utility |
postgis.gdal_enabled_drivers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls postgis GDAL enabled driver settings. |
| Data type |
enumeration |
| Default value |
DISABLE_ALL |
| Allowed values |
DISABLE_ALL,ENABLE_ALL |
| Parameter type |
dynamic |
| Documentation |
postgis.gdal_enabled_drivers |
squeeze.max_xlock_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum time the processed table may be locked exclusively. The source table is locked exclusively during the final stage of processing. If the lock time should exceed this value, the lock is released and the final stage is retried a few more times. |
| Data type |
integer |
| Default value |
0 |
| Allowed values |
0 |
| Parameter type |
read-only |
| Documentation |
squeeze.max_xlock_time |
squeeze.worker_autostart
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Names of databases for which background workers start automatically. Comma-separated list for of databases which squeeze worker starts as soon as the cluster startup has completed. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
squeeze.worker_autostart |
squeeze.worker_role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Role that background workers use to connect to database. If background worker was launched automatically on cluster startup, it uses this role to initiate database connection(s). |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
squeeze.worker_role |
squeeze.workers_per_database
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of squeeze worker processes launched for each database. |
| Data type |
integer |
| Default value |
1 |
| Allowed values |
1 |
| Parameter type |
read-only |
| Documentation |
squeeze.workers_per_database |
timescaledb.bgw_launcher_poll_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Launcher timeout value in milliseconds. Configure the time the launcher waits to look for new TimescaleDB instances. |
| Data type |
integer |
| Default value |
60000 |
| Allowed values |
60000 |
| Parameter type |
read-only |
| Documentation |
timescaledb.bgw_launcher_poll_time |
timescaledb.disable_load
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable the loading of the actual extension. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
timescaledb.disable_load |
timescaledb.max_background_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum background worker processes allocated to TimescaleDB. Max background worker processes allocated to TimescaleDB - set to at least 1 + number of databases in Postgres instance to use background workers. |
| Data type |
integer |
| Default value |
16 |
| Allowed values |
16 |
| Parameter type |
read-only |
| Documentation |
timescaledb.max_background_workers |
timescaledb_osm.disable_load
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable the loading of the actual extension. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
timescaledb_osm.disable_load |
age.enable_containment
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use @> operator to transform MATCH's filter. Otherwise, use -> operator. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
age.enable_containment |
anon.algorithm
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The hash method used for pseudonymizing functions. |
| Data type |
string |
| Default value |
sha256 |
| Allowed values |
sha256 |
| Parameter type |
read-only |
| Documentation |
anon.algorithm |
anon.k_anonymity_provider
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The security label provider used for k-anonymity. |
| Data type |
string |
| Default value |
k_anonymity |
| Allowed values |
k_anonymity |
| Parameter type |
read-only |
| Documentation |
anon.k_anonymity_provider |
anon.masking_policies
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Define multiple masking policies (NOT IMPLEMENTED YET). |
| Data type |
string |
| Default value |
anon |
| Allowed values |
anon |
| Parameter type |
read-only |
| Documentation |
anon.masking_policies |
anon.maskschema
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The schema where the dynamic masking views are stored. |
| Data type |
string |
| Default value |
mask |
| Allowed values |
mask |
| Parameter type |
read-only |
| Documentation |
anon.maskschema |
anon.privacy_by_default
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Mask all columns with NULL (or the default value for NOT NULL columns). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
anon.privacy_by_default |
anon.restrict_to_trusted_schemas
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Masking filters must be in a trusted schema. Activate this option to prevent non-superuser from using their own masking filters. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
anon.restrict_to_trusted_schemas |
anon.salt
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The salt value used for the pseudonymizing functions. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
anon.salt |
anon.sourceschema
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The schema where the table are masked by the dynamic masking engine. |
| Data type |
string |
| Default value |
public |
| Allowed values |
public |
| Parameter type |
read-only |
| Documentation |
anon.sourceschema |
anon.strict_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A masking rule cannot change a column data type, unless you disable this. Disabling the mode is not recommended. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
anon.strict_mode |
anon.transparent_dynamic_masking
| Attribute |
Value |
| Category |
Customized Options |
| Description |
New masking engine (EXPERIMENTAL). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
anon.transparent_dynamic_masking |
auto_explain.log_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN ANALYZE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_analyze |
auto_explain.log_buffers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log buffers usage. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_buffers |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
EXPLAIN format to be used for plan logging. |
| Data type |
enumeration |
| Default value |
text |
| Allowed values |
text,xml,json,yaml |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_format |
auto_explain.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log level for the plan. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,debug,info,notice,warning,log |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_level |
auto_explain.log_min_duration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the minimum execution time above which plans will be logged. Zero prints all plans. -1 turns this feature off. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_min_duration |
auto_explain.log_nested_statements
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log nested statements. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_nested_statements |
auto_explain.log_settings
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log modified configuration parameters affecting query planning. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_settings |
auto_explain.log_timing
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Collect timing data, not just row counts. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_timing |
auto_explain.log_triggers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Include trigger statistics in plans. This has no effect unless log_analyze is also set. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_triggers |
auto_explain.log_verbose
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN VERBOSE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_verbose |
auto_explain.log_wal
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log WAL usage. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_wal |
auto_explain.sample_rate
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Fraction of queries to process. |
| Data type |
numeric |
| Default value |
1.0 |
| Allowed values |
0.0-1.0 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.sample_rate |
azure.accepted_password_auth_method
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Accepted password authentication method. |
| Data type |
set |
| Default value |
md5,scram-sha-256 |
| Allowed values |
md5,scram-sha-256 |
| Parameter type |
dynamic |
| Documentation |
azure.accepted_password_auth_method |
azure_cdc.change_batch_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Buffer size, in megabytes, for change batches. These buffers are used to temporarily store CDC changes before they are written to disk. |
| Data type |
integer |
| Default value |
16 |
| Allowed values |
1-100 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.change_batch_export_timeout
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum time, in seconds, to wait before a batch of changes is ready to be exported. |
| Data type |
integer |
| Default value |
30 |
| Allowed values |
10-60 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.max_fabric_mirrors
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of parallel fabric mirrors that can be run at the same time. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
1-6 |
| Parameter type |
static |
| Documentation |
|
azure_cdc.max_snapshot_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of workers launched for snapshot export. Each worker exports one table at a time. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
0-100 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.onelake_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Buffer size, in megabytes, for upload to Onelake. Onelake uploads files in chunks, buffering the data in memory up to this limit. |
| Data type |
integer |
| Default value |
100 |
| Allowed values |
1-1024 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.parquet_compression
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Compression algorithm to use for parquet files. Determines the compression algorithm to use for parquet files. Supported values are 'uncompressed', 'snappy', 'gzip', and 'zstd'. |
| Data type |
enumeration |
| Default value |
zstd |
| Allowed values |
uncompressed,snappy,gzip,zstd |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.snapshot_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum size (in MB) of the initial snapshot buffer. Per table, up to this much data is buffered before sent to Fabric. Keep in mind that azure_cdc.snapshot_buffer_size*azure_cdc.max_snapshot_workers is the total memory buffer used during initial snapshot. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
10-4000 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.snapshot_export_timeout
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum time, in minutes, to wait before reporting an error when exporting a snapshot of a database. |
| Data type |
integer |
| Default value |
180 |
| Allowed values |
0-1440 |
| Parameter type |
dynamic |
| Documentation |
|
azure.enable_temp_tablespaces_on_local_ssd
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Create temp tablespace on ephemeral disk. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
azure.extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which extensions are allowed to be created in the server. |
| Data type |
set |
| Default value |
|
| Allowed values |
address_standardizer,address_standardizer_data_us,age,amcheck,anon,azure_ai,azure_storage,bloom,btree_gin,btree_gist,citext,cube,dblink,dict_int,dict_xsyn,earthdistance,fuzzystrmatch,hll,hstore,hypopg,intagg,intarray,isn,lo,login_hook,ltree,oracle_fdw,orafce,pageinspect,pg_buffercache,pg_cron,pg_diskann,pg_freespacemap,pg_hint_plan,pg_partman,pg_prewarm,pg_repack,pg_squeeze,pg_stat_statements,pg_trgm,pg_visibility,pgaudit,pgcrypto,pglogical,pgrouting,pgrowlocks,pgstattuple,plpgsql,plv8,postgis,postgis_raster,postgis_sfcgal,postgis_tiger_geocoder,postgis_topology,postgres_fdw,postgres_protobuf,semver,session_variable,sslinfo,tablefunc,tdigest,tds_fdw,timescaledb,topn,tsm_system_rows,tsm_system_time,unaccent,uuid-ossp,vector |
| Parameter type |
dynamic |
| Documentation |
azure.extensions |
azure.fabric_mirror_enabled
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sepcifies the flag indicating if mirroring is enabled on server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
azure.migration_copy_with_binary
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will enable the use of the binary format for copying data during migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_copy_with_binary |
azure.migration_skip_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the analyze phase (vacuumdb --analyze-only) during the migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_analyze |
azure.migration_skip_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of extensions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_extensions |
azure.migration_skip_large_objects
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of large objects such as BLOBs. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_large_objects |
azure.migration_skip_role_user
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will exclude user roles from the migration process. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_role_user |
azure.migration_table_split_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set, this parameter specifies the size at which tables will be partitioned during migration. |
| Data type |
integer |
| Default value |
20480 |
| Allowed values |
1-204800 |
| Parameter type |
dynamic |
| Documentation |
azure.migration_table_split_size |
azure.service_principal_id
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A unique identifier for a service principal in Azure, used to grant permissions and access to resources within a tenant. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
|
azure.service_principal_tenant_id
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A unique identifier for the tenant in which a service principal is created, ensuring the necessary permissions and access to resources within that tenant. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
|
azure.single_to_flex_migration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies if this is a server created for migrating from Azure Database for PostgreSQL Single Server to Flexible Server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
|
azure_storage.allow_network_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allows accessing Azure Storage Blob service from azure_storage extension. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure_storage.allow_network_access |
azure_storage.blob_block_size_mb
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Size of blob block, in megabytes, for PUT blob operations. |
| Data type |
integer |
| Default value |
Depends on resources (vCores, RAM, or disk space) allocated to the server. |
| Allowed values |
1024 |
| Parameter type |
read-only |
| Documentation |
azure_storage.blob_block_size_mb |
Azure-specific notes
The default value for the azure_storage.blob_block_size_mb server parameter is calculated when you provision the instance of Azure Database for PostgreSQL flexible server, based on the product name that you select for its compute. Any subsequent changes of product selection to the compute that supports the flexible server won't have any effect on the default value for the azure_storage.blob_block_size_mb server parameter of that instance.
As of today, if you change the product assigned to an instance, you won't be able to adjust the value of azure_storage.blob_block_size_mb parameter because the parameter is declared as read-only.
The formula used to compute the value of azure_storage.blob_block_size_mb is MIN(3072, MAX(128, memoryGiB * 32)).
Based on the previous formula, the following table lists the values this server parameter would be set to depending on the amount of memory provisioned:
| Memory size |
azure_storage.blob_block_size_mb |
| 2 GiB |
128 MiB |
| 4 GiB |
128 MiB |
| 8 GiB |
256 MiB |
| 16 GiB |
512 MiB |
| 32 GiB |
1024 MiB |
| 48 GiB |
1536 MiB |
| 64 GiB |
2048 MiB |
| 80 GiB |
2560 MiB |
| 128 GiB |
3072 MiB |
| 160 GiB |
3072 MiB |
| 192 GiB |
3072 MiB |
| 256 GiB |
3072 MiB |
| 384 GiB |
3072 MiB |
| 432 GiB |
3072 MiB |
| 672 GiB |
3072 MiB |
azure_storage.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log level used by the azure_storage extension. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,debug,log,info,notice,warning,error |
| Parameter type |
dynamic |
| Documentation |
azure_storage.log_level |
azure_storage.public_account_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allows all users to access data in storage accounts for which there are no credentials, and the storage account access is configured as public. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure_storage.public_account_access |
connection_throttle.bucket_limit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max login tokens per bucket. |
| Data type |
integer |
| Default value |
2000 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables temporary connection throttling per IP for too many login failures. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.factor_bias
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The factor bias for calculating number of tokens for an IP's bucket. |
| Data type |
numeric |
| Default value |
0.8 |
| Allowed values |
0.0-0.9 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.hash_entries_max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max number of entries in the login failures hash table. |
| Data type |
integer |
| Default value |
500 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.reset_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between resetting the login bucket. |
| Data type |
integer |
| Default value |
120 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.restore_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Factor to increase number of tokens by for IPs with low failure rate. |
| Data type |
numeric |
| Default value |
2 |
| Allowed values |
1.0-100.0 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.update_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between updating the login bucket. |
| Data type |
integer |
| Default value |
20 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
cron.database_name
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the database in which pg_cron metadata is kept. |
| Data type |
string |
| Default value |
postgres |
| Allowed values |
[A-Za-z0-9_]+ |
| Parameter type |
static |
| Documentation |
cron.database_name |
cron.enable_superuser_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allow jobs to be scheduled as superuser. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
cron.enable_superuser_jobs |
cron.host
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Hostname to connect to postgres. This setting has no effect when background workers are used. |
| Data type |
string |
| Default value |
/tmp |
| Allowed values |
/tmp |
| Parameter type |
read-only |
| Documentation |
cron.host |
cron.launch_active_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Launch jobs that are defined as active. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
cron.launch_active_jobs |
cron.log_min_messages
| Attribute |
Value |
| Category |
Customized Options |
| Description |
log_min_messages for the launcher bgworker. |
| Data type |
enumeration |
| Default value |
warning |
| Allowed values |
warning |
| Parameter type |
read-only |
| Documentation |
cron.log_min_messages |
cron.log_run
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all jobs runs into the job_run_details table. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_run |
cron.log_statement
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all cron statements prior to execution. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_statement |
cron.max_running_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of jobs that can run concurrently. This value is limited by max_connections. |
| Data type |
integer |
| Default value |
32 |
| Allowed values |
0-5000 |
| Parameter type |
static |
| Documentation |
cron.max_running_jobs |
cron.timezone
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specify timezone used for cron schedule. |
| Data type |
enumeration |
| Default value |
GMT |
| Allowed values |
GMT |
| Parameter type |
read-only |
| Documentation |
cron.timezone |
cron.use_background_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use background workers instead of client sessions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
cron.use_background_workers |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable installing community extensions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
duckdb.allow_community_extensions |
duckdb.allow_unsigned_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allow DuckDB to load extensions with invalid or missing signatures. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
duckdb.allow_unsigned_extensions |
duckdb.autoinstall_known_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Whether known extensions are allowed to be automatically installed when a DuckDB query depends on them. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
duckdb.autoinstall_known_extensions |
duckdb.autoload_known_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Whether known extensions are allowed to be automatically loaded when a DuckDB query depends on them. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
duckdb.autoload_known_extensions |
duckdb.disabled_filesystems
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable specific file systems preventing access (e.g., LocalFileSystem). |
| Data type |
string |
| Default value |
LocalFileSystem, S3FileSystem |
| Allowed values |
LocalFileSystem, S3FileSystem |
| Parameter type |
read-only |
| Documentation |
duckdb.disabled_filesystems |
duckdb.enable_external_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allow the DuckDB to access external state. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
duckdb.enable_external_access |
duckdb.force_execution
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Force queries to use DuckDB execution. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
duckdb.force_execution |
duckdb.max_memory
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum memory DuckDB can use (e.g., 1GB). |
| Data type |
integer |
| Default value |
1024 |
| Allowed values |
1024-688128 |
| Parameter type |
static |
| Documentation |
duckdb.max_memory |
duckdb.max_workers_per_postgres_scan
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of PostgreSQL workers used for a single Postgres scan. |
| Data type |
integer |
| Default value |
2 |
| Allowed values |
0-1024 |
| Parameter type |
static |
| Documentation |
duckdb.max_workers_per_postgres_scan |
duckdb.memory_limit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum memory DuckDB can use (e.g., 1GB), alias for duckdb.max_memory |
| Data type |
integer |
| Default value |
1024 |
| Allowed values |
1024-688128 |
| Parameter type |
static |
| Documentation |
duckdb.memory_limit |
duckdb.postgres_role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Which postgres role should be allowed to use DuckDB execution, use the secrets and create MotherDuck tables. Defaults to superusers only. |
| Data type |
string |
| Default value |
azure_pg_duckdb_admin |
| Allowed values |
azure_pg_duckdb_admin |
| Parameter type |
read-only |
| Documentation |
duckdb.postgres_role |
duckdb.threads
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of DuckDB threads per Postgres backend. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-96 |
| Parameter type |
static |
| Documentation |
duckdb.threads |
duckdb.worker_threads
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of DuckDB threads per Postgres backend, alias for duckdb.threads. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-96 |
| Parameter type |
static |
| Documentation |
duckdb.worker_threads |
index_tuning.analysis_interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the frequency at which each index optimization session is triggered when index_tuning.mode is set to 'REPORT'. |
| Data type |
integer |
| Default value |
720 |
| Allowed values |
60-10080 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.analysis_interval |
index_tuning.max_columns_per_index
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of columns that can be part of the index key for any recommended index. |
| Data type |
integer |
| Default value |
2 |
| Allowed values |
1-10 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_columns_per_index |
index_tuning.max_index_count
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of indexes that can be recommended for each database during one optimization session. |
| Data type |
integer |
| Default value |
10 |
| Allowed values |
1-25 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_index_count |
index_tuning.max_indexes_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of indexes that can be recommended for each table. |
| Data type |
integer |
| Default value |
10 |
| Allowed values |
1-25 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_indexes_per_table |
index_tuning.max_queries_per_database
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of slowest queries per database for which indexes can be recommended. |
| Data type |
integer |
| Default value |
25 |
| Allowed values |
5-100 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_queries_per_database |
index_tuning.max_regression_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Acceptable regression introduced by a recommended index on any of the queries analyzed during one optimization session. |
| Data type |
numeric |
| Default value |
0.1 |
| Allowed values |
0.05-0.2 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_regression_factor |
index_tuning.max_total_size_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum total size, in percentage of total disk space, that all recommended indexes for any given database can use. |
| Data type |
numeric |
| Default value |
0.1 |
| Allowed values |
0-1.0 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_total_size_factor |
index_tuning.min_improvement_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Cost improvement that a recommended index must provide to at least one of the queries analyzed during one optimization session. |
| Data type |
numeric |
| Default value |
0.2 |
| Allowed values |
0-20.0 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.min_improvement_factor |
index_tuning.mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Configures index optimization as disabled ('OFF') or enabled to only emit recommendation. Requires Query Store to be enabled by setting pg_qs.query_capture_mode to 'TOP' or 'ALL'. |
| Data type |
enumeration |
| Default value |
off |
| Allowed values |
off,report |
| Parameter type |
dynamic |
| Documentation |
index_tuning.mode |
index_tuning.unused_dml_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of daily average DML operations affecting the table, so that their unused indexes are considered for dropping. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
0-9999999 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_dml_per_table |
index_tuning.unused_min_period
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of days the index has not been used, based on system statistics, so that it is considered for dropping. |
| Data type |
integer |
| Default value |
35 |
| Allowed values |
30-720 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_min_period |
index_tuning.unused_reads_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of daily average read operations affecting the table, so that their unused indexes are considered for dropping. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
0-9999999 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_reads_per_table |
logfiles.download_enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables or disables server logs functionality. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
logfiles.download_enable |
logfiles.retention_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for server logs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
1-7 |
| Parameter type |
dynamic |
| Documentation |
logfiles.retention_days |
pgaadauth.enable_group_sync
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables synchronization of Entra ID group members. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
pgaudit.log
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which classes of statements will be logged by session audit logging. |
| Data type |
set |
| Default value |
none |
| Allowed values |
none,read,write,function,role,ddl,misc,all |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log |
pgaudit.log_catalog
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_catalog |
pgaudit.log_client
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether audit messages should be visible to client. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_client |
pgaudit.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the log level that will be used for log entries. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,log |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_level |
pgaudit.log_parameter
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that audit logging should include the parameters that were passed with the statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_parameter |
pgaudit.log_relation
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether session audit logging should create a separate log entry for each relation referenced in a SELECT or DML statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_relation |
pgaudit.log_rows
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the rows retrieved or affected by a statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pgaudit.log_rows |
pgaudit.log_statement
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the statement text and parameters. Depending on requirements, the full statement text might not be required in the audit log. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_statement |
pgaudit.log_statement_once
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_statement_once |
pgaudit.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the master role to use for object audit logging. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pgaudit.role |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
whether to drop extra slots on standby that don't match pg_failover_slots.synchronize_slot_names. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.drop_extra_slots |
pg_failover_slots.primary_dsn
| Attribute |
Value |
| Category |
Customized Options |
| Description |
connection string to the primary server for synchronization logical slots on standby. if empty, uses the defaults to primary_conninfo. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.primary_dsn |
pg_failover_slots.standby_slot_names
| Attribute |
Value |
| Category |
Customized Options |
| Description |
list of names of slot that must confirm changes before they're sent by the decoding plugin. List of physical replication slots that must confirm durable flush of a given lsn before commits up to that lsn may be replicated to logical peers by the output plugin. Imposes ordering of physical replication before logical replication. |
| Data type |
string |
| Default value |
azure_standby_, wal_replica_ |
| Allowed values |
azure_standby_, wal_replica_ |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.standby_slot_names |
pg_failover_slots.standby_slots_min_confirmed
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of slots from pg_failover_slots.standby_slot_names that must confirm lsn. Modifies behaviour of pg_failover_slots.standby_slot_names so to allow logical replication of a transaction after at least pg_failover_slots.standby_slots_min_confirmed physical peers have confirmed the transaction as durably flushed. The value -1 (default) means all entries in pg_failover_slots.standby_slot_namesmust confirm the write. The value 0 causes pg_failover_slots.standby_slots_min_confirmedto be effectively ignored. |
| Data type |
integer |
| Default value |
1 |
| Allowed values |
1 |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.standby_slots_min_confirmed |
pg_failover_slots.synchronize_slot_names
| Attribute |
Value |
| Category |
Customized Options |
| Description |
list of slots to synchronize from primary to physical standby. |
| Data type |
string |
| Default value |
name_like:%% |
| Allowed values |
name_like:%% |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.synchronize_slot_names |
pg_failover_slots.version
| Attribute |
Value |
| Category |
Customized Options |
| Description |
pg_failover_slots module version. |
| Data type |
string |
| Default value |
1.0.1 |
| Allowed values |
1.0.1 |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.version |
pg_failover_slots.wait_for_inactive_slots
| Attribute |
Value |
| Category |
Customized Options |
| Description |
whether to wait for an inactive replication slots on primary to catchup with standby. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.wait_for_inactive_slots |
pg_hint_plan.debug_print
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Logs results of hint parsing. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.debug_print |
pg_hint_plan.enable_hint
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Force planner to use plans specified in the hint comment preceding to the query. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.enable_hint |
pg_hint_plan.enable_hint_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Let pg_hint_plan look up the hint table. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.enable_hint_table |
pg_hint_plan.hints_anywhere
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Read hints from anywhere in a query. This option lets pg_hint_plan ignore syntax so be cautious for false reads. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.hints_anywhere |
pg_hint_plan.message_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Message level of debug messages. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
log |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.message_level |
pg_hint_plan.parse_messages
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Message level of parse errors. |
| Data type |
enumeration |
| Default value |
info |
| Allowed values |
info |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.parse_messages |
pglogical.batch_inserts
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use batch insert mechanism if possible. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.batch_inserts |
pglogical.conflict_log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the log level for reporting detected conflicts when the pglogical.conflict_resolution is set to anything else than error. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_log_level |
pglogical.conflict_resolution
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the resolution method for any detected conflicts between local data and incoming changes. |
| Data type |
enumeration |
| Default value |
apply_remote |
| Allowed values |
error,apply_remote,keep_local,last_update_wins,first_update_wins |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_resolution |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
connection options to add to all peer node connections. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pglogical.extra_connection_options |
pglogical.synchronous_commit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
pglogical specific synchronous commit value. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pglogical.synchronous_commit |
pglogical.temp_directory
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Directory to store dumps for local restore. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pglogical.temp_directory |
pglogical.use_spi
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use SPI interface to form actual SQL (INSERT, UPDATE, DELETE) statements to apply incoming changes instead of using internal low level interface. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.use_spi |
pgms_stats.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
|
pgms_wait_sampling.history_period
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type |
integer |
| Default value |
100 |
| Allowed values |
1-600000 |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
all,none |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.query_capture_mode |
pg_partman_bgw.analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_analyze argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.analyze |
pg_partman_bgw.dbname
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Required. The database(s) that run_maintenance() will run on. If more than one, use a comma separated list. If not set, BGW will do nothing. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z0-9_,-]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.dbname |
pg_partman_bgw.interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of seconds between calls to run_maintenance(). |
| Data type |
integer |
| Default value |
3600 |
| Allowed values |
1-315360000 |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.interval |
pg_partman_bgw.jobmon
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_jobmon argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.jobmon |
pg_partman_bgw.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The role that run_maintenance() will run as. Default is postgres. Only a single role name is allowed. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.role |
pg_prewarm.autoprewarm
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Starts the autoprewarm worker. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_prewarm.autoprewarm |
pg_prewarm.autoprewarm_interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the interval between dumps of shared buffers. If set to zero, time-based dumping is disabled. |
| Data type |
integer |
| Default value |
300 |
| Allowed values |
300 |
| Parameter type |
read-only |
| Documentation |
pg_prewarm.autoprewarm_interval |
pg_qs.interval_length_minutes
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type |
integer |
| Default value |
15 |
| Allowed values |
1-30 |
| Parameter type |
static |
| Documentation |
pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_qs.is_enabled_fs |
pg_qs.max_plan_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type |
integer |
| Default value |
7500 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type |
integer |
| Default value |
6000 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Whether and when to capture query positional parameters. |
| Data type |
enumeration |
| Default value |
capture_parameterless_only |
| Allowed values |
capture_parameterless_only,capture_first_sample |
| Parameter type |
dynamic |
| Documentation |
pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets query capture mode for query store. None disables any capturing. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
7 |
| Allowed values |
1-30 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Turns saving query plans on or off for pg_qs |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_qs. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.track_utility |
pg_stat_statements.max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of statements tracked by pg_stat_statements. |
| Data type |
integer |
| Default value |
5000 |
| Allowed values |
100-2147483647 |
| Parameter type |
static |
| Documentation |
pg_stat_statements.max |
pg_stat_statements.save
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Save pg_stat_statements statistics across server shutdowns. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.save |
pg_stat_statements.track
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls which statements are counted by pg_stat_statements. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track |
pg_stat_statements.track_planning
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether planning duration is tracked by pg_stat_statements. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track_planning |
pg_stat_statements.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_stat_statements. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track_utility |
postgis.gdal_enabled_drivers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls postgis GDAL enabled driver settings. |
| Data type |
enumeration |
| Default value |
DISABLE_ALL |
| Allowed values |
DISABLE_ALL,ENABLE_ALL |
| Parameter type |
dynamic |
| Documentation |
postgis.gdal_enabled_drivers |
squeeze.max_xlock_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum time the processed table may be locked exclusively. The source table is locked exclusively during the final stage of processing. If the lock time should exceed this value, the lock is released and the final stage is retried a few more times. |
| Data type |
integer |
| Default value |
0 |
| Allowed values |
0 |
| Parameter type |
read-only |
| Documentation |
squeeze.max_xlock_time |
squeeze.worker_autostart
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Names of databases for which background workers start automatically. Comma-separated list for of databases which squeeze worker starts as soon as the cluster startup has completed. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
squeeze.worker_autostart |
squeeze.worker_role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Role that background workers use to connect to database. If background worker was launched automatically on cluster startup, it uses this role to initiate database connection(s). |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
squeeze.worker_role |
timescaledb.bgw_launcher_poll_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Launcher timeout value in milliseconds. Configure the time the launcher waits to look for new TimescaleDB instances. |
| Data type |
integer |
| Default value |
60000 |
| Allowed values |
60000 |
| Parameter type |
read-only |
| Documentation |
timescaledb.bgw_launcher_poll_time |
timescaledb.disable_load
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable the loading of the actual extension. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
timescaledb.disable_load |
timescaledb.max_background_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum background worker processes allocated to TimescaleDB. Max background worker processes allocated to TimescaleDB - set to at least 1 + number of databases in Postgres instance to use background workers. |
| Data type |
integer |
| Default value |
16 |
| Allowed values |
16 |
| Parameter type |
read-only |
| Documentation |
timescaledb.max_background_workers |
timescaledb_osm.disable_load
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable the loading of the actual extension. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
timescaledb_osm.disable_load |
age.enable_containment
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use @> operator to transform MATCH's filter. Otherwise, use -> operator. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
age.enable_containment |
anon.algorithm
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The hash method used for pseudonymizing functions. |
| Data type |
string |
| Default value |
sha256 |
| Allowed values |
sha256 |
| Parameter type |
read-only |
| Documentation |
anon.algorithm |
anon.k_anonymity_provider
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The security label provider used for k-anonymity. |
| Data type |
string |
| Default value |
k_anonymity |
| Allowed values |
k_anonymity |
| Parameter type |
read-only |
| Documentation |
anon.k_anonymity_provider |
anon.masking_policies
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Define multiple masking policies (NOT IMPLEMENTED YET). |
| Data type |
string |
| Default value |
anon |
| Allowed values |
anon |
| Parameter type |
read-only |
| Documentation |
anon.masking_policies |
anon.maskschema
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The schema where the dynamic masking views are stored. |
| Data type |
string |
| Default value |
mask |
| Allowed values |
mask |
| Parameter type |
read-only |
| Documentation |
anon.maskschema |
anon.privacy_by_default
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Mask all columns with NULL (or the default value for NOT NULL columns). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
anon.privacy_by_default |
anon.restrict_to_trusted_schemas
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Masking filters must be in a trusted schema. Activate this option to prevent non-superuser from using their own masking filters. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
anon.restrict_to_trusted_schemas |
anon.salt
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The salt value used for the pseudonymizing functions. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
anon.salt |
anon.sourceschema
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The schema where the table are masked by the dynamic masking engine. |
| Data type |
string |
| Default value |
public |
| Allowed values |
public |
| Parameter type |
read-only |
| Documentation |
anon.sourceschema |
anon.strict_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A masking rule cannot change a column data type, unless you disable this. Disabling the mode is not recommended. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
anon.strict_mode |
anon.transparent_dynamic_masking
| Attribute |
Value |
| Category |
Customized Options |
| Description |
New masking engine (EXPERIMENTAL). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
anon.transparent_dynamic_masking |
auto_explain.log_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN ANALYZE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_analyze |
auto_explain.log_buffers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log buffers usage. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_buffers |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
EXPLAIN format to be used for plan logging. |
| Data type |
enumeration |
| Default value |
text |
| Allowed values |
text,xml,json,yaml |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_format |
auto_explain.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log level for the plan. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,debug,info,notice,warning,log |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_level |
auto_explain.log_min_duration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the minimum execution time above which plans will be logged. Zero prints all plans. -1 turns this feature off. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_min_duration |
auto_explain.log_nested_statements
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log nested statements. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_nested_statements |
auto_explain.log_settings
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log modified configuration parameters affecting query planning. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_settings |
auto_explain.log_timing
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Collect timing data, not just row counts. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_timing |
auto_explain.log_triggers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Include trigger statistics in plans. This has no effect unless log_analyze is also set. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_triggers |
auto_explain.log_verbose
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN VERBOSE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_verbose |
auto_explain.log_wal
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log WAL usage. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_wal |
auto_explain.sample_rate
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Fraction of queries to process. |
| Data type |
numeric |
| Default value |
1.0 |
| Allowed values |
0.0-1.0 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.sample_rate |
azure.accepted_password_auth_method
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Accepted password authentication method. |
| Data type |
set |
| Default value |
md5 |
| Allowed values |
md5,scram-sha-256 |
| Parameter type |
dynamic |
| Documentation |
azure.accepted_password_auth_method |
azure_cdc.change_batch_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Buffer size, in megabytes, for change batches. These buffers are used to temporarily store CDC changes before they are written to disk. |
| Data type |
integer |
| Default value |
16 |
| Allowed values |
1-100 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.change_batch_export_timeout
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum time, in seconds, to wait before a batch of changes is ready to be exported. |
| Data type |
integer |
| Default value |
30 |
| Allowed values |
10-60 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.max_fabric_mirrors
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of parallel fabric mirrors that can be run at the same time. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
1-6 |
| Parameter type |
static |
| Documentation |
|
azure_cdc.max_snapshot_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of workers launched for snapshot export. Each worker exports one table at a time. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
0-100 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.onelake_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Buffer size, in megabytes, for upload to Onelake. Onelake uploads files in chunks, buffering the data in memory up to this limit. |
| Data type |
integer |
| Default value |
100 |
| Allowed values |
1-1024 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.parquet_compression
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Compression algorithm to use for parquet files. Determines the compression algorithm to use for parquet files. Supported values are 'uncompressed', 'snappy', 'gzip', and 'zstd'. |
| Data type |
enumeration |
| Default value |
zstd |
| Allowed values |
uncompressed,snappy,gzip,zstd |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.snapshot_buffer_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum size (in MB) of the initial snapshot buffer. Per table, up to this much data is buffered before sent to Fabric. Keep in mind that azure_cdc.snapshot_buffer_size*azure_cdc.max_snapshot_workers is the total memory buffer used during initial snapshot. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
10-4000 |
| Parameter type |
dynamic |
| Documentation |
|
azure_cdc.snapshot_export_timeout
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum time, in minutes, to wait before reporting an error when exporting a snapshot of a database. |
| Data type |
integer |
| Default value |
180 |
| Allowed values |
0-1440 |
| Parameter type |
dynamic |
| Documentation |
|
azure.enable_temp_tablespaces_on_local_ssd
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Create temp tablespace on ephemeral disk. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
azure.extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which extensions are allowed to be created in the server. |
| Data type |
set |
| Default value |
|
| Allowed values |
address_standardizer,address_standardizer_data_us,age,amcheck,anon,azure_ai,azure_storage,bloom,btree_gin,btree_gist,citext,cube,dblink,dict_int,dict_xsyn,earthdistance,fuzzystrmatch,hll,hstore,hypopg,intagg,intarray,isn,lo,login_hook,ltree,oracle_fdw,orafce,pageinspect,pg_buffercache,pg_cron,pg_freespacemap,pg_hint_plan,pg_partman,pg_prewarm,pg_repack,pg_squeeze,pg_stat_statements,pg_trgm,pg_visibility,pgaudit,pgcrypto,pglogical,pgrouting,pgrowlocks,pgstattuple,plpgsql,plv8,postgis,postgis_raster,postgis_sfcgal,postgis_tiger_geocoder,postgis_topology,postgres_fdw,postgres_protobuf,semver,session_variable,sslinfo,tablefunc,tdigest,tds_fdw,timescaledb,topn,tsm_system_rows,tsm_system_time,unaccent,uuid-ossp,vector |
| Parameter type |
dynamic |
| Documentation |
azure.extensions |
azure.fabric_mirror_enabled
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the flag indicating if mirroring is enabled on server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure.fabric_mirror_enabled |
azure.migration_copy_with_binary
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will enable the use of the binary format for copying data during migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_copy_with_binary |
azure.migration_skip_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the analyze phase (vacuumdb --analyze-only) during the migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_analyze |
azure.migration_skip_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of extensions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_extensions |
azure.migration_skip_large_objects
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of large objects such as BLOBs. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_large_objects |
azure.migration_skip_role_user
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will exclude user roles from the migration process. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_role_user |
azure.migration_table_split_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set, this parameter specifies the size at which tables will be partitioned during migration. |
| Data type |
integer |
| Default value |
20480 |
| Allowed values |
1-204800 |
| Parameter type |
dynamic |
| Documentation |
azure.migration_table_split_size |
azure.service_principal_id
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A unique identifier for a service principal in Azure, used to grant permissions and access to resources within a tenant. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
|
azure.service_principal_tenant_id
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A unique identifier for the tenant in which a service principal is created, ensuring the necessary permissions and access to resources within that tenant. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
|
azure.single_to_flex_migration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies if this is a server created for migrating from Azure Database for PostgreSQL Single Server to Flexible Server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
|
azure_storage.allow_network_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allows accessing Azure Storage Blob service from azure_storage extension. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure_storage.allow_network_access |
azure_storage.blob_block_size_mb
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Size of blob block, in megabytes, for PUT blob operations. |
| Data type |
integer |
| Default value |
Depends on resources (vCores, RAM, or disk space) allocated to the server. |
| Allowed values |
1024 |
| Parameter type |
read-only |
| Documentation |
azure_storage.blob_block_size_mb |
Azure-specific notes
The default value for the azure_storage.blob_block_size_mb server parameter is calculated when you provision the instance of Azure Database for PostgreSQL flexible server, based on the product name that you select for its compute. Any subsequent changes of product selection to the compute that supports the flexible server won't have any effect on the default value for the azure_storage.blob_block_size_mb server parameter of that instance.
As of today, if you change the product assigned to an instance, you won't be able to adjust the value of azure_storage.blob_block_size_mb parameter because the parameter is declared as read-only.
The formula used to compute the value of azure_storage.blob_block_size_mb is MIN(3072, MAX(128, memoryGiB * 32)).
Based on the previous formula, the following table lists the values this server parameter would be set to depending on the amount of memory provisioned:
| Memory size |
azure_storage.blob_block_size_mb |
| 2 GiB |
128 MiB |
| 4 GiB |
128 MiB |
| 8 GiB |
256 MiB |
| 16 GiB |
512 MiB |
| 32 GiB |
1024 MiB |
| 48 GiB |
1536 MiB |
| 64 GiB |
2048 MiB |
| 80 GiB |
2560 MiB |
| 128 GiB |
3072 MiB |
| 160 GiB |
3072 MiB |
| 192 GiB |
3072 MiB |
| 256 GiB |
3072 MiB |
| 384 GiB |
3072 MiB |
| 432 GiB |
3072 MiB |
| 672 GiB |
3072 MiB |
azure_storage.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log level used by the azure_storage extension. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,debug,log,info,notice,warning,error |
| Parameter type |
dynamic |
| Documentation |
azure_storage.log_level |
azure_storage.public_account_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allows all users to access data in storage accounts for which there are no credentials, and the storage account access is configured as public. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure_storage.public_account_access |
connection_throttle.bucket_limit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max login tokens per bucket. |
| Data type |
integer |
| Default value |
2000 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables temporary connection throttling per IP for too many login failures. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.factor_bias
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The factor bias for calculating number of tokens for an IP's bucket. |
| Data type |
numeric |
| Default value |
0.8 |
| Allowed values |
0.0-0.9 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.hash_entries_max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max number of entries in the login failures hash table. |
| Data type |
integer |
| Default value |
500 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.reset_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between resetting the login bucket. |
| Data type |
integer |
| Default value |
120 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.restore_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Factor to increase number of tokens by for IPs with low failure rate. |
| Data type |
numeric |
| Default value |
2 |
| Allowed values |
1.0-100.0 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.update_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between updating the login bucket. |
| Data type |
integer |
| Default value |
20 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
cron.database_name
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the database in which pg_cron metadata is kept. |
| Data type |
string |
| Default value |
postgres |
| Allowed values |
[A-Za-z0-9_]+ |
| Parameter type |
static |
| Documentation |
cron.database_name |
cron.enable_superuser_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allow jobs to be scheduled as superuser. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
cron.enable_superuser_jobs |
cron.host
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Hostname to connect to postgres. This setting has no effect when background workers are used. |
| Data type |
string |
| Default value |
/tmp |
| Allowed values |
/tmp |
| Parameter type |
read-only |
| Documentation |
cron.host |
cron.launch_active_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Launch jobs that are defined as active. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
cron.launch_active_jobs |
cron.log_min_messages
| Attribute |
Value |
| Category |
Customized Options |
| Description |
log_min_messages for the launcher bgworker. |
| Data type |
enumeration |
| Default value |
warning |
| Allowed values |
warning |
| Parameter type |
read-only |
| Documentation |
cron.log_min_messages |
cron.log_run
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all jobs runs into the job_run_details table. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_run |
cron.log_statement
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all cron statements prior to execution. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_statement |
cron.max_running_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of jobs that can run concurrently. This value is limited by max_connections. |
| Data type |
integer |
| Default value |
32 |
| Allowed values |
0-5000 |
| Parameter type |
static |
| Documentation |
cron.max_running_jobs |
cron.timezone
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specify timezone used for cron schedule. |
| Data type |
enumeration |
| Default value |
GMT |
| Allowed values |
GMT |
| Parameter type |
read-only |
| Documentation |
cron.timezone |
cron.use_background_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use background workers instead of client sessions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
cron.use_background_workers |
index_tuning.analysis_interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the frequency at which each index optimization session is triggered when index_tuning.mode is set to 'REPORT'. |
| Data type |
integer |
| Default value |
720 |
| Allowed values |
60-10080 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.analysis_interval |
index_tuning.max_columns_per_index
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of columns that can be part of the index key for any recommended index. |
| Data type |
integer |
| Default value |
2 |
| Allowed values |
1-10 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_columns_per_index |
index_tuning.max_index_count
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of indexes that can be recommended for each database during one optimization session. |
| Data type |
integer |
| Default value |
10 |
| Allowed values |
1-25 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_index_count |
index_tuning.max_indexes_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of indexes that can be recommended for each table. |
| Data type |
integer |
| Default value |
10 |
| Allowed values |
1-25 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_indexes_per_table |
index_tuning.max_queries_per_database
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of slowest queries per database for which indexes can be recommended. |
| Data type |
integer |
| Default value |
25 |
| Allowed values |
5-100 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_queries_per_database |
index_tuning.max_regression_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Acceptable regression introduced by a recommended index on any of the queries analyzed during one optimization session. |
| Data type |
numeric |
| Default value |
0.1 |
| Allowed values |
0.05-0.2 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_regression_factor |
index_tuning.max_total_size_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum total size, in percentage of total disk space, that all recommended indexes for any given database can use. |
| Data type |
numeric |
| Default value |
0.1 |
| Allowed values |
0-1.0 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_total_size_factor |
index_tuning.min_improvement_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Cost improvement that a recommended index must provide to at least one of the queries analyzed during one optimization session. |
| Data type |
numeric |
| Default value |
0.2 |
| Allowed values |
0-20.0 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.min_improvement_factor |
index_tuning.mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Configures index optimization as disabled ('OFF') or enabled to only emit recommendation. Requires Query Store to be enabled by setting pg_qs.query_capture_mode to 'TOP' or 'ALL'. |
| Data type |
enumeration |
| Default value |
off |
| Allowed values |
off,report |
| Parameter type |
dynamic |
| Documentation |
index_tuning.mode |
index_tuning.unused_dml_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of daily average DML operations affecting the table, so that their unused indexes are considered for dropping. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
0-9999999 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_dml_per_table |
index_tuning.unused_min_period
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of days the index has not been used, based on system statistics, so that it is considered for dropping. |
| Data type |
integer |
| Default value |
35 |
| Allowed values |
30-720 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_min_period |
index_tuning.unused_reads_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of daily average read operations affecting the table, so that their unused indexes are considered for dropping. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
0-9999999 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_reads_per_table |
logfiles.download_enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables or disables server logs functionality. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
logfiles.download_enable |
logfiles.retention_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for server logs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
1-7 |
| Parameter type |
dynamic |
| Documentation |
logfiles.retention_days |
pgaadauth.enable_group_sync
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables synchronization of Entra ID group members. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
pgaudit.log
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which classes of statements will be logged by session audit logging. |
| Data type |
set |
| Default value |
none |
| Allowed values |
none,read,write,function,role,ddl,misc,all |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log |
pgaudit.log_catalog
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_catalog |
pgaudit.log_client
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether audit messages should be visible to client. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_client |
pgaudit.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the log level that will be used for log entries. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,log |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_level |
pgaudit.log_parameter
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that audit logging should include the parameters that were passed with the statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_parameter |
pgaudit.log_relation
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether session audit logging should create a separate log entry for each relation referenced in a SELECT or DML statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_relation |
pgaudit.log_statement_once
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_statement_once |
pgaudit.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the master role to use for object audit logging. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pgaudit.role |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
whether to drop extra slots on standby that don't match pg_failover_slots.synchronize_slot_names. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.drop_extra_slots |
pg_failover_slots.primary_dsn
| Attribute |
Value |
| Category |
Customized Options |
| Description |
connection string to the primary server for synchronization logical slots on standby. if empty, uses the defaults to primary_conninfo. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.primary_dsn |
pg_failover_slots.standby_slot_names
| Attribute |
Value |
| Category |
Customized Options |
| Description |
list of names of slot that must confirm changes before they're sent by the decoding plugin. List of physical replication slots that must confirm durable flush of a given lsn before commits up to that lsn may be replicated to logical peers by the output plugin. Imposes ordering of physical replication before logical replication. |
| Data type |
string |
| Default value |
azure_standby_, wal_replica_ |
| Allowed values |
azure_standby_, wal_replica_ |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.standby_slot_names |
pg_failover_slots.standby_slots_min_confirmed
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of slots from pg_failover_slots.standby_slot_names that must confirm lsn. Modifies behaviour of pg_failover_slots.standby_slot_names so to allow logical replication of a transaction after at least pg_failover_slots.standby_slots_min_confirmed physical peers have confirmed the transaction as durably flushed. The value -1 (default) means all entries in pg_failover_slots.standby_slot_namesmust confirm the write. The value 0 causes pg_failover_slots.standby_slots_min_confirmedto be effectively ignored. |
| Data type |
integer |
| Default value |
1 |
| Allowed values |
1 |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.standby_slots_min_confirmed |
pg_failover_slots.synchronize_slot_names
| Attribute |
Value |
| Category |
Customized Options |
| Description |
list of slots to synchronize from primary to physical standby. |
| Data type |
string |
| Default value |
name_like:%% |
| Allowed values |
name_like:%% |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.synchronize_slot_names |
pg_failover_slots.version
| Attribute |
Value |
| Category |
Customized Options |
| Description |
pg_failover_slots module version. |
| Data type |
string |
| Default value |
1.0.1 |
| Allowed values |
1.0.1 |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.version |
pg_failover_slots.wait_for_inactive_slots
| Attribute |
Value |
| Category |
Customized Options |
| Description |
whether to wait for an inactive replication slots on primary to catchup with standby. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.wait_for_inactive_slots |
pg_hint_plan.debug_print
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Logs results of hint parsing. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.debug_print |
pg_hint_plan.enable_hint
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Force planner to use plans specified in the hint comment preceding to the query. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.enable_hint |
pg_hint_plan.enable_hint_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Let pg_hint_plan look up the hint table. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.enable_hint_table |
pg_hint_plan.hints_anywhere
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Read hints from anywhere in a query. This option lets pg_hint_plan ignore syntax so be cautious for false reads. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.hints_anywhere |
pg_hint_plan.message_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Message level of debug messages. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
log |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.message_level |
pg_hint_plan.parse_messages
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Message level of parse errors. |
| Data type |
enumeration |
| Default value |
info |
| Allowed values |
info |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.parse_messages |
pglogical.batch_inserts
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use batch insert mechanism if possible. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.batch_inserts |
pglogical.conflict_log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the log level for reporting detected conflicts when the pglogical.conflict_resolution is set to anything else than error. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_log_level |
pglogical.conflict_resolution
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the resolution method for any detected conflicts between local data and incoming changes. |
| Data type |
enumeration |
| Default value |
apply_remote |
| Allowed values |
error,apply_remote,keep_local,last_update_wins,first_update_wins |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_resolution |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
connection options to add to all peer node connections. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pglogical.extra_connection_options |
pglogical.synchronous_commit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
pglogical specific synchronous commit value. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pglogical.synchronous_commit |
pglogical.temp_directory
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Directory to store dumps for local restore. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pglogical.temp_directory |
pglogical.use_spi
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use SPI interface to form actual SQL (INSERT, UPDATE, DELETE) statements to apply incoming changes instead of using internal low level interface. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.use_spi |
pgms_stats.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
|
pgms_wait_sampling.history_period
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type |
integer |
| Default value |
100 |
| Allowed values |
1-600000 |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
all,none |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.query_capture_mode |
pg_partman_bgw.analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_analyze argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.analyze |
pg_partman_bgw.dbname
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Required. The database(s) that run_maintenance() will run on. If more than one, use a comma separated list. If not set, BGW will do nothing. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z0-9_,-]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.dbname |
pg_partman_bgw.interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of seconds between calls to run_maintenance(). |
| Data type |
integer |
| Default value |
3600 |
| Allowed values |
1-315360000 |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.interval |
pg_partman_bgw.jobmon
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_jobmon argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.jobmon |
pg_partman_bgw.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The role that run_maintenance() will run as. Default is postgres. Only a single role name is allowed. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.role |
pg_prewarm.autoprewarm
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Starts the autoprewarm worker. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_prewarm.autoprewarm |
pg_prewarm.autoprewarm_interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the interval between dumps of shared buffers. If set to zero, time-based dumping is disabled. |
| Data type |
integer |
| Default value |
300 |
| Allowed values |
300 |
| Parameter type |
read-only |
| Documentation |
pg_prewarm.autoprewarm_interval |
pg_qs.interval_length_minutes
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type |
integer |
| Default value |
15 |
| Allowed values |
1-30 |
| Parameter type |
static |
| Documentation |
pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_qs.is_enabled_fs |
pg_qs.max_plan_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type |
integer |
| Default value |
7500 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type |
integer |
| Default value |
6000 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Whether and when to capture query positional parameters. |
| Data type |
enumeration |
| Default value |
capture_parameterless_only |
| Allowed values |
capture_parameterless_only,capture_first_sample |
| Parameter type |
dynamic |
| Documentation |
pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets query capture mode for query store. None disables any capturing. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
7 |
| Allowed values |
1-30 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Turns saving query plans on or off for pg_qs |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_qs. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.track_utility |
pg_stat_statements.max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of statements tracked by pg_stat_statements. |
| Data type |
integer |
| Default value |
5000 |
| Allowed values |
100-2147483647 |
| Parameter type |
static |
| Documentation |
pg_stat_statements.max |
pg_stat_statements.save
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Save pg_stat_statements statistics across server shutdowns. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.save |
pg_stat_statements.track
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls which statements are counted by pg_stat_statements. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track |
pg_stat_statements.track_planning
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether planning duration is tracked by pg_stat_statements. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track_planning |
pg_stat_statements.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_stat_statements. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track_utility |
postgis.gdal_enabled_drivers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls postgis GDAL enabled driver settings. |
| Data type |
enumeration |
| Default value |
DISABLE_ALL |
| Allowed values |
DISABLE_ALL,ENABLE_ALL |
| Parameter type |
dynamic |
| Documentation |
postgis.gdal_enabled_drivers |
squeeze.max_xlock_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum time the processed table may be locked exclusively. The source table is locked exclusively during the final stage of processing. If the lock time should exceed this value, the lock is released and the final stage is retried a few more times. |
| Data type |
integer |
| Default value |
0 |
| Allowed values |
0 |
| Parameter type |
read-only |
| Documentation |
squeeze.max_xlock_time |
squeeze.worker_autostart
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Names of databases for which background workers start automatically. Comma-separated list for of databases which squeeze worker starts as soon as the cluster startup has completed. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
squeeze.worker_autostart |
squeeze.worker_role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Role that background workers use to connect to database. If background worker was launched automatically on cluster startup, it uses this role to initiate database connection(s). |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
squeeze.worker_role |
timescaledb.bgw_launcher_poll_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Launcher timeout value in milliseconds. Configure the time the launcher waits to look for new TimescaleDB instances. |
| Data type |
integer |
| Default value |
60000 |
| Allowed values |
60000 |
| Parameter type |
read-only |
| Documentation |
timescaledb.bgw_launcher_poll_time |
timescaledb.disable_load
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable the loading of the actual extension. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
timescaledb.disable_load |
timescaledb.max_background_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum background worker processes allocated to TimescaleDB. Max background worker processes allocated to TimescaleDB - set to at least 1 + number of databases in Postgres instance to use background workers. |
| Data type |
integer |
| Default value |
16 |
| Allowed values |
16 |
| Parameter type |
read-only |
| Documentation |
timescaledb.max_background_workers |
timescaledb_osm.disable_load
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable the loading of the actual extension. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
timescaledb_osm.disable_load |
anon.algorithm
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The hash method used for pseudonymizing functions. |
| Data type |
string |
| Default value |
sha256 |
| Allowed values |
sha256 |
| Parameter type |
read-only |
| Documentation |
anon.algorithm |
anon.k_anonymity_provider
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The security label provider used for k-anonymity. |
| Data type |
string |
| Default value |
k_anonymity |
| Allowed values |
k_anonymity |
| Parameter type |
read-only |
| Documentation |
anon.k_anonymity_provider |
anon.masking_policies
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Define multiple masking policies (NOT IMPLEMENTED YET). |
| Data type |
string |
| Default value |
anon |
| Allowed values |
anon |
| Parameter type |
read-only |
| Documentation |
anon.masking_policies |
anon.maskschema
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The schema where the dynamic masking views are stored. |
| Data type |
string |
| Default value |
mask |
| Allowed values |
mask |
| Parameter type |
read-only |
| Documentation |
anon.maskschema |
anon.privacy_by_default
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Mask all columns with NULL (or the default value for NOT NULL columns). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
anon.privacy_by_default |
anon.restrict_to_trusted_schemas
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Masking filters must be in a trusted schema. Activate this option to prevent non-superuser from using their own masking filters. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
anon.restrict_to_trusted_schemas |
anon.salt
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The salt value used for the pseudonymizing functions. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
anon.salt |
anon.sourceschema
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The schema where the table are masked by the dynamic masking engine. |
| Data type |
string |
| Default value |
public |
| Allowed values |
public |
| Parameter type |
read-only |
| Documentation |
anon.sourceschema |
anon.strict_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
A masking rule cannot change a column data type, unless you disable this. Disabling the mode is not recommended. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
anon.strict_mode |
anon.transparent_dynamic_masking
| Attribute |
Value |
| Category |
Customized Options |
| Description |
New masking engine (EXPERIMENTAL). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
anon.transparent_dynamic_masking |
auto_explain.log_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN ANALYZE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_analyze |
auto_explain.log_buffers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log buffers usage. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_buffers |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
EXPLAIN format to be used for plan logging. |
| Data type |
enumeration |
| Default value |
text |
| Allowed values |
text,xml,json,yaml |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_format |
auto_explain.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log level for the plan. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,debug,info,notice,warning,log |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_level |
auto_explain.log_min_duration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the minimum execution time above which plans will be logged. Zero prints all plans. -1 turns this feature off. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_min_duration |
auto_explain.log_nested_statements
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log nested statements. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_nested_statements |
auto_explain.log_settings
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log modified configuration parameters affecting query planning. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_settings |
auto_explain.log_timing
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Collect timing data, not just row counts. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_timing |
auto_explain.log_triggers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Include trigger statistics in plans. This has no effect unless log_analyze is also set. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_triggers |
auto_explain.log_verbose
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN VERBOSE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_verbose |
auto_explain.sample_rate
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Fraction of queries to process. |
| Data type |
numeric |
| Default value |
1.0 |
| Allowed values |
0.0-1.0 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.sample_rate |
azure.accepted_password_auth_method
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Accepted password authentication method. |
| Data type |
set |
| Default value |
md5 |
| Allowed values |
md5,scram-sha-256 |
| Parameter type |
dynamic |
| Documentation |
azure.accepted_password_auth_method |
azure.enable_temp_tablespaces_on_local_ssd
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Create temp tablespace on ephemeral disk. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
azure.extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which extensions are allowed to be created in the server. |
| Data type |
set |
| Default value |
|
| Allowed values |
address_standardizer,address_standardizer_data_us,amcheck,anon,azure_ai,azure_storage,bloom,btree_gin,btree_gist,citext,cube,dblink,dict_int,dict_xsyn,earthdistance,fuzzystrmatch,hll,hstore,hypopg,intagg,intarray,isn,lo,login_hook,ltree,oracle_fdw,orafce,pageinspect,pg_buffercache,pg_cron,pg_freespacemap,pg_hint_plan,pg_partman,pg_prewarm,pg_repack,pg_squeeze,pg_stat_statements,pg_trgm,pg_visibility,pgaudit,pgcrypto,pglogical,pgrouting,pgrowlocks,pgstattuple,plpgsql,plv8,postgis,postgis_raster,postgis_sfcgal,postgis_tiger_geocoder,postgis_topology,postgres_fdw,postgres_protobuf,semver,session_variable,sslinfo,tablefunc,tdigest,tds_fdw,timescaledb,tsm_system_rows,tsm_system_time,unaccent,uuid-ossp,vector |
| Parameter type |
dynamic |
| Documentation |
azure.extensions |
azure.migration_copy_with_binary
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will enable the use of the binary format for copying data during migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_copy_with_binary |
azure.migration_skip_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the analyze phase (vacuumdb --analyze-only) during the migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_analyze |
azure.migration_skip_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of extensions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_extensions |
azure.migration_skip_large_objects
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of large objects such as BLOBs. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_large_objects |
azure.migration_skip_role_user
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will exclude user roles from the migration process. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_role_user |
azure.migration_table_split_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set, this parameter specifies the size at which tables will be partitioned during migration. |
| Data type |
integer |
| Default value |
20480 |
| Allowed values |
1-204800 |
| Parameter type |
dynamic |
| Documentation |
azure.migration_table_split_size |
azure.single_to_flex_migration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies if this is a server created for migrating from Azure Database for PostgreSQL Single Server to Flexible Server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
|
azure_storage.allow_network_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allows accessing Azure Storage Blob service from azure_storage extension. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure_storage.allow_network_access |
azure_storage.blob_block_size_mb
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Size of blob block, in megabytes, for PUT blob operations. |
| Data type |
integer |
| Default value |
Depends on resources (vCores, RAM, or disk space) allocated to the server. |
| Allowed values |
1024 |
| Parameter type |
read-only |
| Documentation |
azure_storage.blob_block_size_mb |
Azure-specific notes
The default value for the azure_storage.blob_block_size_mb server parameter is calculated when you provision the instance of Azure Database for PostgreSQL flexible server, based on the product name that you select for its compute. Any subsequent changes of product selection to the compute that supports the flexible server won't have any effect on the default value for the azure_storage.blob_block_size_mb server parameter of that instance.
As of today, if you change the product assigned to an instance, you won't be able to adjust the value of azure_storage.blob_block_size_mb parameter because the parameter is declared as read-only.
The formula used to compute the value of azure_storage.blob_block_size_mb is MIN(3072, MAX(128, memoryGiB * 32)).
Based on the previous formula, the following table lists the values this server parameter would be set to depending on the amount of memory provisioned:
| Memory size |
azure_storage.blob_block_size_mb |
| 2 GiB |
128 MiB |
| 4 GiB |
128 MiB |
| 8 GiB |
256 MiB |
| 16 GiB |
512 MiB |
| 32 GiB |
1024 MiB |
| 48 GiB |
1536 MiB |
| 64 GiB |
2048 MiB |
| 80 GiB |
2560 MiB |
| 128 GiB |
3072 MiB |
| 160 GiB |
3072 MiB |
| 192 GiB |
3072 MiB |
| 256 GiB |
3072 MiB |
| 384 GiB |
3072 MiB |
| 432 GiB |
3072 MiB |
| 672 GiB |
3072 MiB |
azure_storage.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log level used by the azure_storage extension. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,debug,log,info,notice,warning,error |
| Parameter type |
dynamic |
| Documentation |
azure_storage.log_level |
azure_storage.public_account_access
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allows all users to access data in storage accounts for which there are no credentials, and the storage account access is configured as public. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
azure_storage.public_account_access |
connection_throttle.bucket_limit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max login tokens per bucket. |
| Data type |
integer |
| Default value |
2000 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables temporary connection throttling per IP for too many login failures. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.factor_bias
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The factor bias for calculating number of tokens for an IP's bucket. |
| Data type |
numeric |
| Default value |
0.8 |
| Allowed values |
0.0-0.9 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.hash_entries_max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max number of entries in the login failures hash table. |
| Data type |
integer |
| Default value |
500 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.reset_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between resetting the login bucket. |
| Data type |
integer |
| Default value |
120 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.restore_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Factor to increase number of tokens by for IPs with low failure rate. |
| Data type |
numeric |
| Default value |
2 |
| Allowed values |
1.0-100.0 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.update_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between updating the login bucket. |
| Data type |
integer |
| Default value |
20 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
cron.database_name
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the database in which pg_cron metadata is kept. |
| Data type |
string |
| Default value |
postgres |
| Allowed values |
[A-Za-z0-9_]+ |
| Parameter type |
static |
| Documentation |
cron.database_name |
cron.enable_superuser_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Allow jobs to be scheduled as superuser. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
cron.enable_superuser_jobs |
cron.host
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Hostname to connect to postgres. This setting has no effect when background workers are used. |
| Data type |
string |
| Default value |
/tmp |
| Allowed values |
/tmp |
| Parameter type |
read-only |
| Documentation |
cron.host |
cron.launch_active_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Launch jobs that are defined as active. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
cron.launch_active_jobs |
cron.log_min_messages
| Attribute |
Value |
| Category |
Customized Options |
| Description |
log_min_messages for the launcher bgworker. |
| Data type |
enumeration |
| Default value |
warning |
| Allowed values |
warning |
| Parameter type |
read-only |
| Documentation |
cron.log_min_messages |
cron.log_run
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all jobs runs into the job_run_details table. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_run |
cron.log_statement
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all cron statements prior to execution. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_statement |
cron.max_running_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of jobs that can run concurrently. This value is limited by max_connections. |
| Data type |
integer |
| Default value |
32 |
| Allowed values |
0-5000 |
| Parameter type |
static |
| Documentation |
cron.max_running_jobs |
cron.timezone
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specify timezone used for cron schedule. |
| Data type |
enumeration |
| Default value |
GMT |
| Allowed values |
GMT |
| Parameter type |
read-only |
| Documentation |
cron.timezone |
cron.use_background_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use background workers instead of client sessions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
cron.use_background_workers |
index_tuning.analysis_interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the frequency at which each index optimization session is triggered when index_tuning.mode is set to 'REPORT'. |
| Data type |
integer |
| Default value |
720 |
| Allowed values |
60-10080 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.analysis_interval |
index_tuning.max_columns_per_index
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of columns that can be part of the index key for any recommended index. |
| Data type |
integer |
| Default value |
2 |
| Allowed values |
1-10 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_columns_per_index |
index_tuning.max_index_count
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of indexes that can be recommended for each database during one optimization session. |
| Data type |
integer |
| Default value |
10 |
| Allowed values |
1-25 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_index_count |
index_tuning.max_indexes_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum number of indexes that can be recommended for each table. |
| Data type |
integer |
| Default value |
10 |
| Allowed values |
1-25 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_indexes_per_table |
index_tuning.max_queries_per_database
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of slowest queries per database for which indexes can be recommended. |
| Data type |
integer |
| Default value |
25 |
| Allowed values |
5-100 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_queries_per_database |
index_tuning.max_regression_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Acceptable regression introduced by a recommended index on any of the queries analyzed during one optimization session. |
| Data type |
numeric |
| Default value |
0.1 |
| Allowed values |
0.05-0.2 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_regression_factor |
index_tuning.max_total_size_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum total size, in percentage of total disk space, that all recommended indexes for any given database can use. |
| Data type |
numeric |
| Default value |
0.1 |
| Allowed values |
0-1.0 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.max_total_size_factor |
index_tuning.min_improvement_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Cost improvement that a recommended index must provide to at least one of the queries analyzed during one optimization session. |
| Data type |
numeric |
| Default value |
0.2 |
| Allowed values |
0-20.0 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.min_improvement_factor |
index_tuning.mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Configures index optimization as disabled ('OFF') or enabled to only emit recommendation. Requires Query Store to be enabled by setting pg_qs.query_capture_mode to 'TOP' or 'ALL'. |
| Data type |
enumeration |
| Default value |
off |
| Allowed values |
off,report |
| Parameter type |
dynamic |
| Documentation |
index_tuning.mode |
index_tuning.unused_dml_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of daily average DML operations affecting the table, so that their unused indexes are considered for dropping. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
0-9999999 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_dml_per_table |
index_tuning.unused_min_period
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of days the index has not been used, based on system statistics, so that it is considered for dropping. |
| Data type |
integer |
| Default value |
35 |
| Allowed values |
30-720 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_min_period |
index_tuning.unused_reads_per_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Minimum number of daily average read operations affecting the table, so that their unused indexes are considered for dropping. |
| Data type |
integer |
| Default value |
1000 |
| Allowed values |
0-9999999 |
| Parameter type |
dynamic |
| Documentation |
index_tuning.unused_reads_per_table |
logfiles.download_enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables or disables server logs functionality. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
logfiles.download_enable |
logfiles.retention_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for server logs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
1-7 |
| Parameter type |
dynamic |
| Documentation |
logfiles.retention_days |
pgaadauth.enable_group_sync
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables synchronization of Entra ID group members. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
pgaudit.log
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which classes of statements will be logged by session audit logging. |
| Data type |
set |
| Default value |
none |
| Allowed values |
none,read,write,function,role,ddl,misc,all |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log |
pgaudit.log_catalog
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_catalog |
pgaudit.log_client
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether audit messages should be visible to client. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_client |
pgaudit.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the log level that will be used for log entries. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,log |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_level |
pgaudit.log_parameter
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that audit logging should include the parameters that were passed with the statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_parameter |
pgaudit.log_relation
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether session audit logging should create a separate log entry for each relation referenced in a SELECT or DML statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_relation |
pgaudit.log_statement_once
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_statement_once |
pgaudit.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the master role to use for object audit logging. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pgaudit.role |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
whether to drop extra slots on standby that don't match pg_failover_slots.synchronize_slot_names. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.drop_extra_slots |
pg_failover_slots.primary_dsn
| Attribute |
Value |
| Category |
Customized Options |
| Description |
connection string to the primary server for synchronization logical slots on standby. if empty, uses the defaults to primary_conninfo. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.primary_dsn |
pg_failover_slots.standby_slot_names
| Attribute |
Value |
| Category |
Customized Options |
| Description |
list of names of slot that must confirm changes before they're sent by the decoding plugin. List of physical replication slots that must confirm durable flush of a given lsn before commits up to that lsn may be replicated to logical peers by the output plugin. Imposes ordering of physical replication before logical replication. |
| Data type |
string |
| Default value |
azure_standby_, wal_replica_ |
| Allowed values |
azure_standby_, wal_replica_ |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.standby_slot_names |
pg_failover_slots.standby_slots_min_confirmed
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of slots from pg_failover_slots.standby_slot_names that must confirm lsn. Modifies behaviour of pg_failover_slots.standby_slot_names so to allow logical replication of a transaction after at least pg_failover_slots.standby_slots_min_confirmed physical peers have confirmed the transaction as durably flushed. The value -1 (default) means all entries in pg_failover_slots.standby_slot_namesmust confirm the write. The value 0 causes pg_failover_slots.standby_slots_min_confirmedto be effectively ignored. |
| Data type |
integer |
| Default value |
1 |
| Allowed values |
1 |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.standby_slots_min_confirmed |
pg_failover_slots.synchronize_slot_names
| Attribute |
Value |
| Category |
Customized Options |
| Description |
list of slots to synchronize from primary to physical standby. |
| Data type |
string |
| Default value |
name_like:%% |
| Allowed values |
name_like:%% |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.synchronize_slot_names |
pg_failover_slots.version
| Attribute |
Value |
| Category |
Customized Options |
| Description |
pg_failover_slots module version. |
| Data type |
string |
| Default value |
1.0.1 |
| Allowed values |
1.0.1 |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.version |
pg_failover_slots.wait_for_inactive_slots
| Attribute |
Value |
| Category |
Customized Options |
| Description |
whether to wait for an inactive replication slots on primary to catchup with standby. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_failover_slots.wait_for_inactive_slots |
pg_hint_plan.debug_print
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Logs results of hint parsing. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.debug_print |
pg_hint_plan.enable_hint
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Force planner to use plans specified in the hint comment preceding to the query. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.enable_hint |
pg_hint_plan.enable_hint_table
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Let pg_hint_plan look up the hint table. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.enable_hint_table |
pg_hint_plan.message_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Message level of debug messages. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
log |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.message_level |
pg_hint_plan.parse_messages
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Message level of parse errors. |
| Data type |
enumeration |
| Default value |
info |
| Allowed values |
info |
| Parameter type |
read-only |
| Documentation |
pg_hint_plan.parse_messages |
pglogical.batch_inserts
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use batch insert mechanism if possible. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.batch_inserts |
pglogical.conflict_log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the log level for reporting detected conflicts when the pglogical.conflict_resolution is set to anything else than error. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_log_level |
pglogical.conflict_resolution
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the resolution method for any detected conflicts between local data and incoming changes. |
| Data type |
enumeration |
| Default value |
apply_remote |
| Allowed values |
error,apply_remote,keep_local,last_update_wins,first_update_wins |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_resolution |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
connection options to add to all peer node connections. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pglogical.extra_connection_options |
pglogical.synchronous_commit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
pglogical specific synchronous commit value. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
pglogical.synchronous_commit |
pglogical.temp_directory
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Directory to store dumps for local restore. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
pglogical.temp_directory |
pglogical.use_spi
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use SPI interface to form actual SQL (INSERT, UPDATE, DELETE) statements to apply incoming changes instead of using internal low level interface. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.use_spi |
pgms_stats.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
|
pgms_wait_sampling.history_period
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type |
integer |
| Default value |
100 |
| Allowed values |
1-600000 |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
all,none |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.query_capture_mode |
pg_partman_bgw.analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_analyze argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.analyze |
pg_partman_bgw.dbname
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Required. The database(s) that run_maintenance() will run on. If more than one, use a comma separated list. If not set, BGW will do nothing. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z0-9_,-]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.dbname |
pg_partman_bgw.interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of seconds between calls to run_maintenance(). |
| Data type |
integer |
| Default value |
3600 |
| Allowed values |
1-315360000 |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.interval |
pg_partman_bgw.jobmon
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_jobmon argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.jobmon |
pg_partman_bgw.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The role that run_maintenance() will run as. Default is postgres. Only a single role name is allowed. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.role |
pg_prewarm.autoprewarm
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Starts the autoprewarm worker. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_prewarm.autoprewarm |
pg_prewarm.autoprewarm_interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the interval between dumps of shared buffers. If set to zero, time-based dumping is disabled. |
| Data type |
integer |
| Default value |
300 |
| Allowed values |
300 |
| Parameter type |
read-only |
| Documentation |
pg_prewarm.autoprewarm_interval |
pg_qs.interval_length_minutes
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type |
integer |
| Default value |
15 |
| Allowed values |
1-30 |
| Parameter type |
static |
| Documentation |
pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_qs.is_enabled_fs |
pg_qs.max_plan_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type |
integer |
| Default value |
7500 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type |
integer |
| Default value |
6000 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Whether and when to capture query positional parameters. |
| Data type |
enumeration |
| Default value |
capture_parameterless_only |
| Allowed values |
capture_parameterless_only,capture_first_sample |
| Parameter type |
dynamic |
| Documentation |
pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets query capture mode for query store. None disables any capturing. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
7 |
| Allowed values |
1-30 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Turns saving query plans on or off for pg_qs |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_qs. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.track_utility |
pg_stat_statements.max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of statements tracked by pg_stat_statements. |
| Data type |
integer |
| Default value |
5000 |
| Allowed values |
100-2147483647 |
| Parameter type |
static |
| Documentation |
pg_stat_statements.max |
pg_stat_statements.save
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Save pg_stat_statements statistics across server shutdowns. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.save |
pg_stat_statements.track
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls which statements are counted by pg_stat_statements. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track |
pg_stat_statements.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_stat_statements. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track_utility |
postgis.gdal_enabled_drivers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls postgis GDAL enabled driver settings. |
| Data type |
enumeration |
| Default value |
DISABLE_ALL |
| Allowed values |
DISABLE_ALL,ENABLE_ALL |
| Parameter type |
dynamic |
| Documentation |
postgis.gdal_enabled_drivers |
squeeze.max_xlock_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The maximum time the processed table may be locked exclusively. The source table is locked exclusively during the final stage of processing. If the lock time should exceed this value, the lock is released and the final stage is retried a few more times. |
| Data type |
integer |
| Default value |
0 |
| Allowed values |
0 |
| Parameter type |
read-only |
| Documentation |
squeeze.max_xlock_time |
squeeze.worker_autostart
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Names of databases for which background workers start automatically. Comma-separated list for of databases which squeeze worker starts as soon as the cluster startup has completed. |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
squeeze.worker_autostart |
squeeze.worker_role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Role that background workers use to connect to database. If background worker was launched automatically on cluster startup, it uses this role to initiate database connection(s). |
| Data type |
string |
| Default value |
|
| Allowed values |
|
| Parameter type |
read-only |
| Documentation |
squeeze.worker_role |
timescaledb.bgw_launcher_poll_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Launcher timeout value in milliseconds. Configure the time the launcher waits to look for new TimescaleDB instances. |
| Data type |
integer |
| Default value |
60000 |
| Allowed values |
60000 |
| Parameter type |
read-only |
| Documentation |
timescaledb.bgw_launcher_poll_time |
timescaledb.disable_load
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Disable the loading of the actual extension. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
timescaledb.disable_load |
timescaledb.max_background_workers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Maximum background worker processes allocated to TimescaleDB. Max background worker processes allocated to TimescaleDB - set to at least 1 + number of databases in Postgres instance to use background workers. |
| Data type |
integer |
| Default value |
16 |
| Allowed values |
16 |
| Parameter type |
read-only |
| Documentation |
timescaledb.max_background_workers |
auto_explain.log_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN ANALYZE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_analyze |
auto_explain.log_buffers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log buffers usage. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_buffers |
| Attribute |
Value |
| Category |
Customized Options |
| Description |
EXPLAIN format to be used for plan logging. |
| Data type |
enumeration |
| Default value |
text |
| Allowed values |
text,xml,json,yaml |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_format |
auto_explain.log_min_duration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the minimum execution time above which plans will be logged. Zero prints all plans. -1 turns this feature off. |
| Data type |
integer |
| Default value |
-1 |
| Allowed values |
-1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_min_duration |
auto_explain.log_nested_statements
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log nested statements. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_nested_statements |
auto_explain.log_timing
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Collect timing data, not just row counts. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_timing |
auto_explain.log_triggers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Include trigger statistics in plans. This has no effect unless log_analyze is also set. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_triggers |
auto_explain.log_verbose
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Use EXPLAIN VERBOSE for plan logging. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
auto_explain.log_verbose |
auto_explain.sample_rate
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Fraction of queries to process. |
| Data type |
numeric |
| Default value |
1.0 |
| Allowed values |
0.0-1.0 |
| Parameter type |
dynamic |
| Documentation |
auto_explain.sample_rate |
azure.accepted_password_auth_method
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Accepted password authentication method. |
| Data type |
set |
| Default value |
md5 |
| Allowed values |
md5,scram-sha-256 |
| Parameter type |
dynamic |
| Documentation |
azure.accepted_password_auth_method |
azure.allow_hostname_in_username
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies if hostname is allowed in the username for Azure Database for PostgreSQL flexible server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
|
azure.enable_temp_tablespaces_on_local_ssd
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Create temp tablespace on ephemeral disk. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
azure.extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which extensions are allowed to be created in the server. |
| Data type |
set |
| Default value |
|
| Allowed values |
address_standardizer,address_standardizer_data_us,amcheck,anon,bloom,btree_gin,btree_gist,citext,cube,dblink,dict_int,dict_xsyn,earthdistance,fuzzystrmatch,hstore,hypopg,intagg,intarray,isn,lo,login_hook,ltree,orafce,pageinspect,pg_buffercache,pg_cron,pg_freespacemap,pg_hint_plan,pg_partman,pg_prewarm,pg_repack,pg_squeeze,pg_stat_statements,pg_trgm,pg_visibility,pgaudit,pgcrypto,pglogical,pgrouting,pgrowlocks,pgstattuple,plpgsql,plv8,postgis,postgis_raster,postgis_sfcgal,postgis_tiger_geocoder,postgis_topology,postgres_fdw,semver,session_variable,sslinfo,tablefunc,tds_fdw,timescaledb,tsm_system_rows,tsm_system_time,unaccent,uuid-ossp,vector |
| Parameter type |
dynamic |
| Documentation |
azure.extensions |
azure.migration_copy_with_binary
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will enable the use of the binary format for copying data during migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_copy_with_binary |
azure.migration_skip_analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the analyze phase (vacuumdb --analyze-only) during the migration. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_analyze |
azure.migration_skip_extensions
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of extensions. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_extensions |
azure.migration_skip_large_objects
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will skip the migration of large objects such as BLOBs. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_large_objects |
azure.migration_skip_role_user
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set to on, this parameter will exclude user roles from the migration process. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on, off |
| Parameter type |
dynamic |
| Documentation |
azure.migration_skip_role_user |
azure.migration_table_split_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
When set, this parameter specifies the size at which tables will be partitioned during migration. |
| Data type |
integer |
| Default value |
20480 |
| Allowed values |
1-204800 |
| Parameter type |
dynamic |
| Documentation |
azure.migration_table_split_size |
azure.single_to_flex_migration
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies if this is a server created for migrating from Azure Database for PostgreSQL Single Server to Flexible Server. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
off |
| Parameter type |
read-only |
| Documentation |
|
connection_throttle.bucket_limit
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max login tokens per bucket. |
| Data type |
integer |
| Default value |
2000 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables temporary connection throttling per IP for too many login failures. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.factor_bias
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The factor bias for calculating number of tokens for an IP's bucket. |
| Data type |
numeric |
| Default value |
0.8 |
| Allowed values |
0.0-0.9 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.hash_entries_max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Max number of entries in the login failures hash table. |
| Data type |
integer |
| Default value |
500 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.reset_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between resetting the login bucket. |
| Data type |
integer |
| Default value |
120 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.restore_factor
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Factor to increase number of tokens by for IPs with low failure rate. |
| Data type |
numeric |
| Default value |
2 |
| Allowed values |
1.0-100.0 |
| Parameter type |
dynamic |
| Documentation |
|
connection_throttle.update_time
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Time between updating the login bucket. |
| Data type |
integer |
| Default value |
20 |
| Allowed values |
1-2147483647 |
| Parameter type |
dynamic |
| Documentation |
|
cron.database_name
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the database in which pg_cron metadata is kept. |
| Data type |
string |
| Default value |
postgres |
| Allowed values |
[A-Za-z0-9_]+ |
| Parameter type |
static |
| Documentation |
cron.database_name |
cron.log_run
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all jobs runs into the job_run_details table. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_run |
cron.log_statement
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Log all cron statements prior to execution. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
static |
| Documentation |
cron.log_statement |
cron.max_running_jobs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of jobs that can run concurrently. This value is limited by max_connections. |
| Data type |
integer |
| Default value |
32 |
| Allowed values |
0-5000 |
| Parameter type |
static |
| Documentation |
cron.max_running_jobs |
logfiles.download_enable
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Enables or disables server logs functionality. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
logfiles.download_enable |
logfiles.retention_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for server logs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
3 |
| Allowed values |
1-7 |
| Parameter type |
dynamic |
| Documentation |
logfiles.retention_days |
pgaudit.log
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies which classes of statements will be logged by session audit logging. |
| Data type |
set |
| Default value |
none |
| Allowed values |
none,read,write,function,role,ddl,misc,all |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log |
pgaudit.log_catalog
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_catalog |
pgaudit.log_client
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether audit messages should be visible to client. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_client |
pgaudit.log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the log level that will be used for log entries. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,log |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_level |
pgaudit.log_parameter
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies that audit logging should include the parameters that were passed with the statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_parameter |
pgaudit.log_relation
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether session audit logging should create a separate log entry for each relation referenced in a SELECT or DML statement. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_relation |
pgaudit.log_statement_once
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pgaudit.log_statement_once |
pgaudit.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Specifies the master role to use for object audit logging. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pgaudit.role |
pglogical.batch_inserts
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use batch insert mechanism if possible. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.batch_inserts |
pglogical.conflict_log_level
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the log level for reporting detected conflicts when the pglogical.conflict_resolution is set to anything else than error. |
| Data type |
enumeration |
| Default value |
log |
| Allowed values |
debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_log_level |
pglogical.conflict_resolution
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the resolution method for any detected conflicts between local data and incoming changes. |
| Data type |
enumeration |
| Default value |
apply_remote |
| Allowed values |
error,apply_remote,keep_local,last_update_wins,first_update_wins |
| Parameter type |
dynamic |
| Documentation |
pglogical.conflict_resolution |
pglogical.use_spi
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Tells PGLogical to use SPI interface to form actual SQL (INSERT, UPDATE, DELETE) statements to apply incoming changes instead of using internal low level interface. |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pglogical.use_spi |
pgms_stats.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
|
pgms_wait_sampling.history_period
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type |
integer |
| Default value |
100 |
| Allowed values |
1-600000 |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
all,none |
| Parameter type |
dynamic |
| Documentation |
pgms_wait_sampling.query_capture_mode |
pg_partman_bgw.analyze
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_analyze argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.analyze |
pg_partman_bgw.dbname
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Required. The database(s) that run_maintenance() will run on. If more than one, use a comma separated list. If not set, BGW will do nothing. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z0-9_,-]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.dbname |
pg_partman_bgw.interval
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Number of seconds between calls to run_maintenance(). |
| Data type |
integer |
| Default value |
3600 |
| Allowed values |
1-315360000 |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.interval |
pg_partman_bgw.jobmon
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Same purpose as the p_jobmon argument to run_maintenance(). |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.jobmon |
pg_partman_bgw.role
| Attribute |
Value |
| Category |
Customized Options |
| Description |
The role that run_maintenance() will run as. Default is postgres. Only a single role name is allowed. |
| Data type |
string |
| Default value |
|
| Allowed values |
[A-Za-z\\._]* |
| Parameter type |
dynamic |
| Documentation |
pg_partman_bgw.role |
pg_qs.interval_length_minutes
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type |
integer |
| Default value |
15 |
| Allowed values |
1-30 |
| Parameter type |
static |
| Documentation |
pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on |
| Parameter type |
read-only |
| Documentation |
pg_qs.is_enabled_fs |
pg_qs.max_plan_size
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type |
integer |
| Default value |
7500 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type |
integer |
| Default value |
6000 |
| Allowed values |
100-10000 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Whether and when to capture query positional parameters. |
| Data type |
enumeration |
| Default value |
capture_parameterless_only |
| Allowed values |
capture_parameterless_only,capture_first_sample |
| Parameter type |
dynamic |
| Documentation |
pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets query capture mode for query store. None disables any capturing. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type |
integer |
| Default value |
7 |
| Allowed values |
1-30 |
| Parameter type |
dynamic |
| Documentation |
pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Turns saving query plans on or off for pg_qs |
| Data type |
boolean |
| Default value |
off |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_qs. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_qs.track_utility |
pg_stat_statements.max
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Sets the maximum number of statements tracked by pg_stat_statements. |
| Data type |
integer |
| Default value |
5000 |
| Allowed values |
100-2147483647 |
| Parameter type |
static |
| Documentation |
pg_stat_statements.max |
pg_stat_statements.save
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Save pg_stat_statements statistics across server shutdowns. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.save |
pg_stat_statements.track
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls which statements are counted by pg_stat_statements. |
| Data type |
enumeration |
| Default value |
none |
| Allowed values |
top,all,none |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track |
pg_stat_statements.track_utility
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Selects whether utility commands are tracked by pg_stat_statements. |
| Data type |
boolean |
| Default value |
on |
| Allowed values |
on,off |
| Parameter type |
dynamic |
| Documentation |
pg_stat_statements.track_utility |
postgis.gdal_enabled_drivers
| Attribute |
Value |
| Category |
Customized Options |
| Description |
Controls postgis GDAL enabled driver settings. |
| Data type |
enumeration |
| Default value |
DISABLE_ALL |
| Allowed values |
DISABLE_ALL,ENABLE_ALL |
| Parameter type |
dynamic |
| Documentation |
postgis.gdal_enabled_drivers |