SurrealDB icon

SurrealDB

Interaction with a SurrealDB database

Table → Get Table

AI-generated

Summary

Retrieve metadata information about a specified SurrealDB table, including its structure and properties.

Inputs

  • table (required) — The name of the SurrealDB table to fetch metadata for (e.g., "person", "product"). Can also be a full record ID, from which the table name is extracted automatically.
  • options.namespace — An optional namespace override for the operation, superseding the default credential setting.
  • options.database — An optional database override for the operation, superseding the default credential setting.
  • connectionPooling.maxConnections — Maximum number of connections in the connection pool.
  • connectionPooling.minConnections — Minimum number of connections to keep in the connection pool.
  • connectionPooling.acquireTimeout — Timeout in milliseconds waiting to acquire a connection from the pool.
  • connectionPooling.healthCheckInterval — Interval in milliseconds between connection health checks in the pool.
  • connectionPooling.maxIdleTime — Maximum idle time in milliseconds before a connection is closed.
  • connectionPooling.retryAttempts — Number of retry attempts when acquiring a connection fails.
  • connectionPooling.retryDelay — Delay in milliseconds between retry attempts to acquire a connection.
  • connectionPooling.enableConnectionValidation — Whether to validate connections before use to ensure health.
  • connectionPooling.connectionValidationTimeout — Timeout in milliseconds for connection validation queries.

Output shape

a single record

Returns metadata details about the specified table, such as schema and structure properties. Optional connection pooling configuration parameters affect operation performance but do not change output data. The operation rejects if the table does not exist.

Links

Discussion