Update warehouse reference¶

Database objects and procedures¶

The following database objects are created through the configuration/update_warehouse.sql.

PUBLIC.UPDATE_WAREHOUSE(warehouse_name STRING)¶

Entry point procedure available to the ADMIN role. This procedure invokes the Java UpdateWarehouseHandler.updateWarehouse handler.

PUBLIC.UPDATE_WAREHOUSE_INTERNAL(warehouse_name STRING)¶

Procedure used for providing additional connector specific logic. By default, it returns 'response_code': 'OK'. It is invoked by the default UpdateWarehouseCallback. Can be overwritten both in SQL and Java.

Custom handler¶

Handler and its internals can be customized using the following two approaches.

Procedure replacement approach¶

The following components can be replaced using SQL.

Handler¶

To provide a custom implementation of UpdateWarehouseHandler the PUBLIC.UPDATE_WAREHOUSE procedure must be replaced. For example:

CREATE OR REPLACE PROCEDURE PUBLIC.UPDATE_WAREHOUSE(warehouse_name STRING)
RETURNS VARIANT
LANGUAGE JAVA
RUNTIME_VERSION = '11'
PACKAGES = ('com.snowflake:snowpark:1.11.0')
IMPORTS = ('/connectors-native-sdk.jar')
HANDLER = 'com.custom.handler.CustomUpdateWarehouseHandler.updateWarehouse';

GRANT USAGE ON PROCEDURE PUBLIC.UPDATE_WAREHOUSE(STRING) TO APPLICATION ROLE ADMIN;
Copy

Internal procedure¶

The INTERNAL procedure can also be customized through SQL. It can even invoke another Java handler:

CREATE OR REPLACE PROCEDURE PUBLIC.UPDATE_WAREHOUSE_INTERNAL(warehouse_name STRING)
RETURNS VARIANT
LANGUAGE SQL
EXECUTE AS OWNER
AS
BEGIN
    -- SOME CUSTOM LOGIC

    RETURN OBJECT_CONSTRUCT('response_code', 'OK');
END;
Copy
CREATE OR REPLACE PROCEDURE PUBLIC.UPDATE_WAREHOUSE_INTERNAL(warehouse_name STRING)
    RETURNS VARIANT
    LANGUAGE JAVA
    RUNTIME_VERSION = '11'
    PACKAGES = ('com.snowflake:snowpark:1.11.0')
    IMPORTS = ('/connectors-native-sdk.jar')
    HANDLER = 'com.custom.handler.CustomUpdateWarehouseCallback.execute';
Copy

Builder approach¶

UpdateWarehouseHandler can be customized using UpdateWarehouseHandlerBuilder. This builder allows the developer to provide custom implementations of the following interfaces:

  • UpdateWarehouseInputValidator

  • UpdateWarehouseCallback

  • ConnectorErrorHelper

In case one of them is not provided - the default implementation provided by the SDK will be used.

class CustomUpdateWarehouseInputValidator implements UpdateWarehouseInputValidator {

    @Override
    public ConnectorResponse validate(Identifier warehouse) {
        // CUSTOM VALIDATION LOGIC
        return ConnectorResponse.success();
    }
}

class CustomHandler {

    // Path to this method needs to be specified in the PUBLIC.UPDATE_WAREHOUSE procedure using SQL
    public static Variant updateWarehouse(Session session, String warehouseName) {
        // Using the builder
        var handler = UpdateWarehouseHandler.builder(session)
            .withInputValidator(new CustomUpdateWarehouseInputValidator())
            .build();
        return handler.updateWarehouse(warehouseName).toVariant();
    }
}
Copy
Language: English