Skip to content

[docs] Align Flink add_acl procedure docs with the implementation #4100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Rango-2017 wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −6
Open

[docs] Align Flink add_acl procedure docs with the implementation #4100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions website/docs/engine-flink/procedures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ CALL [catalog_name.]sys.add_acl(

**Parameters:**

- `resource` (required): The resource to grant permissions on. Can be `'CLUSTER'` for cluster-level permissions or a specific resource name (e.g., database or table name).
- `permission` (required): The permission type to grant. Valid values are `'ALLOW'` or `'DENY'`.
- `resource` (required): The resource to grant permissions on. Must be `'cluster'` for cluster-level permissions, `'cluster.<database>'` for a database, or `'cluster.<database>.<table>'` for a table.
- `permission` (required): The permission type to grant. Currently only `'ALLOW'` is supported.
- `principal` (required): The principal to grant permissions to, in the format `'Type:Name'` (e.g., `'User:Alice'`).
- `operation` (required): The operation type to grant. Valid values include `'READ'`, `'WRITE'`, `'CREATE'`, `'DELETE'`, `'ALTER'`, `'DESCRIBE'`, `'CLUSTER_ACTION'`, `'IDEMPOTENT_WRITE'`.
- `operation` (required): The operation type to grant. Valid values are `'READ'`, `'WRITE'`, `'CREATE'`, `'DROP'`, `'ALTER'`, `'DESCRIBE'`, and `'ALL'`. `'ANY'` is only for filters and should not be used when adding ACLs.
- `host` (optional): The host from which the principal can access the resource. Defaults to `'*'` (all hosts).

**Example:**
Expand All @@ -52,7 +52,7 @@ USE fluss_catalog;

-- Grant read permission to user Alice from any host
CALL sys.add_acl(
resource => 'CLUSTER',
resource => 'cluster',
permission => 'ALLOW',
principal => 'User:Alice',
operation => 'READ',
Expand All @@ -61,7 +61,7 @@ CALL sys.add_acl(

-- Grant write permission to user Bob from a specific host
CALL sys.add_acl(
resource => 'my_database.my_table',
resource => 'cluster.my_database.my_table',
permission => 'ALLOW',
principal => 'User:Bob',
operation => 'WRITE',
Expand Down Expand Up @@ -97,7 +97,7 @@ USE fluss_catalog;

-- Remove a specific ACL entry
CALL sys.drop_acl(
resource => 'CLUSTER',
resource => 'cluster',
permission => 'ALLOW',
principal => 'User:Alice',
operation => 'READ',
Expand Down