JDBC 驱动程序 API 支持¶

方法¶

Snowflake 特定行为¶

无。

其他方法¶

getQueryID()¶

目的:

此方法返回此 CallableStatement 最近执行的查询的 Snowflake 查询 ID。如果尚未使用 callable 语句执行任何查询，则该方法返回 null。

实参:

无。

返回:

此方法以字符串形式返回 ID，其中包含 UUID。有关 UUIDs 的信息包含在 SQL 函数 UUID_STRING 的描述中。

抛出:

该方法可以抛出 SQLException。

方法¶

Snowflake 特定行为¶

• close()

  关闭对象。对象关闭后，调用该关闭对象的几乎任何方法都会引发 SQLException。对已关闭的对象调用 close 无害，并且不会引发异常。

• getMetaData()

  允许获取关于 JDBC 驱动程序和 Snowflake 的元数据。例如，可以了解是否支持事务。

  有关可以调用返回值的方法的更多信息，请参阅 对象：DatabaseMetaData。

• prepareStatement(String sql)

  此方法返回可用于执行 SQL 语句的 preparedStatement 对象。可以调用 preparedStatement 对象的 execute() 方法来执行该语句。该语句可以按原样执行，也可以在将值绑定到语句之后执行。

  备注

  在某些系统中，在准备语句后，可以重复执行该语句，而无需重新编译语句。一次准备，重复执行，可以节省少量的时间和资源。

  在 Snowflake 中，prepareStatement() 实际上并不编译代码。相反，PreparedStatement.execute()、PreparedStatement.executeQuery() 和 PreparedStatement.executeUpdate() 会编译并执行语句。因此，与简单地使用 Statement.execute() 相比，在执行之前准备语句并不能节省资源。

• prepareCall(String sql)

• prepareCall(String sql, boolean)

• prepareCall(String sql, int, int)

• prepareCall(String sql, int, int, int)

  与大多数 JDBC 实现一样， prepareCall 方法可用于将参数绑定到存储过程。例如，支持以下内容：

  CallableStatement stmt = testConnection.prepareCall("call read_result_set(?,?) ");
  

  Copy

  但是，在 Snowflake JDBC 驱动程序中， prepareCall 方法不支持绑定存储过程 返回值 的 ? = 语法。例如， 不 支持以下语句：

  CallableStatement stmt = testConnection.prepareCall("? = call read_result_set() ");  -- INVALID
  

  Copy

其他方法¶

这些方法是对 JDBC Connection 接口支持的方法的补充。

public ResultSet createResultSet(String queryID)

目的:

给定 异步启动的 SQL 语句 的 queryID，检索查询结果并在 ResultSet 对象中返回结果。

此方法通常可以在 SQL 语句完成后 24 小时内调用。

实参:

queryID：要获得结果的查询的查询 ID。

返回:

ResultSet。如果查询尚未完成运行，则服务器将返回“空” ResultSet。用户可以调用 resultSet.unwrap(SnowflakeResultSet.class).getStatus() 了解数据何时可用。

抛出:

此方法可以抛出 SQLException。

备注:

此方法是 JDBC 标准的 Snowflake 扩展。要使用此方法，必须 展开 连接对象。

示例:

ResultSet resultSet;
resultSet = connection.unwrap(SnowflakeConnection.class).createResultSet(queryID);

Copy

有关包含对此方法的调用的更广泛的示例，请参阅 异步查询示例。

public InputStream downloadStream(String stageName, String sourceFileName, boolean decompress)

目的:

此方法从给定的内部暂存区下载文件并返回输入流。

实参:

stageName：暂存区名称。

sourceFileName：暂存区中的文件路径。

decompress：如果文件压缩，则为 true。

返回:

此方法返回 InputStream。

抛出:

如果发生 SQL 错误，此方法将抛出 SQLException。

示例:

有关部分示例，请参阅 将数据文件直接从内部暂存区下载到流。

public String getSessionID()

目的:

此方法返回当前会话的会话 ID。

实参:

无

返回:

以字符串形式返回会话 ID。

抛出:

如果发生任何 SQL 错误，例如，如果连接已关闭，则此方法将抛出 SQLException。

使用说明:

由于会话 ID 在连接打开时不会改变，因此会话 ID 被缓存在本地（而不是每次都从服务器检索）以提高性能。

public prepareStatement(String sql, Boolean skipParsing)

此方法已弃用。 skipParsing 参数不再影响方法的行为；无论 skipParsing 参数的设置如何，此方法的行为都与 prepareStatement(String sql) 方法相同。

新代码应使用方法 prepareStatement(String sql)。

方便时，应将使用此方法的双实参版本的现有代码更新为使用单实参方法 prepareStatement(String sql)。

public void uploadStream(String stageName, String destPrefix, InputStream inputStream, String destFileName, boolean compressData)

目的:

此方法从流压缩数据并将其上传到内部暂存区位置。数据将作为一个文件上传。此方法不进行拆分。

实参:

stageName：暂存区名称（例如 ~，或表名称或暂存区名称）。

destPrefix：将数据上传到暂存区时应使用的路径/前缀。

inputStream：将从中上传数据的输入流。

destFileName：要使用的目标文件名。

compressData：在上传流之前是否压缩数据。

返回:

无。

抛出:

如果无法压缩数据并将其从流中放入暂存区，则此方法将抛出 java.sql.SQLException。

备注:

调用方负责在调用方法后释放 inputStream。

示例:

有关部分示例，请参阅 将数据文件直接从流上传到内部暂存区。

方法¶

Snowflake 特定行为¶

public ResultSet getColumnPrivileges(String, String, String, String)

此方法始终返回一个空集，因为 Snowflake 不支持列级权限。

public ResultSet getStreams(String, String, String)

目的:

此方法返回有关指定数据库和架构中包含的 流 的信息。

实参:

• originalCatalog：数据库的名称。

• originalSchemaPattern：用于标识架构的模式（支持 通配符）。

• streamName：流的名称（支持 通配符）。

返回:

此方法返回包含每个流的行的 ResultSet，每行包括以下各列：

• name：流的名称。

• database_name：包含流的架构的数据库名称。

  数据库对象（例如流）包含在架构中，而架构又包含在数据库中。

• schema_name：包含流的架构的名称。

• owner：拥有流的角色。

• comment：与流关联的注释。

• table_name：流跟踪其 DML 更新的表的名称。

• source_type：流的源对象。可能的值包括：

  • table

  • view

  • directory table

  • external table

• base_tables：视图的基础表。此列仅适用于视图上的流。

• type：流的类型。目前，该函数始终返回 DELTA。

• stale：流是否在 stale_after 时间过去之前最后一次读取。如果为 TRUE，则流可能已过时。

  当流已过时，无法读取它。可以重新创建流以恢复从中读取。为了防止流过时，应该在 stale_after 时间过去之前使用该流。

• mode：流的类型。可能的值包括：

  • APPEND_ONLY：指示流是仅追加流。

  • INSERT_ONLY：指示流仅返回插入行的信息。此值仅适用于外部表中的流。

  • DEFAULT：指示流位于表中。

抛出:

如果发生 SQL 错误，此方法将抛出 SQLException。

支持 null 参数¶

某些 DatabaseMetaData 方法接受数据库对象名称（例如表/目录名称）的 null 值。默认情况下， null 值表示该方法不筛选该实参。例如，如果向 getColumns() 传递 schemaPattern 实参的 null 值，那么 getColumns() 将返回所有架构的值。

对于其中一些方法，可以使用以下 :doc:` 参数 </sql-reference/parameters>` 覆盖 null 实参的默认行为：

• CLIENT_METADATA_REQUEST_USE_CONNECTION_CTX。

• CLIENT_METADATA_USE_SESSION_DATABASE。

支持数据库对象名称中的通配符¶

某些 DatabaseMetaData 方法支持数据库对象名称（如表/目录名称）中的模式匹配通配符。支持的通配符包括：

• %：匹配零个或多个字符的任意字符串。

• _：匹配任意一个字符。

以下示例显示了要传递给 getColumns() 方法以获取指定数据库 (TEMPORARYDB1) 和架构 (TEMPORARYSCHEMA1) 中所有表和所有列的名称的内容：

getColumns( connection,
    "TEMPORARYDB1",      // Database name.
    "TEMPORARYSCHEMA1",  // Schema name.
    "%",                 // All table names.
    "%"                  // All column names.
    );

数据库对象名称（如表名称）通常包含下划线，例如 SHIPPING_ADDRESSES。当然，在不转义下划线的情况下搜索 SHIPPING_ADDRESSES，不仅会找到名为 SHIPPING_ADDRESSES 的表，还会找到诸如 SHIPPING2ADDRESSES 之类的表。如果要搜索 SHIPPING_ADDRESSES，但不想搜索 SHIPPING2ADDRESSES，则需要转义通配符，以指示希望将其视为字面量。要转义字符，请在字符前面加上反斜杠。

如果要将反斜杠字符本身用作字面量字符，也必须对其进行转义。例如，若要搜索名为 T_& 的表，其中下划线、与号和反斜杠是名称的字面量部分，而不是通配符或转义字符，方法调用应类似于以下内容：

getColumns(
    connection, "TEMPORARYDB1", "TEMPORARYSCHEMA1", "T\\_\\\\", "%" // All column names.
    );

上面的每个反斜杠都必须额外转义一次，因为 Java 编译器希望反斜杠被转义：

Java sees...............: T\\_\\%\\\\
SQL sees................: T\_\%\\
The actual table name is: T_%\

方法¶

Snowflake 特定行为¶

无。

示例¶

以下代码片段显示了用于获取属性信息的程序的一部分：

  // Demonstrate the Driver.getPropertyInfo() method.
  public static void do_the_real_work(String connectionString) throws Exception {
    Properties properties = new Properties();
    Driver driver = DriverManager.getDriver(connectionString);
    DriverPropertyInfo[] dpinfo = driver.getPropertyInfo("", properties);
    System.out.println(dpinfo[0].description);
  }

请注意，在一般情况下，对此方法的调用应在循环中。如果检索有关属性的信息，然后设置该属性，则新设置可能会使其他属性相关，因此可能需要检索这些属性并对其进行设置。

方法¶

Snowflake 特定行为¶

无。

方法¶

Snowflake 特定行为¶

• addBatch()

  仅支持 INSERT 语句。

  addBatch 方法（与 executeBatch 结合使用），允许将多行数据作为单个 INSERT 语句的一部分插入。

  使用批处理和不使用批处理之间的区别类似于使用多行插入和单行插入之间的区别：

  INSERT INTO t1 (c1, c2) VALUES (1, 'One');   -- single row inserted.
  
  INSERT INTO t1 (c1, c2) VALUES (1, 'One'),   -- multiple rows inserted.
                                 (2, 'Two'),
                                 (3, 'Three');
  

  Copy

  插入成批的行通常比在单个 INSERT 语句中插入相同数量的行更有效。使用 AUTOCOMMIT 时（即当每个 INSERT 都是单独的事务时），优势甚至更大。

  有关使用 addBatch 的示例，请参阅 批处理插入。

  备注

  可以绑定的数据大小或可以批量合并的数据大小存在上限。有关详细信息，请参阅 查询文本大小的限制。

• execute()

  此方法编译并执行创建 PreparedStatement 对象时提供的 SQL 语句。语句可以是任何类型的 SQL 语句。execute() 方法不返回 ResultSet。

  此方法不返回任何内容。如果要执行查询，并且需要在语句执行时返回 ResultSet，请使用 executeQuery() 方法。

• executeQuery()

  此方法编译并执行创建 PreparedStatement 对象时提供的 SQL 语句，返回 ResultSet。

• executeUpdate()

  此方法编译并执行创建 PreparedStatement 对象时提供的 SQL 语句。该语句必须是 DML 语句（INSERT、UPDATE、DELETE 等）或不返回任何内容的 SQL 语句（例如 DDL 语句）。

  executeUpdate() 方法返回一个整数，即如果语句是 DML 语句，则为更新的行数。如果语句未更新任何行，该函数返回 0。

  如果需要执行返回 ResultSet 的 SQL 语句，请使用其他方法，例如 executeQuery()。

• setObject()

  将时间戳变量绑定到时间戳列时，可以使用此方法指定应用于解释时间戳值的时间戳变体 (TIMESTAMP_LTZ、TIMESTAMP_NTZ、TIMESTAMP_TZ)。有关详细信息，请参阅 将变量绑定到时间戳列。

其他方法¶

以下方法是对 PreparedStatement 接口支持的方法的补充。

executeAsyncQuery()¶

目的:

此方法执行 异步查询，该查询涉及提交要执行的 SQL 语句，然后将控制权返回给调用方，而无需等待查询完成。

任何对 executeQuery() 有效的 SQL 语句也对 executeAsyncQuery() 有效。

备注

文件传输语句（如 PUT 和 GET）对 executeAsyncQuery() 有效，但行为同步。

实参:

无。

返回:

“空的” ResultSet。用户应通过调用 resultSet.unwrap(SnowflakeResultSet.class).getStatus() 轮询结果集，直到查询结果可用。

抛出:

此方法可以抛出 SQLException。

备注:

此方法是 JDBC 标准的 Snowflake 扩展。要使用此方法，必须 展开 PreparedStatement 对象。

示例:

...
PreparedStatement prepStatement = connection.prepareStatement("insert into testTable values (?)");
prepStatement.setInt(1, 33);
ResultSet rs = prepStatement.executeAsyncQuery();
...

Copy

有关使用非常相似的 SnowflakeStatement.executeAsyncQuery() 方法的更广泛示例，请参阅 异步查询示例。

getQueryID()

目的:

此方法返回此 SnowflakePreparedStatement 最近执行的查询的 Snowflake 查询 ID。如果尚未使用此预准备语句执行任何查询，则该方法将返回 null。

实参:

无。

返回:

该方法以字符串形式返回 ID，其中包含 UUID。

抛出:

该方法可以抛出 SQLException。

备注:

此方法是 JDBC 标准的 Snowflake 扩展。要使用此方法，必须 展开 SnowflakePreparedStatement。

对于 异步查询，在语句执行完成之前，查询 ID 不可用。如果在调用 executeAsyncQuery() 之后但在语句执行完成之前调用 SnowflakePreparedStatement.getQueryID()，则返回值可能是 NULL。请改为对 executeAsyncQuery() 返回的 ResultSet 对象调用 resultSet.unwrap(SnowflakeResultSet.class).getQueryID()。

示例:

此部分示例演示如何调用该方法：

    // Retrieve the query ID from the PreparedStatement.
    String queryID;
    queryID = preparedStatement.unwrap(SnowflakePreparedStatement.class).getQueryID();

Copy

枚举常量¶

每个枚举常量表示异步查询可能的不同状态。

方法¶

枚举类型定义以下方法，当查询状态为 FAILED_WITH_ERROR 时，可以使用这些方法获取有关错误的详细信息。

getErrorCode()¶

目的:

如果在执行查询期间发生错误，此方法将从服务器返回错误代码。

实参:

无。

返回:

该方法返回 int 形式的错误代码。如果未发生错误，该方法将返回值 0。

示例:

QueryStatus queryStatus = resultSet.unwrap(SnowflakeResultSet.class).getStatus();
if (queryStatus == queryStatus.FAILED_WITH_ERROR) {
  // Print the error code to stdout
  System.out.format("Error code: %d%n", queryStatus.getErrorCode());
}

Copy

有关包含对此方法的调用的更广泛的示例，请参阅 异步查询示例。

getErrorMessage()¶

目的:

如果在执行查询期间发生错误，此方法将从服务器返回错误消息。

实参:

无。

返回:

该方法返回 String 形式的错误消息。如果未发生错误，该方法将返回值 No error reported。

示例:

QueryStatus queryStatus = resultSet.unwrap(SnowflakeResultSet.class).getStatus();
if (queryStatus == queryStatus.FAILED_WITH_ERROR) {
  // Print the error message to stdout
  System.out.format("Error message: %s%n", queryStatus.getErrorMessage());
}

Copy

有关包含对此方法的调用的更广泛的示例，请参阅 异步查询示例。

方法¶

Snowflake 特定行为¶

• close()

  关闭对象。对象关闭后，调用该关闭对象的几乎任何方法都会引发 SQLException。对已关闭的对象调用 close 无害，并且不会引发异常。

• getDate()、getTime()、getTimestamp()

  在版本 3.12.17 及更高版本的 JDBC 驱动程序中，这些方法使用会话时区（由 TIMEZONE 参数指定）。旧版本使用 JVM 的时区。

  要变更这些方法以使用 JVM 的时区，请将 JDBC_USE_SESSION_TIMEZONE 参数设置为 FALSE。

• getMetaData()

  如果 ResultSet 对象用于 异步查询，则此方法将被阻止，直到查询完成执行。在调用此方法之前，可以使用 resultSet.unwrap(SnowflakeResultSet.class).getStatus() 获取查询状态。

• next()

  这会将结果中的下一行设置为“当前”行。对 get*() 方法的调用（如 getInt()）从当前行获取值。

  如果 ResultSet 已通过调用 close 方法关闭，则后续调用 next 将返回 false，而不是引发异常。

  如果 ResultSet 对象用于 异步查询，则此方法将被阻止，直到结果可用。在调用此方法之前，可以使用 resultSet.unwrap(SnowflakeResultSet.class).getStatus() 获取查询状态。

其他方法¶

getQueryID()

目的:

此方法返回生成此结果集的语句的 Snowflake 查询 ID。

实参:

无。

返回:

该方法以字符串形式返回 ID，其中包含 UUID。

备注:

此方法是 JDBC 标准的 Snowflake 扩展。要使用此方法，必须 展开 ResultSet。

示例:

    String queryID2;
    queryID2 = resultSet.unwrap(SnowflakeResultSet.class).getQueryID();

Copy

getStatus()¶

目的:

对于异步查询返回的 ResultSet，例如 SnowflakeStatement.executeAsyncQuery()，此方法返回查询的状态。状态指示查询是成功完成、未成功完成还是尚未完成。

实参:

无。

返回:

QueryStatus 枚举常量。

抛出:

此方法可以抛出 SQLException。

备注:

此方法是 JDBC 标准的 Snowflake 扩展。要使用此方法，必须 展开 ResultSet 对象。

示例:

QueryStatus queryStatus = resultSet.unwrap(SnowflakeResultSet.class).getStatus();

Copy

有关包含对此方法的调用的更广泛的示例，请参阅 异步查询示例。

方法¶

Snowflake 特定行为¶

• ResultSetMetaData 类没有 close() 方法。当用户关闭从中创建 ResultSetMetaData 对象的 ResultSet 时，打开的 ResultSetMetaData 对象被隐式关闭。

• getCatalogName()、getSchemaName()、getTableName()

  如果 ResultSet 对象用于 异步查询，则这些方法返回空字符串。

• 对于 GEOGRAPHY 列，getColumnTypeName 返回 GEOGRAPHY。

  请注意， getColumnType 和 getColumnClassName 方法不表示列类型为 GEOGRAPHY。

其他方法¶

getColumnIndex(String columnName):

目的:

返回与 columnName 对应的列的索引。例如，如果名为“BirthDate”的列是表中的第三列，则 getColumnIndex（“BirthDate”）返回 2。（索引从 0 开始，而不是从 1 开始。）

实参:

要查找其索引的列的名称。

返回:

返回一个整数，其中包含与 columnName 对应的列的索引。如果 columnName 与结果集中的任何列都不匹配，则返回 -1。

抛出:

该方法可以抛出 SQLException。

getColumnNames():

目的:

此函数返回结果集中所有列名的列表。

这与 ResultSetMetaData 中的函数 getColumnName（int 列）不同，后者根据索引返回单个列名。

实参:

无。

返回:

返回值的数据类型为“List<String>”。该列表包含列的名称。名称的顺序与列索引的顺序相同。

抛出:

该方法可以抛出 SQLException。

getInternalColumnType(int column):

目的:

返回指定列的数据类型。

实参:

column：这表示需要其数据类型的列的索引（从 1 开始）。

返回:

返回指定列的数据类型。数据类型为整数。

抛出:

该方法可以抛出 SQLException。

getQueryID()

目的:

返回应用此元数据的查询的 Snowflake 查询 ID。

实参:

无。

返回:

此方法返回为其生成此元数据的查询的查询 ID。查询 ID 是一个字符串，其中包含 UUID。有关 UUIDs 的信息包含在 SQL 函数 UUID_STRING 的描述中。

抛出:

该方法可以抛出 SQLException。

方法¶

SnowflakeTimestampWithTimezone(
    long seconds,
    int nanoseconds,
    TimeZone tz)

SnowflakeTimestampWithTimezone(
    Timestamp ts,
    TimeZone tz)

SnowflakeTimestampWithTimezone(
    Timestamp ts)

Snowflake 特定行为¶

• getTimezone()

  从时间戳返回时区。

  import java.sql.Timestamp;
  import java.time.ZonedDateTime;
  import java.util.TimeZone;
  
  public void testGetTimezone() {
      String timezone = "Australia/Sydney";
  
      // Create a timestamp from a point in time
      Long datetime = System.currentTimeMillis();
      Timestamp currentTimestamp = new Timestamp(datetime);
      SnowflakeTimestampWithTimezone ts =
          new SnowflakeTimestampWithTimezone(currentTimestamp, TimeZone.getTimeZone(timezone));
  
      // Verify timezone was set
      assertEquals(ts.getTimezone().getID(), timezone);
  }
  

  Copy

• toZonedDateTime()

  将 SnowflakeTimestampWithTimezone 时间戳转换为分区的日期时间（Java ZonedDateTime 对象）。

  import java.sql.Timestamp;
  import java.time.ZonedDateTime;
  import java.util.TimeZone;
  
  public void testToZonedDateTime() {
      String timezone = "Australia/Sydney";
      String zonedDateTime = "2022-03-17T10:10:08+11:00[Australia/Sydney]";
  
      // Create a timestamp from a point in time
      Long datetime = 1647472208000L;
      Timestamp timestamp = new Timestamp(datetime);
      SnowflakeTimestampWithTimezone ts =
          new SnowflakeTimestampWithTimezone(timestamp, TimeZone.getTimeZone(timezone));
      ZonedDateTime zd = ts.toZonedDateTime();
  
      // Verify timestamp was converted to zoned datetime
      assertEquals(zd.toString(), zonedDateTime);
  }
  

  Copy

方法¶

Snowflake 特定行为¶

• close()

  此方法关闭对象。对象关闭后，调用该关闭对象的几乎任何方法都会引发 SQLException。对已关闭的对象调用 close 无害，并且不会引发异常。

• getBatchQueryID()

  此方法返回此 Statement 最近执行的查询批次的 Snowflake 查询 IDs 的列表。如果尚未使用该语句执行任何查询，则该方法将返回 null。

  此方法是 JDBC 标准的 Snowflake 扩展。要使用此方法，必须 展开 该语句。例如：

      connection.setAutoCommit(false);
      statement.addBatch("SELECT 1;");
      statement.addBatch("SELECT 2;");
      statement.executeBatch();
      connection.commit();
      connection.setAutoCommit(true);
      List<String> batchQueryIDs1;
      // Since getQueryID is not standard JDBC API, we must call unwrap() to
      // use these Snowflake methods.
      batchQueryIDs1 = statement.unwrap(SnowflakeStatement.class).getBatchQueryIDs();
      int num_query_ids = batchQueryIDs1.size();
      if (num_query_ids != 2) {
        System.out.println("ERROR: wrong number of query IDs in batch 1.");
      }
      // Check that each query ID is plausible.
      for (int i = 0; i < num_query_ids; i++) {
        String qid = batchQueryIDs1.get(i);
        if (!is_plausible_query_id(qid)) {
          msg = "SEVERE WARNING: suspicious query ID in batch";
          System.out.println("msg");
          System.out.println(qid);
        }
      }
  

  Copy

• getUpdateCount()

  此方法返回最近执行的 SQL 语句更新的行数。

  • 如果语句是 DML 语句（INSERT、UPDATE、DELETE 等），则 getUpdateCount() 返回添加、删除或变更的行数。请注意，如果未变更行，则此值可以为 0。

  • 如果语句是 SELECT 语句，则 getUpdateCount() 返回 -1。

  • 如果语句是 DDL 语句，则 getUpdateCount() 返回 -1。

其他方法¶

executeAsyncQuery(String)

目的:

此方法执行 异步查询，该查询涉及提交要执行的 SQL 语句，然后将控制权返回给调用方，而无需等待查询完成。

实参:

包含要执行的 SQL 命令的字符串。任何对 executeQuery() 有效的 SQL 语句也对 executeAsyncQuery() 有效。

备注

文件传输语句（如 PUT 和 GET）对 executeAsyncQuery() 有效，但行为同步。

返回:

“空的” ResultSet。用户应通过调用 resultSet.unwrap(SnowflakeResultSet.class).getStatus() 轮询结果集，直到查询结果可用。

抛出:

该方法可以抛出 SQLException。

备注:

此方法是 JDBC 标准的 Snowflake 扩展。要使用此方法，必须 展开 Statement 对象。

示例:

有关包含对此方法的调用的示例，请参阅 异步查询示例。

getQueryID()

目的:

此方法返回此 Statement 最近执行的查询的 Snowflake 查询 ID。

实参:

无。

返回:

此语句最近执行的查询的查询 ID。查询 ID 是一个字符串，其中包含 UUID。如果尚未使用该语句执行任何查询，则该方法将返回 null。

抛出:

该方法可以抛出 SQLException。

备注:

此方法是 JDBC 标准的 Snowflake 扩展。要使用此方法，必须 展开 该语句。

对于 异步查询，在语句执行完成之前，查询 ID 不可用。如果在调用 executeAsyncQuery() 之后但在语句执行完成之前调用 SnowflakeStatement.getQueryID()，则返回值可能是 NULL。请改为对 executeAsyncQuery() 返回的 ResultSet 对象调用 resultSet.unwrap(SnowflakeResultSet.class).getQueryID()。

示例:

    String queryID1;
    queryID1 = statement.unwrap(SnowflakeStatement.class).getQueryID();

Copy

setParameter(String parameter_name, <type> <value>)¶

目的:

SnowflakeStatement 类将 setParameter 方法作为 Snowflake 扩展提供。这允许调用方设置特定于 Snowflake 的 JDBC 参数。

该方法重载。不同的 JDBC 参数需要不同的数据类型。每个有效数据类型都存在一个方法，该方法可以作为第二个实参传递给函数。

实参:

parameter_name：

此字符串必须包含预定义的 Snowflake JDBC 参数的名称。下面列出了预定义的 JDBC 参数（及其有效值或范围）：

JDBC 参数	备注
MULTI_STATEMENT_COUNT	指定语句数的整数（0 = 无限数量的语句； 1 或更高表示应执行的确切语句数）。

value：

这是要分配给指定 JDBC 参数的值。请确保数据类型与指定的 JDBC 参数兼容。

返回:

无。

抛出:

此函数可以抛出 SQLException。

备注:

此方法是 JDBC 标准的 Snowflake 扩展。要使用此方法，必须 展开 该语句。

示例:

Statement statement1;
...
// Tell Statement to expect to execute 2 statements:
statement1.unwrap(SnowflakeStatement.class).setParameter(
        "MULTI_STATEMENT_COUNT", 2);

Copy