typeDetails

Return composite type, domain, or range type details including attributes/constraints/subtype and which columns use it.

read-onlyany connectionsweeps instancesweeps group

Synopsis

typeDetails(schema, type)

Description

Return composite type, domain, or range type details including attributes/constraints/subtype and which columns use it.

Parameters

schema requiredstring
type requiredstring

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

Output

Keyed by type name; each value is its attributes or subtype and the columns using 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": "typeDetails",
    "arguments": {
      "schema": "shop",
      "type": "money_amount"
    }
  }
}

Result

{
  "money_amount": {
    "kind": "domain",
    "base_type": "numeric(12,2)",
    "not_null": true,
    "constraints": [
      "CHECK (VALUE >= 0)"
    ],
    "columns": [
      "shop.order_items.unit_price"
    ]
  }
}

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.