Tables

List tables

Get a list of tables, optionally filtered by database it belongs to. Use fields parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using limit and before or after query params.

get/v1/tables

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/tables
  • Auth: HTTP bearer

Query parameters

fieldsstring
Example:tableConstraints,tablePartition,usageSummary,owners,customMetrics,columns,sampleData,tags,followers,joins,schemaDefinition,dataModel,extension,testSuite,domains,dataProducts,lifeCycle,sourceHash

Fields requested in the returned resource

databasestring
Example:snowflakeWestCoast.financeDB

Filter tables by database fully qualified name

databaseSchemastring
Example:snowflakeWestCoast.financeDB.schema

Filter tables by databaseSchema fully qualified name

databaseSchemaRegexstring
Example:finance_schema_.*

Filter tables by database schema regex pattern applied to databaseSchema.name by default. To apply the regex to the fully qualified name, set regexFilterByFqn=true. For better performance, use this in combination with the database query filter.

tableRegexstring
Example:orders_.*

Filter tables by table regex pattern applied to the table name by default. To apply the regex to the table fully qualified name, set regexFilterByFqn=true. For better performance, use this in combination with the database and/or databaseSchema query filters.

includeEmptyTestSuiteboolean
Example:true

Include tables with an empty test suite (i.e. no test cases have been created for this table). Default to true

limitinteger

Limit the number tables returned. (1 to 1000000, default = 10)

beforestring

Returns list of tables before this cursor

afterstring

Returns list of tables after this cursor

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

regexFilterByFqnboolean

When true, regex filters match against fullyQualifiedName instead of name. Default is false.

regexMode'include' | 'exclude'

Controls how regex filters are applied. 'include' returns matching entities, 'exclude' returns non-matching entities. Default is 'include'.

Response

List of tables

warningsCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.