Puppet Type: postgresql_psql

Defined in:
lib/puppet/type/postgresql_psql.rb

Overview

github.com/puppetlabs/puppetlabs-postgresql/blob/master/lib/puppet/type/postgresql_psql.rb

Parameter Summary

  • name (Parameter) (Namevar) -

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

  • command (Property) Default value: { @resource[:name] } -

    The SQL command to execute via psql.

  • connect_settings (Parameter) -

    Connection settings that will be used when connecting to postgres

  • cwd (Parameter) Default value: ("/tmp") -

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

  • db (Parameter) -

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

  • environment (Parameter) -

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

  • onlyif (Parameter) -

    An optional SQL command to execute prior to the main :command;

  • port (Parameter) -

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

  • psql_group (Parameter) Default value: ("postgres") -

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

  • psql_path (Parameter) Default value: ("psql") -

    The path to psql executable.

  • psql_user (Parameter) Default value: ("postgres") -

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

  • refreshonly (Parameter) Default value: (:false) -

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

    Allowed Values:
    • :true
    • :false
  • search_path (Parameter) -

    The schema search path to use when executing the SQL command

  • unless (Parameter) -

    An optional SQL command to execute prior to the main :command;

Features

Available Providers