Database Schemas

List database schemas

Get a list of database schemas, 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/databaseSchemas

Request

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

Query parameters

fieldsstring
Example:owners,tables,usageSummary,tags,certification,extension,domains,sourceHash,followers

Fields requested in the returned resource

databasestring
Example:customerDatabase

Filter schemas by database name

databaseSchemaRegexstring
Example:finance_.*

Filter schemas by regex pattern applied to the schema name by default. To apply the regex to the fullyQualifiedName instead, set regexFilterByFqn=true. For better performance use in combination with the database query filter.

limitinteger

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

beforestring

Returns list of schemas before this cursor

afterstring

Returns list of schemas 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 database schema

warningsCountinteger

Changes

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