Class ExternalMetadataClient

Index

Constructors

Methods

createExternalMetadataV2 deleteExternalMetadataV2 getExternalMetadataV2 listExternalMetadataV2 listExternalMetadataV2Iter updateExternalMetadataV2

Constructors

constructor

new ExternalMetadataClient(options: ClientOptions): ExternalMetadataClient
Parameters
- options: ClientOptions
Returns ExternalMetadataClient
- Defined in client.ts:52

Methods

createExternalMetadataV2

createExternalMetadataV2(
req: CreateExternalMetadataRequest,
options?: CallOptions,
): Promise<ExternalMetadata>
Creates a new external metadata object in the parent metastore if the caller is a metastore admin or has the CREATE_EXTERNAL_METADATA privilege. Grants BROWSE to all account users upon creation by default.
Parameters
- req: CreateExternalMetadataRequest
- Optionaloptions: CallOptions
Returns Promise<ExternalMetadata>
- Defined in client.ts:71

deleteExternalMetadataV2

deleteExternalMetadataV2(
req: DeleteExternalMetadataRequest,
options?: CallOptions,
): Promise<void>
Deletes the external metadata object that matches the supplied name. The caller must be a metastore admin, the owner of the external metadata object, or a user that has the MANAGE privilege.
Parameters
- req: DeleteExternalMetadataRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:107

getExternalMetadataV2

getExternalMetadataV2(
req: GetExternalMetadataRequest,
options?: CallOptions,
): Promise<ExternalMetadata>
Gets the specified external metadata object in a metastore. The caller must be a metastore admin, the owner of the external metadata object, or a user that has the BROWSE privilege.
Parameters
- req: GetExternalMetadataRequest
- Optionaloptions: CallOptions
Returns Promise<ExternalMetadata>
- Defined in client.ts:133

listExternalMetadataV2

listExternalMetadataV2(
req: ListExternalMetadataRequest,
options?: CallOptions,
): Promise<ListExternalMetadataResponseV2>
Gets an array of external metadata objects in the metastore. If the caller is the metastore admin, all external metadata objects will be retrieved. Otherwise, only external metadata objects that the caller has BROWSE on will be retrieved. There is no guarantee of a specific ordering of the elements in the array.
Parameters
- req: ListExternalMetadataRequest
- Optionaloptions: CallOptions
Returns Promise<ListExternalMetadataResponseV2>
- Defined in client.ts:167

listExternalMetadataV2Iter

listExternalMetadataV2Iter(
req: ListExternalMetadataRequest,
options?: CallOptions,
): AsyncGenerator<ExternalMetadata>
Parameters
- req: ListExternalMetadataRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<ExternalMetadata>
- Defined in client.ts:207

updateExternalMetadataV2

updateExternalMetadataV2(
req: UpdateExternalMetadataRequest,
options?: CallOptions,
): Promise<ExternalMetadata>
Updates the external metadata object that matches the supplied name. The caller can only update either the owner or other metadata fields in one request. The caller must be a metastore admin, the owner of the external metadata object, or a user that has the MODIFY privilege. If the caller is updating the owner, they must also have the MANAGE privilege.
Parameters
- req: UpdateExternalMetadataRequest
- Optionaloptions: CallOptions
Returns Promise<ExternalMetadata>
- Defined in client.ts:229