Skip to content

Commit

Permalink
global mgmt: improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ohsayan committed Jun 17, 2024
1 parent 17a1240 commit ebd765d
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions docs/system/c.global-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,21 @@ SYSCTL REPORT STATUS

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).

## Inspecting all spaces
## Inspecting global state

The following query provides a quick overview of the global system state, including users, spaces and settings:

```sql
INSPECT GLOBAL
```

This will return a JSON like this:

The single DDL query that lets you do a "sneak peek" into the status of the entire system is the `INSPECT GLOBAL` query. It
returns a JSON string like this:
```json
{
"spaces:"["space1", "space2"],
"users":["root", "staging_server"],
"settings:{},
"spaces": ["prodApp1", "prodApp2"],
"users": ["root", "staging_app_server", "prod_app_server"],
"settings": {}
}
```

Expand Down

0 comments on commit ebd765d

Please sign in to comment.