Describe the database: its folder (`root`), `metastore` (`metastore.yaml`: read it freely,
const url = 'https://example.com/datanotes/operations/describe_database/';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/datanotes/operations/describe_database/ \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{}'Describe the database: its folder (root), metastore (metastore.yaml: read it freely,
but it is read-only for agents and changes only through the schema operations), configuration
(default catalog and schema, row partition and file-name formats, archive folder, time zone,
history, automatic links),
journal folder, bases (shared column sets and the tables using them), catalogs → schemas → tables (with row_count, tags, and unreadable_count when some rows’ front matter cannot be read) and views;
catalogs and schemas show their comment (set with comment_on). A table or base defined before
descriptions were required has missing_descriptions: what lacks one, for alter_table / alter_column
(define_base for a base) to fill, so every table and column says what it holds.
Authorizations
Section titled “Authorizations”Request Body
Section titled “Request Body”object
Example generated
{}Responses
Section titled “Responses”Done.
The database: configuration, catalogs, schemas, tables, views and bases.
object
Database folder in the vault.
Path of metastore.yaml (catalogs, schemas, tables, views).
Folder of the operation journal.
Database configuration.
object
Date format of row sub-folders; empty = flat.
Date format of row file names.
IANA time zone; empty = values stored as given.
Transaction log (time travel) on by default.
Automatic links in the text writes put in bodies (on by default).
Tables and views by catalog and schema.
object
What the catalog holds (comment_on).
Present (true) on the default catalog.
object
What the schema holds (comment_on).
object
Catalog.schema.table
Row count.
Rows whose front matter cannot be read, when there are any: not in row_count, since every read leaves them out. check_table lists them (code unreadable).
Key/value labels of the table, when it has any.
object
What has no description, when something has none (a table defined before descriptions were required): fill them with alter_table and alter_column.
object
True when the table itself has no description.
The columns without a description.
object
Bases (shared columns) and the tables that extend each one.
object
The bases this base builds on, in order.
Column names the base declares.
Qualified tables extending it.
What has no description, when something has none (a base defined before descriptions were required): define_base fills them.
object
True when the base has no comment.
The base’s columns without a description.
Example generated
{ "root": "example", "metastore": "example", "journal": "example", "config": { "default_catalog": "example", "default_schema": "example", "default_partition": "example", "default_filename": "example", "archive_folder": "example", "timezone": "example", "history": true, "autolink": true }, "catalogs": [ { "catalog": "example", "description": "example", "default": true, "schemas": [ { "schema": "example", "description": "example", "tables": [ { "name": "example", "qualified": "example", "row_count": 1, "unreadable_count": 1, "description": "example", "tags": { "additionalProperty": "example" }, "missing_descriptions": { "table": true, "columns": [ "example" ] } } ], "views": [ { "name": "example", "qualified": "example", "description": "example" } ] } ] } ], "bases": [ { "name": "example", "description": "example", "bases": [ "example" ], "columns": [ "example" ], "tables": [ "example" ], "missing_descriptions": { "base": true, "columns": [ "example" ] } } ]}Bad input: the body is not a JSON object, or an argument is unknown, missing or of the wrong type.
object
What went wrong, for a person or an agent.
Example generated
{ "error": "example"}Missing or wrong bearer token.
object
What went wrong, for a person or an agent.
Example generated
{ "error": "example"}Unexpected error.
object
What went wrong, for a person or an agent.
Example generated
{ "error": "example"}