Menu dokumentacji

API katalogu#

API katalogu udostępnia tabele, które mogą być odpytywane przy użyciu tych danych uwierzytelniających. Nigdy nie ujawnia, czy ukryta nazwa istnieje w innej organizacji.

Lista schematów#

GET/catalog

Zwraca widoczne zasoby schematów. Nazwy odpowiadają środkowej części titan.<schema>.<table>.

Lista tabel#

GET/catalog/{schema}

Zwraca tabele i widoki logiczne w jednym schemacie. Zakoduj schemat w adresie URL jako jeden segment ścieżki.

Opis tabeli#

GET/catalog/{schema}/{table}

Zwraca nazwę kwalifikowaną i uporządkowane kolumny z typem danych oraz informacją o możliwości wartości null. Użyj tej odpowiedzi do zbudowania zapytania bez analizowania etykiet interfejsu.

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 }
  ]
}

Brakujące i nieautoryzowane nazwy zwracają ten sam błąd 404 catalog_not_found. Odczyt katalogu wymaga zakresu odczytu danych lub zapytań obsługiwanego przez bieżące wdrożenie API.

Odpowiedź odzwierciedla jeden widok katalogu w chwili żądania. Jeśli źródło wykryje kolumnę po pobraniu metadanych, przed wygenerowaniem ścisłej projekcji pobierz tabelę ponownie.