Class WarehousesClient

Index

Constructors

Methods

createDefaultWarehouseOverride createWarehouse deleteDefaultWarehouseOverride deleteWarehouse editWarehouse getDefaultWarehouseOverride getWarehouse getWorkspaceWarehouseConfig listDefaultWarehouseOverrides listDefaultWarehouseOverridesIter listWarehouses listWarehousesIter setWorkspaceWarehouseConfig startWarehouse stopWarehouse updateDefaultWarehouseOverride

Constructors

constructor

new WarehousesClient(options: ClientOptions): WarehousesClient
Parameters
- options: ClientOptions
Returns WarehousesClient
- Defined in client.ts:89

Methods

createDefaultWarehouseOverride

createDefaultWarehouseOverride(
req: CreateDefaultWarehouseOverrideRequest,
options?: CallOptions,
): Promise<DefaultWarehouseOverride>
Creates a new default warehouse override for a user. Users can create their own override. Admins can create overrides for any user.
Parameters
- req: CreateDefaultWarehouseOverrideRequest
- Optionaloptions: CallOptions
Returns Promise<DefaultWarehouseOverride>
- Defined in client.ts:108

createWarehouse

createWarehouse(
req: CreateWarehouseRequest,
options?: CallOptions,
): Promise<CreateWarehouseWaiter>
Creates a new SQL warehouse.
Parameters
- req: CreateWarehouseRequest
- Optionaloptions: CallOptions
Returns Promise<CreateWarehouseWaiter>
- Defined in client.ts:186

deleteDefaultWarehouseOverride

deleteDefaultWarehouseOverride(
req: DeleteDefaultWarehouseOverrideRequest,
options?: CallOptions,
): Promise<void>
Deletes the default warehouse override for a user. Users can delete their own override. Admins can delete overrides for any user. After deletion, the workspace default warehouse will be used.
Parameters
- req: DeleteDefaultWarehouseOverrideRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:202

deleteWarehouse

deleteWarehouse(
req: DeleteWarehouseRequest,
options?: CallOptions,
): Promise<DeleteWarehouseResponse>
Deletes a SQL warehouse.
Parameters
- req: DeleteWarehouseRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteWarehouseResponse>
- Defined in client.ts:225

editWarehouse

editWarehouse(
req: EditWarehouseRequest,
options?: CallOptions,
): Promise<EditWarehouseWaiter>
Updates the configuration for a SQL warehouse.
Parameters
- req: EditWarehouseRequest
- Optionaloptions: CallOptions
Returns Promise<EditWarehouseWaiter>
- Defined in client.ts:284

getDefaultWarehouseOverride

getDefaultWarehouseOverride(
req: GetDefaultWarehouseOverrideRequest,
options?: CallOptions,
): Promise<DefaultWarehouseOverride>
Returns the default warehouse override for a user. Users can fetch their own override. Admins can fetch overrides for any user. If no override exists, the UI will fallback to the workspace default warehouse.
Parameters
- req: GetDefaultWarehouseOverrideRequest
- Optionaloptions: CallOptions
Returns Promise<DefaultWarehouseOverride>
- Defined in client.ts:300

getWarehouse

getWarehouse(
req: GetWarehouseRequest,
options?: CallOptions,
): Promise<GetWarehouseResponse>
Gets the information for a single SQL warehouse.
Parameters
- req: GetWarehouseRequest
- Optionaloptions: CallOptions
Returns Promise<GetWarehouseResponse>
- Defined in client.ts:329

getWorkspaceWarehouseConfig

getWorkspaceWarehouseConfig(
_req: GetWorkspaceWarehouseConfigRequest,
options?: CallOptions,
): Promise<GetWorkspaceWarehouseConfigResponse>
Gets the workspace level configuration that is shared by all SQL warehouses in a workspace.
Parameters
- _req: GetWorkspaceWarehouseConfigRequest
- Optionaloptions: CallOptions
Returns Promise<GetWorkspaceWarehouseConfigResponse>
- Defined in client.ts:358

listDefaultWarehouseOverrides

listDefaultWarehouseOverrides(
req: ListDefaultWarehouseOverridesRequest,
options?: CallOptions,
): Promise<ListDefaultWarehouseOverridesResponse>
Lists all default warehouse overrides in the workspace. Only workspace administrators can list all overrides.
Parameters
- req: ListDefaultWarehouseOverridesRequest
- Optionaloptions: CallOptions
Returns Promise<ListDefaultWarehouseOverridesResponse>
- Defined in client.ts:393

listDefaultWarehouseOverridesIter

listDefaultWarehouseOverridesIter(
req: ListDefaultWarehouseOverridesRequest,
options?: CallOptions,
): AsyncGenerator<DefaultWarehouseOverride>
Parameters
- req: ListDefaultWarehouseOverridesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<DefaultWarehouseOverride>
- Defined in client.ts:433

listWarehouses

listWarehouses(
req: ListWarehousesRequest,
options?: CallOptions,
): Promise<ListWarehousesResponse>
Lists all SQL warehouses that a user has access to.
Parameters
- req: ListWarehousesRequest
- Optionaloptions: CallOptions
Returns Promise<ListWarehousesResponse>
- Defined in client.ts:451

listWarehousesIter

listWarehousesIter(
req: ListWarehousesRequest,
options?: CallOptions,
): AsyncGenerator<EndpointInfo>
Parameters
- req: ListWarehousesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<EndpointInfo>
- Defined in client.ts:491

setWorkspaceWarehouseConfig

setWorkspaceWarehouseConfig(
req: SetWorkspaceWarehouseConfigRequest,
options?: CallOptions,
): Promise<SetWorkspaceWarehouseConfigResponse>
Sets the workspace level configuration that is shared by all SQL warehouses in a workspace.
Parameters
- req: SetWorkspaceWarehouseConfigRequest
- Optionaloptions: CallOptions
Returns Promise<SetWorkspaceWarehouseConfigResponse>
- Defined in client.ts:509

startWarehouse

startWarehouse(
req: StartRequest,
options?: CallOptions,
): Promise<StartWarehouseWaiter>
Starts a SQL warehouse.
Parameters
- req: StartRequest
- Optionaloptions: CallOptions
Returns Promise<StartWarehouseWaiter>
- Defined in client.ts:575

stopWarehouse

stopWarehouse(
req: StopRequest,
options?: CallOptions,
): Promise<StopWarehouseWaiter>
Stops a SQL warehouse.
Parameters
- req: StopRequest
- Optionaloptions: CallOptions
Returns Promise<StopWarehouseWaiter>
- Defined in client.ts:617

updateDefaultWarehouseOverride

updateDefaultWarehouseOverride(
req: UpdateDefaultWarehouseOverrideRequest,
options?: CallOptions,
): Promise<DefaultWarehouseOverride>
Updates an existing default warehouse override for a user. Users can update their own override. Admins can update overrides for any user.
Parameters
- req: UpdateDefaultWarehouseOverrideRequest
- Optionaloptions: CallOptions
Returns Promise<DefaultWarehouseOverride>
- Defined in client.ts:632

Class WarehousesClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns WarehousesClient

Methods

createDefaultWarehouseOverride

Parameters

Returns Promise<DefaultWarehouseOverride>

createWarehouse

Parameters

Returns Promise<CreateWarehouseWaiter>

deleteDefaultWarehouseOverride

Parameters

Returns Promise<void>

deleteWarehouse

Parameters

Returns Promise<DeleteWarehouseResponse>

editWarehouse

Parameters

Returns Promise<EditWarehouseWaiter>

getDefaultWarehouseOverride

Parameters

Returns Promise<DefaultWarehouseOverride>

getWarehouse

Parameters

Returns Promise<GetWarehouseResponse>

getWorkspaceWarehouseConfig

Parameters

Returns Promise<GetWorkspaceWarehouseConfigResponse>

listDefaultWarehouseOverrides

Parameters

Returns Promise<ListDefaultWarehouseOverridesResponse>

listDefaultWarehouseOverridesIter

Parameters

Returns AsyncGenerator<DefaultWarehouseOverride>

listWarehouses

Parameters

Returns Promise<ListWarehousesResponse>

listWarehousesIter

Parameters

Returns AsyncGenerator<EndpointInfo>

setWorkspaceWarehouseConfig

Parameters

Returns Promise<SetWorkspaceWarehouseConfigResponse>

startWarehouse

Parameters

Returns Promise<StartWarehouseWaiter>

stopWarehouse

Parameters

Returns Promise<StopWarehouseWaiter>

updateDefaultWarehouseOverride

Parameters

Returns Promise<DefaultWarehouseOverride>

Settings

On This Page