config.yaml

# Copyright 2023 Canonical Ltd.
# See LICENSE file for licensing details.

options:
  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
      crashes and there are replicas.
    type: string
    default: "on"
  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”.
    type: string
    default: "pg_catalog.simple"
  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"
  logging_log_connections:
    description: |
      Logs each successful connection.
    type: boolean
    default: false
  logging_log_disconnections:
    description: |
      Logs end of a session, including duration.
    type: boolean
    default: false
  logging_log_lock_waits:
    description: |
      Logs long lock waits.
    type: boolean
    default: false
  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
  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:
    description: |
      Sets the maximum number of simultaneously prepared transactions.
      Allowed values are: from 0 to 262143.
    type: int
    default: 0
  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:
    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:
    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:
    description: |
      Enables the planner to use constraints to optimize queries.
      Allowed values are: “on”, “off” and “partition”.
    type: string
    default: "partition"
  optimizer_default_statistics_target:
    description: |
      Sets the default statistics target. Allowed values are: from 1 to 10000.
    type: int
    default: 100
  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_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
  plugin_citext_enable:
    default: false
    type: boolean
    description: Enable citext extension
  plugin_debversion_enable:
    default: false
    type: boolean
    description: Enable debversion extension
  plugin_hstore_enable:
    default: false
    type: boolean
    description: Enable hstore extension
  plugin_pg_trgm_enable:
    default: false
    type: boolean
    description: Enable pg_trgm extension
  plugin_plpython3u_enable:
    default: false
    type: boolean
    description: Enable PL/Python extension
  plugin_unaccent_enable:
    default: false
    type: boolean
    description: Enable unaccent extension
  plugin_bloom_enable:
    default: false
    type: boolean
    description: Enable bloom extension
  plugin_btree_gin_enable:
    default: false
    type: boolean
    description: Enable btree_gin extension
  plugin_btree_gist_enable:
    default: false
    type: boolean
    description: Enable btree_gist extension
  plugin_cube_enable:
    default: false
    type: boolean
    description: Enable cube extension
  plugin_dict_int_enable:
    default: false
    type: boolean
    description: Enable dict_int extension
  plugin_dict_xsyn_enable:
    default: false
    type: boolean
    description: Enable dict_xsyn extension
  plugin_earthdistance_enable:
    default: false
    type: boolean
    description: Enable earthdistance extension
  plugin_fuzzystrmatch_enable:
    default: false
    type: boolean
    description: Enable fuzzystrmatch extension
  plugin_intarray_enable:
    default: false
    type: boolean
    description: Enable intarray extension
  plugin_isn_enable:
    default: false
    type: boolean
    description: Enable isn extension
  plugin_lo_enable:
    default: false
    type: boolean
    description: Enable lo extension
  plugin_ltree_enable:
    default: false
    type: boolean
    description: Enable ltree extension
  plugin_old_snapshot_enable:
    default: false
    type: boolean
    description: Enable old_snapshot extension
  plugin_pg_freespacemap_enable:
    default: false
    type: boolean
    description: Enable pg_freespacemap extension
  plugin_pgrowlocks_enable:
    default: false
    type: boolean
    description: Enable pgrowlocks extension
  plugin_pgstattuple_enable:
    default: false
    type: boolean
    description: Enable pgstattuple extension
  plugin_pg_visibility_enable:
    default: false
    type: boolean
    description: Enable pg_visibility extension
  plugin_seg_enable:
    default: false
    type: boolean
    description: Enable seg extension
  plugin_tablefunc_enable:
    default: false
    type: boolean
    description: Enable tablefunc extension
  plugin_tcn_enable:
    default: false
    type: boolean
    description: Enable tcn extension
  plugin_tsm_system_rows_enable:
    default: false
    type: boolean
    description: Enable tsm_system_rows extension
  plugin_tsm_system_time_enable:
    default: false
    type: boolean
    description: Enable tsm_system_time extension
  plugin_uuid_ossp_enable:
    default: false
    type: boolean
    description: Enable uuid_ossp extension
  plugin_spi_enable:
    default: false
    type: boolean
    description: Enable spi extension
  plugin_bool_plperl_enable:
    default: false
    type: boolean
    description: Enable bool_plperl extension
  plugin_hll_enable:
    default: false
    type: boolean
    description: Enable hll extension
  plugin_hypopg_enable:
    default: false
    type: boolean
    description: Enable hypopg extension
  plugin_ip4r_enable:
    default: false
    type: boolean
    description: Enable ip4r extension
  plugin_plperl_enable:
    default: false
    type: boolean
    description: Enable plperl extension
  plugin_jsonb_plperl_enable:
    default: false
    type: boolean
    description: Enable jsonb_plperl extension
  plugin_orafce_enable:
    default: false
    type: boolean
    description: Enable orafce extension
  plugin_pg_similarity_enable:
    default: false
    type: boolean
    description: Enable pg_similarity extension
  plugin_prefix_enable:
    default: false
    type: boolean
    description: Enable prefix extension
  plugin_rdkit_enable:
    default: false
    type: boolean
    description: Enable rdkit extension
  plugin_tds_fdw_enable:
    default: false
    type: boolean
    description: Enable tds_fdw extension
  plugin_icu_ext_enable:
    default: false
    type: boolean
    description: Enable icu_ext extension
  plugin_pltcl_enable:
    default: false
    type: boolean
    description: Enable pltcl extension
  plugin_postgis_enable:
    default: false
    type: boolean
    description: Enable postgis extension
  plugin_address_standardizer_enable:
    default: false
    type: boolean
    description: Enable address_standardizer extension
  plugin_postgis_raster_enable:
    default: false
    type: boolean
    description: Enable postgis_raster extension
  plugin_address_standardizer_data_us_enable:
    default: false
    type: boolean
    description: Enable address_standardizer_data_us extension
  plugin_postgis_tiger_geocoder_enable:
    default: false
    type: boolean
    description: Enable postgis_tiger_geocoder extension
  plugin_postgis_topology_enable:
    default: false
    type: boolean
    description: Enable postgis_topology extension
  plugin_vector_enable:
    default: false
    type: boolean
    description: Enable pgvector extension
  plugin_timescaledb_enable:
    default: false
    type: boolean
    description: Enable timescaledb extension
  profile:
   description: |
      Profile representing the scope of deployment, and used to tune resource allocation.
      Allowed values are: “production” and “testing”.
      Production will tune postgresql for maximum performance while testing will tune for
      minimal running performance.
   type: string
   default: production
  profile-limit-memory:
    type: int
    description: |
      [DEPRECTATED] Use profile_limit_memory instead. 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. This
      config option cannot be set at the same time as 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. This config option cannot be
      set at the same time as profile-limit-memory.
  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_standard_conforming_strings:
    description: |
      Causes ... strings to treat backslashes literally.
    type: boolean
    default: true
  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"
  response_bytea_output:
    description: |
      Sets the output format for bytes.
      Allowed values are: “escape” and “hex”.
    type: string
    default: "hex"
  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:
    description: |
      Sets the locale for formatting numbers.
      Allowed values are the locales available in the unit.
    type: string
    default: "C"
  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"
  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:
    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:
    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_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).
    type: float
    default: 2.0
  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_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
  experimental_max_connections:
    type: int
    description: |
      [EXPERIMENTAL] Force set max_connections.