database_catalogs

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

Overview

Name	database_catalogs
Type	Resource
Id	databricks_workspace.database.database_catalogs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string
database_instance_name	string	The name of the DatabaseInstance housing the database.
database_name	string	The name of the database (in a instance) associated with the catalog.
create_database_if_not_exists	boolean
uid	string

list

Name	Datatype	Description
name	string
database_instance_name	string	The name of the DatabaseInstance housing the database.
database_name	string	The name of the database (in a instance) associated with the catalog.
create_database_if_not_exists	boolean
uid	string

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 Catalog.
list	select	instance_name, deployment_name	page_size, page_token	This API is currently unimplemented, but exposed for Terraform support.
create	insert	deployment_name, catalog		Create a Database Catalog.
update	update	name, update_mask, deployment_name, database_catalog		This API is currently unimplemented, but exposed for Terraform support.
delete	delete	name, deployment_name		Delete a Database Catalog.

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)
instance_name	string	Name of the instance to get database catalogs for.
name	string	str
update_mask	string	The list of fields to update. Setting this field is not yet supported.
page_size	integer	Upper bound for items returned.
page_token	string	Pagination token to go to the next page of synced database tables. Requests first page if absent.

SELECT examples

get

Get a Database Catalog.

SELECT
name,
database_instance_name,
database_name,
create_database_if_not_exists,
uid
FROM databricks_workspace.database.database_catalogs
WHERE name = '{{ name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

This API is currently unimplemented, but exposed for Terraform support.

SELECT
name,
database_instance_name,
database_name,
create_database_if_not_exists,
uid
FROM databricks_workspace.database.database_catalogs
WHERE instance_name = '{{ instance_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Create a Database Catalog.

INSERT INTO databricks_workspace.database.database_catalogs (
catalog,
deployment_name
)
SELECT 
'{{ catalog }}' /* required */,
'{{ deployment_name }}'
RETURNING
name,
database_instance_name,
database_name,
create_database_if_not_exists,
uid
;

Manifest

# Description fields are for documentation purposes
- name: database_catalogs
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the database_catalogs resource.
  - name: catalog
    description: |
      :returns: :class:`DatabaseCatalog`
    value:
      name: "{{ name }}"
      database_instance_name: "{{ database_instance_name }}"
      database_name: "{{ database_name }}"
      create_database_if_not_exists: {{ create_database_if_not_exists }}
      uid: "{{ uid }}"

UPDATE examples

update

This API is currently unimplemented, but exposed for Terraform support.

UPDATE databricks_workspace.database.database_catalogs
SET 
database_catalog = '{{ database_catalog }}'
WHERE 
name = '{{ name }}' --required
AND update_mask = '{{ update_mask }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND database_catalog = '{{ database_catalog }}' --required
RETURNING
name,
database_instance_name,
database_name,
create_database_if_not_exists,
uid;

DELETE examples

delete

Delete a Database Catalog.

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