metastore

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

Overview

Name	metastore
Type	Resource
Id	azure.synapse_artifacts.metastore

Fields

The following fields are returned by SELECT queries:

get_database_operations

Name	Datatype	Description
status	string	Enumerates possible Status of the resource. Known values are: "Creating", "Created", and "Failed".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_database_operations	select	id, endpoint		Gets status of the database.
update	update	id, endpoint		Update files in Syms.
delete	delete	id, endpoint		Remove files in Syms.
register	exec	id, endpoint		Register files in Syms.

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
endpoint	string	The service endpoint host (no scheme). (default: )
id	string	The name of the database to be created. The name can contain only alphanumeric characters and should not exceed 24 characters. Required.

SELECT examples

get_database_operations

Gets status of the database.

SELECT
status
FROM azure.synapse_artifacts.metastore
WHERE id = '{{ id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

UPDATE examples

update

Update files in Syms.

UPDATE azure.synapse_artifacts.metastore
SET 
-- No updatable properties
WHERE 
id = '{{ id }}' --required
AND endpoint = '{{ endpoint }}' --required
RETURNING
status;

DELETE examples

delete

Remove files in Syms.

DELETE FROM azure.synapse_artifacts.metastore
WHERE id = '{{ id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

register

Register files in Syms.

EXEC azure.synapse_artifacts.metastore.register 
@id='{{ id }}' --required, 
@endpoint='{{ endpoint }}' --required
;