Resource Type: postgresql_psql

Defined in:

lib/puppet/type/postgresql_psql.rb

Providers:

ruby

Overview

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

Properties

• command

  The SQL command to execute via psql.

Parameters

• connect_settings

  Connection settings that will be used when connecting to postgres

• cwd (defaults to: /tmp)

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

• db

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

• environment

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

• instance (defaults to: main)

  The postgresql instance under which the psql command should be executed.

• name (namevar)

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

• 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.

• port

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

• 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.

• psql_group (defaults to: postgres)

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

• psql_path (defaults to: psql)

  The path to psql executable.

• psql_user (defaults to: postgres)

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

• refreshonly (defaults to: false)

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

  Supported values:

  • true
  • false
• search_path

  The schema search path to use when executing the SQL command

• sensitive (defaults to: false)

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

  Supported values:

  • true
  • false
• 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.‘