Fetch the database schema
Fetch a database service’s schema (tables, views, functions, hypertables, …).
GET
/api/v1/database-services/{id}/sql/api/schemaAuthorization
tse_sessionAPI key · cookierequiredPath parameters
idstringrequiredQuery parameters
databasestringschemastringinternalbooleandefinitionsbooleancommentsbooleanResponses
200
OK
idstringrequirednamestringrequiredschemasNamespacedSchema[]requiredShow propertiesHide properties
Array of
NamespacedSchemacommentstringenumsEnumSchema[]Show propertiesHide properties
Array of
EnumSchemacommentstringnamestringrequiredvaluesstring[]functionsRoutine[]Show propertiesHide properties
Array of
Routineargumentsstringcommentstringdefinitionstringnamestringrequiredtypestringrequiredmaterialized_viewsViewSchema[]Show propertiesHide properties
Array of
ViewSchemacolumnsViewColumnSchema[]Show propertiesHide properties
Array of
ViewColumnSchemacommentstringnamestringrequiredtypestringrequiredcommentstringcontinuous_aggregateContinuousAggregateInfoShow propertiesHide properties
compression_enabledbooleanrequiredmaterialized_onlybooleanrequireddefinitionstringindexesIndexSchema[]Show propertiesHide properties
Array of
IndexSchemacolumnsstringrequireddefinitionstringis_uniquebooleannamestringrequiredwhere_clausestringnamestringrequiredtriggersTriggerSchema[]Show propertiesHide properties
Array of
TriggerSchemamanipulationstringrequirednamestringrequiredstatementstringrequiredtimingstringrequirednamestringrequiredproceduresRoutine[]Show propertiesHide properties
Array of
RoutineargumentsstringcommentstringdefinitionstringnamestringrequiredtypestringrequiredtablesTableSchema[]Show propertiesHide properties
Array of
TableSchemachecksCheckConstraint[]Show propertiesHide properties
Array of
CheckConstraintcolumnsstring[]expressionstringrequirednamestringrequiredcolumnsTableColumnSchema[]Show propertiesHide properties
Array of
TableColumnSchemacommentstringdefaultstringidentity_typestringis_serialbooleannamestringrequirednot_nullbooleantypestringrequiredcommentstringconstraintsTableConstraint[]Show propertiesHide properties
Array of
TableConstraintcolumnsstring[]namestringrequiredref_columnsstring[]ref_tablestringtypestringrequiredexclusionsExclusionConstraint[]Show propertiesHide properties
Array of
ExclusionConstraintdefinitionstringrequirednamestringrequiredforeignForeignTableInfoShow propertiesHide properties
optionsstring[]serverstringrequiredwrapperstringrequiredhypertableHypertableInfoShow propertiesHide properties
compression_enabledbooleanrequirednum_chunksinteger<int64>requiredindexesIndexSchema[]namestringrequiredpartitionsPartitionInfo[]Show propertiesHide properties
Array of
PartitionInfoboundstringnamestringrequiredschemastringtriggersTriggerSchema[]viewsViewSchema[]Show propertiesHide properties
Array of
ViewSchemacolumnsViewColumnSchema[]commentstringcontinuous_aggregateContinuousAggregateInfodefinitionstringindexesIndexSchema[]namestringrequiredtriggersTriggerSchema[]default
Error
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message