Get table details

Retrieve details about a table.

GET /databases/{database}/tables/{table}/

cURL

cURL

curl --request GET \
  --url https://localhost/api/v2/databases/%7Bdatabase%7D/tables/%7Btable%7D/

200

{
  "columns": [
    {
      "default_value": "<string>",
      "generation_expression": "<string>",
      "hidden": true,
      "name": "<string>",
      "nullable": true,
      "type": "<string>"
    }
  ],
  "configure_zone_statement": "<string>",
  "create_table_statement": "<string>",
  "descriptor_id": 123,
  "grants": [
    {
      "privileges": [
        "<string>"
      ],
      "user": "<string>"
    }
  ],
  "indexes": [
    {
      "column": "<string>",
      "direction": "<string>",
      "implicit": true,
      "name": "<string>",
      "seq": 123,
      "storing": true,
      "unique": true
    }
  ],
  "range_count": 123,
  "zone_config": {
    "constraints": [
      {
        "constraints": [
          {
            "key": "<string>",
            "type": 123,
            "value": "<string>"
          }
        ],
        "num_replicas": 123
      }
    ],
    "gc": {
      "ttl_seconds": 123
    },
    "global_reads": true,
    "inherited_constraints": true,
    "inherited_lease_preferences": true,
    "lease_preferences": [
      {
        "constraints": [
          {
            "key": "<string>",
            "type": 123,
            "value": "<string>"
          }
        ]
      }
    ],
    "null_voter_constraints_is_empty": true,
    "num_replicas": 123,
    "num_voters": 123,
    "range_max_bytes": 123,
    "range_min_bytes": 123,
    "subzone_spans": [
      {
        "end_key": [
          123
        ],
        "key": [
          123
        ],
        "subzone_index": 123
      }
    ],
    "subzones": [
      {
        "config": "<unknown>",
        "index_id": 123,
        "partition_name": "<string>"
      }
    ],
    "voter_constraints": [
      {
        "constraints": [
          {
            "key": "<string>",
            "type": 123,
            "value": "<string>"
          }
        ],
        "num_replicas": 123
      }
    ]
  },
  "zone_config_level": 123
}

Path Parameters

database · string · required

Name of the database being looked up.

table · string · required

Name of table being looked up. Table may be schema-qualified (schema.table) and each name component that contains sql unsafe characters such as . or uppercase letters must be surrounded in double quotes like "Naughty schema".table.

Response

200

application/json

Database details response

Grants, column names, and indexes for a table.

columns · object[]

Show child attributes

configure_zone_statement · string

The output of "SHOW ZONE CONFIGURATION FOR TABLE" for this table. It is a SQL statement that would re-configure the table's current zone if executed.

create_table_statement · string

The output of "SHOW CREATE" for this table; it is a SQL statement that would re-create the table's current schema if executed.

descriptor_id · integer<int64>

An identifier used to uniquely identify this table. It can be used to find events pertaining to this table by filtering on the target_id field of events.

grants · Grant is an entry from SHOW GRANTS. · object[]

Show child attributes

indexes · object[]

Show child attributes

range_count · integer<int64>

The size of the table in ranges. This provides a rough estimate of the storage requirements for the table.

zone_config · ZoneConfig holds configuration that applies to one or more ranges. · object

For internal use only.

Show child attributes

zone_config_level · integer<int32>

The object level at which the configuration is defined. This is needed because objects without a specifically indicated Zone Configuration will inherit the configuration of their "parent".