Skip to content

Commit ffc9014

Browse files
committed
Added delete notes to the query system catalog role
1 parent feddcee commit ffc9014

1 file changed

Lines changed: 24 additions & 6 deletions

File tree

modules/learn/pages/security/roles.adoc

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1117,9 +1117,9 @@ Cannot use the Query Workbench in Couchbase Server Web Console.
11171117
[#query-system-catalog]
11181118
=== Query System Catalog
11191119

1120-
The Query System Catalog role lets the user query the system catalog using {sqlpp}.
1121-
This access include querying `system:indexes`, `system:prepareds`, and tables listing current and past queries.
1122-
Assign this role to developers who need to query these tables when troubleshooting and debugging queries.
1120+
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.
1121+
1122+
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.
11231123

11241124
The role grants Couchbase Server Web Console access.
11251125

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

11441144
| *Query*
1145-
| Can query system tables
1146-
| Cannot perform any other query actions.
1147-
Cannot use the Query Workbench in Couchbase Server Web Console.
1145+
|
1146+
*SELECT* from all system catalog tables.
1147+
1148+
1149+
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.
1150+
1151+
*DELETE* from the following in-memory system tables to clear caches and logs:
1152+
`system:active_requests`
1153+
`system:completed_requests`
1154+
`system:completed_requests_history`
1155+
`system:prepareds`
1156+
`system:functions_cache`
1157+
`system:dictionary_cache`
1158+
`system:tasks_cache`
1159+
`system:aus_settings`
1160+
1161+
|
1162+
* Cannot perform any other query actions.
1163+
* Cannot use the Query Workbench in Couchbase Server Web Console.
1164+
* Cannot `INSERT` or `UPDATE` system catalog tables. For this functionality (available from 8.0+), see the `manage_system_catalog` role.
11481165

11491166
|===
11501167

1168+
11511169
[#manage-global-functions]
11521170
=== Manage Global Functions
11531171

0 commit comments

Comments
 (0)