org.apache.beam.sdk.io.snowflake

Class SnowflakeIO.Read<T>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<T>>

org.apache.beam.sdk.io.snowflake.SnowflakeIO.Read<T>

All Implemented Interfaces:

java.io.Serializable, org.apache.beam.sdk.transforms.display.HasDisplayData

Enclosing class:

SnowflakeIO

public abstract static class SnowflakeIO.Read<T>
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<T>>

Implementation of SnowflakeIO.read().

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnowflakeIO.Read.CleanTmpFilesFromGcsFn Removes temporary staged files after reading.
static class	SnowflakeIO.Read.MapCsvToStringArrayFn Parses String from incoming data in PCollection to have proper format for CSV files.

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

annotations, name, resourceHints

Constructor Summary

Constructors

Constructor and Description
Read()

Method Summary

Modifier and Type	Method and Description
org.apache.beam.sdk.values.PCollection<T>	expand(org.apache.beam.sdk.values.PBegin input)
SnowflakeIO.Read<T>	fromQuery(java.lang.String query) A query to be executed in Snowflake.
SnowflakeIO.Read<T>	fromQuery(org.apache.beam.sdk.options.ValueProvider<java.lang.String> query)
SnowflakeIO.Read<T>	fromTable(java.lang.String table) A table name to be read in Snowflake.
SnowflakeIO.Read<T>	fromTable(org.apache.beam.sdk.options.ValueProvider<java.lang.String> table)
void	populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)
SnowflakeIO.Read<T>	withCoder(org.apache.beam.sdk.coders.Coder<T> coder) A Coder to be used by the output PCollection generated by the source.
SnowflakeIO.Read<T>	withCsvMapper(SnowflakeIO.CsvMapper<T> csvMapper) User-defined function mapping CSV lines into user data.
SnowflakeIO.Read<T>	withDataSourceConfiguration(SnowflakeIO.DataSourceConfiguration config) Setting information about Snowflake server.
SnowflakeIO.Read<T>	withDataSourceProviderFn(org.apache.beam.sdk.transforms.SerializableFunction<java.lang.Void,javax.sql.DataSource> dataSourceProviderFn) Setting function that will provide SnowflakeIO.DataSourceConfiguration in runtime.
SnowflakeIO.Read<T>	withQuotationMark(java.lang.String quotationMark) Sets Snowflake-specific quotations around strings.
SnowflakeIO.Read<T>	withQuotationMark(org.apache.beam.sdk.options.ValueProvider<java.lang.String> quotationMark)
SnowflakeIO.Read<T>	withStagingBucketName(java.lang.String stagingBucketName) Name of the cloud bucket (GCS by now) to use as tmp location of CSVs during COPY statement.
SnowflakeIO.Read<T>	withStagingBucketName(org.apache.beam.sdk.options.ValueProvider<java.lang.String> stagingBucketName)
SnowflakeIO.Read<T>	withStorageIntegrationName(java.lang.String integrationName) Name of the Storage Integration in Snowflake to be used.
SnowflakeIO.Read<T>	withStorageIntegrationName(org.apache.beam.sdk.options.ValueProvider<java.lang.String> integrationName)

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Read

public Read()

Method Detail

withDataSourceConfiguration

public SnowflakeIO.Read<T> withDataSourceConfiguration(SnowflakeIO.DataSourceConfiguration config)

Setting information about Snowflake server.

Parameters:

config - An instance of SnowflakeIO.DataSourceConfiguration.

withDataSourceProviderFn

public SnowflakeIO.Read<T> withDataSourceProviderFn(org.apache.beam.sdk.transforms.SerializableFunction<java.lang.Void,javax.sql.DataSource> dataSourceProviderFn)

Setting function that will provide SnowflakeIO.DataSourceConfiguration in runtime.

Parameters:

dataSourceProviderFn - a SerializableFunction.

fromQuery

public SnowflakeIO.Read<T> fromQuery(java.lang.String query)

A query to be executed in Snowflake.

Parameters:

query - String with query.

fromQuery

public SnowflakeIO.Read<T> fromQuery(org.apache.beam.sdk.options.ValueProvider<java.lang.String> query)

fromTable

public SnowflakeIO.Read<T> fromTable(java.lang.String table)

A table name to be read in Snowflake.

Parameters:

table - String with the name of the table.

fromTable

public SnowflakeIO.Read<T> fromTable(org.apache.beam.sdk.options.ValueProvider<java.lang.String> table)

withStagingBucketName

public SnowflakeIO.Read<T> withStagingBucketName(java.lang.String stagingBucketName)

Name of the cloud bucket (GCS by now) to use as tmp location of CSVs during COPY statement.

Parameters:

stagingBucketName - String with the name of the bucket.

withStagingBucketName

public SnowflakeIO.Read<T> withStagingBucketName(org.apache.beam.sdk.options.ValueProvider<java.lang.String> stagingBucketName)

withStorageIntegrationName

public SnowflakeIO.Read<T> withStorageIntegrationName(java.lang.String integrationName)

Name of the Storage Integration in Snowflake to be used. See https://docs.snowflake.com/en/sql-reference/sql/create-storage-integration.html for reference.

Parameters:

integrationName - String with the name of the Storage Integration.

withStorageIntegrationName

public SnowflakeIO.Read<T> withStorageIntegrationName(org.apache.beam.sdk.options.ValueProvider<java.lang.String> integrationName)

withCsvMapper

public SnowflakeIO.Read<T> withCsvMapper(SnowflakeIO.CsvMapper<T> csvMapper)

User-defined function mapping CSV lines into user data.

Parameters:

csvMapper - an instance of SnowflakeIO.CsvMapper.

withCoder

public SnowflakeIO.Read<T> withCoder(org.apache.beam.sdk.coders.Coder<T> coder)

A Coder to be used by the output PCollection generated by the source.

Parameters:

coder - an instance of Coder.

withQuotationMark

public SnowflakeIO.Read<T> withQuotationMark(java.lang.String quotationMark)

Sets Snowflake-specific quotations around strings.

Parameters:

quotationMark - with possible single quote ', double quote " or nothing. Default value is single quotation '.

Returns:

withQuotationMark

public SnowflakeIO.Read<T> withQuotationMark(org.apache.beam.sdk.options.ValueProvider<java.lang.String> quotationMark)

expand

public org.apache.beam.sdk.values.PCollection<T> expand(org.apache.beam.sdk.values.PBegin input)

Specified by:

expand in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<T>>

populateDisplayData

public void populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)

Specified by:

populateDisplayData in interface org.apache.beam.sdk.transforms.display.HasDisplayData

Overrides:

populateDisplayData in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<T>>