Table
A database table is a table that already exists in a Postgres database of a Lakebase database instance and is registered in Unity Catalog, so that it is governed and discoverable there while the Postgres table remains the source of truth. Unlike a synced table, no data is copied from a Unity Catalog source table into Postgres.
DatabaseTable object
A database table is a table that already exists in a Postgres database of a Lakebase database instance and is registered in Unity Catalog, so that it is governed and discoverable there while the Postgres table remains the source of truth. Unlike a synced table, no data is copied from a Unity Catalog source table into Postgres.
- namestringPublic Preview
Full three-part (catalog, schema, table) name of the table in Unity Catalog. The catalog must be a standard or default storage catalog; database tables cannot be registered in a database catalog. The schema and table parts must match the schema and table names of the Postgres table that is registered.
- database_instance_namestringPublic Preview
The name of the database instance that hosts the Postgres table. It must be set when creating a database table.
- logical_database_namestringPublic Preview
The name of the Postgres database in the instance that contains the table. It must be set when creating a database table. Tables in the system databases postgres, databricks_system, template0 and template1, and tables in the schemas pg_catalog and information_schema, cannot be registered.
Get a Database Table Public Preview
GET
Get a Database Table. The request fails if the name refers to a synced table or to a table that is not a database table; for synced tables, use Get a Synced Database Table.
API scopes: postgres
Parameters
- namestringRequiredpath
Specifies the database table by its full three-part (catalog, schema, table) name.
Response
Returns the DatabaseTable object.
Create a Database Table Public Preview
POST
Create a Database Table. This registers a table that already exists in a Postgres database of a database instance as a table in Unity Catalog. The Postgres database, schema and table must already exist; the request does not create them. Repeating the request for the same table succeeds, and a request for a name that is already registered from a different database or instance fails. To create a Postgres table from a Unity Catalog source table instead, use Create a Synced Database Table.
API scopes: postgres
Request body
- namestringRequired
Full three-part (catalog, schema, table) name of the table in Unity Catalog. The catalog must be a standard or default storage catalog; database tables cannot be registered in a database catalog. The schema and table parts must match the schema and table names of the Postgres table that is registered.
- database_instance_namestring
The name of the database instance that hosts the Postgres table. It must be set when creating a database table.
- logical_database_namestring
The name of the Postgres database in the instance that contains the table. It must be set when creating a database table. Tables in the system databases postgres, databricks_system, template0 and template1, and tables in the schemas pg_catalog and information_schema, cannot be registered.
Response
Returns the DatabaseTable object.
Delete a Database Table Public Preview
DELETE
Delete a Database Table. This removes the table from Unity Catalog only; the Postgres table and its data are kept. Tables in a database catalog cannot be deleted with this method, and synced tables must be deleted with Delete a Synced Database Table.
API scopes: postgres
Parameters
- namestringRequiredpath
Specifies the database table by its full three-part (catalog, schema, table) name.