Documents info for root system information (#1054)

surrealdb · Jan 13, 2025 · 6dcffdf · 6dcffdf
1 parent 8017acb
commit 6dcffdf
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/src/content/doc-surrealql/statements/info.mdx b/src/content/doc-surrealql/statements/info.mdx
@@ -32,7 +32,10 @@ There are a number of different `INFO` commands for retrieving the configuration
 ## System  information
 
 ### Root information
-The top-level ROOT command returns information regarding the users and namespaces which exists within the SurrealDB system.
+The top-level ROOT command returns information regarding:
+- The users and namespaces which exists within the SurrealDB system.
+- The memory allocated by SurrealDB itself. Note that this may not match what the operating system reports, as it also includes memory consumed by third-party libraries or pre-allocated memory.
+- The level of parallelism: This number indicates the number of available hardware threads.
 
 > [!NOTE]
 > You must be authenticated as a top-level root user to execute this command.
@@ -48,6 +51,10 @@ INFO FOR ROOT;
     "namespaces": {
         "ns": "DEFINE NAMESPACE ns"
     },
+	"system": {
+		"memory_allocated": 57844023,
+		"parallelism": 12
+	},
     "users": {
         "example": "DEFINE USER example ON ROOT PASSHASH '$argon2id$v=19$m=19456,t=2,p=1$S8ggGUFSZY9B6+ZUJADNAw$jcFYLOrx1tq+/YlVk63QNZcP+VbsGD8lpFPvM59aZF4' ROLES OWNER"
     }
@@ -281,4 +288,4 @@ INFO FOR TABLE user STRUCTURE;
 	lives: [],
 	tables: []
 }
-```
+```