database_tables

Creates, updates, deletes, gets or lists a database_tables resource.

Overview

Name	database_tables
Type	Resource
Id	databricks_workspace.database.database_tables

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Full three-part (catalog, schema, table) name of the table.
database_instance_name	string	Name of the target database instance. This is required when creating database tables in standard catalogs. This is optional when creating database tables in registered catalogs. If this field is specified when creating database tables in registered catalogs, the database instance name MUST match that of the registered catalog (or the request will be rejected).
logical_database_name	string	Target Postgres database object (logical database) name for this table. When creating a table in a standard catalog, this field is required. In this scenario, specifying this field will allow targeting an arbitrary postgres database. Registration of database tables via /database/tables is currently only supported in standard catalogs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, deployment_name		Get a Database Table.
create	insert	deployment_name, table		Create a Database Table. Useful for registering pre-existing PG tables in UC. See
delete	delete	name, deployment_name		Delete a Database Table.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
name	string	str

SELECT examples

get

Get a Database Table.

SELECT
name,
database_instance_name,
logical_database_name
FROM databricks_workspace.database.database_tables
WHERE name = '{{ name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

INSERT examples

create

Create a Database Table. Useful for registering pre-existing PG tables in UC. See

INSERT INTO databricks_workspace.database.database_tables (
table,
deployment_name
)
SELECT 
'{{ table }}' /* required */,
'{{ deployment_name }}'
RETURNING
name,
database_instance_name,
logical_database_name
;

Manifest

# Description fields are for documentation purposes
- name: database_tables
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the database_tables resource.
  - name: table
    description: |
      :returns: :class:`DatabaseTable`
    value:
      name: "{{ name }}"
      database_instance_name: "{{ database_instance_name }}"
      logical_database_name: "{{ logical_database_name }}"

DELETE examples

delete

Delete a Database Table.

DELETE FROM databricks_workspace.database.database_tables
WHERE name = '{{ name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;