Actions36
- Record Actions
- Table Actions
- Field Actions
- Index Actions
- Relationship Actions
- Query Actions
- System Actions
- Batch Actions
System → Health Check
AI-generatedSummary
Check the health status of the SurrealDB server and verify connection readiness.
Inputs
- Options — Optional parameters to override default namespace and database in the SurrealDB credential for this operation.
- Connection Pooling — Optional connection pooling settings to configure max/min connections, timeouts, retry attempts, and connection validation specifically for this health check operation.
Output shape
An array containing a single item with the health check result object providing server health info.
The operation allows overriding the namespace and database on a per-call basis but these are optional. Connection pooling settings adjust how connections for this operation are managed. The output includes the server's health status data as returned by SurrealDB, typically including connectivity and readiness details.
Examples
Example 1: Verify if the SurrealDB server is reachable and operational.
Use the Health Check operation optionally specifying a namespace and database to override credential defaults; adjust connection pooling parameters if needed for performance.