From ebd765d3e557e48dd33a7a33403d9ef1bf01437b Mon Sep 17 00:00:00 2001 From: Sayan Nandan Date: Mon, 17 Jun 2024 13:13:23 +0530 Subject: [PATCH] global mgmt: improve docs --- docs/system/c.global-management.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/system/c.global-management.md b/docs/system/c.global-management.md index 8de014f25..d58723397 100644 --- a/docs/system/c.global-management.md +++ b/docs/system/c.global-management.md @@ -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": {} } ```