Skip to content

Commit a9e6984

Browse files
authored
Update document for postgresql_default_privileges resource (#468)
1 parent 95d8d6d commit a9e6984

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

Diff for: website/docs/r/postgresql_default_privileges.html.markdown

+18-4
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,31 @@ resource "postgresql_default_privileges" "read_only_tables" {
2828

2929
## Argument Reference
3030

31-
* `role` - (Required) The name of the role to which grant default privileges on.
31+
* `role` - (Required) The role that will automatically be granted the specified privileges on new objects created by the owner.
3232
* `database` - (Required) The database to grant default privileges for this role.
33-
* `owner` - (Required) Role for which apply default privileges (You can change default privileges only for objects that will be created by yourself or by roles that you are a member of).
33+
* `owner` - (Required) Specifies the role that creates objects for which the default privileges will be applied.
3434
* `schema` - (Optional) The database schema to set default privileges for this role.
3535
* `object_type` - (Required) The PostgreSQL object type to set the default privileges on (one of: table, sequence, function, type, schema).
36-
* `privileges` - (Required) The list of privileges to apply as default privileges. An empty list could be provided to revoke all default privileges for this role.
36+
* `privileges` - (Required) List of privileges (e.g., SELECT, INSERT, UPDATE, DELETE) to grant on new objects created by the owner. An empty list could be provided to revoke all default privileges for this role.
3737

3838

3939
## Examples
4040

41-
Revoke default privileges for functions for "public" role:
41+
### Grant default privileges for tables to "current_role" role:
42+
43+
```hcl
44+
resource "postgresql_default_privileges" "grant_table_privileges" {
45+
database = postgresql_database.example_db.name
46+
role = "current_role"
47+
owner = "owner_role"
48+
schema = "public"
49+
object_type = "table"
50+
privileges = ["SELECT", "INSERT", "UPDATE"]
51+
}
52+
```
53+
Whenever the `owner_role` creates a new table in the `public` schema, the `current_role` is automatically granted SELECT, INSERT, and UPDATE privileges on that table.
54+
55+
### Revoke default privileges for functions for "public" role:
4256

4357
```hcl
4458
resource "postgresql_default_privileges" "revoke_public" {

0 commit comments

Comments
 (0)