REFERENCE.md

# Reference

<!-- DO NOT EDIT: This document was generated by Puppet Strings -->

## Table of Contents

### Classes

#### Public Classes

* [`postgresql::client`](#postgresqlclient): Installs PostgreSQL client software. Set the following parameters if you have a custom version you would like to install.
* [`postgresql::globals`](#postgresqlglobals): Class for setting cross-class global overrides.
* [`postgresql::lib::devel`](#postgresqllibdevel): This class installs postgresql development libraries.
* [`postgresql::lib::docs`](#postgresqllibdocs): Installs PostgreSQL bindings for Postgres-Docs. Set the following parameters if you have a custom version you would like to install.
* [`postgresql::lib::java`](#postgresqllibjava): This class installs the postgresql jdbc connector.
* [`postgresql::lib::perl`](#postgresqllibperl): This class installs the perl libs for postgresql.
* [`postgresql::lib::python`](#postgresqllibpython): This class installs the python libs for postgresql.
* [`postgresql::server`](#postgresqlserver): This installs a PostgreSQL server
* [`postgresql::server::contrib`](#postgresqlservercontrib): Install the contrib postgresql packaging.
* [`postgresql::server::plperl`](#postgresqlserverplperl): This class installs the PL/Perl procedural language for postgresql.
* [`postgresql::server::plpython`](#postgresqlserverplpython): This class installs the PL/Python procedural language for postgresql.
* [`postgresql::server::postgis`](#postgresqlserverpostgis): Install the postgis postgresql packaging.

#### Private Classes

* `postgresql::dnfmodule`: Manage the DNF module
* `postgresql::params`
* `postgresql::repo`
* `postgresql::repo::apt_postgresql_org`
* `postgresql::repo::yum_postgresql_org`
* `postgresql::server::config`
* `postgresql::server::initdb`
* `postgresql::server::install`
* `postgresql::server::late_initdb`: Manage the default encoding when database initialization is managed by the package
* `postgresql::server::passwd`
* `postgresql::server::reload`
* `postgresql::server::service`

### Defined types

* [`postgresql::server::config_entry`](#postgresqlserverconfig_entry): Manage a postgresql.conf entry.
* [`postgresql::server::database`](#postgresqlserverdatabase): Define for creating a database.
* [`postgresql::server::database_grant`](#postgresqlserverdatabase_grant): Manage a database grant.
* [`postgresql::server::db`](#postgresqlserverdb): Define for conveniently creating a role, database and assigning the correctpermissions.
* [`postgresql::server::default_privileges`](#postgresqlserverdefault_privileges): Manage a database defaults privileges. Only works with PostgreSQL version 9.6 and above.
* [`postgresql::server::extension`](#postgresqlserverextension): Activate an extension on a postgresql database.
* [`postgresql::server::grant`](#postgresqlservergrant): Define for granting permissions to roles.
* [`postgresql::server::grant_role`](#postgresqlservergrant_role): Define for granting membership to a role.
* [`postgresql::server::pg_hba_rule`](#postgresqlserverpg_hba_rule): This resource manages an individual rule that applies to the file defined in target.
* [`postgresql::server::pg_ident_rule`](#postgresqlserverpg_ident_rule): This resource manages an individual rule that applies to the file defined in target.
* [`postgresql::server::reassign_owned_by`](#postgresqlserverreassign_owned_by): Define for reassigning the ownership of objects within a database.
* [`postgresql::server::recovery`](#postgresqlserverrecovery): This resource manages the parameters that applies to the recovery.conf template.
* [`postgresql::server::role`](#postgresqlserverrole): Define for creating a database role.
* [`postgresql::server::schema`](#postgresqlserverschema): Create a new schema.
* [`postgresql::server::table_grant`](#postgresqlservertable_grant): This resource wraps the grant resource to manage table grants specifically.
* [`postgresql::server::tablespace`](#postgresqlservertablespace): This module creates tablespace.
* [`postgresql::validate_db_connection`](#postgresqlvalidate_db_connection): This type validates that a successful postgres connection.

### Resource types

* [`postgresql_conf`](#postgresql_conf): This type allows puppet to manage postgresql.conf parameters.
* [`postgresql_conn_validator`](#postgresql_conn_validator): Verify if a connection can be successfully established
* [`postgresql_psql`](#postgresql_psql): An arbitrary tag for your own reference; the name of the message.
* [`postgresql_replication_slot`](#postgresql_replication_slot): Manages Postgresql replication slots.

### Functions

#### Public Functions

* [`postgresql::default`](#postgresqldefault): This function pull default values from the `params` class  or `globals` class if the value is not present in `params`.
* [`postgresql::postgresql_escape`](#postgresqlpostgresql_escape): This function escapes a string using [Dollar Quoting](https://www.postgresql.org/docs/12/sql-syntax-lexical.html#SQL-SYNTAX-DOLLAR-QUOTING) using a randomly generated tag if required.
* [`postgresql::postgresql_password`](#postgresqlpostgresql_password): This function returns the postgresql password hash from the clear text username / password
* [`postgresql_escape`](#postgresql_escape): DEPRECATED.  Use the namespaced function [`postgresql::postgresql_escape`](#postgresqlpostgresql_escape) instead.
* [`postgresql_password`](#postgresql_password): DEPRECATED.  Use the namespaced function [`postgresql::postgresql_password`](#postgresqlpostgresql_password) instead.

#### Private Functions

* `postgresql::postgresql_acls_to_resources_hash`: This internal function translates the ipv(4|6)acls format into a resource suitable for create_resources.

### Tasks

* [`sql`](#sql): Allows you to execute arbitary SQL

## Classes

### <a name="postgresqlclient"></a>`postgresql::client`

Installs PostgreSQL client software. Set the following parameters if you have a custom version you would like to install.

* **Note** Make sure to add any necessary yum or apt repositories if specifying a custom version.

#### Parameters

The following parameters are available in the `postgresql::client` class:

* [`file_ensure`](#file_ensure)
* [`validcon_script_path`](#validcon_script_path)
* [`package_name`](#package_name)
* [`package_ensure`](#package_ensure)

##### <a name="file_ensure"></a>`file_ensure`

Data type: `Enum['file', 'absent']`

Ensure the connection validation script is present

Default value: `'file'`

##### <a name="validcon_script_path"></a>`validcon_script_path`

Data type: `Stdlib::Absolutepath`

Optional. Absolute path for the postgresql connection validation script.

Default value: `$postgresql::params::validcon_script_path`

##### <a name="package_name"></a>`package_name`

Data type: `String[1]`

Sets the name of the PostgreSQL client package.

Default value: `$postgresql::params::client_package_name`

##### <a name="package_ensure"></a>`package_ensure`

Data type: `String[1]`

Ensure the client package is installed

Default value: `'present'`

### <a name="postgresqlglobals"></a>`postgresql::globals`

Class for setting cross-class global overrides.

* **Note** Most server-specific defaults should be overridden in the postgresql::server class.
This class should be used only if you are using a non-standard OS, or if you are changing elements that can only be changed here, such as version or manage_package_repo.

#### Parameters

The following parameters are available in the `postgresql::globals` class:

* [`client_package_name`](#client_package_name)
* [`server_package_name`](#server_package_name)
* [`contrib_package_name`](#contrib_package_name)
* [`devel_package_name`](#devel_package_name)
* [`java_package_name`](#java_package_name)
* [`docs_package_name`](#docs_package_name)
* [`perl_package_name`](#perl_package_name)
* [`plperl_package_name`](#plperl_package_name)
* [`plpython_package_name`](#plpython_package_name)
* [`python_package_name`](#python_package_name)
* [`postgis_package_name`](#postgis_package_name)
* [`service_name`](#service_name)
* [`service_provider`](#service_provider)
* [`service_status`](#service_status)
* [`default_database`](#default_database)
* [`validcon_script_path`](#validcon_script_path)
* [`initdb_path`](#initdb_path)
* [`createdb_path`](#createdb_path)
* [`psql_path`](#psql_path)
* [`pg_hba_conf_path`](#pg_hba_conf_path)
* [`pg_ident_conf_path`](#pg_ident_conf_path)
* [`postgresql_conf_path`](#postgresql_conf_path)
* [`postgresql_conf_mode`](#postgresql_conf_mode)
* [`recovery_conf_path`](#recovery_conf_path)
* [`default_connect_settings`](#default_connect_settings)
* [`pg_hba_conf_defaults`](#pg_hba_conf_defaults)
* [`datadir`](#datadir)
* [`confdir`](#confdir)
* [`bindir`](#bindir)
* [`xlogdir`](#xlogdir)
* [`logdir`](#logdir)
* [`log_line_prefix`](#log_line_prefix)
* [`user`](#user)
* [`group`](#group)
* [`version`](#version)
* [`postgis_version`](#postgis_version)
* [`repo_proxy`](#repo_proxy)
* [`repo_baseurl`](#repo_baseurl)
* [`yum_repo_commonurl`](#yum_repo_commonurl)
* [`needs_initdb`](#needs_initdb)
* [`encoding`](#encoding)
* [`locale`](#locale)
* [`data_checksums`](#data_checksums)
* [`timezone`](#timezone)
* [`manage_pg_hba_conf`](#manage_pg_hba_conf)
* [`manage_pg_ident_conf`](#manage_pg_ident_conf)
* [`manage_recovery_conf`](#manage_recovery_conf)
* [`manage_postgresql_conf_perms`](#manage_postgresql_conf_perms)
* [`manage_datadir`](#manage_datadir)
* [`manage_logdir`](#manage_logdir)
* [`manage_xlogdir`](#manage_xlogdir)
* [`manage_package_repo`](#manage_package_repo)
* [`manage_dnf_module`](#manage_dnf_module)
* [`module_workdir`](#module_workdir)
* [`manage_selinux`](#manage_selinux)

##### <a name="client_package_name"></a>`client_package_name`

Data type: `Any`

Overrides the default PostgreSQL client package name.

Default value: ``undef``

##### <a name="server_package_name"></a>`server_package_name`

Data type: `Any`

Overrides the default PostgreSQL server package name.

Default value: ``undef``

##### <a name="contrib_package_name"></a>`contrib_package_name`

Data type: `Any`

Overrides the default PostgreSQL contrib package name.

Default value: ``undef``

##### <a name="devel_package_name"></a>`devel_package_name`

Data type: `Any`

Overrides the default PostgreSQL devel package name.

Default value: ``undef``

##### <a name="java_package_name"></a>`java_package_name`

Data type: `Any`

Overrides the default PostgreSQL java package name.

Default value: ``undef``

##### <a name="docs_package_name"></a>`docs_package_name`

Data type: `Any`

Overrides the default PostgreSQL docs package name.

Default value: ``undef``

##### <a name="perl_package_name"></a>`perl_package_name`

Data type: `Any`

Overrides the default PostgreSQL Perl package name.

Default value: ``undef``

##### <a name="plperl_package_name"></a>`plperl_package_name`

Data type: `Any`

Overrides the default PostgreSQL PL/Perl package name.

Default value: ``undef``

##### <a name="plpython_package_name"></a>`plpython_package_name`

Data type: `Any`

Overrides the default PostgreSQL PL/Python package name.

Default value: ``undef``

##### <a name="python_package_name"></a>`python_package_name`

Data type: `Any`

Overrides the default PostgreSQL Python package name.

Default value: ``undef``

##### <a name="postgis_package_name"></a>`postgis_package_name`

Data type: `Any`

Overrides the default PostgreSQL PostGIS package name.

Default value: ``undef``

##### <a name="service_name"></a>`service_name`

Data type: `Any`

Overrides the default PostgreSQL service name.

Default value: ``undef``

##### <a name="service_provider"></a>`service_provider`

Data type: `Any`

Overrides the default PostgreSQL service provider.

Default value: ``undef``

##### <a name="service_status"></a>`service_status`

Data type: `Any`

Overrides the default status check command for your PostgreSQL service.

Default value: ``undef``

##### <a name="default_database"></a>`default_database`

Data type: `Any`

Specifies the name of the default database to connect with.

Default value: ``undef``

##### <a name="validcon_script_path"></a>`validcon_script_path`

Data type: `Any`

Scipt path for the connection validation check.

Default value: ``undef``

##### <a name="initdb_path"></a>`initdb_path`

Data type: `Any`

Path to the initdb command.

Default value: ``undef``

##### <a name="createdb_path"></a>`createdb_path`

Data type: `Any`

Deprecated. Path to the createdb command.

Default value: ``undef``

##### <a name="psql_path"></a>`psql_path`

Data type: `Any`

Sets the path to the psql command.

Default value: ``undef``

##### <a name="pg_hba_conf_path"></a>`pg_hba_conf_path`

Data type: `Any`

Specifies the path to your pg_hba.conf file.

Default value: ``undef``

##### <a name="pg_ident_conf_path"></a>`pg_ident_conf_path`

Data type: `Any`

Specifies the path to your pg_ident.conf file.

Default value: ``undef``

##### <a name="postgresql_conf_path"></a>`postgresql_conf_path`

Data type: `Any`

Sets the path to your postgresql.conf file.

Default value: ``undef``

##### <a name="postgresql_conf_mode"></a>`postgresql_conf_mode`

Data type: `Optional[Stdlib::Filemode]`

Sets the mode of your postgresql.conf file. Only relevant if manage_postgresql_conf_perms is true.

Default value: ``undef``

##### <a name="recovery_conf_path"></a>`recovery_conf_path`

Data type: `Any`

Path to your recovery.conf file.

Default value: ``undef``

##### <a name="default_connect_settings"></a>`default_connect_settings`

Data type: `Any`

Default connection settings.

Default value: `{}`

##### <a name="pg_hba_conf_defaults"></a>`pg_hba_conf_defaults`

Data type: `Any`

Disables the defaults supplied with the module for pg_hba.conf if set to false.

Default value: ``undef``

##### <a name="datadir"></a>`datadir`

Data type: `Any`

Overrides the default PostgreSQL data directory for the target platform.
Changing the datadir after installation causes the server to come to a full stop before making the change.
For Red Hat systems, the data directory must be labeled appropriately for SELinux.
On Ubuntu, you must explicitly set needs_initdb = true to allow Puppet to initialize the database in the new datadir (needs_initdb defaults to true on other systems).
Warning! If datadir is changed from the default, Puppet does not manage purging of the original data directory, which causes it to fail if the data directory is changed back to the original

Default value: ``undef``

##### <a name="confdir"></a>`confdir`

Data type: `Any`

Overrides the default PostgreSQL configuration directory for the target platform.

Default value: ``undef``

##### <a name="bindir"></a>`bindir`

Data type: `Any`

Overrides the default PostgreSQL binaries directory for the target platform.

Default value: ``undef``

##### <a name="xlogdir"></a>`xlogdir`

Data type: `Any`

Overrides the default PostgreSQL xlog directory.

Default value: ``undef``

##### <a name="logdir"></a>`logdir`

Data type: `Any`

Overrides the default PostgreSQL log directory.

Default value: ``undef``

##### <a name="log_line_prefix"></a>`log_line_prefix`

Data type: `Any`

Overrides the default PostgreSQL log prefix.

Default value: ``undef``

##### <a name="user"></a>`user`

Data type: `Any`

Overrides the default PostgreSQL super user and owner of PostgreSQL related files in the file system.

Default value: ``undef``

##### <a name="group"></a>`group`

Data type: `Any`

Overrides the default postgres user group to be used for related files in the file system.

Default value: ``undef``

##### <a name="version"></a>`version`

Data type: `Any`

The version of PostgreSQL to install and manage.

Default value: ``undef``

##### <a name="postgis_version"></a>`postgis_version`

Data type: `Any`

Defines the version of PostGIS to install, if you install PostGIS.

Default value: ``undef``

##### <a name="repo_proxy"></a>`repo_proxy`

Data type: `Any`

Sets the proxy option for the official PostgreSQL yum-repositories only.

Default value: ``undef``

##### <a name="repo_baseurl"></a>`repo_baseurl`

Data type: `Any`

Sets the baseurl for the PostgreSQL repository. Useful if you host your own mirror of the repository.

Default value: ``undef``

##### <a name="yum_repo_commonurl"></a>`yum_repo_commonurl`

Data type: `Any`

Sets the url for the PostgreSQL common Yum repository. Useful if you host your own mirror of the YUM repository.

Default value: ``undef``

##### <a name="needs_initdb"></a>`needs_initdb`

Data type: `Any`

Explicitly calls the initdb operation after the server package is installed and before the PostgreSQL service is started.

Default value: ``undef``

##### <a name="encoding"></a>`encoding`

Data type: `Any`

Sets the default encoding for all databases created with this module.
On certain operating systems, this is also used during the template1 initialization, so it becomes a default outside of the module as well.

Default value: ``undef``

##### <a name="locale"></a>`locale`

Data type: `Any`

Sets the default database locale for all databases created with this module.
On certain operating systems, this is also used during the template1 initialization, so it becomes a default outside of the module as well.
On Debian, you'll need to ensure that the 'locales-all' package is installed for full functionality of PostgreSQL.

Default value: ``undef``

##### <a name="data_checksums"></a>`data_checksums`

Data type: `Any`

Use checksums on data pages to help detect corruption by the I/O system that would otherwise be silent.
Warning: This option is used during initialization by initdb, and cannot be changed later.

Default value: ``undef``

##### <a name="timezone"></a>`timezone`

Data type: `Any`

Sets the default timezone of the postgresql server. The postgresql built-in default is taking the systems timezone information.

Default value: ``undef``

##### <a name="manage_pg_hba_conf"></a>`manage_pg_hba_conf`

Data type: `Any`

Allow Puppet to manage the pg_hba.conf file.

Default value: ``undef``

##### <a name="manage_pg_ident_conf"></a>`manage_pg_ident_conf`

Data type: `Any`

Allow Puppet to manage the pg_ident.conf file.

Default value: ``undef``

##### <a name="manage_recovery_conf"></a>`manage_recovery_conf`

Data type: `Any`

Allow Puppet to manage the recovery.conf file.

Default value: ``undef``

##### <a name="manage_postgresql_conf_perms"></a>`manage_postgresql_conf_perms`

Data type: `Any`

Whether to manage the postgresql conf file permissions. This means owner,
group and mode. Contents are not managed but should be managed through
postgresql::server::config_entry.

Default value: ``undef``

##### <a name="manage_datadir"></a>`manage_datadir`

Data type: `Any`

Set to false if you have file{ $datadir: } already defined

Default value: ``undef``

##### <a name="manage_logdir"></a>`manage_logdir`

Data type: `Any`

Set to false if you have file{ $logdir: } already defined

Default value: ``undef``

##### <a name="manage_xlogdir"></a>`manage_xlogdir`

Data type: `Any`

Set to false if you have file{ $xlogdir: } already defined

Default value: ``undef``

##### <a name="manage_package_repo"></a>`manage_package_repo`

Data type: `Any`

Sets up official PostgreSQL repositories on your host if set to true.

Default value: ``undef``

##### <a name="manage_dnf_module"></a>`manage_dnf_module`

Data type: `Boolean`

Manage the DNF module. This only makes sense on distributions that use DNF
package manager, such as EL8 or Fedora. It also requires Puppet 5.5.20+ or
Puppet 6.15.0+ since they ship the dnfmodule provider.

Default value: ``false``

##### <a name="module_workdir"></a>`module_workdir`

Data type: `Any`

Specifies working directory under which the psql command should be executed. May need to specify if '/tmp' is on volume mounted with noexec option.

Default value: ``undef``

##### <a name="manage_selinux"></a>`manage_selinux`

Data type: `Any`



Default value: ``undef``

### <a name="postgresqllibdevel"></a>`postgresql::lib::devel`

This class installs postgresql development libraries.

#### Parameters

The following parameters are available in the `postgresql::lib::devel` class:

* [`package_name`](#package_name)
* [`package_ensure`](#package_ensure)
* [`link_pg_config`](#link_pg_config)

##### <a name="package_name"></a>`package_name`

Data type: `String`

Override devel package name

Default value: `$postgresql::params::devel_package_name`

##### <a name="package_ensure"></a>`package_ensure`

Data type: `String[1]`

Ensure the development libraries are installed

Default value: `'present'`

##### <a name="link_pg_config"></a>`link_pg_config`

Data type: `Boolean`

If the bin directory used by the PostgreSQL page is not /usr/bin or /usr/local/bin, symlinks pg_config from the package's bin dir into usr/bin (not applicable to Debian systems). Set to false to disable this behavior.

Default value: `$postgresql::params::link_pg_config`

### <a name="postgresqllibdocs"></a>`postgresql::lib::docs`

Installs PostgreSQL bindings for Postgres-Docs. Set the following parameters if you have a custom version you would like to install.

* **Note** Make sure to add any necessary yum or apt repositories if specifying a custom version.

#### Parameters

The following parameters are available in the `postgresql::lib::docs` class:

* [`package_name`](#package_name)
* [`package_ensure`](#package_ensure)

##### <a name="package_name"></a>`package_name`

Data type: `String`

Specifies the name of the PostgreSQL docs package.

Default value: `$postgresql::params::docs_package_name`

##### <a name="package_ensure"></a>`package_ensure`

Data type: `String[1]`

Whether the PostgreSQL docs package resource should be present.

Default value: `'present'`

### <a name="postgresqllibjava"></a>`postgresql::lib::java`

This class installs the postgresql jdbc connector.

* **Note** Make sure to add any necessary yum or apt repositories if specifying a custom version.

#### Parameters

The following parameters are available in the `postgresql::lib::java` class:

* [`package_name`](#package_name)
* [`package_ensure`](#package_ensure)

##### <a name="package_name"></a>`package_name`

Data type: `String`

Specifies the name of the PostgreSQL java package.

Default value: `$postgresql::params::java_package_name`

##### <a name="package_ensure"></a>`package_ensure`

Data type: `String[1]`

Specifies whether the package is present.

Default value: `'present'`

### <a name="postgresqllibperl"></a>`postgresql::lib::perl`

This class installs the perl libs for postgresql.

#### Parameters

The following parameters are available in the `postgresql::lib::perl` class:

* [`package_name`](#package_name)
* [`package_ensure`](#package_ensure)

##### <a name="package_name"></a>`package_name`

Data type: `String`

Specifies the name of the PostgreSQL perl package to install.

Default value: `$postgresql::params::perl_package_name`

##### <a name="package_ensure"></a>`package_ensure`

Data type: `String[1]`

Ensure the perl libs for postgresql are installed.

Default value: `'present'`

### <a name="postgresqllibpython"></a>`postgresql::lib::python`

This class installs the python libs for postgresql.

#### Parameters

The following parameters are available in the `postgresql::lib::python` class:

* [`package_name`](#package_name)
* [`package_ensure`](#package_ensure)

##### <a name="package_name"></a>`package_name`

Data type: `String[1]`

The name of the PostgreSQL Python package.

Default value: `$postgresql::params::python_package_name`

##### <a name="package_ensure"></a>`package_ensure`

Data type: `String[1]`

Ensure the python libs for postgresql are installed.

Default value: `'present'`

### <a name="postgresqlserver"></a>`postgresql::server`

This installs a PostgreSQL server

#### Parameters

The following parameters are available in the `postgresql::server` class:

* [`postgres_password`](#postgres_password)
* [`package_name`](#package_name)
* [`package_ensure`](#package_ensure)
* [`plperl_package_name`](#plperl_package_name)
* [`plpython_package_name`](#plpython_package_name)
* [`service_ensure`](#service_ensure)
* [`service_enable`](#service_enable)
* [`service_manage`](#service_manage)
* [`service_name`](#service_name)
* [`service_restart_on_change`](#service_restart_on_change)
* [`service_provider`](#service_provider)
* [`service_reload`](#service_reload)
* [`service_status`](#service_status)
* [`default_database`](#default_database)
* [`default_connect_settings`](#default_connect_settings)
* [`listen_addresses`](#listen_addresses)
* [`port`](#port)
* [`ip_mask_deny_postgres_user`](#ip_mask_deny_postgres_user)
* [`ip_mask_allow_all_users`](#ip_mask_allow_all_users)
* [`ipv4acls`](#ipv4acls)
* [`ipv6acls`](#ipv6acls)
* [`initdb_path`](#initdb_path)
* [`createdb_path`](#createdb_path)
* [`psql_path`](#psql_path)
* [`pg_hba_conf_path`](#pg_hba_conf_path)
* [`pg_ident_conf_path`](#pg_ident_conf_path)
* [`postgresql_conf_path`](#postgresql_conf_path)
* [`postgresql_conf_mode`](#postgresql_conf_mode)
* [`recovery_conf_path`](#recovery_conf_path)
* [`datadir`](#datadir)
* [`xlogdir`](#xlogdir)
* [`logdir`](#logdir)
* [`log_line_prefix`](#log_line_prefix)
* [`pg_hba_conf_defaults`](#pg_hba_conf_defaults)
* [`user`](#user)
* [`group`](#group)
* [`needs_initdb`](#needs_initdb)
* [`encoding`](#encoding)
* [`locale`](#locale)
* [`data_checksums`](#data_checksums)
* [`timezone`](#timezone)
* [`manage_pg_hba_conf`](#manage_pg_hba_conf)
* [`manage_pg_ident_conf`](#manage_pg_ident_conf)
* [`manage_recovery_conf`](#manage_recovery_conf)
* [`manage_postgresql_conf_perms`](#manage_postgresql_conf_perms)
* [`module_workdir`](#module_workdir)
* [`manage_datadir`](#manage_datadir)
* [`manage_logdir`](#manage_logdir)
* [`manage_xlogdir`](#manage_xlogdir)
* [`roles`](#roles)
* [`config_entries`](#config_entries)
* [`pg_hba_rules`](#pg_hba_rules)
* [`version`](#version)
* [`extra_systemd_config`](#extra_systemd_config)
* [`manage_selinux`](#manage_selinux)
* [`password_encryption`](#password_encryption)

##### <a name="postgres_password"></a>`postgres_password`

Data type: `Optional[Variant[String[1], Sensitive[String[1]], Integer]]`

Sets the password for the postgres user to your specified value. By default, this setting uses the superuser account in the Postgres database, with a user called postgres and no password.

Default value: ``undef``

##### <a name="package_name"></a>`package_name`

Data type: `Any`

Specifies the name of the package to use for installing the server software.

Default value: `$postgresql::params::server_package_name`

##### <a name="package_ensure"></a>`package_ensure`

Data type: `Any`

Passes a value through to the package resource when creating the server instance.

Default value: `$postgresql::params::package_ensure`

##### <a name="plperl_package_name"></a>`plperl_package_name`

Data type: `Any`

Sets the default package name for the PL/Perl extension.

Default value: `$postgresql::params::plperl_package_name`

##### <a name="plpython_package_name"></a>`plpython_package_name`

Data type: `Any`

Sets the default package name for the PL/Python extension.

Default value: `$postgresql::params::plpython_package_name`

##### <a name="service_ensure"></a>`service_ensure`

Data type: `Any`

Ensure service is installed

Default value: `$postgresql::params::service_ensure`

##### <a name="service_enable"></a>`service_enable`

Data type: `Any`

Enable the PostgreSQL service

Default value: `$postgresql::params::service_enable`

##### <a name="service_manage"></a>`service_manage`

Data type: `Any`

Defines whether or not Puppet should manage the service.

Default value: `$postgresql::params::service_manage`

##### <a name="service_name"></a>`service_name`

Data type: `Any`

Overrides the default PostgreSQL service name.

Default value: `$postgresql::params::service_name`

##### <a name="service_restart_on_change"></a>`service_restart_on_change`

Data type: `Any`

Overrides the default behavior to restart your PostgreSQL service when a config entry has been changed that requires a service restart to become active.

Default value: `$postgresql::params::service_restart_on_change`

##### <a name="service_provider"></a>`service_provider`

Data type: `Any`

Overrides the default PostgreSQL service provider.

Default value: `$postgresql::params::service_provider`

##### <a name="service_reload"></a>`service_reload`

Data type: `Any`

Overrides the default reload command for your PostgreSQL service.

Default value: `$postgresql::params::service_reload`

##### <a name="service_status"></a>`service_status`

Data type: `Any`

Overrides the default status check command for your PostgreSQL service.

Default value: `$postgresql::params::service_status`

##### <a name="default_database"></a>`default_database`

Data type: `Any`

Specifies the name of the default database to connect with. On most systems this is 'postgres'.

Default value: `$postgresql::params::default_database`

##### <a name="default_connect_settings"></a>`default_connect_settings`

Data type: `Any`

Specifies a hash of environment variables used when connecting to a remote server. Becomes the default for other defined types, such as postgresql::server::role.

Default value: `$postgresql::globals::default_connect_settings`

##### <a name="listen_addresses"></a>`listen_addresses`

Data type: `Any`

Address list on which the PostgreSQL service will listen

Default value: `$postgresql::params::listen_addresses`

##### <a name="port"></a>`port`

Data type: `Any`

Specifies the port for the PostgreSQL server to listen on. Note: The same port number is used for all IP addresses the server listens on. Also, for Red Hat systems and early Debian systems, changing the port causes the server to come to a full stop before being able to make the change.
Default value: 5432. Meaning the Postgres server listens on TCP port 5432.

Default value: `$postgresql::params::port`

##### <a name="ip_mask_deny_postgres_user"></a>`ip_mask_deny_postgres_user`

Data type: `Any`

Specifies the IP mask from which remote connections should be denied for the postgres superuser.
Default value: '0.0.0.0/0', which denies any remote connection.

Default value: `$postgresql::params::ip_mask_deny_postgres_user`

##### <a name="ip_mask_allow_all_users"></a>`ip_mask_allow_all_users`

Data type: `Any`

Overrides PostgreSQL defaults for remote connections. By default, PostgreSQL does not allow database user accounts to connect via TCP from remote machines. If you'd like to allow this, you can override this setting.
Set to '0.0.0.0/0' to allow database users to connect from any remote machine, or '192.168.0.0/1' to allow connections from any machine on your local '192.168' subnet.
Default value: '127.0.0.1/32'.

Default value: `$postgresql::params::ip_mask_allow_all_users`

##### <a name="ipv4acls"></a>`ipv4acls`

Data type: `Array[String[1]]`

Lists strings for access control for connection method, users, databases, IPv4 addresses;

Default value: `$postgresql::params::ipv4acls`

##### <a name="ipv6acls"></a>`ipv6acls`

Data type: `Array[String[1]]`

Lists strings for access control for connection method, users, databases, IPv6 addresses.

Default value: `$postgresql::params::ipv6acls`

##### <a name="initdb_path"></a>`initdb_path`

Data type: `Any`

Specifies the path to the initdb command.

Default value: `$postgresql::params::initdb_path`

##### <a name="createdb_path"></a>`createdb_path`

Data type: `Any`

Deprecated. Specifies the path to the createdb command.

Default value: `$postgresql::params::createdb_path`

##### <a name="psql_path"></a>`psql_path`

Data type: `Any`

Specifies the path to the psql command.

Default value: `$postgresql::params::psql_path`

##### <a name="pg_hba_conf_path"></a>`pg_hba_conf_path`

Data type: `Any`

Specifies the path to your pg_hba.conf file.

Default value: `$postgresql::params::pg_hba_conf_path`

##### <a name="pg_ident_conf_path"></a>`pg_ident_conf_path`

Data type: `Any`

Specifies the path to your pg_ident.conf file.

Default value: `$postgresql::params::pg_ident_conf_path`

##### <a name="postgresql_conf_path"></a>`postgresql_conf_path`

Data type: `Any`

Specifies the path to your postgresql.conf file.

Default value: `$postgresql::params::postgresql_conf_path`

##### <a name="postgresql_conf_mode"></a>`postgresql_conf_mode`

Data type: `Optional[Stdlib::Filemode]`

Sets the mode of your postgresql.conf file. Only relevant if manage_postgresql_conf_perms is true.

Default value: `$postgresql::params::postgresql_conf_mode`

##### <a name="recovery_conf_path"></a>`recovery_conf_path`

Data type: `Any`

Specifies the path to your recovery.conf file.

Default value: `$postgresql::params::recovery_conf_path`

##### <a name="datadir"></a>`datadir`

Data type: `Any`

PostgreSQL data directory

Default value: `$postgresql::params::datadir`

##### <a name="xlogdir"></a>`xlogdir`

Data type: `Any`

PostgreSQL xlog directory

Default value: `$postgresql::params::xlogdir`

##### <a name="logdir"></a>`logdir`

Data type: `Any`

PostgreSQL log directory

Default value: `$postgresql::params::logdir`

##### <a name="log_line_prefix"></a>`log_line_prefix`

Data type: `Any`

PostgreSQL log line prefix

Default value: `$postgresql::params::log_line_prefix`

##### <a name="pg_hba_conf_defaults"></a>`pg_hba_conf_defaults`

Data type: `Any`

If false, disables the defaults supplied with the module for pg_hba.conf. This is useful if you disagree with the defaults and wish to override them yourself. Be sure that your changes of course align with the rest of the module, as some access is required to perform basic psql operations for example.

Default value: `$postgresql::params::pg_hba_conf_defaults`

##### <a name="user"></a>`user`

Data type: `Any`

Overrides the default PostgreSQL super user and owner of PostgreSQL related files in the file system.

Default value: `$postgresql::params::user`

##### <a name="group"></a>`group`

Data type: `Any`

Overrides the default postgres user group to be used for related files in the file system.

Default value: `$postgresql::params::group`

##### <a name="needs_initdb"></a>`needs_initdb`

Data type: `Any`

Explicitly calls the initdb operation after server package is installed, and before the PostgreSQL service is started.

Default value: `$postgresql::params::needs_initdb`

##### <a name="encoding"></a>`encoding`

Data type: `Any`

Sets the default encoding for all databases created with this module. On certain operating systems this is also used during the template1 initialization, so it becomes a default outside of the module as well.

Default value: `$postgresql::params::encoding`

##### <a name="locale"></a>`locale`

Data type: `Any`

Sets the default database locale for all databases created with this module. On certain operating systems this is used during the template1 initialization as well, so it becomes a default outside of the module.

Default value: `$postgresql::params::locale`

##### <a name="data_checksums"></a>`data_checksums`

Data type: `Any`

Boolean. Use checksums on data pages to help detect corruption by the I/O system that would otherwise be silent.
Warning: This option is used during initialization by initdb, and cannot be changed later. If set, checksums are calculated for all objects, in all databases.

Default value: `$postgresql::params::data_checksums`

##### <a name="timezone"></a>`timezone`

Data type: `Any`

Set timezone for the PostgreSQL instance

Default value: `$postgresql::params::timezone`

##### <a name="manage_pg_hba_conf"></a>`manage_pg_hba_conf`

Data type: `Any`

Boolean. Whether to manage the pg_hba.conf.

Default value: `$postgresql::params::manage_pg_hba_conf`

##### <a name="manage_pg_ident_conf"></a>`manage_pg_ident_conf`

Data type: `Any`

Boolean. Overwrites the pg_ident.conf file.

Default value: `$postgresql::params::manage_pg_ident_conf`

##### <a name="manage_recovery_conf"></a>`manage_recovery_conf`

Data type: `Any`

Boolean. Specifies whether or not manage the recovery.conf.

Default value: `$postgresql::params::manage_recovery_conf`

##### <a name="manage_postgresql_conf_perms"></a>`manage_postgresql_conf_perms`

Data type: `Boolean`

Whether to manage the postgresql conf file permissions. This means owner,
group and mode. Contents are not managed but should be managed through
postgresql::server::config_entry.

Default value: `$postgresql::params::manage_postgresql_conf_perms`

##### <a name="module_workdir"></a>`module_workdir`

Data type: `Any`

Working directory for the PostgreSQL module

Default value: `$postgresql::params::module_workdir`

##### <a name="manage_datadir"></a>`manage_datadir`

Data type: `Any`

Set to false if you have file{ $datadir: } already defined

Default value: `$postgresql::params::manage_datadir`

##### <a name="manage_logdir"></a>`manage_logdir`

Data type: `Any`

Set to false if you have file{ $logdir: } already defined

Default value: `$postgresql::params::manage_logdir`

##### <a name="manage_xlogdir"></a>`manage_xlogdir`

Data type: `Any`

Set to false if you have file{ $xlogdir: } already defined

Default value: `$postgresql::params::manage_xlogdir`

##### <a name="roles"></a>`roles`

Data type: `Hash[String, Hash]`

Specifies a hash from which to generate postgresql::server::role resources.

Default value: `{}`

##### <a name="config_entries"></a>`config_entries`

Data type: `Hash[String, Any]`

Specifies a hash from which to generate postgresql::server::config_entry resources.

Default value: `{}`

##### <a name="pg_hba_rules"></a>`pg_hba_rules`

Data type: `Hash[String, Hash]`

Specifies a hash from which to generate postgresql::server::pg_hba_rule resources.

Default value: `{}`

##### <a name="version"></a>`version`

Data type: `Any`

Deprecated. Use postgresql::globals instead. Sets PostgreSQL version

Default value: ``undef``

##### <a name="extra_systemd_config"></a>`extra_systemd_config`

Data type: `Any`

Adds extra config to systemd config file, can for instance be used to add extra openfiles. This can be a multi line string

Default value: `$postgresql::params::extra_systemd_config`

##### <a name="manage_selinux"></a>`manage_selinux`

Data type: `Boolean`



Default value: `$postgresql::params::manage_selinux`

##### <a name="password_encryption"></a>`password_encryption`

Data type: `Any`



Default value: `$postgresql::params::password_encryption`

### <a name="postgresqlservercontrib"></a>`postgresql::server::contrib`

Install the contrib postgresql packaging.

#### Parameters

The following parameters are available in the `postgresql::server::contrib` class:

* [`package_name`](#package_name)
* [`package_ensure`](#package_ensure)

##### <a name="package_name"></a>`package_name`

Data type: `Optional[String[1]]`

The name of the PostgreSQL contrib package.

Default value: `$postgresql::params::contrib_package_name`

##### <a name="package_ensure"></a>`package_ensure`

Data type: `String[1]`

Ensure the contrib package is installed.

Default value: `'present'`

### <a name="postgresqlserverplperl"></a>`postgresql::server::plperl`

This class installs the PL/Perl procedural language for postgresql.

#### Parameters

The following parameters are available in the `postgresql::server::plperl` class:

* [`package_ensure`](#package_ensure)
* [`package_name`](#package_name)

##### <a name="package_ensure"></a>`package_ensure`

Data type: `Any`

The ensure parameter passed on to PostgreSQL PL/Perl package resource.

Default value: `'present'`

##### <a name="package_name"></a>`package_name`

Data type: `Any`

The name of the PostgreSQL PL/Perl package.

Default value: `$postgresql::server::plperl_package_name`

### <a name="postgresqlserverplpython"></a>`postgresql::server::plpython`

This class installs the PL/Python procedural language for postgresql.

#### Parameters

The following parameters are available in the `postgresql::server::plpython` class:

* [`package_ensure`](#package_ensure)
* [`package_name`](#package_name)

##### <a name="package_ensure"></a>`package_ensure`

Data type: `Any`

Specifies whether the package is present.

Default value: `'present'`

##### <a name="package_name"></a>`package_name`

Data type: `Any`

Specifies the name of the postgresql PL/Python package.

Default value: `$postgresql::server::plpython_package_name`

### <a name="postgresqlserverpostgis"></a>`postgresql::server::postgis`

Install the postgis postgresql packaging.

#### Parameters

The following parameters are available in the `postgresql::server::postgis` class:

* [`package_name`](#package_name)
* [`package_ensure`](#package_ensure)

##### <a name="package_name"></a>`package_name`

Data type: `String`

Sets the package name.

Default value: `$postgresql::params::postgis_package_name`

##### <a name="package_ensure"></a>`package_ensure`

Data type: `String[1]`

Specifies if the package is present or not.

Default value: `'present'`

## Defined types

### <a name="postgresqlserverconfig_entry"></a>`postgresql::server::config_entry`

Manage a postgresql.conf entry.

#### Parameters

The following parameters are available in the `postgresql::server::config_entry` defined type:

* [`ensure`](#ensure)
* [`value`](#value)
* [`path`](#path)

##### <a name="ensure"></a>`ensure`

Data type: `Enum['present', 'absent']`

Removes an entry if set to 'absent'.

Default value: `'present'`

##### <a name="value"></a>`value`

Data type: `Any`

Defines the value for the setting.

Default value: ``undef``

##### <a name="path"></a>`path`

Data type: `Any`

Path for postgresql.conf

Default value: ``false``

### <a name="postgresqlserverdatabase"></a>`postgresql::server::database`

Define for creating a database.

#### Parameters

The following parameters are available in the `postgresql::server::database` defined type:

* [`comment`](#comment)
* [`dbname`](#dbname)
* [`owner`](#owner)
* [`tablespace`](#tablespace)
* [`template`](#template)
* [`encoding`](#encoding)
* [`locale`](#locale)
* [`istemplate`](#istemplate)
* [`connect_settings`](#connect_settings)

##### <a name="comment"></a>`comment`

Data type: `Any`

Sets a comment on the database.

Default value: ``undef``

##### <a name="dbname"></a>`dbname`

Data type: `Any`

Sets the name of the database.

Default value: `$title`

##### <a name="owner"></a>`owner`

Data type: `Any`

Sets name of the database owner.

Default value: ``undef``

##### <a name="tablespace"></a>`tablespace`

Data type: `Any`

Sets tablespace for where to create this database.

Default value: ``undef``

##### <a name="template"></a>`template`

Data type: `Any`

Specifies the name of the template database from which to build this database. Default value: 'template0'.

Default value: `'template0'`

##### <a name="encoding"></a>`encoding`

Data type: `Any`

Overrides the character set during creation of the database.

Default value: `$postgresql::server::encoding`

##### <a name="locale"></a>`locale`

Data type: `Any`

Overrides the locale during creation of the database.

Default value: `$postgresql::server::locale`

##### <a name="istemplate"></a>`istemplate`

Data type: `Any`

Defines the database as a template if set to true.

Default value: ``false``

##### <a name="connect_settings"></a>`connect_settings`

Data type: `Any`

Specifies a hash of environment variables used when connecting to a remote server.

Default value: `$postgresql::server::default_connect_settings`

### <a name="postgresqlserverdatabase_grant"></a>`postgresql::server::database_grant`

Manage a database grant.

#### Parameters

The following parameters are available in the `postgresql::server::database_grant` defined type:

* [`privilege`](#privilege)
* [`db`](#db)
* [`role`](#role)
* [`ensure`](#ensure)
* [`psql_db`](#psql_db)
* [`psql_user`](#psql_user)
* [`connect_settings`](#connect_settings)

##### <a name="privilege"></a>`privilege`

Data type: `Any`

Specifies comma-separated list of privileges to grant. Valid options: 'ALL', 'CREATE', 'CONNECT', 'TEMPORARY', 'TEMP'.

##### <a name="db"></a>`db`

Data type: `Any`

Specifies the database to which you are granting access.

##### <a name="role"></a>`role`

Data type: `Any`

Specifies the role or user whom you are granting access to.

##### <a name="ensure"></a>`ensure`

Data type: `Any`

Specifies whether to grant or revoke the privilege. Revoke or 'absent' works only in PostgreSQL version 9.1.24 or later.

Default value: ``undef``

##### <a name="psql_db"></a>`psql_db`

Data type: `Any`

Defines the database to execute the grant against. This should not ordinarily be changed from the default

Default value: ``undef``

##### <a name="psql_user"></a>`psql_user`

Data type: `Any`

Specifies the OS user for running psql. Default value: The default user for the module, usually 'postgres'.

Default value: ``undef``

##### <a name="connect_settings"></a>`connect_settings`

Data type: `Any`

Specifies a hash of environment variables used when connecting to a remote server.

Default value: ``undef``

### <a name="postgresqlserverdb"></a>`postgresql::server::db`

Define for conveniently creating a role, database and assigning the correctpermissions.

#### Parameters

The following parameters are available in the `postgresql::server::db` defined type:

* [`user`](#user)
* [`password`](#password)
* [`comment`](#comment)
* [`dbname`](#dbname)
* [`encoding`](#encoding)
* [`locale`](#locale)
* [`grant`](#grant)
* [`tablespace`](#tablespace)
* [`template`](#template)
* [`istemplate`](#istemplate)
* [`owner`](#owner)

##### <a name="user"></a>`user`

Data type: `Any`

User to create and assign access to the database upon creation. Mandatory.

##### <a name="password"></a>`password`

Data type: `Variant[String, Sensitive[String]]`

Required Sets the password for the created user.

##### <a name="comment"></a>`comment`

Data type: `Any`

Defines a comment to be stored about the database using the PostgreSQL COMMENT command.

Default value: ``undef``

##### <a name="dbname"></a>`dbname`

Data type: `Any`

Sets the name of the database to be created.

Default value: `$title`

##### <a name="encoding"></a>`encoding`

Data type: `Any`

Overrides the character set during creation of the database.

Default value: `$postgresql::server::encoding`

##### <a name="locale"></a>`locale`

Data type: `Any`

Overrides the locale during creation of the database.

Default value: `$postgresql::server::locale`

##### <a name="grant"></a>`grant`

Data type: `Any`

Specifies the permissions to grant during creation. Default value: 'ALL'.

Default value: `'ALL'`

##### <a name="tablespace"></a>`tablespace`

Data type: `Any`

Defines the name of the tablespace to allocate the created database to.

Default value: ``undef``

##### <a name="template"></a>`template`

Data type: `Any`

Specifies the name of the template database from which to build this database. Defaults value: template0.

Default value: `'template0'`

##### <a name="istemplate"></a>`istemplate`

Data type: `Any`

Specifies that the database is a template, if set to true.

Default value: ``false``

##### <a name="owner"></a>`owner`

Data type: `Any`

Sets a user as the owner of the database.

Default value: ``undef``

### <a name="postgresqlserverdefault_privileges"></a>`postgresql::server::default_privileges`

Manage a database defaults privileges. Only works with PostgreSQL version 9.6 and above.

#### Parameters

The following parameters are available in the `postgresql::server::default_privileges` defined type:

* [`target_role`](#target_role)
* [`ensure`](#ensure)
* [`role`](#role)
* [`db`](#db)
* [`object_type`](#object_type)
* [`privilege`](#privilege)
* [`schema`](#schema)
* [`psql_db`](#psql_db)
* [`psql_user`](#psql_user)
* [`psql_path`](#psql_path)
* [`port`](#port)
* [`connect_settings`](#connect_settings)
* [`psql_path`](#psql_path)
* [`group`](#group)

##### <a name="target_role"></a>`target_role`

Data type: `Optional[String]`

Target role whose created objects will receive the default privileges. Defaults to the current user.

Default value: ``undef``

##### <a name="ensure"></a>`ensure`

Data type: `Enum['present',
    'absent'
  ]`

Specifies whether to grant or revoke the privilege.

Default value: `'present'`

##### <a name="role"></a>`role`

Data type: `String`

Specifies the role or user whom you are granting access to.

##### <a name="db"></a>`db`

Data type: `String`

Specifies the database to which you are granting access.

##### <a name="object_type"></a>`object_type`

Data type: `Pattern[
    /(?i:^FUNCTIONS$)/,
    /(?i:^ROUTINES$)/,
    /(?i:^SEQUENCES$)/,
    /(?i:^TABLES$)/,
    /(?i:^TYPES$)/,
    /(?i:^SCHEMAS$)/
  ]`

Specify target object type: 'FUNCTIONS', 'ROUTINES', 'SEQUENCES', 'TABLES', 'TYPES'.

##### <a name="privilege"></a>`privilege`

Data type: `String`

Specifies comma-separated list of privileges to grant. Valid options: depends on object type.

##### <a name="schema"></a>`schema`

Data type: `String`

Target schema. Defaults to 'public'. Can be set to '' to apply to all schemas.

Default value: `'public'`

##### <a name="psql_db"></a>`psql_db`

Data type: `String`

Defines the database to execute the grant against. This should not ordinarily be changed from the default.

Default value: `$postgresql::server::default_database`

##### <a name="psql_user"></a>`psql_user`

Data type: `String`

Specifies the OS user for running psql. Default value: The default user for the module, usually 'postgres'.

Default value: `$postgresql::server::user`

##### <a name="psql_path"></a>`psql_path`

Data type: `String`

Specifies the OS user for running psql. Default value: The default user for the module, usually 'postgres'.

Default value: `$postgresql::server::psql_path`

##### <a name="port"></a>`port`

Data type: `Integer`

Specifies the port to access the server. Default value: The default user for the module, usually '5432'.

Default value: `$postgresql::server::port`

##### <a name="connect_settings"></a>`connect_settings`

Data type: `Hash`

Specifies a hash of environment variables used when connecting to a remote server.

Default value: `$postgresql::server::default_connect_settings`

##### <a name="psql_path"></a>`psql_path`

Specifies the path to the psql command.

Default value: `$postgresql::server::psql_path`

##### <a name="group"></a>`group`

Data type: `String`



Default value: `$postgresql::server::group`

### <a name="postgresqlserverextension"></a>`postgresql::server::extension`

Activate an extension on a postgresql database.

#### Parameters

The following parameters are available in the `postgresql::server::extension` defined type:

* [`database`](#database)
* [`extension`](#extension)
* [`schema`](#schema)
* [`version`](#version)
* [`ensure`](#ensure)
* [`package_name`](#package_name)
* [`package_ensure`](#package_ensure)
* [`port`](#port)
* [`connect_settings`](#connect_settings)
* [`database_resource_name`](#database_resource_name)

##### <a name="database"></a>`database`

Data type: `Any`

Specifies the database on which to activate the extension.

##### <a name="extension"></a>`extension`

Data type: `Any`

Specifies the extension to activate. If left blank, uses the name of the resource.

Default value: `$name`

##### <a name="schema"></a>`schema`

Data type: `Optional[String[1]]`

Specifies the schema on which to activate the extension.

Default value: ``undef``

##### <a name="version"></a>`version`

Data type: `Optional[String[1]]`

Specifies the version of the extension which the database uses. When an extension package is updated, this does not automatically change the effective version in each database.
This needs be updated using the PostgreSQL-specific SQL ALTER EXTENSION...
version may be set to latest, in which case the SQL ALTER EXTENSION "extension" UPDATE is applied to this database (only).
version may be set to a specific version, in which case the extension is updated using ALTER EXTENSION "extension" UPDATE TO 'version'
eg. If extension is set to postgis and version is set to 2.3.3, this will apply the SQL ALTER EXTENSION "postgis" UPDATE TO '2.3.3' to this database only.
version may be omitted, in which case no ALTER EXTENSION... SQL is applied, and the version will be left unchanged.

Default value: ``undef``

##### <a name="ensure"></a>`ensure`

Data type: `String[1]`

Specifies whether to activate or deactivate the extension. Valid options: 'present' or 'absent'.

Default value: `'present'`

##### <a name="package_name"></a>`package_name`

Data type: `Any`

Specifies a package to install prior to activating the extension.

Default value: ``undef``

##### <a name="package_ensure"></a>`package_ensure`

Data type: `Any`

Overrides default package deletion behavior. By default, the package specified with package_name is installed when the extension is activated and removed when the extension is deactivated. To override this behavior, set the ensure value for the package.

Default value: ``undef``

##### <a name="port"></a>`port`

Data type: `Optional[Integer]`

Port to use when connecting.

Default value: ``undef``

##### <a name="connect_settings"></a>`connect_settings`

Data type: `Any`

Specifies a hash of environment variables used when connecting to a remote server.

Default value: `postgresql::default('default_connect_settings')`

##### <a name="database_resource_name"></a>`database_resource_name`

Data type: `Any`

Specifies the resource name of the DB being managed. Defaults to the parameter $database, if left blank.

Default value: `$database`

### <a name="postgresqlservergrant"></a>`postgresql::server::grant`

Define for granting permissions to roles.

#### Parameters

The following parameters are available in the `postgresql::server::grant` defined type:

* [`role`](#role)
* [`db`](#db)
* [`privilege`](#privilege)
* [`object_type`](#object_type)
* [`object_name`](#object_name)
* [`psql_db`](#psql_db)
* [`psql_user`](#psql_user)
* [`port`](#port)
* [`onlyif_exists`](#onlyif_exists)
* [`connect_settings`](#connect_settings)
* [`ensure`](#ensure)
* [`group`](#group)
* [`psql_path`](#psql_path)
* [`object_arguments`](#object_arguments)

##### <a name="role"></a>`role`

Data type: `String`

Specifies the role or user whom you are granting access to.

##### <a name="db"></a>`db`

Data type: `String`

Specifies the database to which you are granting access.

##### <a name="privilege"></a>`privilege`

Data type: `String`

Specifies the privilege to grant. Valid options: 'ALL', 'ALL PRIVILEGES' or 'object_type' dependent string.

Default value: `''`

##### <a name="object_type"></a>`object_type`

Data type: `Pattern[#/(?i:^COLUMN$)/,
    /(?i:^ALL SEQUENCES IN SCHEMA$)/,
    /(?i:^ALL TABLES IN SCHEMA$)/,
    /(?i:^DATABASE$)/,
    #/(?i:^FOREIGN DATA WRAPPER$)/,
    #/(?i:^FOREIGN SERVER$)/,
    /(?i:^FUNCTION$)/,
    /(?i:^LANGUAGE$)/,
    #/(?i:^PROCEDURAL LANGUAGE$)/,
    /(?i:^TABLE$)/,
    #/(?i:^TABLESPACE$)/,
    /(?i:^SCHEMA$)/,
    /(?i:^SEQUENCE$)/
    #/(?i:^VIEW$)/
  ]`

Specifies the type of object to which you are granting privileges. Valid options: 'DATABASE', 'SCHEMA', 'SEQUENCE', 'ALL SEQUENCES IN SCHEMA', 'TABLE' or 'ALL TABLES IN SCHEMA'.

Default value: `'database'`

##### <a name="object_name"></a>`object_name`

Data type: `Optional[Variant[
            Array[String,2,2],
            String[1]]
  ]`

Specifies name of object_type to which to grant access, can be either a string or a two element array. String: 'object_name' Array: ['schema_name', 'object_name']

Default value: ``undef``

##### <a name="psql_db"></a>`psql_db`

Data type: `String`

Specifies the database to execute the grant against. This should not ordinarily be changed from the default

Default value: `$postgresql::server::default_database`

##### <a name="psql_user"></a>`psql_user`

Data type: `String`

Sets the OS user to run psql.

Default value: `$postgresql::server::user`

##### <a name="port"></a>`port`

Data type: `Integer`

Port to use when connecting.

Default value: `$postgresql::server::port`

##### <a name="onlyif_exists"></a>`onlyif_exists`

Data type: `Boolean`

Create grant only if doesn't exist

Default value: ``false``

##### <a name="connect_settings"></a>`connect_settings`

Data type: `Hash`

Specifies a hash of environment variables used when connecting to a remote server.

Default value: `$postgresql::server::default_connect_settings`

##### <a name="ensure"></a>`ensure`

Data type: `Enum['present',
        'absent'
  ]`

Specifies whether to grant or revoke the privilege. Default is to grant the privilege. Valid values: 'present', 'absent'.

Default value: `'present'`

##### <a name="group"></a>`group`

Data type: `String`

Sets the OS group to run psql

Default value: `$postgresql::server::group`

##### <a name="psql_path"></a>`psql_path`

Data type: `String`

Sets the path to psql command

Default value: `$postgresql::server::psql_path`

##### <a name="object_arguments"></a>`object_arguments`

Data type: `Array[String[1],0]`



Default value: `[]`

### <a name="postgresqlservergrant_role"></a>`postgresql::server::grant_role`

Define for granting membership to a role.

#### Parameters

The following parameters are available in the `postgresql::server::grant_role` defined type:

* [`group`](#group)
* [`role`](#role)
* [`ensure`](#ensure)
* [`psql_db`](#psql_db)
* [`psql_user`](#psql_user)
* [`port`](#port)
* [`connect_settings`](#connect_settings)

##### <a name="group"></a>`group`

Data type: `String[1]`

Specifies the group role to which you are assigning a role.

##### <a name="role"></a>`role`

Data type: `String[1]`

Specifies the role you want to assign to a group. If left blank, uses the name of the resource.

Default value: `$name`

##### <a name="ensure"></a>`ensure`

Data type: `Enum['present', 'absent']`

Specifies whether to grant or revoke the membership. Valid options: 'present' or 'absent'.

Default value: `'present'`

##### <a name="psql_db"></a>`psql_db`

Data type: `Any`

Specifies the database to execute the grant against. This should not ordinarily be changed from the default

Default value: `$postgresql::server::default_database`

##### <a name="psql_user"></a>`psql_user`

Data type: `Any`

Sets the OS user to run psql.

Default value: `$postgresql::server::user`

##### <a name="port"></a>`port`

Data type: `Any`

Port to use when connecting.

Default value: `$postgresql::server::port`

##### <a name="connect_settings"></a>`connect_settings`

Data type: `Any`

Specifies a hash of environment variables used when connecting to a remote server.

Default value: `$postgresql::server::default_connect_settings`

### <a name="postgresqlserverpg_hba_rule"></a>`postgresql::server::pg_hba_rule`

This resource manages an individual rule that applies to the file defined in target.

#### Parameters

The following parameters are available in the `postgresql::server::pg_hba_rule` defined type:

* [`type`](#type)
* [`database`](#database)
* [`user`](#user)
* [`auth_method`](#auth_method)
* [`address`](#address)
* [`description`](#description)
* [`auth_option`](#auth_option)
* [`order`](#order)
* [`target`](#target)
* [`postgresql_version`](#postgresql_version)

##### <a name="type"></a>`type`

Data type: `Enum['local', 'host', 'hostssl', 'hostnossl', 'hostgssenc']`

Sets the type of rule.
Enum['local','host','hostssl','hostnossl','hostgssenc'].

##### <a name="database"></a>`database`

Data type: `String`

Sets a comma-separated list of databases that this rule matches.

##### <a name="user"></a>`user`

Data type: `String`

Sets a comma-separated list of users that this rule matches.

##### <a name="auth_method"></a>`auth_method`

Data type: `String`

Provides the method that is used for authentication for the connection that this rule matches. Described further in the PostgreSQL pg_hba.conf documentation.

##### <a name="address"></a>`address`

Data type: `Optional[String]`

Sets a CIDR based address for this rule matching when the type is not 'local'.

Default value: ``undef``

##### <a name="description"></a>`description`

Data type: `String`

Defines a longer description for this rule, if required. This description is placed in the comments above the rule in pg_hba.conf. Default value: 'none'.

Default value: `'none'`

##### <a name="auth_option"></a>`auth_option`

Data type: `Optional[String]`

For certain auth_method settings there are extra options that can be passed. Consult the PostgreSQL pg_hba.conf documentation for further details.

Default value: ``undef``

##### <a name="order"></a>`order`

Data type: `Variant[String, Integer]`

Sets an order for placing the rule in pg_hba.conf. This can be either a string or an integer. If it is an integer, it will be converted to a string by zero-padding it to three digits. E.g. 42 will be zero-padded to the string '042'. The pg_hba_rule fragments are sorted using the alpha sorting order. Default value: 150.

Default value: `150`

##### <a name="target"></a>`target`

Data type: `Stdlib::Absolutepath`

Provides the target for the rule, and is generally an internal only property. Use with caution.

Default value: `$postgresql::server::pg_hba_conf_path`

##### <a name="postgresql_version"></a>`postgresql_version`

Data type: `String`

Manages pg_hba.conf without managing the entire PostgreSQL instance.

Default value: `$postgresql::server::_version`

### <a name="postgresqlserverpg_ident_rule"></a>`postgresql::server::pg_ident_rule`

This resource manages an individual rule that applies to the file defined in target.

#### Parameters

The following parameters are available in the `postgresql::server::pg_ident_rule` defined type:

* [`map_name`](#map_name)
* [`system_username`](#system_username)
* [`database_username`](#database_username)
* [`description`](#description)
* [`order`](#order)
* [`target`](#target)

##### <a name="map_name"></a>`map_name`

Data type: `Any`

Sets the name of the user map that is used to refer to this mapping in pg_hba.conf.

##### <a name="system_username"></a>`system_username`

Data type: `Any`

Specifies the operating system user name (the user name used to connect to the database).

##### <a name="database_username"></a>`database_username`

Data type: `Any`

Specifies the user name of the database user. The system_username is mapped to this user name.

##### <a name="description"></a>`description`

Data type: `Any`

Sets a longer description for this rule if required. This description is placed in the comments above the rule in pg_ident.conf. Default value: 'none'.

Default value: `'none'`

##### <a name="order"></a>`order`

Data type: `Any`

Defines an order for placing the mapping in pg_ident.conf. Default value: 150.

Default value: `'150'`

##### <a name="target"></a>`target`

Data type: `Any`

Provides the target for the rule and is generally an internal only property. Use with caution.

Default value: `$postgresql::server::pg_ident_conf_path`

### <a name="postgresqlserverreassign_owned_by"></a>`postgresql::server::reassign_owned_by`

Define for reassigning the ownership of objects within a database.

* **Note** This enables us to force the a particular ownership for objects within a database

#### Parameters

The following parameters are available in the `postgresql::server::reassign_owned_by` defined type:

* [`old_role`](#old_role)
* [`new_role`](#new_role)
* [`db`](#db)
* [`psql_user`](#psql_user)
* [`port`](#port)
* [`connect_settings`](#connect_settings)

##### <a name="old_role"></a>`old_role`

Data type: `String`

Specifies the role or user who is the current owner of the objects in the specified db

##### <a name="new_role"></a>`new_role`

Data type: `String`

Specifies the role or user who will be the new owner of these objects

##### <a name="db"></a>`db`

Data type: `String`

Specifies the database to which the 'REASSIGN OWNED' will be applied

##### <a name="psql_user"></a>`psql_user`

Data type: `String`

Specifies the OS user for running psql.

Default value: `$postgresql::server::user`

##### <a name="port"></a>`port`

Data type: `Integer`

Port to use when connecting.

Default value: `$postgresql::server::port`

##### <a name="connect_settings"></a>`connect_settings`

Data type: `Hash`

Specifies a hash of environment variables used when connecting to a remote server.

Default value: `$postgresql::server::default_connect_settings`

### <a name="postgresqlserverrecovery"></a>`postgresql::server::recovery`

This resource manages the parameters that applies to the recovery.conf template.

* **Note** Allows you to create the content for recovery.conf. For more details see the usage example and the PostgreSQL documentation.
Every parameter value is a string set in the template except recovery_target_inclusive, pause_at_recovery_target, standby_mode and recovery_min_apply_delay.
A detailed description of all listed parameters can be found in the PostgreSQL documentation.
Only the specified parameters are recognized in the template. The recovery.conf is only created if at least one parameter is set and manage_recovery_conf is set to true.

#### Parameters

The following parameters are available in the `postgresql::server::recovery` defined type:

* [`restore_command`](#restore_command)
* [`archive_cleanup_command`](#archive_cleanup_command)
* [`recovery_end_command`](#recovery_end_command)
* [`recovery_target_name`](#recovery_target_name)
* [`recovery_target_time`](#recovery_target_time)
* [`recovery_target_xid`](#recovery_target_xid)
* [`recovery_target_inclusive`](#recovery_target_inclusive)
* [`recovery_target`](#recovery_target)
* [`recovery_target_timeline`](#recovery_target_timeline)
* [`pause_at_recovery_target`](#pause_at_recovery_target)
* [`standby_mode`](#standby_mode)
* [`primary_conninfo`](#primary_conninfo)
* [`primary_slot_name`](#primary_slot_name)
* [`trigger_file`](#trigger_file)
* [`recovery_min_apply_delay`](#recovery_min_apply_delay)
* [`target`](#target)

##### <a name="restore_command"></a>`restore_command`

Data type: `Any`

The shell command to execute to retrieve an archived segment of the WAL file series.

Default value: ``undef``

##### <a name="archive_cleanup_command"></a>`archive_cleanup_command`

Data type: `Any`

This optional parameter specifies a shell command that will be executed at every restartpoint.

Default value: ``undef``

##### <a name="recovery_end_command"></a>`recovery_end_command`

Data type: `Any`

This parameter specifies a shell command that will be executed once only at the end of recovery.

Default value: ``undef``

##### <a name="recovery_target_name"></a>`recovery_target_name`

Data type: `Any`

This parameter specifies the named restore point (created with pg_create_restore_point()) to which recovery will proceed.

Default value: ``undef``

##### <a name="recovery_target_time"></a>`recovery_target_time`

Data type: `Any`

This parameter specifies the time stamp up to which recovery will proceed.

Default value: ``undef``

##### <a name="recovery_target_xid"></a>`recovery_target_xid`

Data type: `Any`

This parameter specifies the transaction ID up to which recovery will proceed.

Default value: ``undef``

##### <a name="recovery_target_inclusive"></a>`recovery_target_inclusive`

Data type: `Any`

Specifies whether to stop just after the specified recovery target (true), or just before the recovery target (false).

Default value: ``undef``

##### <a name="recovery_target"></a>`recovery_target`

Data type: `Any`

This parameter specifies that recovery should end as soon as a consistent state is reached, i.e. as early as possible.

Default value: ``undef``

##### <a name="recovery_target_timeline"></a>`recovery_target_timeline`

Data type: `Any`

Specifies recovering into a particular timeline.

Default value: ``undef``

##### <a name="pause_at_recovery_target"></a>`pause_at_recovery_target`

Data type: `Any`

Specifies whether recovery should pause when the recovery target is reached.

Default value: ``undef``

##### <a name="standby_mode"></a>`standby_mode`

Data type: `Any`

Specifies whether to start the PostgreSQL server as a standby.

Default value: ``undef``

##### <a name="primary_conninfo"></a>`primary_conninfo`

Data type: `Any`

Specifies a connection string to be used for the standby server to connect with the primary.

Default value: ``undef``

##### <a name="primary_slot_name"></a>`primary_slot_name`

Data type: `Any`

Optionally specifies an existing replication slot to be used when connecting to the primary via streaming replication to control resource removal on the upstream node.

Default value: ``undef``

##### <a name="trigger_file"></a>`trigger_file`

Data type: `Any`

Specifies a trigger file whose presence ends recovery in the standby.

Default value: ``undef``

##### <a name="recovery_min_apply_delay"></a>`recovery_min_apply_delay`

Data type: `Any`

This parameter allows you to delay recovery by a fixed period of time, measured in milliseconds if no unit is specified.

Default value: ``undef``

##### <a name="target"></a>`target`

Data type: `Any`

Provides the target for the rule, and is generally an internal only property. Use with caution.

Default value: `$postgresql::server::recovery_conf_path`

### <a name="postgresqlserverrole"></a>`postgresql::server::role`

Define for creating a database role.

#### Parameters

The following parameters are available in the `postgresql::server::role` defined type:

* [`update_password`](#update_password)
* [`password_hash`](#password_hash)
* [`createdb`](#createdb)
* [`createrole`](#createrole)
* [`db`](#db)
* [`port`](#port)
* [`login`](#login)
* [`inherit`](#inherit)
* [`superuser`](#superuser)
* [`replication`](#replication)
* [`connection_limit`](#connection_limit)
* [`username`](#username)
* [`connect_settings`](#connect_settings)
* [`ensure`](#ensure)
* [`psql_user`](#psql_user)
* [`psql_group`](#psql_group)
* [`psql_path`](#psql_path)
* [`module_workdir`](#module_workdir)
* [`hash`](#hash)
* [`salt`](#salt)

##### <a name="update_password"></a>`update_password`

Data type: `Any`

If set to true, updates the password on changes. Set this to false to not modify the role's password after creation.

Default value: ``true``

##### <a name="password_hash"></a>`password_hash`

Data type: `Variant[Boolean, String, Sensitive[String]]`

Sets the hash to use during password creation.

Default value: ``false``

##### <a name="createdb"></a>`createdb`

Data type: `Any`

Specifies whether to grant the ability to create new databases with this role.

Default value: ``false``

##### <a name="createrole"></a>`createrole`

Data type: `Any`

Specifies whether to grant the ability to create new roles with this role.

Default value: ``false``

##### <a name="db"></a>`db`

Data type: `Any`

Database used to connect to.

Default value: `$postgresql::server::default_database`

##### <a name="port"></a>`port`

Data type: `Any`

Port to use when connecting.

Default value: ``undef``

##### <a name="login"></a>`login`

Data type: `Any`

Specifies whether to grant login capability for the new role.

Default value: ``true``

##### <a name="inherit"></a>`inherit`

Data type: `Any`

Specifies whether to grant inherit capability for the new role.

Default value: ``true``

##### <a name="superuser"></a>`superuser`

Data type: `Any`

Specifies whether to grant super user capability for the new role.

Default value: ``false``

##### <a name="replication"></a>`replication`

Data type: `Any`

Provides provides replication capabilities for this role if set to true.

Default value: ``false``

##### <a name="connection_limit"></a>`connection_limit`

Data type: `Any`

Specifies how many concurrent connections the role can make. Default value: '-1', meaning no limit.

Default value: `'-1'`

##### <a name="username"></a>`username`

Data type: `Any`

Defines the username of the role to create.

Default value: `$title`

##### <a name="connect_settings"></a>`connect_settings`

Data type: `Any`

Specifies a hash of environment variables used when connecting to a remote server.

Default value: `$postgresql::server::default_connect_settings`

##### <a name="ensure"></a>`ensure`

Data type: `Enum['present', 'absent']`

Specify whether to create or drop the role. Specifying 'present' creates the role. Specifying 'absent' drops the role.

Default value: `'present'`

##### <a name="psql_user"></a>`psql_user`

Data type: `Any`

Sets the OS user to run psql

Default value: `$postgresql::server::user`

##### <a name="psql_group"></a>`psql_group`

Data type: `Any`

Sets the OS group to run psql

Default value: `$postgresql::server::group`

##### <a name="psql_path"></a>`psql_path`

Data type: `Any`

Sets path to psql command

Default value: `$postgresql::server::psql_path`

##### <a name="module_workdir"></a>`module_workdir`

Data type: `Any`

Specifies working directory under which the psql command should be executed. May need to specify if '/tmp' is on volume mounted with noexec option.

Default value: `$postgresql::server::module_workdir`

##### <a name="hash"></a>`hash`

Data type: `Enum['md5', 'scram-sha-256']`

Specify the hash method for pg password

Default value: `'md5'`

##### <a name="salt"></a>`salt`

Data type: `Optional[Variant[String[1], Integer]]`

Specify the salt use for the scram-sha-256 encoding password (default username)

Default value: ``undef``

### <a name="postgresqlserverschema"></a>`postgresql::server::schema`

Create a new schema.

* **Note** The database must exist and the PostgreSQL user should have enough privileges

#### Examples

##### 

```puppet
postgresql::server::schema {'private':
    db => 'template1',
}
```

#### Parameters

The following parameters are available in the `postgresql::server::schema` defined type:

* [`db`](#db)
* [`owner`](#owner)
* [`schema`](#schema)
* [`connect_settings`](#connect_settings)

##### <a name="db"></a>`db`

Data type: `Any`

Required. Sets the name of the database in which to create this schema.

Default value: `$postgresql::server::default_database`

##### <a name="owner"></a>`owner`

Data type: `Any`

Sets the default owner of the schema.

Default value: ``undef``

##### <a name="schema"></a>`schema`

Data type: `Any`

Sets the name of the schema.

Default value: `$title`

##### <a name="connect_settings"></a>`connect_settings`

Data type: `Any`

Specifies a hash of environment variables used when connecting to a remote server.

Default value: `$postgresql::server::default_connect_settings`

### <a name="postgresqlservertable_grant"></a>`postgresql::server::table_grant`

This resource wraps the grant resource to manage table grants specifically.

#### Parameters

The following parameters are available in the `postgresql::server::table_grant` defined type:

* [`privilege`](#privilege)
* [`table`](#table)
* [`db`](#db)
* [`role`](#role)
* [`ensure`](#ensure)
* [`port`](#port)
* [`psql_db`](#psql_db)
* [`psql_user`](#psql_user)
* [`connect_settings`](#connect_settings)
* [`onlyif_exists`](#onlyif_exists)

##### <a name="privilege"></a>`privilege`

Data type: `Any`

Specifies comma-separated list of privileges to grant. Valid options: 'ALL', 'SELECT', 'INSERT', 'UPDATE', 'DELETE', 'TRUNCATE', 'REFERENCES', 'TRIGGER'.

##### <a name="table"></a>`table`

Data type: `Any`

Specifies the table to which you are granting access.

##### <a name="db"></a>`db`

Data type: `Any`

Specifies which database the table is in.

##### <a name="role"></a>`role`

Data type: `Any`

Specifies the role or user to whom you are granting access.

##### <a name="ensure"></a>`ensure`

Data type: `Any`

Specifies whether to grant or revoke the privilege. Default is to grant the privilege.

Default value: ``undef``

##### <a name="port"></a>`port`

Data type: `Any`

Port to use when connecting.

Default value: ``undef``

##### <a name="psql_db"></a>`psql_db`

Data type: `Any`

Specifies the database to execute the grant against. This should not ordinarily be changed from the default.

Default value: ``undef``

##### <a name="psql_user"></a>`psql_user`

Data type: `Any`

Specifies the OS user for running psql.

Default value: ``undef``

##### <a name="connect_settings"></a>`connect_settings`

Data type: `Any`

Specifies a hash of environment variables used when connecting to a remote server.

Default value: ``undef``

##### <a name="onlyif_exists"></a>`onlyif_exists`

Data type: `Any`

Create grant only if it doesn't exist.

Default value: ``false``

### <a name="postgresqlservertablespace"></a>`postgresql::server::tablespace`

This module creates tablespace.

#### Parameters

The following parameters are available in the `postgresql::server::tablespace` defined type:

* [`location`](#location)
* [`manage_location`](#manage_location)
* [`owner`](#owner)
* [`spcname`](#spcname)
* [`connect_settings`](#connect_settings)

##### <a name="location"></a>`location`

Data type: `Any`

Specifies the path to locate this tablespace.

##### <a name="manage_location"></a>`manage_location`

Data type: `Any`

Set to false if you have file{ $location: } already defined

Default value: ``true``

##### <a name="owner"></a>`owner`

Data type: `Any`

Specifies the default owner of the tablespace.

Default value: ``undef``

##### <a name="spcname"></a>`spcname`

Data type: `Any`

Specifies the name of the tablespace.

Default value: `$title`

##### <a name="connect_settings"></a>`connect_settings`

Data type: `Any`

Specifies a hash of environment variables used when connecting to a remote server.

Default value: `$postgresql::server::default_connect_settings`

### <a name="postgresqlvalidate_db_connection"></a>`postgresql::validate_db_connection`

This validated if the postgres connection can be established
between the node on which this resource is run and a specified postgres
instance (host/port/user/password/database name).

#### Parameters

The following parameters are available in the `postgresql::validate_db_connection` defined type:

* [`database_host`](#database_host)
* [`database_name`](#database_name)
* [`database_password`](#database_password)
* [`database_username`](#database_username)
* [`database_port`](#database_port)
* [`connect_settings`](#connect_settings)
* [`run_as`](#run_as)
* [`sleep`](#sleep)
* [`tries`](#tries)
* [`create_db_first`](#create_db_first)

##### <a name="database_host"></a>`database_host`

Data type: `Any`

Database host address

Default value: ``undef``

##### <a name="database_name"></a>`database_name`

Data type: `Any`

Specifies the name of the database you wish to test.

Default value: ``undef``

##### <a name="database_password"></a>`database_password`

Data type: `Optional[Variant[String, Sensitive[String]]]`

Specifies the password to connect with.

Default value: ``undef``

##### <a name="database_username"></a>`database_username`

Data type: `Any`

Specifies the username to connect with.

Default value: ``undef``

##### <a name="database_port"></a>`database_port`

Data type: `Any`

Defines the port to use when connecting.

Default value: ``undef``

##### <a name="connect_settings"></a>`connect_settings`

Data type: `Any`

Specifies a hash of environment variables used when connecting to a remote server.

Default value: ``undef``

##### <a name="run_as"></a>`run_as`

Data type: `Any`

Specifies the user to run the psql command as.

Default value: ``undef``

##### <a name="sleep"></a>`sleep`

Data type: `Any`

Sets the number of seconds to sleep for before trying again after a failure.

Default value: `2`

##### <a name="tries"></a>`tries`

Data type: `Any`

Sets the number of attempts after failure before giving up and failing the resource.

Default value: `10`

##### <a name="create_db_first"></a>`create_db_first`

Data type: `Any`

Creates the database when obtaining a successful connection.

Default value: ``true``

## Resource types

### <a name="postgresql_conf"></a>`postgresql_conf`

This type allows puppet to manage postgresql.conf parameters.

#### Properties

The following properties are available in the `postgresql_conf` type.

##### `ensure`

Valid values: `present`, `absent`

The basic property that the resource should be in.

Default value: `present`

##### `target`

The path to postgresql.conf

##### `value`

The value to set for this parameter.

#### Parameters

The following parameters are available in the `postgresql_conf` type.

* [`name`](#name)
* [`provider`](#provider)

##### <a name="name"></a>`name`

Valid values: `%r{^[\w\.]+$}`

namevar

The postgresql parameter name to manage.

##### <a name="provider"></a>`provider`

The specific backend to use for this `postgresql_conf` resource. You will seldom need to specify this --- Puppet will
usually discover the appropriate provider for your platform.

### <a name="postgresql_conn_validator"></a>`postgresql_conn_validator`

Verify that a connection can be successfully established between a node
and the PostgreSQL server.  Its primary use is as a precondition to
prevent configuration changes from being applied if the PostgreSQL
server cannot be reached, but it could potentially be used for other
purposes such as monitoring.

#### Properties

The following properties are available in the `postgresql_conn_validator` type.

##### `ensure`

Valid values: `present`, `absent`

Ensure connection validation

Default value: `present`

#### Parameters

The following parameters are available in the `postgresql_conn_validator` type.

* [`command`](#command)
* [`connect_settings`](#connect_settings)
* [`db_name`](#db_name)
* [`db_password`](#db_password)
* [`db_username`](#db_username)
* [`host`](#host)
* [`name`](#name)
* [`port`](#port)
* [`provider`](#provider)
* [`psql_path`](#psql_path)
* [`run_as`](#run_as)
* [`sleep`](#sleep)
* [`tries`](#tries)

##### <a name="command"></a>`command`

Command to run against target database.

Default value: `SELECT 1`

##### <a name="connect_settings"></a>`connect_settings`

Hash of environment variables for connection to a db.

##### <a name="db_name"></a>`db_name`

The name of the database you are trying to validate a connection with.

##### <a name="db_password"></a>`db_password`

The password required to access the target PostgreSQL database.

##### <a name="db_username"></a>`db_username`

A user that has access to the target PostgreSQL database.

##### <a name="host"></a>`host`

The DNS name or IP address of the server where PostgreSQL should be running.

##### <a name="name"></a>`name`

namevar

An arbitrary name used as the identity of the resource.

##### <a name="port"></a>`port`

The port that the PostgreSQL server should be listening on.

##### <a name="provider"></a>`provider`

The specific backend to use for this `postgresql_conn_validator` resource. You will seldom need to specify this ---
Puppet will usually discover the appropriate provider for your platform.

##### <a name="psql_path"></a>`psql_path`

Path to the psql command.

##### <a name="run_as"></a>`run_as`

System user that will run the psql command.

##### <a name="sleep"></a>`sleep`

The length of sleep time between connection tries.

Default value: `2`

##### <a name="tries"></a>`tries`

The number of tries to validate the connection to the target PostgreSQL database.

Default value: `10`

### <a name="postgresql_psql"></a>`postgresql_psql`

An arbitrary tag for your own reference; the name of the message.

#### Properties

The following properties are available in the `postgresql_psql` type.

##### `command`

The SQL command to execute via psql.

#### Parameters

The following parameters are available in the `postgresql_psql` type.

* [`connect_settings`](#connect_settings)
* [`cwd`](#cwd)
* [`db`](#db)
* [`environment`](#environment)
* [`name`](#name)
* [`onlyif`](#onlyif)
* [`port`](#port)
* [`provider`](#provider)
* [`psql_group`](#psql_group)
* [`psql_path`](#psql_path)
* [`psql_user`](#psql_user)
* [`refreshonly`](#refreshonly)
* [`search_path`](#search_path)
* [`sensitive`](#sensitive)
* [`unless`](#unless)

##### <a name="connect_settings"></a>`connect_settings`

Connection settings that will be used when connecting to postgres

##### <a name="cwd"></a>`cwd`

The working directory under which the psql command should be executed.

Default value: `/tmp`

##### <a name="db"></a>`db`

The name of the database to execute the SQL command against, this overrides any PGDATABASE value in connect_settings

##### <a name="environment"></a>`environment`

Any additional environment variables you want to set for a
SQL command. Multiple environment variables should be
specified as an array.

##### <a name="name"></a>`name`

namevar

An arbitrary tag for your own reference; the name of the message.

##### <a name="onlyif"></a>`onlyif`

An optional SQL command to execute prior to the main :command;
this is generally intended to be used for idempotency, to check
for the existence of an object in the database to determine whether
or not the main SQL command needs to be executed at all.

##### <a name="port"></a>`port`

The port of the database server to execute the SQL command against, this overrides any PGPORT value in connect_settings.

##### <a name="provider"></a>`provider`

The specific backend to use for this `postgresql_psql` resource. You will seldom need to specify this --- Puppet will
usually discover the appropriate provider for your platform.

##### <a name="psql_group"></a>`psql_group`

The system user group account under which the psql command should be executed.

Default value: `postgres`

##### <a name="psql_path"></a>`psql_path`

The path to psql executable.

Default value: `psql`

##### <a name="psql_user"></a>`psql_user`

The system user account under which the psql command should be executed.

Default value: `postgres`

##### <a name="refreshonly"></a>`refreshonly`

Valid values: ``true``, ``false``

If 'true', then the SQL will only be executed via a notify/subscribe event.

Default value: ``false``

##### <a name="search_path"></a>`search_path`

The schema search path to use when executing the SQL command

##### <a name="sensitive"></a>`sensitive`

Valid values: ``true``, ``false``

If 'true', then the executed command will not be echoed into the log. Use this to protect sensitive information passing
through.

Default value: ``false``

##### <a name="unless"></a>`unless`

An optional SQL command to execute prior to the main :command;
this is generally intended to be used for idempotency, to check
for the existence of an object in the database to determine whether
or not the main SQL command needs to be executed at all.'

### <a name="postgresql_replication_slot"></a>`postgresql_replication_slot`

This type allows to create and destroy replication slots
to register warm standby replication on a Postgresql
primary server.

#### Properties

The following properties are available in the `postgresql_replication_slot` type.

##### `ensure`

Valid values: `present`, `absent`

The basic property that the resource should be in.

Default value: `present`

#### Parameters

The following parameters are available in the `postgresql_replication_slot` type.

* [`name`](#name)
* [`provider`](#provider)

##### <a name="name"></a>`name`

Valid values: `%r{^[a-z0-9_]+$}`

namevar

The name of the slot to create. Must be a valid replication slot name.

##### <a name="provider"></a>`provider`

The specific backend to use for this `postgresql_replication_slot` resource. You will seldom need to specify this ---
Puppet will usually discover the appropriate provider for your platform.

## Functions

### <a name="postgresqldefault"></a>`postgresql::default`

Type: Puppet Language

This function pull default values from the `params` class  or `globals` class if the value is not present in `params`.

#### Examples

##### 

```puppet
postgresql::default('variable')
```

#### `postgresql::default(String $parameter_name)`

The postgresql::default function.

Returns: `Any`

##### Examples

###### 

```puppet
postgresql::default('variable')
```

##### `parameter_name`

Data type: `String`



### <a name="postgresqlpostgresql_escape"></a>`postgresql::postgresql_escape`

Type: Ruby 4.x API

This function escapes a string using [Dollar Quoting](https://www.postgresql.org/docs/12/sql-syntax-lexical.html#SQL-SYNTAX-DOLLAR-QUOTING) using a randomly generated tag if required.

#### `postgresql::postgresql_escape(String[1] $input_string)`

The postgresql::postgresql_escape function.

Returns: `String` A `Dollar Quoted` string

##### `input_string`

Data type: `String[1]`

The unescaped string you want to escape using `dollar quoting`

### <a name="postgresqlpostgresql_password"></a>`postgresql::postgresql_password`

Type: Ruby 4.x API

This function returns the postgresql password hash from the clear text username / password

#### `postgresql::postgresql_password(Variant[String[1], Integer] $username, Variant[String[1], Sensitive[String[1]], Integer] $password, Optional[Boolean] $sensitive, Optional[Optional[Enum['md5', 'scram-sha-256']]] $hash, Optional[Optional[Variant[String[1], Integer]]] $salt)`

The postgresql::postgresql_password function.

Returns: `Variant[String, Sensitive[String]]` The postgresql password hash from the clear text username / password.

##### `username`

Data type: `Variant[String[1], Integer]`

The clear text `username`

##### `password`

Data type: `Variant[String[1], Sensitive[String[1]], Integer]`

The clear text `password`

##### `sensitive`

Data type: `Optional[Boolean]`

If the Postgresql-Passwordhash should be of Datatype Sensitive[String]

##### `hash`

Data type: `Optional[Optional[Enum['md5', 'scram-sha-256']]]`

Set type for password hash

##### `salt`

Data type: `Optional[Optional[Variant[String[1], Integer]]]`

Use a specific salt value for scram-sha-256, default is username

### <a name="postgresql_escape"></a>`postgresql_escape`

Type: Ruby 4.x API

DEPRECATED.  Use the namespaced function [`postgresql::postgresql_escape`](#postgresqlpostgresql_escape) instead.

#### `postgresql_escape(Any *$args)`

The postgresql_escape function.

Returns: `Any`

##### `*args`

Data type: `Any`



### <a name="postgresql_password"></a>`postgresql_password`

Type: Ruby 4.x API

DEPRECATED.  Use the namespaced function [`postgresql::postgresql_password`](#postgresqlpostgresql_password) instead.

#### `postgresql_password(Any *$args)`

The postgresql_password function.

Returns: `Any`

##### `*args`

Data type: `Any`



## Tasks

### <a name="sql"></a>`sql`

Allows you to execute arbitary SQL

**Supports noop?** false

#### Parameters

##### `database`

Data type: `Optional[String[1]]`

Database to connect to

##### `host`

Data type: `Optional[String[1]]`

Hostname to connect to

##### `password`

Data type: `Optional[String[1]]`

The password

##### `port`

Data type: `Optional[String[1]]`

The port

##### `sql`

Data type: `String[1]`

The SQL you want to execute

##### `user`

Data type: `Optional[String[1]]`

The user