Skip to main content
GET
/
v1
/
instances
/
{instance}
/
databases
/
{database}
/
catalog
cURL
curl --request GET \
  --url https://api.example.com/v1/instances/{instance}/databases/{database}/catalog
{
  "name": "<string>",
  "schemas": [
    {
      "name": "<string>",
      "tables": [
        {
          "name": "<string>",
          "columns": {
            "columns": [
              {
                "name": "<string>",
                "semanticType": "<string>",
                "labels": {},
                "classification": "<string>",
                "objectSchema": {
                  "type": "TYPE_UNSPECIFIED",
                  "structKind": {
                    "properties": {}
                  },
                  "arrayKind": {
                    "kind": "<unknown>"
                  },
                  "semanticType": "<string>"
                }
              }
            ]
          },
          "objectSchema": {
            "type": "TYPE_UNSPECIFIED",
            "structKind": {
              "properties": {}
            },
            "arrayKind": {
              "kind": "<unknown>"
            },
            "semanticType": "<string>"
          },
          "classification": "<string>"
        }
      ]
    }
  ]
}

Path Parameters

​
instance
string
required

The instance id.

​
database
string
required

The database id.

Response

OK

Catalog metadata for a database including schemas, tables, and columns.

​
name
string

The name of the database catalog. Format: instances/{instance}/databases/{database}/catalog

​
schemas
object[]

The schemas in the database.