Metastore interface

Package:

@azure/synapse-artifacts

Interface representing a Metastore.

Methods

delete(string, MetastoreDeleteOptionalParams)	Remove files in Syms
getDatabaseOperations(string, MetastoreGetDatabaseOperationsOptionalParams)	Gets status of the database
register(string, MetastoreRegisterObject, MetastoreRegisterOptionalParams)	Register files in Syms
update(string, MetastoreUpdateObject, MetastoreUpdateOptionalParams)	Update files in Syms

Method Details

delete(string, MetastoreDeleteOptionalParams)

Remove files in Syms

function delete(id: string, options?: MetastoreDeleteOptionalParams): Promise<void>

Parameters

id

string

options

MetastoreDeleteOptionalParams

The options parameters.

Returns

Promise<void>

getDatabaseOperations(string, MetastoreGetDatabaseOperationsOptionalParams)

Gets status of the database

function getDatabaseOperations(id: string, options?: MetastoreGetDatabaseOperationsOptionalParams): Promise<MetastoreRequestSuccessResponse>

Parameters

id

string

options

MetastoreGetDatabaseOperationsOptionalParams

The options parameters.

Returns

Promise<MetastoreRequestSuccessResponse>

register(string, MetastoreRegisterObject, MetastoreRegisterOptionalParams)

Register files in Syms

function register(id: string, registerBody: MetastoreRegisterObject, options?: MetastoreRegisterOptionalParams): Promise<MetastoreRegistrationResponse>

Parameters

id

string

The name of the database to be created. The name can contain only alphanumeric characters and should not exceed 24 characters

registerBody

MetastoreRegisterObject

The body for the register request

options

MetastoreRegisterOptionalParams

The options parameters.

Returns

Promise<MetastoreRegistrationResponse>

update(string, MetastoreUpdateObject, MetastoreUpdateOptionalParams)

Update files in Syms

function update(id: string, updateBody: MetastoreUpdateObject, options?: MetastoreUpdateOptionalParams): Promise<MetastoreUpdationResponse>

Parameters

id

string

The name of the database to be updated

updateBody

MetastoreUpdateObject

The body for the update request

options

MetastoreUpdateOptionalParams

The options parameters.

Returns

Promise<MetastoreUpdationResponse>