SurrealDB icon

SurrealDB

Interaction with a SurrealDB database

Index → Describe Index

AI-generated

Summary

Retrieve detailed information about a specific index on a given table in SurrealDB.

Inputs

  • Table (required) — Specify the name of the table where the index is defined.
  • Index Name (required) — Provide the name of the index to describe.
  • Namespace — Optionally specify a namespace to override the default credential setting for this operation.
  • Database — Optionally specify a database to override the default credential setting for this operation.
  • Options — Additional operation-specific options, though none apply specifically to describeIndex beyond general options.
  • Connection Pooling — Configure connection pooling settings for improved performance and reliability during the operation.

Output shape

a list containing objects with detailed information about the specified index, such as index properties and configuration

Returns details for the specified index on the specified table. The output structure reflects the index metadata as provided by SurrealDB. If the index does not exist or an error occurs, the output may indicate the failure.

Links

Discussion