Add docs for Row-level security (RLS) #19527
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Files changed:
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
rmloveland
force-pushed
the
20250414-DOC-10439-row-level-security
branch
7 times, most recently
from
dc16ae3 to
2cb3af9
Compare
rmloveland
force-pushed
the
20250414-DOC-10439-row-level-security
branch
9 times, most recently
from
56780c5 to
f07bb90
Compare
rmloveland
force-pushed
the
20250414-DOC-10439-row-level-security
branch
4 times, most recently
from
181509f to
0046485
Compare
Fixes DOC-10439, DOC-12948 Summary of changes: - Add 'Row-level security' overview page - Add or update SQL statement docs for: - `CREATE POLICY` - `ALTER POLICY` - `DROP POLICY` - `SHOW POLICIES` - `ALTER TABLE {ENABLE,DISABLE} ROW LEVEL SECURITY` - `ALTER TABLE {FORCE,UNFORCE} ROW LEVEL SECURITY` - `CREATE ROLE ... WITH BYPASSRLS` - `ALTER ROLE ... WITH BYPASSRLS`
rmloveland
force-pushed
the
20250414-DOC-10439-row-level-security
branch
from
0046485 to
20ddc91
Compare
spilchen
requested changes
May 6, 2025
Contributor
Author
|
thanks for the review @spilchen, i've tried to address your feedback, this is RFAL - changes are in latest commit |
Contributor
Author
|
thanks for the additional comments @spilchen , this is RFAL again! |
spilchen
reviewed
May 12, 2025
taroface
reviewed
May 12, 2025
src/current/v25.2/alter-policy.md
Outdated
| ALTER POLICY policy_name ON table_name RENAME TO new_policy_name; | ||
| ALTER POLICY policy_name ON table_name | ||
| [ TO { role_name | PUBLIC | CURRENT_USER | SESSION_USER } [, ...] ] |
Contributor
There was a problem hiding this comment.
Are the { } brackets here part of the SQL syntax convention or are you using it to denote a placeholder as we do elsewhere in the docs? If the latter, I'd recommend excluding it from the SQL syntax as it might be confusing to mix with [ ] and ( ).
Contributor
Author
There was a problem hiding this comment.
ah my bad, just a mistake, i have changed them from {} to () since the latter usually represents a list of OR things in a BNF grammar AIUI
Contributor
There was a problem hiding this comment.
These still look like { } to me, but maybe I'm out of sync?
Contributor
Author
... also fix a busted link
Contributor
Author
spilchen
approved these changes
May 13, 2025
Contributor
spilchen
left a comment
spilchen
left a comment
There was a problem hiding this comment.
Looks good to me. Thanks for revising.
taroface
approved these changes
May 13, 2025
Contributor
taroface
left a comment
taroface
left a comment
There was a problem hiding this comment.
Have a few follow-up comments but overall LGTM!
src/current/v25.2/alter-policy.md
Outdated
| ALTER POLICY policy_name ON table_name RENAME TO new_policy_name; | ||
| ALTER POLICY policy_name ON table_name | ||
| [ TO { role_name | PUBLIC | CURRENT_USER | SESSION_USER } [, ...] ] |
Contributor
There was a problem hiding this comment.
These still look like { } to me, but maybe I'm out of sync?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes DOC-10439, DOC-12948
Summary of changes:
CREATE POLICYALTER POLICYDROP POLICYSHOW POLICIESALTER TABLE {ENABLE,DISABLE} ROW LEVEL SECURITYALTER TABLE {FORCE,UNFORCE} ROW LEVEL SECURITYCREATE ROLE ... WITH BYPASSRLSALTER ROLE ... WITH BYPASSRLS