Defined Type: postgresql::server::table_grant

Defined in:
manifests/server/table_grant.pp

Summary

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

Overview

Parameters:

  • privilege (Enum['ALL', 'SELECT', 'INSERT', 'UPDATE', 'DELETE', 'TRUNCATE', 'REFERENCES', 'TRIGGER', 'all', 'select', 'insert', 'update', 'delete', 'truncate', 'references', 'trigger']) —

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

  • table (String[1]) —

    Specifies the table to which you are granting access.

  • db (String[1]) —

    Specifies which database the table is in.

  • role (String[1]) —

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

  • ensure (Optional[Enum['present', 'absent']]) (defaults to: undef) —

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

  • port (Optional[Variant[String[1], Stdlib::Port]]) (defaults to: undef) —

    Port to use when connecting.

  • psql_db (Optional[String[1]]) (defaults to: undef) —

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

  • psql_user (Optional[String[1]]) (defaults to: undef) —

    Specifies the OS user for running psql.

  • connect_settings (Optional[Hash]) (defaults to: undef) —

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

  • onlyif_exists (Boolean) (defaults to: false) —

    Create grant only if it doesn’t exist.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'manifests/server/table_grant.pp', line 15

define postgresql::server::table_grant (
  Enum['ALL', 'SELECT', 'INSERT', 'UPDATE', 'DELETE', 'TRUNCATE', 'REFERENCES', 'TRIGGER', 'all', 'select', 'insert', 'update', 'delete',
  'truncate', 'references', 'trigger'] $privilege,
  String[1]                                           $table,
  String[1]                                           $db,
  String[1]                                           $role,
  Optional[Enum['present', 'absent']]                 $ensure           = undef,
  Optional[Variant[String[1], Stdlib::Port]]          $port             = undef,
  Optional[String[1]]                                 $psql_db          = undef,
  Optional[String[1]]                                 $psql_user        = undef,
  Optional[Hash]                                      $connect_settings = undef,
  Boolean                                             $onlyif_exists    = false,
) {
  if $port =~ String {
    deprecation('postgres_port', 'Passing a string to the port parameter is deprecated. Stdlib::Port will be the enforced datatype in the next major release')
  }
  postgresql::server::grant { "table:${name}":
    ensure           => $ensure,
    role             => $role,
    db               => $db,
    port             => $port,
    privilege        => $privilege,
    object_type      => 'TABLE',
    object_name      => $table,
    psql_db          => $psql_db,
    psql_user        => $psql_user,
    onlyif_exists    => $onlyif_exists,
    connect_settings => $connect_settings,
  }
}