Skip to content

Added delete notes to the query system catalog role #3971

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
wants to merge 1 commit into
base: release/8.0
Choose a base branch
from
Open

Added delete notes to the query system catalog role #3971

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
30 changes: 24 additions & 6 deletions modules/learn/pages/security/roles.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1117,9 +1117,9 @@ Cannot use the Query Workbench in Couchbase Server Web Console.
[#query-system-catalog]
=== Query System Catalog

The Query System Catalog role lets the user query the system catalog using {sqlpp}.
This access include querying `system:indexes`, `system:prepareds`, and tables listing current and past queries.
Assign this role to developers who need to query these tables when troubleshooting and debugging queries.
The Query System Catalog role lets the user query the system catalog using {sqlpp}. Importantly, this role also grants permissions to **delete** from certain in-memory system tables, which is useful for clearing caches and historical query logs without restarting a server.
Copy link
Contributor

@rao-shwe rao-shwe Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use line breaks. Start each sentence on a new line. The same comment for the rest of the updates on this page.

Avoid using Bold font to emphasise the words in a paragraph.

Avoid using the word "Importantly".


This access includes querying `system:indexes` and `system:prepareds`, as well as tables listing current and past queries. Assign this role to developers who need to query these tables when troubleshooting and debugging.

The role grants Couchbase Server Web Console access.

Expand All @@ -1142,12 +1142,30 @@ Cannot add, failover, remove, modify services, or rebalance servers.
| Cannot list scopes or collections, create, drop, edit settings, read or write data

| *Query*
| Can query system tables
| Cannot perform any other query actions.
Cannot use the Query Workbench in Couchbase Server Web Console.
|
*SELECT* from all system catalog tables.


Querying certain keyspaces like `system:indexes`, `system:keyspaces`, and `system:scopes` is subject to row-based filtering. The user must also have the appropriate `SELECT` privilege on the underlying keyspace or collection to see the corresponding entries.

*DELETE* from the following in-memory system tables to clear caches and logs:
`system:active_requests`
`system:completed_requests`
`system:completed_requests_history`
`system:prepareds`
`system:functions_cache`
`system:dictionary_cache`
`system:tasks_cache`
`system:aus_settings`

|
* Cannot perform any other query actions.
* Cannot use the Query Workbench in Couchbase Server Web Console.
Copy link
Contributor

@rao-shwe rao-shwe Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment is for next line with the following content:

see the manage_system_catalog role.

Check if it is the query_manage_system_catalog role? If Yes, then add a link to the section in the same page https://docs.couchbase.com/server/current/learn/security/roles.html#query_manage_system_catalog.

* Cannot `INSERT` or `UPDATE` system catalog tables. For this functionality (available from 8.0+), see the `manage_system_catalog` role.
Copy link
Contributor

@rao-shwe rao-shwe Nov 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Cannot `INSERT` or `UPDATE` system catalog tables. For this functionality (available from 8.0+), see the `manage_system_catalog` role.
* Cannot `INSERT` or `UPDATE` system catalog tables.
For this functionality (available in 8.0 and later versions), see the `manage_system_catalog` role.


|===


[#manage-global-functions]
=== Manage Global Functions

Expand Down
Loading