GET /v1/databaseSchemas
from metadata.sdk import configure
from metadata.sdk.entities import DatabaseSchemas
configure(
host="https://your-company.getcollate.io/api",
jwt_token="your-jwt-token"
)
# List with pagination
page = DatabaseSchemas.list(limit=50, fields=["owners", "tags"])
for s in page.entities:
print(f"{s.fullyQualifiedName}")
if s.owners:
print(f" Owners: {[o.name for o in s.owners]}")
# List all with auto-pagination
all_schemas = DatabaseSchemas.list_all(batch_size=100)
for schema in all_schemas:
print(f"{schema.fullyQualifiedName}")
import static org.openmetadata.sdk.fluent.DatabaseSchemas.*;
// Retrieve by ID
DatabaseSchema schema = DatabaseSchemas.retrieve(schemaId);
// List schemas
var result = DatabaseSchemas.list()
.fields("owners", "tags")
.limit(50)
.execute();
for (DatabaseSchema s : result.getData()) {
System.out.println(s.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/databaseSchemas?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by database
curl "{base_url}/api/v1/databaseSchemas?database=Glue.default&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/databaseSchemas?database=Glue.default&fields=owners,tables,usageSummary&limit=50" \
-H "Authorization: Bearer {access_token}"
# With multiple fields
curl "{base_url}/api/v1/databaseSchemas?database=Glue.default&fields=owners,tables,tags,domains,usageSummary&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "f681432b-e66c-4096-a1cd-7771358c5323",
"name": "information_schema",
"fullyQualifiedName": "Glue.default.information_schema",
"description": "This **mock** database contains tables related to the Glue service",
"version": 0.1,
"updatedAt": 1769982658171,
"updatedBy": "admin",
"href": "http://localhost:8585/api/v1/databaseSchemas/f681432b-e66c-4096-a1cd-7771358c5323",
"owners": [],
"service": {
"id": "0fab117a-4c58-4ebb-9d42-beab0768fa8e",
"type": "databaseService",
"name": "Glue",
"fullyQualifiedName": "Glue",
"displayName": "Glue",
"deleted": false,
"href": "http://localhost:8585/api/v1/services/databaseServices/0fab117a-4c58-4ebb-9d42-beab0768fa8e"
},
"serviceType": "Glue",
"database": {
"id": "9655ba5b-b8d7-419c-98f4-16b976692ad8",
"type": "database",
"name": "default",
"fullyQualifiedName": "Glue.default",
"description": "This **mock** database contains tables related to the Glue service",
"displayName": "default",
"deleted": false,
"href": "http://localhost:8585/api/v1/databases/9655ba5b-b8d7-419c-98f4-16b976692ad8"
},
"tables": [
{
"id": "49cae725-62e6-48b4-b604-7ea915659d9a",
"type": "table",
"name": "sales",
"fullyQualifiedName": "Glue.default.information_schema.sales",
"description": "Sales data",
"displayName": "sales",
"deleted": false,
"href": "http://localhost:8585/api/v1/tables/49cae725-62e6-48b4-b604-7ea915659d9a"
},
{
"id": "b9988329-cb3e-469b-8d10-d6a21de8b0b9",
"type": "table",
"name": "marketing",
"fullyQualifiedName": "Glue.default.information_schema.marketing",
"description": "Marketing data",
"displayName": "marketing",
"deleted": false,
"href": "http://localhost:8585/api/v1/tables/b9988329-cb3e-469b-8d10-d6a21de8b0b9"
}
],
"tags": [],
"deleted": false,
"sourceUrl": "https://www.glue.com/information_schema",
"domains": [],
"entityStatus": "Unprocessed"
}
],
"paging": {
"after": "...",
"total": 28
}
}
List Database Schemas
List all database schema entities with optional filtering by database, owner, tag, domain, and pagination support via the Collate REST API.
GET
/
v1
/
databaseSchemas
GET /v1/databaseSchemas
from metadata.sdk import configure
from metadata.sdk.entities import DatabaseSchemas
configure(
host="https://your-company.getcollate.io/api",
jwt_token="your-jwt-token"
)
# List with pagination
page = DatabaseSchemas.list(limit=50, fields=["owners", "tags"])
for s in page.entities:
print(f"{s.fullyQualifiedName}")
if s.owners:
print(f" Owners: {[o.name for o in s.owners]}")
# List all with auto-pagination
all_schemas = DatabaseSchemas.list_all(batch_size=100)
for schema in all_schemas:
print(f"{schema.fullyQualifiedName}")
import static org.openmetadata.sdk.fluent.DatabaseSchemas.*;
// Retrieve by ID
DatabaseSchema schema = DatabaseSchemas.retrieve(schemaId);
// List schemas
var result = DatabaseSchemas.list()
.fields("owners", "tags")
.limit(50)
.execute();
for (DatabaseSchema s : result.getData()) {
System.out.println(s.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/databaseSchemas?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by database
curl "{base_url}/api/v1/databaseSchemas?database=Glue.default&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/databaseSchemas?database=Glue.default&fields=owners,tables,usageSummary&limit=50" \
-H "Authorization: Bearer {access_token}"
# With multiple fields
curl "{base_url}/api/v1/databaseSchemas?database=Glue.default&fields=owners,tables,tags,domains,usageSummary&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "f681432b-e66c-4096-a1cd-7771358c5323",
"name": "information_schema",
"fullyQualifiedName": "Glue.default.information_schema",
"description": "This **mock** database contains tables related to the Glue service",
"version": 0.1,
"updatedAt": 1769982658171,
"updatedBy": "admin",
"href": "http://localhost:8585/api/v1/databaseSchemas/f681432b-e66c-4096-a1cd-7771358c5323",
"owners": [],
"service": {
"id": "0fab117a-4c58-4ebb-9d42-beab0768fa8e",
"type": "databaseService",
"name": "Glue",
"fullyQualifiedName": "Glue",
"displayName": "Glue",
"deleted": false,
"href": "http://localhost:8585/api/v1/services/databaseServices/0fab117a-4c58-4ebb-9d42-beab0768fa8e"
},
"serviceType": "Glue",
"database": {
"id": "9655ba5b-b8d7-419c-98f4-16b976692ad8",
"type": "database",
"name": "default",
"fullyQualifiedName": "Glue.default",
"description": "This **mock** database contains tables related to the Glue service",
"displayName": "default",
"deleted": false,
"href": "http://localhost:8585/api/v1/databases/9655ba5b-b8d7-419c-98f4-16b976692ad8"
},
"tables": [
{
"id": "49cae725-62e6-48b4-b604-7ea915659d9a",
"type": "table",
"name": "sales",
"fullyQualifiedName": "Glue.default.information_schema.sales",
"description": "Sales data",
"displayName": "sales",
"deleted": false,
"href": "http://localhost:8585/api/v1/tables/49cae725-62e6-48b4-b604-7ea915659d9a"
},
{
"id": "b9988329-cb3e-469b-8d10-d6a21de8b0b9",
"type": "table",
"name": "marketing",
"fullyQualifiedName": "Glue.default.information_schema.marketing",
"description": "Marketing data",
"displayName": "marketing",
"deleted": false,
"href": "http://localhost:8585/api/v1/tables/b9988329-cb3e-469b-8d10-d6a21de8b0b9"
}
],
"tags": [],
"deleted": false,
"sourceUrl": "https://www.glue.com/information_schema",
"domains": [],
"entityStatus": "Unprocessed"
}
],
"paging": {
"after": "...",
"total": 28
}
}
List Database Schemas
List all database schemas with optional filtering and pagination.Query Parameters
string
Filter by database fully qualified name.
string
Filter by domain fully qualified name.
integer
default:"10"
Maximum number of results to return (max: 1000000).
string
Cursor for backward pagination.
string
Cursor for forward pagination.
string
Comma-separated list of fields to include:
owners, tables, usageSummary, tags, certification, extension, domains, sourceHash, followers.string
default:"non-deleted"
Include
all, deleted, or non-deleted entities.GET /v1/databaseSchemas
from metadata.sdk import configure
from metadata.sdk.entities import DatabaseSchemas
configure(
host="https://your-company.getcollate.io/api",
jwt_token="your-jwt-token"
)
# List with pagination
page = DatabaseSchemas.list(limit=50, fields=["owners", "tags"])
for s in page.entities:
print(f"{s.fullyQualifiedName}")
if s.owners:
print(f" Owners: {[o.name for o in s.owners]}")
# List all with auto-pagination
all_schemas = DatabaseSchemas.list_all(batch_size=100)
for schema in all_schemas:
print(f"{schema.fullyQualifiedName}")
import static org.openmetadata.sdk.fluent.DatabaseSchemas.*;
// Retrieve by ID
DatabaseSchema schema = DatabaseSchemas.retrieve(schemaId);
// List schemas
var result = DatabaseSchemas.list()
.fields("owners", "tags")
.limit(50)
.execute();
for (DatabaseSchema s : result.getData()) {
System.out.println(s.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/databaseSchemas?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by database
curl "{base_url}/api/v1/databaseSchemas?database=Glue.default&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/databaseSchemas?database=Glue.default&fields=owners,tables,usageSummary&limit=50" \
-H "Authorization: Bearer {access_token}"
# With multiple fields
curl "{base_url}/api/v1/databaseSchemas?database=Glue.default&fields=owners,tables,tags,domains,usageSummary&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "f681432b-e66c-4096-a1cd-7771358c5323",
"name": "information_schema",
"fullyQualifiedName": "Glue.default.information_schema",
"description": "This **mock** database contains tables related to the Glue service",
"version": 0.1,
"updatedAt": 1769982658171,
"updatedBy": "admin",
"href": "http://localhost:8585/api/v1/databaseSchemas/f681432b-e66c-4096-a1cd-7771358c5323",
"owners": [],
"service": {
"id": "0fab117a-4c58-4ebb-9d42-beab0768fa8e",
"type": "databaseService",
"name": "Glue",
"fullyQualifiedName": "Glue",
"displayName": "Glue",
"deleted": false,
"href": "http://localhost:8585/api/v1/services/databaseServices/0fab117a-4c58-4ebb-9d42-beab0768fa8e"
},
"serviceType": "Glue",
"database": {
"id": "9655ba5b-b8d7-419c-98f4-16b976692ad8",
"type": "database",
"name": "default",
"fullyQualifiedName": "Glue.default",
"description": "This **mock** database contains tables related to the Glue service",
"displayName": "default",
"deleted": false,
"href": "http://localhost:8585/api/v1/databases/9655ba5b-b8d7-419c-98f4-16b976692ad8"
},
"tables": [
{
"id": "49cae725-62e6-48b4-b604-7ea915659d9a",
"type": "table",
"name": "sales",
"fullyQualifiedName": "Glue.default.information_schema.sales",
"description": "Sales data",
"displayName": "sales",
"deleted": false,
"href": "http://localhost:8585/api/v1/tables/49cae725-62e6-48b4-b604-7ea915659d9a"
},
{
"id": "b9988329-cb3e-469b-8d10-d6a21de8b0b9",
"type": "table",
"name": "marketing",
"fullyQualifiedName": "Glue.default.information_schema.marketing",
"description": "Marketing data",
"displayName": "marketing",
"deleted": false,
"href": "http://localhost:8585/api/v1/tables/b9988329-cb3e-469b-8d10-d6a21de8b0b9"
}
],
"tags": [],
"deleted": false,
"sourceUrl": "https://www.glue.com/information_schema",
"domains": [],
"entityStatus": "Unprocessed"
}
],
"paging": {
"after": "...",
"total": 28
}
}
Returns
Returns a paginated list of database schema objects. By default, only basic fields are included. Use thefields parameter to request additional data.
Response
array
Array of database schema objects.
Show properties
Show properties
string
Unique identifier for the schema (UUID format).
string
Schema name.
string
Fully qualified name in format
service.database.schema.string
Human-readable display name.
object
Reference to the parent database.
object
Reference to the parent database service.
string
Type of database service (e.g., Snowflake, BigQuery, PostgreSQL).
array
List of owners (teams and users) assigned to the schema. Only included when
fields contains owners.array
Classification tags applied to the schema. Only included when
fields contains tags.array
Domain assignments for governance. Only included when
fields contains domains.array
Child tables within this schema. Only included when
fields contains tables.object
Usage statistics and query counts. Only included when
fields contains usageSummary.object
Certification status of the schema. Only included when
fields contains certification.object
Custom properties defined on this schema. Only included when
fields contains extension.string
Hash of the source metadata for change detection. Only included when
fields contains sourceHash.array
Users following this schema for updates. Only included when
fields contains followers.Was this page helpful?
⌘I