Skip to content

Commit ebd765d

Browse files
committed
global mgmt: improve docs
1 parent 17a1240 commit ebd765d

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

docs/system/c.global-management.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,21 @@ SYSCTL REPORT STATUS
1313

1414
If you receive an error code, we recommend you to connect to the host and check logs. If the server has crashed, you may need to [recover the database](recovery).
1515

16-
## Inspecting all spaces
16+
## Inspecting global state
17+
18+
The following query provides a quick overview of the global system state, including users, spaces and settings:
19+
20+
```sql
21+
INSPECT GLOBAL
22+
```
23+
24+
This will return a JSON like this:
1725

18-
The single DDL query that lets you do a "sneak peek" into the status of the entire system is the `INSPECT GLOBAL` query. It
19-
returns a JSON string like this:
2026
```json
2127
{
22-
"spaces:"["space1", "space2"],
23-
"users":["root", "staging_server"],
24-
"settings:{},
28+
"spaces": ["prodApp1", "prodApp2"],
29+
"users": ["root", "staging_app_server", "prod_app_server"],
30+
"settings": {}
2531
}
2632
```
2733

0 commit comments

Comments
 (0)