快速参考：适用于 SQL 命令的 Snowpark Java APIs

本主题供您快速参考与 SQL 命令对应的一些 Snowpark APIs

（请注意，此处未列出与 SQL 命令对应的完整 APIs 列表。）

执行查询

选择列

要选择特定列，请使用 select。

SQL 语句示例

Snowpark 代码示例

 
SELECT id, name FROM sample_product_data;

DataFrame df = session.table("sample_product_data");

DataFrame dfSelectedCols = df.select(Functions.col("id"), Functions.col("name"));

dfSelectedCols.show();

重命名列

要重命名列，请使用 as 或 alias。

SQL 语句示例

Snowpark 代码示例

 
SELECT id AS item_id FROM sample_product_data;

DataFrame df = session.table("sample_product_data");

DataFrame dfRenamedCol = df.select(Functions.col("id").as("item_id"));

dfRenamedCol.show();

DataFrame df = session.table("sample_product_data");

DataFrame dfRenamedCol = df.select(Functions.col("id").alias("item_id"));

dfRenamedCol.show();

筛选数据

要筛选数据，请使用 filter 或 where。

SQL 语句示例

Snowpark 代码示例

 
SELECT * FROM sample_product_data WHERE id = 1;

DataFrame df = session.table("sample_product_data");

DataFrame dfFilteredRows = df.filter(Functions.col("id").equal_to(Functions.lit(1)));

dfFilteredRows.show();

DataFrame df = session.table("sample_product_data");

DataFrame dfFilteredRows = df.where(Functions.col("id").equal_to(Functions.lit(1)));

dfFilteredRows.show();

对数据进行排序

要对数据进行排序，请使用 sort。

SQL 语句示例

Snowpark 代码示例

 
SELECT * FROM sample_product_data ORDER BY category_id;

DataFrame df = session.table("sample_product_data");

DataFrame dfSorted = df.sort(Functions.col("category_id"));

dfSorted.show();

限制返回的行数

要限制返回的行数，请使用 limit。请参阅 限制 DataFrame 中的行数。

SQL 语句示例

Snowpark 代码示例

 
SELECT * FROM sample_product_data
  ORDER BY category_id LIMIT 2;

DataFrame df = session.table("sample_product_data");

DataFrame dfSorted = df.sort(Functions.col("category_id")).limit(2);

Row[] arrayRows = dfSorted.collect();

执行联接

要执行联接，请使用 join 或 naturalJoin。请参阅 联接 DataFrames。

SQL 语句示例

Snowpark 代码示例

 
SELECT * FROM sample_a
  INNER JOIN sample_b
  on sample_a.id_a = sample_b.id_a;

DataFrame dfLhs = session.table("sample_a");

DataFrame dfRhs = session.table("sample_b");

DataFrame dfJoined =
  dfLhs.join(dfRhs, dfLhs.col("id_a").equal_to(dfRhs.col("id_a")));

dfJoined.show();

SELECT * FROM sample_a NATURAL JOIN sample_b;

DataFrame dfLhs = session.table("sample_a");

DataFrame dfRhs = session.table("sample_b");

DataFrame dfJoined = dfLhs.naturalJoin(dfRhs);

dfJoined.show();

查询半结构化数据

要遍历半结构化数据，请使用 subField("<field_name>") 和 subField(<index>)。请参阅 使用半结构化数据。

SQL 语句示例

Snowpark 代码示例

 
SELECT src:salesperson.name FROM car_sales;

DataFrame df = session.table("car_sales");

DataFrame dfJsonField =
  df.select(Functions.col("src").subField("salesperson").subField("name"));

dfJsonField.show();

对数据进行分组和聚合

要对数据进行分组，请使用 groupBy。这将返回 RelationalGroupedDataFrame 对象，您可以使用该对象执行聚合。

SQL 语句示例

Snowpark 代码示例

 
SELECT category_id, count(*)
  FROM sample_product_data GROUP BY category_id;

DataFrame df = session.table("sample_product_data");

DataFrame dfCountPerCategory = df.groupBy(Functions.col("category_id")).count();

dfCountPerCategory.show();

调用窗口函数

要调用 窗口函数，请使用 Window 对象方法来构建 WindowSpec 对象，该对象反过来可用于窗口函数（类似于使用 '<function> OVER ...PARTITION BY ...ORDER BY')。

SQL 语句示例

Snowpark 代码示例

 
SELECT category_id, id, SUM(amount) OVER
  (PARTITION BY category_id ORDER BY product_date)
  FROM sample_product_data ORDER BY product_date;

WindowSpec window = Window.partitionBy(
  Functions.col("category_id")).orderBy(Functions.col("product_date"));

DataFrame df = session.table("sample_product_data");

DataFrame dfCumulativePrices = df.select(
  Functions.col("category_id"), Functions.col("product_date"),
  Functions.sum(Functions.col("amount")).over(window)).sort(Functions.col("product_date"));

dfCumulativePrices.show();

更新、删除和合并行

要更新、删除和合并表中的行，请使用 Updatable。请参阅 更新、删除和合并表中的行。

SQL 语句示例

Snowpark 代码示例

 
UPDATE sample_product_data
  SET serial_number = 'xyz' WHERE id = 12;

import java.util.HashMap;
import java.util.Map;
...

Map<Column, Column> assignments = new HashMap<>();

assignments.put(Functions.col("serial_number"), Functions.lit("xyz"));

Updatable updatableDf = session.table("sample_product_data");

UpdateResult updateResult =
  updatableDf.update(
    assignments,
    Functions.col("id").equal_to(Functions.lit(12)));

System.out.println("Number of rows updated: " + updateResult.getRowsUpdated());

DELETE FROM sample_product_data
  WHERE category_id = 50;

Updatable updatableDf = session.table("sample_product_data");

DeleteResult deleteResult =
  updatableDf.delete(updatableDf.col("category_id").equal_to(Functions.lit(50)));

System.out.println("Number of rows deleted: " + deleteResult.getRowsDeleted());

MERGE  INTO target_table USING source_table
  ON target_table.id = source_table.id
  WHEN MATCHED THEN
    UPDATE SET target_table.description =
      source_table.description;

import java.util.HashMap;
import java.util.Map;

Map<String, Column> assignments = new HashMap<>();
assignments.put("description", source.col("description"));
MergeResult mergeResult =
  target.merge(source, target.col("id").equal_to(source.col("id")))
  .whenMatched.updateColumn(assignments)
  .collect();

使用暂存区

有关使用暂存区的更多信息，请参阅 处理暂存区中的文件。

从暂存区上传和下载文件

要从暂存区上传和下载文件，请使用 FileOperation。请参阅 在暂存区中上传和下载文件。

SQL 语句示例

Snowpark 代码示例

 
PUT file:///tmp/*.csv @myStage OVERWRITE = TRUE;

import java.util.HashMap;
import java.util.Map;
...
Map<String, String> putOptions = new HashMap<>();

putOptions.put("OVERWRITE", "TRUE");

PutResult[] putResults = session.file().put(
  "file:///tmp/*.csv", "@myStage", putOptions);

for (PutResult result : putResults) {
  System.out.println(result.getSourceFileName() + ": " + result.getStatus());
}

GET @myStage file:///tmp PATTERN = '.*.csv.gz';

import java.util.HashMap;
import java.util.Map;
...
Map<String, String> getOptions = new HashMap<>();

getOptions.put("PATTERN", "'.*.csv.gz'");

GetResult[] getResults = session.file().get(
"@myStage", "file:///tmp", getOptions);

for (GetResult result : getResults) {
  System.out.println(result.getFileName() + ": " + result.getStatus());
}

从暂存区的文件中读取数据

要从暂存区的文件中读取数据，请使用 DataFrameReader 为数据创建 DataFrame。请参阅 为暂存区中的文件设置 DataFrame。

SQL 语句示例

Snowpark 代码示例

 
CREATE FILE FORMAT snowpark_temp_format TYPE = JSON;

SELECT "$1"[0]['salesperson']['name'] FROM (
  SELECT $1::VARIANT AS "$1" FROM @mystage/car_sales.json(
    FILE_FORMAT => 'snowpark_temp_format')) LIMIT 10;

DROP FILE FORMAT snowpark_temp_format;

DataFrame df = session.read().json(
  "@mystage/car_sales.json").select(
    Functions.col("$1").subField(0).subField("salesperson").subField("name"));

df.show();

将暂存区文件中的数据复制到表中

将暂存区文件中的数据复制到表中，请使用 DataFrameReader 为数据创建 CopyableDataFrame，并使用 copyInto 方法将数据复制到表中。请参阅 将数据从文件复制到表中。

SQL 语句示例

Snowpark 代码示例

 
COPY INTO new_car_sales
  FROM @mystage/car_sales.json
  FILE_FORMAT = (TYPE = JSON);

CopyableDataFrame dfCopyableDf = session.read().json("@mystage/car_sales.json");
dfCopyableDf.copyInto("new_car_sales");

将 DataFrame 保存到暂存区上的文件

要将 DataFrame 保存到暂存区上的文件，请使用以您要用的文件格式命名的 DataFrameWriter 方法。请参阅 将 DataFrame 保存到暂存区上的文件。

SQL 语句示例

Snowpark 代码示例

 
COPY INTO @mystage/saved_data.json
  FROM (  SELECT  *  FROM (car_sales) )
  FILE_FORMAT = ( TYPE = JSON COMPRESSION = 'none' )
  OVERWRITE = TRUE
  DETAILED_OUTPUT = TRUE

DataFrame df = session.table("car_sales");

WriteFileResult writeFileResult = df.write().mode(
  SaveMode.Overwrite).option(
  "DETAILED_OUTPUT", "TRUE").option(
  "compression", "none").json(
  "@mystage/saved_data.json");

创建和调用用户定义的函数 (UDFs)

要创建匿名 UDF，请使用 Functions.udf。

要创建可按名称调用的临时或永久 UDF，请使用 UDFRegistration.registerTemporary 或 UDFRegistration.registerPermanent。

要按名称调用永久 UDF，请使用 Functions.callUDF。

有关详细信息，请参阅 在 Java 中为 DataFrames 创建用户定义的函数 (UDFs) 和 调用标量用户定义的函数 (UDFs)。

SQL 语句示例

Snowpark 代码示例

 
CREATE FUNCTION <temp_function_name>
  RETURNS INT
  LANGUAGE JAVA
  ...
  AS
  ...;

SELECT ...,
  <temp_function_name>(quantity) AS doublenum
  FROM sample_product_data;

UserDefinedFunction doubleUdf =
  Functions.udf(
    (Integer x) -> x + x,
    DataTypes.IntegerType,
    DataTypes.IntegerType);

DataFrame df = session.table("sample_product_data");

DataFrame dfWithDoubleNum =
  df.withColumn("doubleNum",
    doubleUdf.apply(Functions.col("quantity")));

dfWithDoubleNum.show();

CREATE FUNCTION <temp_function_name>
  RETURNS INT
  LANGUAGE JAVA
  ...
  AS
  ...;

SELECT ...,
  <temp_function_name>(quantity) AS doublenum
  FROM sample_product_data;

UserDefinedFunction doubleUdf =
  session
    .udf()
    .registerTemporary(
      "doubleUdf",
      (Integer x) -> x + x,
      DataTypes.IntegerType,
      DataTypes.IntegerType);

DataFrame df = session.table("sample_product_data");

DataFrame dfWithDoubleNum =
  df.withColumn("doubleNum",
    Functions.callUDF("doubleUdf", Functions.col("quantity")));
dfWithDoubleNum.show();

CREATE FUNCTION doubleUdf(arg1 INT)
  RETURNS INT
  LANGUAGE JAVA
  ...
  AS
  ...;

SELECT ...,
  doubleUdf(quantity) AS doublenum
  FROM sample_product_data;

UserDefinedFunction doubleUdf =
  session
    .udf()
    .registerPermanent(
      "doubleUdf",
      (Integer x) -> x + x,
      DataTypes.IntegerType,
      DataTypes.IntegerType,
      "mystage");

DataFrame df = session.table("sample_product_data");

DataFrame dfWithDoubleNum =
  df.withColumn("doubleNum",
    Functions.callUDF("doubleUdf", Functions.col("quantity")));
dfWithDoubleNum.show();

创建和调用存储过程

有关使用 Snowpark 创建存储过程的指南，请参阅 在 Java 中为 DataFrames 创建存储过程。

SQL 语句示例

Snowpark 代码示例

 
CREATE PROCEDURE <temp_procedure_name>(x INTEGER, y INTEGER)
  RETURNS INTEGER
  LANGUAGE JAVA
  ...
  AS
  $$
  BEGIN
    RETURN x + y;
  END
  $$
  ;

CALL <temp_procedure_name>(2, 3);

StoredProcedure sp =
  session.sproc().registerTemporary((Session session, Integer x, Integer y) -> x + y,
    new DataType[] {DataTypes.IntegerType, DataTypes.IntegerType},
    DataTypes.IntegerType);

  session.storedProcedure(sp, 2, 3).show();

CREATE PROCEDURE sproc(x INTEGER, y INTEGER)
  RETURNS INTEGER
  LANGUAGE JAVA
  ...
  AS
  $$
  BEGIN
   RETURN x + y;
  END
  $$
  ;

CALL sproc(2, 3);

String name = "sproc";

StoredProcedure sp =
  session.sproc().registerTemporary(name,
    (Session session, Integer x, Integer y) -> x + y,
    new DataType[] {DataTypes.IntegerType, DataTypes.IntegerType},
    DataTypes.IntegerType);

  session.storedProcedure(name, 2, 3).show();

CREATE PROCEDURE add_hundred(x INTEGER)
  RETURNS INTEGER
  LANGUAGE JAVA
  ...
  AS
  $$
  BEGIN
   RETURN x + 100;
  END
  $$
  ;

CALL add_hundred(3);

String name = "add_hundred";
String stageName = "sproc_libs";

StoredProcedure sp =
  session.sproc().registerPermanent(
    name,
    (Session session, Integer x) -> x + 100,
    DataTypes.IntegerType,
    DataTypes.IntegerType,
    stageName,
    true);

  session.storedProcedure(name, 3).show();