enumDetails

Return enum type details including values and which columns use it.

read-onlyany connectionsweeps instancesweeps group

Synopsis

enumDetails(enum, schema)

Description

Return enum type details including values and which columns use it.

Parameters

enum requiredstring

schema requiredstring

Also accepts connection, instance, group, described once under arguments every tool takes.

Output

Keyed by enum type name; each value is its values and the columns that reference it. An absent extension or a missing grant is reported as {error, hint} in place of the map.

Scope

A physical replica is byte-identical here, so asking each member of a replication group adds nothing.

Example mocked data

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "enumDetails",
    "arguments": {
      "schema": "shop",
      "enum": "payment_method"
    }
  }
}

Result

{
  "payment_method": {
    "description": "How an order was paid.",
    "values": [
      "card",
      "transfer",
      "voucher"
    ],
    "columns": [
      "shop.orders.payment_method"
    ]
  }
}

Invented values on a fictional shop database, shaped by and checked against this tool's output schema. Real output is returned as structuredContent to clients that negotiate MCP 2025-06-18 or later.

See also

listSchemas, listTables, tableDetails, tableStats, largeObjects, listPartitions, partitionDetails, listTableStats, tableSize, listTableSizes, listFunctions, functionDetails, listEnums, listTypes, typeDetails, columnHistogram, listExtendedStatistics, listSequences