Skip to content

[DOC-11906] Add system:group_info & system:bucket_info keyspaces #338

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

Merged
merged 2 commits into from
Apr 24, 2025
Merged

[DOC-11906] Add system:group_info & system:bucket_info keyspaces #338

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
78744a1
add system:group_info and system:bucket_info
rakhi-prathap Apr 10, 2025
a739ce7
remove a line
rakhi-prathap Apr 10, 2025
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
81 changes: 81 additions & 0 deletions modules/n1ql/pages/n1ql-intro/sysinfo.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ a| [%hardbreaks]
<<querying-keyspaces,system:keyspaces>>
<<querying-indexes,system:indexes>>
<<querying-dual,system:dual>>
<<querying-groups, system:group_info>>
<<querying-bucket-info, system:bucket_info>>

a| [%hardbreaks]
xref:n1ql:n1ql-manage/monitoring-n1ql-query.adoc#vitals[system:vitals]
Expand Down Expand Up @@ -424,6 +426,85 @@ SELECT 2+5 FROM system:dual

The query returns the result of the expression, 7 in this case.

[#querying-groups]
== Query Groups

You can query group information using the `system:group_info` keyspace as follows:

[source,sqlpp]
----
SELECT * FROM system:group_info;
----

This catalog contains the following attributes:

[options="header", cols="~a,~a,~a"]
|===
|Name|Description|Schema

|**description** +
__required__
|User-defined description associated with the group.
|String

|**id** +
__required__
|ID of the group.
|String

|**ldap_group_ref** +
__optional__
|LDAP mapping associated with the group.
|String

|**roles** +
__required__
|List of RBAC roles for the group.
|Array of <<roles,roles>> objects
|===

[[roles]]
**Roles**
[options="header", cols="~a,~a,~a"]
|===
|Name|Description|Schema

|**bucket_name** +
__optional__
|Name of the bucket to which the role applies.
|String

|**collection_name** +
__optional__
|Name of the collection to which the role applies.
|String

|**role** +
__required__
|Specifies the RBAC role.
|String

|**scope_name** +
__optional__
|Name of the scope to which the role applies.
|String
|===

[#querying-bucket-info]
== Query Bucket Information

The `system:bucket_info` (alias: `system:database_info`) keyspace provides comprehensive information about all buckets, including their metadata, configuration settings, memory usage, and other details.

You can query the keyspace as follows:

[source,sqlpp]
----
SELECT * FROM system:bucket_info;
----

The query returns the same data as the xref:server:rest-api:rest-buckets-summary.adoc[pools/default/buckets] REST API.
However, the `vBucketServerMap.vBucketMap` field is returned in a more compact format as a pipe-delimited string, rather than an array of arrays.

[#sys_my-user-info]
== Monitor Your User Info

Expand Down