com.snowflake.snowpark_java

Class DataFrameWriter

java.lang.Object

com.snowflake.snowpark_java.DataFrameWriter

public class DataFrameWriter
extends Object

Provides methods for writing data from a DataFrame to supported output destinations.

To use this object:

1. Access an instance of a DataFrameWriter by calling the DataFrame.write method. 1. Specify the save mode to use (overwrite or append) by calling the mode() method. This method returns a DataFrameWriter that is configured to save data using the specified mode. The default SaveMode is SaveMode.Append. 1. Call a `saveAs*` method to save the data to the specified destination.

Since:

1.1.0

Method Summary

Modifier and Type	Method and Description
DataFrameWriterAsyncActor	async() Returns a DataFrameWriterAsyncActor object that can be used to execute DataFrameWriter actions asynchronously.
DataFrameWriter	mode(SaveMode saveMode) Returns a new DataFrameWriter with the specified save mode configuration.
DataFrameWriter	mode(String saveMode) Returns a new DataFrameWriter with the specified save mode configuration.
DataFrameWriter	option(String key, Object value) Sets the specified option in the DataFrameWriter.
void	saveAsTable(String tableName) Writes the data to the specified table in a Snowflake database.
void	saveAsTable(String[] multipartIdentifier) Writes the data to the specified table in a Snowflake database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

option

public DataFrameWriter option(String key,
                              Object value)

Sets the specified option in the DataFrameWriter.

Use this method to configure options:

• columnOrder: save data into a table with table's column name order if saveMode is Append and the target table exists.

Parameters:

key - Name of the option.

value - Value of the option.

Returns:

A DataFrameWriter

Since:

1.4.0

saveAsTable

public void saveAsTable(String tableName)

Writes the data to the specified table in a Snowflake database. tableName can be a fully-qualified object identifier.

For example:

 df.write().saveAsTable("db1.public_schema.table1");
 

Parameters:

tableName - Name of the table where the data should be saved.

Since:

1.1.0

saveAsTable

public void saveAsTable(String[] multipartIdentifier)

Writes the data to the specified table in a Snowflake database.

For example:

 df.write().saveAsTable(new String[]{"db_name", "schema_name", "table_name"})
 

Parameters:

multipartIdentifier - A sequence of strings that specify the database name, schema name, and table name.

Since:

1.1.0

mode

public DataFrameWriter mode(String saveMode)

Returns a new DataFrameWriter with the specified save mode configuration.

Parameters:

saveMode - One of the following strings: `"APPEND"`, `"OVERWRITE"`, `"ERRORIFEXISTS"`, or `"IGNORE"`

Returns:

This DataFrameWriter

Since:

1.1.0

mode

public DataFrameWriter mode(SaveMode saveMode)

Returns a new DataFrameWriter with the specified save mode configuration.

Parameters:

saveMode - One of the following save modes: SaveMode.Append, SaveMode.Overwrite, SaveMode.ErrorIfExists, SaveMode.Ignore

Returns:

This DataFrameWriter

Since:

1.1.0

async

public DataFrameWriterAsyncActor async()

Returns a DataFrameWriterAsyncActor object that can be used to execute DataFrameWriter actions asynchronously.

Returns:

A DataFrameWriterAsyncActor object

Since:

1.2.0