Added descriptions and example to postgresql type

Added some description that where lacking for some parameters.

An example detailing the use of --login parameter was added to avoid
confusion.
This commit is contained in:
Michelle 2023-02-02 20:12:11 -05:00
parent 0d14070f4e
commit 462fbb1167
No known key found for this signature in database
GPG Key ID: 5B606256B7FA58F1
1 changed files with 12 additions and 0 deletions

View File

@ -27,10 +27,19 @@ All parameter map directly to the corresponding postgres createrole
parameters.
login
Allow the created user to log into the database.
createdb
Automatically creates a database for the role just created.
createrole
Allows the new role to create new roles.
superuser
The new role has superuser privileges.
inherit
Allows the new role to inherit privileges from another user.
EXAMPLES
--------
@ -41,6 +50,9 @@ EXAMPLES
__postgres_role myrole --password 'secret'
# Without the parameter `--login` the role won't have login privileges
__postgres_role myrole --password 'secret' --login
__postgres_role admin --password 'very-secret' --superuser
__postgres_role dbcustomer --password 'bla' --createdb