Skip to content

Commit 9ca4b42

Browse files
author
Lauren
committed
Merge pull request puppetlabs#598 from hunner/update_readme
Update readme with types docs
2 parents 3e20a16 + 7b711f4 commit 9ca4b42

File tree

1 file changed

+74
-0
lines changed

1 file changed

+74
-0
lines changed

README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,12 @@ Resources:
153153
* [postgresql::server::tablespace](#resource-postgresqlservertablespace)
154154
* [postgresql::validate_db_connection](#resource-postgresqlvalidate_db_connection)
155155

156+
Custom Resources:
157+
158+
* [postgresql\_psql](#custom-resource-postgresql_psql)
159+
* [postgresql\_replication\_slot](#custom-resource-postgresql_replication_slot)
160+
* [postgresql\_conf](#custom-resource-postgresql_conf)
161+
156162
Functions:
157163

158164
* [postgresql\_password](#function-postgresql_password)
@@ -846,6 +852,74 @@ Upon failure, sets the number of attempts before giving up and failing the resou
846852
This will ensure the database is created before running the test. This only really works if your test is local. Defaults to `true`.
847853

848854

855+
### Custom Resource: postgresql\_psql
856+
This type allows puppet to run psql statements.
857+
858+
#### `name`
859+
An arbitrary tag for your own reference; the name of the message. This is the
860+
namevar.
861+
862+
#### `command`
863+
The SQL command to execute via psql. Required.
864+
865+
#### `cwd`
866+
The working directory under which the psql command should be executed. Defaults
867+
to '/tmp'
868+
869+
#### `db`
870+
The name of the database to execute the SQL command against.
871+
872+
#### `environment`
873+
Any additional environment variables you want to set for a SQL command.
874+
Multiple environment variables should be specified as an array.
875+
876+
#### `port`
877+
The port of the database server to execute the SQL command against.
878+
879+
#### `psql\_group`
880+
The system user group account under which the psql command should be executed.
881+
Defaults to 'postgres'
882+
883+
#### `psql\_path`
884+
The path to psql executable. Defaults to 'psql'
885+
886+
#### `psql\_user`
887+
The system user account under which the psql command should be executed.
888+
Defaults to "postgres"
889+
890+
#### `refreshonly`
891+
If 'true', then the SQL will only be executed via a notify/subscribe event.
892+
Valid values are true or false. Defaults to false.
893+
894+
#### `search\_path`
895+
The schema search path to use when executing the SQL command
896+
897+
#### `unless`
898+
An optional SQL command to execute prior to the main :command; this is
899+
generally intended to be used for idempotency, to check for the existence of an
900+
object in the database to determine whether or not the main SQL command needs
901+
to be executed at all.
902+
903+
### Custom Resource: postgresql\_conf
904+
This type allows puppet to manage postgresql.conf parameters.
905+
906+
#### `name`
907+
The postgresql parameter name to manage. This is the namevar.
908+
909+
#### `target`
910+
The path to postgresql.conf. Defaults to '/etc/postgresql.conf'
911+
912+
#### `value`
913+
The value to set for this parameter.
914+
915+
### Custom Resource: postgresql\_replication\_slot
916+
This type allows to create and destroy replication slots
917+
to register warm standby replication on a Postgresql
918+
master server.
919+
920+
#### `name`
921+
The name of the slot to create. Must be a validt replication slot name. This is the namevar.
922+
849923
###Function: postgresql\_password
850924
If you need to generate a postgres encrypted password, use `postgresql_password`. You can call it from your production manifests if you don't mind them containing the clear text versions of your passwords, or you can call it from the command line and then copy and paste the encrypted password into your manifest:
851925

0 commit comments

Comments
 (0)