Skip to main content

Documentation index: llms.txt. This page is also available as markdown: append .md to this URL or send Accept: text/markdown.

Database

A database represents a collection of tables and views, providing insights into data. Each database contains metadata, documentation, and links to its source and related entities.

type Database {
id: ID!
description: String
externalId: String!
isHidden: Boolean!
name: String!
slug: String!
sourceId: String!
warehouse: Source!
createdAt: Timestamp!
deletedAt: Timestamp
updatedAt: Timestamp!
}

Fields

Database.id ● ID! non-null scalar general

Unique Catalog identifier of the resource

Database.description ● String scalar general

The Catalog documentation for this database

Database.externalId ● String! non-null scalar general

The technical database identifier from the warehouse database structure

Database.isHidden ● Boolean! non-null scalar general

Whether this database is hidden

Database.name ● String! non-null scalar general

The technical database identifier from the warehouse database structure

Database.slug ● String! non-null scalar general

Unique Catalog slug of the resource

Database.sourceId ● String! non-null scalar general

The source (warehouse) ID of the database

Database.warehouse ● Source! non-null object sources

The warehouse of the database

Database.createdAt ● Timestamp! non-null scalar general

Date and time the resource was created

Database.deletedAt ● Timestamp scalar general

Date and time the resource was deleted

Database.updatedAt ● Timestamp! non-null scalar general

Date and time the resource was last updated

Example

{
"id": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
"description": "Contains customer information",
"externalId": "customers",
"isHidden": false,
"name": "Customers",
"slug": "s-customers-4",
"sourceId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
"warehouse": {
"lastRefreshedAt": 1758555879800,
"origin": "EXTRACTION",
"technology": "SNOWFLAKE",
"type": "COMMUNICATION",
"createdAt": 1758555879800,
"deletedAt": 1758555879800,
"updatedAt": 1758555879800
}
}

Returned By

Member Of