连接配置参考¶

数据库对象和过程¶

以下数据库对象是通过文件 configuration/connection_configuration.sql 创建的。

PUBLIC.SET_CONNECTION_CONFIGURATION (connection_configuration VARIANT)¶

入口点过程可用于 ADMIN 角色。此过程会调用 Java函数 ConnectionConfigurationHandler.setConnectionConfiguration()。

PUBLIC.SET_CONNECTION_CONFIGURATION_VALIDATE (connection_configuration VARIANT)¶

用于对特定连接器进行配置验证的过程。它还可以用于转换配置的某些部分。转换后的配置需要作为附加 "config" 属性返回。默认情况下，它会返回 'response_code': 'OK'。它由 DefaultConnectionConfigurationInputValidator 调用。在 SQL 和 Java 中都可以被覆盖。

PUBLIC.SET_CONNECTION_CONFIGURATION_INTERNAL (connection_configuration VARIANT)¶

用于连接器特定附加连接配置的过程，例如将外部访问集成添加到其他过程。默认情况下，它会返回 'response_code': 'OK'。它由 InternalConnectionConfigurationCallback 调用。在 SQL 和 Java 中都可以被覆盖。

PUBLIC.GET_CONNECTION_CONFIGURATION()¶

用于从内部表中检索当前连接配置的过程。它可供 ADMIN 和 VIEWER 用户使用。

自定义处理程序¶

可以使用以下两种方法对处理程序及其内部结构进行自定义。

过程替换方法¶

可以使用 SQL 替换以下组件。

处理程序¶

若要提供 ConnectionConfigurationHandler 的完整自定义实施，则必须替换 PUBLIC.SET_CONNECTION_CONFIGURATION 过程。例如：

CREATE OR REPLACE PROCEDURE PUBLIC.SET_CONNECTION_CONFIGURATION(config VARIANT)
  RETURNS VARIANT
  LANGUAGE JAVA
  RUNTIME_VERSION = '11'
  PACKAGES = ('com.snowflake:snowpark:1.11.0')
  IMPORTS = ('/connectors-native-sdk.jar')
  HANDLER = 'com.custom.handler.CustomConnectionConfigurationHandler.setConnectionConfiguration';

GRANT USAGE ON PROCEDURE PUBLIC.CONFIGURE_CONNECTOR(VARIANT) TO APPLICATION ROLE ADMIN;

内部过程¶

内部 VALIDATE 和 INTERNAL 过程也可以通过 SQL 进行自定义。它们还可以调用另一个 Java 处理程序：

CREATE OR REPLACE PROCEDURE PUBLIC.SET_CONNECTION_CONFIGURATION_INTERNAL(config VARIANT)
  RETURNS VARIANT
  LANGUAGE SQL
  EXECUTE AS OWNER
  AS
  BEGIN
    -- SOME CUSTOM LOGIC BEGIN
    SELECT sysdate();
    -- SOME CUSTOM LOGIC END

    RETURN OBJECT_CONSTRUCT('response_code', 'OK', '"config"', '"transformed config variant"');
  END;

CREATE OR REPLACE PROCEDURE PUBLIC.SET_CONNECTION_CONFIGURATION_VALIDATE(config VARIANT)
  RETURNS VARIANT
  LANGUAGE JAVA
  RUNTIME_VERSION = '11'
  PACKAGES = ('com.snowflake:snowpark:1.11.0')
  IMPORTS = ('/connectors-native-sdk.jar')
  HANDLER = 'com.custom.handler.CustomConnectionConfigurationValidateHandler.setConnectionConfiguration';

生成器方法¶

可以使用 ConnectionConfigurationHandlerBuilder 对 ConnectionConfigurationHandler 进行自定义。此生成器允许用户提供以下界面的自定义实施：

如果没有提供其中一项，则将使用 SDK 提供的默认实施。

class CustomConnectionConfigurationInputValidator implements ConnectionConfigurationInputValidator {
  @Override
  public ConnectorResponse validate(Variant config) {
    // CUSTOM LOGIC
    return ConnectorResponse.success();
  }
}

class CustomHandler {

  // Path to this method needs to be specified in the PUBLIC.SET_CONNECTION_CONFIGURATION procedure using SQL
  public static Variant configureConnection(Session session, Variant configuration) {
    //Using builder
    var handler = ConnectionConfigurationHandler.builder(session)
      .withInputValidator(new CustomConnectionConfigurationInputValidator())
      .build();
    return handler.connectionConfiguration(configuration).toVariant();
  }
}