SurrealDB icon

SurrealDB

Interaction with a SurrealDB database

Field → List Fields

AI-generated

Summary

List all fields (columns) defined in a specified table within SurrealDB, optionally targeting a specific namespace and database.

Inputs

  • Table (required) — The name of the table from which to list fields
  • Namespace — Optional namespace override for the operation
  • Database — Optional database override for the operation
  • Connection Pooling — Optional connection pooling settings to configure connection management for performance optimization

Output shape

a list of field definitions

The operation returns an array listing all fields within the specified table. Optional namespace and database parameters override the default credential context. Connection pooling options affect performance but do not change output shape.

Examples

Example 1: Retrieve all fields from a table

Specify the target table name under 'Table' to receive all field metadata from that table.

Links

Discussion