From b572c71fccb010f661b333959106c5979a7eb589 Mon Sep 17 00:00:00 2001 From: Marcelo Henrique Neppel Date: Thu, 2 Oct 2025 14:01:21 -0300 Subject: [PATCH] Update config options name pattern Signed-off-by: Marcelo Henrique Neppel --- config.yaml | 352 +++++++++--------- docs/explanation/connection-pooling.md | 2 +- docs/explanation/users.md | 2 +- docs/how-to/enable-ldap.md | 2 +- .../logical-replication/set-up-clusters.md | 6 +- 5 files changed, 182 insertions(+), 182 deletions(-) diff --git a/config.yaml b/config.yaml index f015158001..35f9a258c2 100644 --- a/config.yaml +++ b/config.yaml @@ -2,55 +2,55 @@ # See LICENSE file for licensing details. options: - synchronous_node_count: + synchronous-node-count: description: | Sets the number of synchronous nodes to be maintained in the cluster. Should be either "all", "majority" or a positive integer value. type: string default: "all" - connection_authentication_timeout: + connection-authentication-timeout: description: | Sets the maximum allowed time to complete client authentication. Allowed values are: from 1 to 600. type: int default: 60 - connection_statement_timeout: + connection-statement-timeout: description: | Sets the maximum allowed duration of any statement. Allowed values are: from 0 to 2147483647. type: int default: 0 - cpu_parallel_leader_participation: + cpu-parallel-leader-participation: description: | Controls whether Gather and Gather Merge also run subplans. type: boolean default: true - durability_synchronous_commit: + durability-synchronous-commit: description: | Sets the current transactions synchronization level. This charm allows only the - “on”, “remote_apply” and “remote_write” values to avoid data loss if the primary + “on”, “remote-apply” and “remote-write” values to avoid data loss if the primary crashes and there are replicas. type: string default: "on" - durability_wal_keep_size: + durability-wal-keep-size: description: | Sets the minimum size of the WAL file to be kept for the replication. Allowed values are: from 0 to 2147483647. type: int default: 4096 - experimental_max_connections: + experimental-max-connections: type: int description: | [EXPERIMENTAL] Force set max_connections. - instance_default_text_search_config: + instance-default-text-search-config: description: | Selects the text search configuration that is used by those variants of the text search functions that do not have an explicit argument specifying it. - Allowed values start with “pg_catalog.” followed by a language name, like - “pg_catalog.english”. + Allowed values start with “pg-catalog.” followed by a language name, like + “pg-catalog.english”. type: string default: "pg_catalog.simple" - instance_max_locks_per_transaction: + instance-max-locks-per-transaction: description: | Specifies the maximum amount of memory to be used by maintenance operations, such as "VACUUM", "CREATE INDEX", and "ALTER TABLE ADD FOREIGN KEY". @@ -58,333 +58,333 @@ options: Allowed values are: from 64 to 2147483647. type: int default: 64 - instance_password_encryption: + instance-password-encryption: description: | Determines the algorithm to use to encrypt the password. Allowed values are: “md5” and “scram-sha-256”. type: string default: "scram-sha-256" - instance_synchronize_seqscans: + instance-synchronize-seqscans: description: | Enable synchronized sequential scans. type: boolean default: true - ldap_map: + ldap-map: description: | List of mapped LDAP group names to PostgreSQL group names, separated by commas. The map is used to assign LDAP synchronized users to PostgreSQL authorization groups. - Example: =,= + Example: =,= type: string - ldap_search_filter: + ldap-search-filter: description: | The LDAP search filter to match users with. Example: (|(uid=$username)(email=$username)) type: string default: "(uid=$username)" - logging_client_min_messages: + logging-client-min-messages: description: | Sets the message levels that are sent to the client. Allowed values are one of 'debug5', 'debug4', 'debug3', 'debug2', 'debug1', 'log', 'notice', 'warning' or 'error'. Each level includes all the levels that follow it. The later the level, the fewer messages are sent. type: string default: "notice" - logging_log_connections: + logging-log-connections: description: | Logs each successful connection. type: boolean default: true - logging_log_disconnections: + logging-log-disconnections: description: | Logs end of a session, including duration. type: boolean default: true - logging_log_lock_waits: + logging-log-lock-waits: description: | Logs long lock waits. type: boolean default: false - logging_log_min_duration_statement: + logging-log-min-duration-statement: description: | Sets the minimum running time (milliseconds) above which statements will be logged. Allowed values are: from -1 to 2147483647 (-1 disables logging statement durations). type: int default: -1 - logging_track_functions: + logging-track-functions: description: | Collects function-level statistics on database activity. Allowed values are one of 'none', 'pl', 'all'. Enables tracking of function call counts and time used. Specify pl to track only procedural-language functions type: string default: "none" - logical_replication_subscription_request: + logical-replication-subscription-request: description: | Set of databases corresponding to list of tables with schema notation in JSON format, which will be requested from publiblisher cluster to subscribe on via logical replication. Example: {"": [".", ...], ...} type: string default: "{}" - memory_maintenance_work_mem: + memory-maintenance-work-mem: description: | Sets the maximum memory (KB) to be used for maintenance operations. Allowed values are: from 1024 to 2147483647. type: int default: 65536 - memory_max_prepared_transactions: + memory-max-prepared-transactions: description: | Sets the maximum number of simultaneously prepared transactions. Allowed values are: from 0 to 262143. type: int default: 0 - memory_shared_buffers: + memory-shared-buffers: description: | Sets the number of shared memory buffers (8 kB) used by the server. This charm allows to set this value up to 40% of the available memory from the unit, as it is unlikely that an allocation of more than that will work better than a smaller amount. Allowed values are: from 16 to 1073741823. type: int - memory_temp_buffers: + memory-temp-buffers: description: | Sets the maximum number of temporary buffers (8 kB) used by each session. Allowed values are: from 100 to 1073741823. type: int default: 1024 - memory_work_mem: + memory-work-mem: description: | Sets the maximum memory (KB) to be used for query workspaces. Allowed values are: from 64 to 2147483647. type: int default: 4096 - optimizer_constraint_exclusion: + optimizer-constraint-exclusion: description: | Enables the planner to use constraints to optimize queries. Allowed values are: “on”, “off” and “partition”. type: string default: "partition" - optimizer_cpu_index_tuple_cost: + optimizer-cpu-index-tuple-cost: description: | Sets the planner's estimate of the cost of processing each index entry during an index scan. Allowed values are: from 0 to 1.80E+308. type: float default: 0.005 - optimizer_cpu_operator_cost: + optimizer-cpu-operator-cost: description: | Sets the planner's estimate of the cost of processing each operator or function call. Allowed values are: from 0 to 1.80E+308. type: float default: 0.0025 - optimizer_cpu_tuple_cost: + optimizer-cpu-tuple-cost: description: | Sets the planner's estimate of the cost of processing each tuple (row). Allowed values are: from 0 to 1.80E+308. type: float default: 0.01 - optimizer_cursor_tuple_fraction: + optimizer-cursor-tuple-fraction: description: | Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved. Allowed values are: from 0 to 1. type: float default: 0.1 - optimizer_default_statistics_target: + optimizer-default-statistics-target: description: | Sets the default statistics target. Allowed values are: from 1 to 10000. type: int default: 100 - optimizer_enable_async_append: + optimizer-enable-async-append: description: | Enables the planner's use of async append plans. type: boolean default: true - optimizer_enable_bitmapscan: + optimizer-enable-bitmapscan: description: | Enables the planner's use of bitmap-scan plans. type: boolean default: true - optimizer_enable_gathermerge: + optimizer-enable-gathermerge: description: | Enables the planner's use of gather merge plans. type: boolean default: true - optimizer_enable_hashagg: + optimizer-enable-hashagg: description: | Enables the planner's use of hashed aggregation plans. type: boolean default: true - optimizer_enable_hashjoin: + optimizer-enable-hashjoin: description: | Enables the planner's use of hash join plans. type: boolean default: true - optimizer_enable_incremental_sort: + optimizer-enable-incremental-sort: description: | Enables the planner's use of incremental sort steps. type: boolean default: true - optimizer_enable_indexonlyscan: + optimizer-enable-indexonlyscan: description: | Enables the planner's use of index-only-scan plans. type: boolean default: true - optimizer_enable_indexscan: + optimizer-enable-indexscan: description: | Enables the planner's use of index-scan plans. type: boolean default: true - optimizer_enable_material: + optimizer-enable-material: description: | Enables the planner's use of materialization. type: boolean default: true - optimizer_enable_memoize: + optimizer-enable-memoize: description: | Enables the planner's use of memoization. type: boolean default: true - optimizer_enable_mergejoin: + optimizer-enable-mergejoin: description: | Enables the planner's use of merge join plans. type: boolean default: true - optimizer_enable_nestloop: + optimizer-enable-nestloop: description: | Enables the planner's use of nested-loop join plans. type: boolean default: true - optimizer_enable_parallel_append: + optimizer-enable-parallel-append: description: | Enables the planner's use of parallel append plans. type: boolean default: true - optimizer_enable_parallel_hash: + optimizer-enable-parallel-hash: description: | Enables the planner's use of parallel hash plans. type: boolean default: true - optimizer_enable_partition_pruning: + optimizer-enable-partition-pruning: description: | Enables plan-time and execution-time partition pruning. type: boolean default: true - optimizer_enable_partitionwise_aggregate: + optimizer-enable-partitionwise-aggregate: description: | Enables partitionwise aggregation and grouping. type: boolean default: false - optimizer_enable_partitionwise_join: + optimizer-enable-partitionwise-join: description: | Enables partitionwise join. type: boolean default: false - optimizer_enable_seqscan: + optimizer-enable-seqscan: description: | Enables the planner's use of sequential-scan plans. type: boolean default: true - optimizer_enable_sort: + optimizer-enable-sort: description: | Enables the planner's use of explicit sort steps. type: boolean default: true - optimizer_enable_tidscan: + optimizer-enable-tidscan: description: | Enables the planner's use of TID scan plans. type: boolean default: true - optimizer_from_collapse_limit: + optimizer-from-collapse-limit: description: | Sets the FROM-list size beyond which subqueries are not collapsed. Allowed values are: from 1 to 2147483647. type: int default: 8 - optimizer_geqo: + optimizer-geqo: description: | Enables genetic query optimization. type: boolean default: true - optimizer_geqo_effort: + optimizer-geqo-effort: description: | GEQO: effort is used to set the default for other GEQO parameters. Allowed values are: from 1 to 10. type: int default: 5 - optimizer_geqo_generations: + optimizer-geqo-generations: description: | GEQO: number of iterations of the algorithm. Allowed values are: from 0 to 2147483647. type: int default: 0 - optimizer_geqo_pool_size: + optimizer-geqo-pool-size: description: | GEQO: number of individuals in the population. Allowed values are: from 0 to 2147483647. type: int default: 0 - optimizer_geqo_seed: + optimizer-geqo-seed: description: | GEQO: seed for random path selection. Allowed values are: from 0 to 1. type: float default: 0.0 - optimizer_geqo_selection_bias: + optimizer-geqo-selection-bias: description: | GEQO: selective pressure within the population. Allowed values are: from 1.5 to 2. type: float default: 2.0 - optimizer_geqo_threshold: + optimizer-geqo-threshold: description: | Sets the threshold of FROM items beyond which GEQO is used. Allowed values are: from 2 to 2147483647. type: int default: 12 - optimizer_jit: + optimizer-jit: description: | Allow JIT compilation. type: boolean default: true - optimizer_jit_above_cost: + optimizer-jit-above-cost: description: | Perform JIT compilation if query is more expensive. Allowed values are: from -1 to 1.80E+308. type: float default: 100000.0 - optimizer_jit_inline_above_cost: + optimizer-jit-inline-above-cost: description: | Perform JIT inlining if query is more expensive. Allowed values are: from -1 to 1.80E+308. type: float default: 500000.0 - optimizer_jit_optimize_above_cost: + optimizer-jit-optimize-above-cost: description: | Optimize JIT-compiled functions if query is more expensive. Allowed values are: from -1 to 1.80E+308. type: float default: 500000.0 - optimizer_join_collapse_limit: + optimizer-join-collapse-limit: description: | Sets the FROM-list size beyond which JOIN constructs are not flattened. Allowed values are: from 1 to 2147483647. type: int default: 8 - optimizer_min_parallel_index_scan_size: + optimizer-min-parallel-index-scan-size: description: | Sets the minimum amount of index data for a parallel scan. Allowed values are: from 0 to 715827882. type: int default: 64 - optimizer_min_parallel_table_scan_size: + optimizer-min-parallel-table-scan-size: description: | Sets the minimum amount of table data for a parallel scan. Allowed values are: from 0 to 715827882. type: int default: 1024 - optimizer_parallel_setup_cost: + optimizer-parallel-setup-cost: description: | Sets the planner's estimate of the cost of starting up worker processes for parallel query. Allowed values are: from 0 to 1.80E+308. type: float default: 1000.0 - optimizer_parallel_tuple_cost: + optimizer-parallel-tuple-cost: description: | Sets the planner's estimate of the cost of passing each tuple (row) from worker to leader backend. Allowed values are: from 0 to 1.80E+308. @@ -397,211 +397,211 @@ options: Allowed values: "all", "first", "none" type: string default: first - plugin_address_standardizer_data_us_enable: + plugin-address-standardizer-data-us-enable: default: false type: boolean description: Enable address_standardizer_data_us extension - plugin_address_standardizer_enable: + plugin-address-standardizer-enable: default: false type: boolean description: Enable address_standardizer extension - plugin_audit_enable: + plugin-audit-enable: default: true type: boolean description: Enable pgAudit extension - plugin_bloom_enable: + plugin-bloom-enable: default: false type: boolean description: Enable bloom extension - plugin_bool_plperl_enable: + plugin-bool-plperl-enable: default: false type: boolean description: Enable bool_plperl extension - plugin_btree_gin_enable: + plugin-btree-gin-enable: default: false type: boolean description: Enable btree_gin extension - plugin_btree_gist_enable: + plugin-btree-gist-enable: default: false type: boolean description: Enable btree_gist extension - plugin_citext_enable: + plugin-citext-enable: default: false type: boolean description: Enable citext extension - plugin_cube_enable: + plugin-cube-enable: default: false type: boolean description: Enable cube extension - plugin_debversion_enable: + plugin-debversion-enable: default: false type: boolean description: Enable debversion extension - plugin_dict_int_enable: + plugin-dict-int-enable: default: false type: boolean description: Enable dict_int extension - plugin_dict_xsyn_enable: + plugin-dict-xsyn-enable: default: false type: boolean description: Enable dict_xsyn extension - plugin_earthdistance_enable: + plugin-earthdistance-enable: default: false type: boolean description: Enable earthdistance extension - plugin_fuzzystrmatch_enable: + plugin-fuzzystrmatch-enable: default: false type: boolean description: Enable fuzzystrmatch extension - plugin_hll_enable: + plugin-hll-enable: default: false type: boolean description: Enable hll extension - plugin_hstore_enable: + plugin-hstore-enable: default: false type: boolean description: Enable hstore extension - plugin_hypopg_enable: + plugin-hypopg-enable: default: false type: boolean description: Enable hypopg extension - plugin_icu_ext_enable: + plugin-icu-ext-enable: default: false type: boolean description: Enable icu_ext extension - plugin_intarray_enable: + plugin-intarray-enable: default: false type: boolean description: Enable intarray extension - plugin_ip4r_enable: + plugin-ip4r-enable: default: false type: boolean description: Enable ip4r extension - plugin_isn_enable: + plugin-isn-enable: default: false type: boolean description: Enable isn extension - plugin_jsonb_plperl_enable: + plugin-jsonb-plperl-enable: default: false type: boolean description: Enable jsonb_plperl extension - plugin_lo_enable: + plugin-lo-enable: default: false type: boolean description: Enable lo extension - plugin_ltree_enable: + plugin-ltree-enable: default: false type: boolean description: Enable ltree extension - plugin_old_snapshot_enable: + plugin-old-snapshot-enable: default: false type: boolean description: Enable old_snapshot extension - plugin_orafce_enable: + plugin-orafce-enable: default: false type: boolean description: Enable orafce extension - plugin_pg_freespacemap_enable: + plugin-pg-freespacemap-enable: default: false type: boolean description: Enable pg_freespacemap extension - plugin_pg_similarity_enable: + plugin-pg-similarity-enable: default: false type: boolean description: Enable pg_similarity extension - plugin_pg_trgm_enable: + plugin-pg-trgm-enable: default: false type: boolean description: Enable pg_trgm extension - plugin_pg_visibility_enable: + plugin-pg-visibility-enable: default: false type: boolean description: Enable pg_visibility extension - plugin_pgrowlocks_enable: + plugin-pgrowlocks-enable: default: false type: boolean description: Enable pgrowlocks extension - plugin_pgstattuple_enable: + plugin-pgstattuple-enable: default: false type: boolean description: Enable pgstattuple extension - plugin_plperl_enable: + plugin-plperl-enable: default: false type: boolean description: Enable plperl extension - plugin_plpython3u_enable: + plugin-plpython3u-enable: default: false type: boolean description: Enable PL/Python extension - plugin_pltcl_enable: + plugin-pltcl-enable: default: false type: boolean description: Enable pltcl extension - plugin_postgis_enable: + plugin-postgis-enable: default: false type: boolean description: Enable postgis extension - plugin_postgis_raster_enable: + plugin-postgis-raster-enable: default: false type: boolean description: Enable postgis_raster extension - plugin_postgis_tiger_geocoder_enable: + plugin-postgis-tiger-geocoder-enable: default: false type: boolean description: Enable postgis_tiger_geocoder extension - plugin_postgis_topology_enable: + plugin-postgis-topology-enable: default: false type: boolean description: Enable postgis_topology extension - plugin_prefix_enable: + plugin-prefix-enable: default: false type: boolean description: Enable prefix extension - plugin_rdkit_enable: + plugin-rdkit-enable: default: false type: boolean description: Enable rdkit extension - plugin_seg_enable: + plugin-seg-enable: default: false type: boolean description: Enable seg extension - plugin_spi_enable: + plugin-spi-enable: default: false type: boolean description: Enable spi extension - plugin_tablefunc_enable: + plugin-tablefunc-enable: default: false type: boolean description: Enable tablefunc extension - plugin_tcn_enable: + plugin-tcn-enable: default: false type: boolean description: Enable tcn extension - plugin_tds_fdw_enable: + plugin-tds-fdw-enable: default: false type: boolean description: Enable tds_fdw extension - plugin_timescaledb_enable: + plugin-timescaledb-enable: default: false type: boolean description: Enable timescaledb extension - plugin_tsm_system_rows_enable: + plugin-tsm-system-rows-enable: default: false type: boolean description: Enable tsm_system_rows extension - plugin_tsm_system_time_enable: + plugin-tsm-system-time-enable: default: false type: boolean description: Enable tsm_system_time extension - plugin_unaccent_enable: + plugin-unaccent-enable: default: false type: boolean description: Enable unaccent extension - plugin_uuid_ossp_enable: + plugin-uuid-ossp-enable: default: false type: boolean description: Enable uuid_ossp extension - plugin_vector_enable: + plugin-vector-enable: default: false type: boolean description: Enable pgvector extension @@ -613,42 +613,42 @@ options: minimal running performance. type: string default: "production" - profile_limit_memory: + profile-limit-memory: type: int description: | Amount of memory in Megabytes to limit PostgreSQL and associated process to. If unset, this will be decided according to the default memory limit in the selected profile. Only comes into effect when the `production` profile is selected. - request_array_nulls: + request-array-nulls: description: | Enable input of NULL elements in arrays. type: boolean default: true - request_backslash_quote: + request-backslash-quote: description: | Sets whether "\'" is allowed in string literals. - Allowed values are "safe_encoding" and "on" and "off". + Allowed values are "safe-encoding" and "on" and "off". Safe_encoding is allow only if client encoding does not allow ASCII \ within a multibyte character. type: string default: "safe_encoding" - request_date_style: + request-date-style: description: | Sets the display format for date and time values. Allowed formats are explained in https://www.postgresql.org/docs/14/runtime-config-client.html#GUC-DATESTYLE. type: string default: "ISO, MDY" - request_deadlock_timeout: + request-deadlock-timeout: description: | Sets the time to wait on a lock before checking for deadlock. Allowed values are: from 1 to 2147483647. type: int default: 1000 - request_default_transaction_deferrable: + request-default-transaction-deferrable: escription: | Sets the default deferrable status of new transactions. type: boolean default: false - request_default_transaction_isolation: + request-default-transaction-isolation: description: | Sets the transaction isolation level of each new transaction. Allowed values are one of 'serializable', 'repeatable read', 'read committed', 'read uncommitted'. @@ -659,129 +659,129 @@ options: query or data-modification statement was executed in this transaction. type: string default: "read committed" - request_default_transaction_read_only: + request-default-transaction-read-only: description: | Sets the default read-only status of new transactions. type: boolean default: false - request_escape_string_warning: + request-escape-string-warning: description: | Warn about backslash escapes in ordinary string literals. type: boolean default: true - request_lock_timeout: + request-lock-timeout: description: | Sets the maximum allowed duration of any wait for a lock. Allowed values are: from 0 to 2147483647. type: int default: 0 - request_standard_conforming_strings: + request-standard-conforming-strings: description: | Causes ... strings to treat backslashes literally. type: boolean default: true - request_time_zone: + request-time-zone: description: | Sets the time zone for displaying and interpreting time stamps. Allowed values are the ones from IANA time zone data, a time zone abbreviation like PST and POSIX-style time zone specifications. type: string default: "UTC" - request_track_activity_query_size: + request-track-activity-query-size: description: | Sets the size reserved for pg_stat_activity.query, in bytes. Allowed values are: from 100 to 1048576. type: int default: 1024 - request_transform_null_equals: + request-transform-null-equals: description: | Treats "expr=NULL" as "expr IS NULL" type: boolean default: false - request_xmlbinary: + request-xmlbinary: description: | Sets how binary values are to be encoded in XML. Allowed values are one of 'base64', 'hex'. type: string default: "base64" - request_xmloption: + request-xmloption: description: | Sets whether XML data in implicit parsing and serialization operations is to be considered as documents or content fragments. Allowed values are one of 'content', 'document'. type: string default: "content" - response_bytea_output: + response-bytea-output: description: | Sets the output format for bytes. Allowed values are: “escape” and “hex”. type: string default: "hex" - response_exit_on_error: + response-exit-on-error: description: | Terminate session on any error. type: boolean default: false - response_extra_float_digits: + response-extra-float-digits: description: | Sets the number of digits displayed for floating-point values. Allowed values are: from -15 to 3. type: int default: 1 - response_gin_fuzzy_search_limit: + response-gin-fuzzy-search-limit: description: | Sets the maximum allowed result for exact search by GIN. Allowed values are: from 0 to 2147483647. type: int default: 0 - response_lc_monetary: + response-lc-monetary: description: | Sets the locale for formatting monetary amounts. Allowed values are the locales available in the unit. type: string default: "C" - response_lc_numeric: + response-lc-numeric: description: | Sets the locale for formatting numbers. Allowed values are the locales available in the unit. type: string default: "C" - response_lc_time: + response-lc-time: description: | Sets the locale for formatting date and time values. Allowed values are the locales available in the unit. type: string default: "C" - session_idle_in_transaction_session_timeout: + session-idle-in-transaction-session-timeout: description: | Sets the maximum allowed idle time between queries, when in a transaction. Allowed values are: from 0 to 2147483647. type: int default: 0 - storage_bgwriter_lru_maxpages: + storage-bgwriter-lru-maxpages: description: | Background writer maximum number of LRU pages to flush per round. Allowed values are: from 0 to 1073741823. type: int default: 100 - storage_bgwriter_lru_multiplier: + storage-bgwriter-lru-multiplier: description: | Multiple of the average buffer usage to free per round. Allowed values are: from 0 to 10. type: float default: 2.0 - storage_default_table_access_method: + storage-default-table-access-method: description: | Sets the default table access method for new tables. These entries can be created using the CREATE ACCESS METHOD SQL command. type: string default: "heap" - storage_gin_pending_list_limit: + storage-gin-pending-list-limit: description: | Sets the maximum size of the pending list for GIN index. Allowed values are: from 64 to 2147483647. type: int default: 4096 - storage_old_snapshot_threshold: + storage-old-snapshot-threshold: description: | Time before a snapshot is too old to read pages changed after the snapshot was taken. Allowed values are: from -1 to 86400. @@ -795,130 +795,130 @@ options: and SHOULD NOT be used by applications. This needs to be a Juju Secret URI pointing to a secret that contains the following content: `: `. Possible users: backup, monitoring, operator, replication, rewind. - vacuum_autovacuum_analyze_scale_factor: + vacuum-autovacuum-analyze-scale-factor: description: | Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default, 0.1, means 10% of table size. Allowed values are: from 0 to 100. type: float default: 0.1 - vacuum_autovacuum_analyze_threshold: + vacuum-autovacuum-analyze-threshold: description: | Sets the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. Allowed values are: from 0 to 2147483647. type: int default: 50 - vacuum_autovacuum_freeze_max_age: + vacuum-autovacuum-freeze-max-age: description: | Maximum age (in transactions) before triggering autovacuum on a table to prevent transaction ID wraparound. Allowed values are: from 100000 to 2000000000. type: int default: 200000000 - vacuum_autovacuum_naptime: + vacuum-autovacuum-naptime: description: | Time to sleep between autovacuum runs. Allowed values are: from 1 to 2147483. type: int default: 60 - vacuum_autovacuum_vacuum_cost_delay: + vacuum-autovacuum-vacuum-cost-delay: description: | Sets cost delay value (milliseconds) that will be used in automatic VACUUM operations. Allowed values are: from -1 to 100 (-1 tells PostgreSQL to use the regular - vacuum_cost_delay value). + vacuum-cost-delay value). type: float default: 2.0 - vacuum_autovacuum_vacuum_cost_limit: + vacuum-autovacuum-vacuum-cost-limit: description: | Vacuum cost amount available before napping, for autovacuum. Allowed values are: from -1 to 10000. type: int default: -1 - vacuum_autovacuum_vacuum_insert_scale_factor: + vacuum-autovacuum-vacuum-insert-scale-factor: description: | Number of tuple inserts prior to vacuum as a fraction of reltuples. Allowed values are: from 0 to 100. type: float default: 0.2 - vacuum_autovacuum_vacuum_insert_threshold: + vacuum-autovacuum-vacuum-insert-threshold: description: | Minimum number of tuple inserts prior to vacuum, or -1 to disable insert vacuums. Allowed values are: from -1 to 2147483647. type: int default: 1000 - vacuum_autovacuum_vacuum_scale_factor: + vacuum-autovacuum-vacuum-scale-factor: description: | Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default, 0.2, means 20% of table size. Allowed values are: from 0 to 100. type: float default: 0.2 - vacuum_autovacuum_vacuum_threshold: + vacuum-autovacuum-vacuum-threshold: description: | Minimum number of tuple updates or deletes prior to vacuum. Allowed values are: from 0 to 2147483647. type: int default: 50 - vacuum_vacuum_cost_delay: + vacuum-vacuum-cost-delay: description: | Vacuum cost delay in milliseconds. Allowed values are: from 0 to 100. type: float default: 0.0 - vacuum_vacuum_cost_limit: + vacuum-vacuum-cost-limit: description: | Vacuum cost amount available before napping. Allowed values are: from 1 to 10000. type: int default: 200 - vacuum_vacuum_cost_page_dirty: + vacuum-vacuum-cost-page-dirty: description: | Vacuum cost for a page dirtied by vacuum. Allowed values are: from 0 to 10000. type: int default: 20 - vacuum_vacuum_cost_page_hit: + vacuum-vacuum-cost-page-hit: description: | Vacuum cost for a page found in the buffer cache. Allowed values are: from 0 to 10000. type: int default: 1 - vacuum_vacuum_cost_page_miss: + vacuum-vacuum-cost-page-miss: description: | Vacuum cost for a page not found in the buffer cache. Allowed values are: from 0 to 10000. type: int default: 2 - vacuum_vacuum_failsafe_age: + vacuum-vacuum-failsafe-age: description: | Age at which VACUUM should trigger failsafe to avoid a wraparound outage. Allowed values are: from 0 to 2100000000. type: int default: 1600000000 - vacuum_vacuum_freeze_min_age: + vacuum-vacuum-freeze-min-age: description: | Minimum age at which VACUUM should freeze a table row. Allowed values are: from 0 to 1000000000. type: int default: 50000000 - vacuum_vacuum_freeze_table_age: + vacuum-vacuum-freeze-table-age: description: | Age (in transactions) at which VACUUM should scan whole table to freeze tuples. Allowed values are: from 0 to 2000000000. type: int default: 150000000 - vacuum_vacuum_multixact_failsafe_age: + vacuum-vacuum-multixact-failsafe-age: description: | Multixact age at which VACUUM should trigger failsafe to avoid a wraparound outage. Allowed values are: from 0 to 2100000000. type: int default: 1600000000 - vacuum_vacuum_multixact_freeze_min_age: + vacuum-vacuum-multixact-freeze-min-age: description: | Minimum age at which VACUUM should freeze a MultiXactId in a table row. Allowed values are: from 0 to 1000000000. type: int default: 5000000 - vacuum_vacuum_multixact_freeze_table_age: + vacuum-vacuum-multixact-freeze-table-age: description: | Multixact age at which VACUUM should scan whole table to freeze tuples. Allowed values are: from 0 to 2000000000. diff --git a/docs/explanation/connection-pooling.md b/docs/explanation/connection-pooling.md index 63886c0196..c84844cece 100644 --- a/docs/explanation/connection-pooling.md +++ b/docs/explanation/connection-pooling.md @@ -8,7 +8,7 @@ A way to achieve this with Charmed PostgreSQL K8s is by integrating with the [Pg ## Increasing maximum allowed connections -If using PgBouncer is not enough to handle the connections load of your application, you can increase the amount of connections that PostgreSQL can open via the [`experimental_max_connections` config parameter](https://charmhub.io/postgresql-k8s/configurations#experimental_max_connections). +If using PgBouncer is not enough to handle the connections load of your application, you can increase the amount of connections that PostgreSQL can open via the [`experimental-max-connections` config parameter](https://charmhub.io/postgresql-k8s/configurations#experimental-max-connections). ```{caution} Each connection opened by PostgreSQL spawns a new process, which is resource-intensive. Use this option as a last resort. diff --git a/docs/explanation/users.md b/docs/explanation/users.md index 2b04f630e1..afa0627e4a 100644 --- a/docs/explanation/users.md +++ b/docs/explanation/users.md @@ -121,5 +121,5 @@ Read more about the supported charm interfaces in [](/explanation/interfaces-and The operator considers Identity users all those that are automatically created when the LDAP integration is enabled, or in other words, the [GLAuth](https://charmhub.io/glauth-k8s) charm is related/integrated. -When synchronised from the LDAP server, these users do not have any permissions by default, so the LDAP group they belonged to must be mapped to a PostgreSQL pre-defined authorisation role by using the `ldap_map` configuration option. +When synchronised from the LDAP server, these users do not have any permissions by default, so the LDAP group they belonged to must be mapped to a PostgreSQL pre-defined authorisation role by using the `ldap-map` configuration option. diff --git a/docs/how-to/enable-ldap.md b/docs/how-to/enable-ldap.md index 7e1349270e..b914c39a02 100644 --- a/docs/how-to/enable-ldap.md +++ b/docs/how-to/enable-ldap.md @@ -82,7 +82,7 @@ juju integrate postgresql-k8s:receive-ca-cert send-ca-cert To have LDAP users available in PostgreSQL, provide a comma separated list of LDAP groups to already created PostgreSQL authorisation groups. To create those groups before hand, refer to the [data integrator charm](https://charmhub.io/data-integrator). ```text -juju config postgresql-k8s ldap_map="=" +juju config postgresql-k8s ldap-map="=" ``` ## Disable LDAP diff --git a/docs/how-to/logical-replication/set-up-clusters.md b/docs/how-to/logical-replication/set-up-clusters.md index a9a231b38a..301b2601c1 100644 --- a/docs/how-to/logical-replication/set-up-clusters.md +++ b/docs/how-to/logical-replication/set-up-clusters.md @@ -95,7 +95,7 @@ CREATE TABLE Configure the replication of that specific database and table (remember to specify the table schema; it's the `public` schema in this example): ```sh -juju config postgresql2 logical_replication_subscription_request='{"testdb": ["public.asd"]}' +juju config postgresql2 logical-replication-subscription-request='{"testdb": ["public.asd"]}' ``` After a few seconds, you can check that the data has been replicated: @@ -134,7 +134,7 @@ testdb=> \q juju integrate postgresql1:logical-replication postgresql2:logical-replication-offer -juju config postgresql1 logical_replication_subscription_request='{"testdb": ["public.asd2"]}' +juju config postgresql1 logical-replication-subscription-request='{"testdb": ["public.asd2"]}' psql postgresql://relation_id_8:NTgtJkVfUHLiYDk5@postgresql1-primary.dev.svc.cluster.local:5432/testdb psql (16.9 (Ubuntu 16.9-0ubuntu0.24.04.1)) @@ -151,4 +151,4 @@ And the same table, or even different tables, can be replicated to multiple clus If the relation between the PostgreSQL clusters is broken, the data will be kept in both clusters, but the replication will stop. You can re-enable logical replication by following the steps from [](/how-to/logical-replication/re-enable). -The same will happen for that specific table if you change the table in the `logical_replication_subscription_request` config option to a different table or remove it completely. If one or more tables other than the current one are specified, the replication will continue for those tables, but the current table will not be replicated any more. +The same will happen for that specific table if you change the table in the `logical-replication-subscription-request` config option to a different table or remove it completely. If one or more tables other than the current one are specified, the replication will continue for those tables, but the current table will not be replicated any more.