Class SystemSchemasClient

Index

Constructors

Methods

disableSystemSchema enableSystemSchema listSystemSchemas listSystemSchemasIter

Constructors

constructor

new SystemSchemasClient(options: ClientOptions): SystemSchemasClient
Parameters
- options: ClientOptions
Returns SystemSchemasClient
- Defined in client.ts:53

Methods

disableSystemSchema

disableSystemSchema(
req: DisableSystemSchemaRequest,
options?: CallOptions,
): Promise<DisableSystemSchemaResponse>
Disables the system schema and removes it from the system catalog. The caller must be an account admin or a metastore admin.
Parameters
- req: DisableSystemSchemaRequest
- Optionaloptions: CallOptions
Returns Promise<DisableSystemSchemaResponse>
- Defined in client.ts:72

enableSystemSchema

enableSystemSchema(
req: EnableSystemSchemaRequest,
options?: CallOptions,
): Promise<EnableSystemSchemaResponse>
Enables the system schema and adds it to the system catalog. The caller must be an account admin or a metastore admin.
Parameters
- req: EnableSystemSchemaRequest
- Optionaloptions: CallOptions
Returns Promise<EnableSystemSchemaResponse>
- Defined in client.ts:107

listSystemSchemas

listSystemSchemas(
req: ListSystemSchemasRequest,
options?: CallOptions,
): Promise<ListSystemSchemasResponse>
Gets an array of system schemas for a metastore. The caller must be an account admin or a metastore admin.

NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.

PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.
Parameters
- req: ListSystemSchemasRequest
- Optionaloptions: CallOptions
Returns Promise<ListSystemSchemasResponse>
- Defined in client.ts:145

listSystemSchemasIter

listSystemSchemasIter(
req: ListSystemSchemasRequest,
options?: CallOptions,
): AsyncGenerator<SystemSchemaInfo>
Parameters
- req: ListSystemSchemasRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<SystemSchemaInfo>
- Defined in client.ts:182