ドキュメントメニュー

カタログ API#

カタログ API は、この認証情報でクエリできるテーブルを公開します。別の組織に非表示の名前が存在するかどうかを明かすことはありません。

スキーマを一覧表示#

GET/catalog

参照可能なスキーマリソースを返します。名前は、titan.<schema>.<table> の中央の部分に一致します。

テーブルを一覧表示#

GET/catalog/{schema}

1 つのスキーマ内のテーブルと論理ビューを返します。スキーマ名は、単一のパス区間として URL エンコードしてください。

テーブルの詳細を取得#

GET/catalog/{schema}/{table}

修飾名と、データ型および NULL 許容性を含む順序付きの列を返します。表示用ラベルをスクレイピングせず、このレスポンスを使ってクエリを組み立ててください。

json
{
  "object": "table",
  "schema": "stripe",
  "name": "charges",
  "qualified_name": "titan.stripe.charges",
  "columns": [
    { "name": "id", "type": "string", "nullable": false },
    { "name": "amount", "type": "integer", "nullable": true }
  ]
}

存在しない名前と、アクセスが許可されていない名前は、どちらも 404 catalog_not_found を返します。カタログの読み取りには、現在の API の導入段階で受け付ける、データまたはクエリの読み取りスコープが必要です。

レスポンスは、リクエスト時点のカタログの状態を反映します。メタデータの取得後にソースが列を検出した場合は、厳密に列を指定するクエリを生成する前に、テーブルの情報を再取得してください。