org.apache.beam.sdk.io.snowflake

Class SnowflakeIO.DataSourceConfiguration

java.lang.Object

org.apache.beam.sdk.io.snowflake.SnowflakeIO.DataSourceConfiguration

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

SnowflakeIO

public abstract static class SnowflakeIO.DataSourceConfiguration
extends java.lang.Object
implements java.io.Serializable

A POJO describing a DataSource, providing all properties allowing to create a DataSource.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataSourceConfiguration()

Method Summary

Modifier and Type	Method and Description
javax.sql.DataSource	buildDatasource() Builds SnowflakeBasicDataSource based on the current configuration.
static SnowflakeIO.DataSourceConfiguration	create(javax.sql.DataSource dataSource) Creates SnowflakeIO.DataSourceConfiguration from existing instance of DataSource.
static SnowflakeIO.DataSourceConfiguration	create(SnowflakeCredentials credentials) Creates SnowflakeIO.DataSourceConfiguration from instance of SnowflakeCredentials.
abstract java.lang.String	getDatabase()
abstract javax.sql.DataSource	getDataSource()
abstract java.lang.Integer	getLoginTimeout()
abstract java.lang.String	getOauthToken()
abstract java.lang.String	getPassword()
abstract java.lang.Integer	getPortNumber()
abstract java.security.PrivateKey	getPrivateKey()
abstract java.lang.String	getRole()
abstract java.lang.String	getSchema()
abstract java.lang.String	getServerName()
abstract java.lang.Boolean	getSsl()
abstract java.lang.String	getUrl()
abstract java.lang.String	getUsername()
abstract java.lang.Boolean	getValidate()
abstract java.lang.String	getWarehouse()
SnowflakeIO.DataSourceConfiguration	withDatabase(java.lang.String database) Sets database to use.
SnowflakeIO.DataSourceConfiguration	withLoginTimeout(java.lang.Integer loginTimeout) Sets loginTimeout that will be used in SnowflakeBasicDataSource:setLoginTimeout.
SnowflakeIO.DataSourceConfiguration	withoutValidation() Disables validation of connection parameters prior to pipeline submission.
SnowflakeIO.DataSourceConfiguration	withPortNumber(java.lang.Integer portNumber) Sets port number to use to connect to Snowflake.
SnowflakeIO.DataSourceConfiguration	withRole(java.lang.String role) Sets user's role to be used when running queries on Snowflake.
SnowflakeIO.DataSourceConfiguration	withSchema(java.lang.String schema) Sets schema to use when connecting to Snowflake.
SnowflakeIO.DataSourceConfiguration	withServerName(java.lang.String serverName) Sets the name of the Snowflake server.
SnowflakeIO.DataSourceConfiguration	withUrl(java.lang.String url) Sets URL of Snowflake server in following format: jdbc:snowflake://.snowflakecomputing.com
SnowflakeIO.DataSourceConfiguration	withWarehouse(java.lang.String warehouse) Sets Snowflake Warehouse to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceConfiguration

public DataSourceConfiguration()

Method Detail

getUrl

@Nullable
public abstract java.lang.String getUrl()

getUsername

@Nullable
public abstract java.lang.String getUsername()

getPassword

@Nullable
public abstract java.lang.String getPassword()

getPrivateKey

@Nullable
public abstract java.security.PrivateKey getPrivateKey()

getOauthToken

@Nullable
public abstract java.lang.String getOauthToken()

getDatabase

@Nullable
public abstract java.lang.String getDatabase()

getWarehouse

@Nullable
public abstract java.lang.String getWarehouse()

getSchema

@Nullable
public abstract java.lang.String getSchema()

getServerName

@Nullable
public abstract java.lang.String getServerName()

getPortNumber

@Nullable
public abstract java.lang.Integer getPortNumber()

getRole

@Nullable
public abstract java.lang.String getRole()

getLoginTimeout

@Nullable
public abstract java.lang.Integer getLoginTimeout()

getSsl

@Nullable
public abstract java.lang.Boolean getSsl()

getValidate

@Nullable
public abstract java.lang.Boolean getValidate()

getDataSource

@Nullable
public abstract javax.sql.DataSource getDataSource()

create

public static SnowflakeIO.DataSourceConfiguration create(javax.sql.DataSource dataSource)

Creates SnowflakeIO.DataSourceConfiguration from existing instance of DataSource.

Parameters:

dataSource - - an instance of DataSource.

create

public static SnowflakeIO.DataSourceConfiguration create(SnowflakeCredentials credentials)

Creates SnowflakeIO.DataSourceConfiguration from instance of SnowflakeCredentials.

Parameters:

credentials - - an instance of SnowflakeCredentials.

withUrl

public SnowflakeIO.DataSourceConfiguration withUrl(java.lang.String url)

Sets URL of Snowflake server in following format: jdbc:snowflake://.snowflakecomputing.com

Either withUrl or withServerName is required.

Parameters:

url - - String with URL of the Snowflake server.

withDatabase

public SnowflakeIO.DataSourceConfiguration withDatabase(java.lang.String database)

Sets database to use.

Parameters:

database - - String with database name.

withWarehouse

public SnowflakeIO.DataSourceConfiguration withWarehouse(java.lang.String warehouse)

Sets Snowflake Warehouse to use.

Parameters:

warehouse - - String with warehouse name.

withSchema

public SnowflakeIO.DataSourceConfiguration withSchema(java.lang.String schema)

Sets schema to use when connecting to Snowflake.

Parameters:

schema - - String with schema name.

withServerName

public SnowflakeIO.DataSourceConfiguration withServerName(java.lang.String serverName)

Sets the name of the Snowflake server. Following format is required: .snowflakecomputing.com

Either withServerName or withUrl is required.

Parameters:

serverName - - String with server name.

withPortNumber

public SnowflakeIO.DataSourceConfiguration withPortNumber(java.lang.Integer portNumber)

Sets port number to use to connect to Snowflake.

Parameters:

portNumber - - Integer with port number.

withRole

public SnowflakeIO.DataSourceConfiguration withRole(java.lang.String role)

Sets user's role to be used when running queries on Snowflake.

Parameters:

role - - String with role name.

withLoginTimeout

public SnowflakeIO.DataSourceConfiguration withLoginTimeout(java.lang.Integer loginTimeout)

Sets loginTimeout that will be used in SnowflakeBasicDataSource:setLoginTimeout.

Parameters:

loginTimeout - - Integer with timeout value.

withoutValidation

public SnowflakeIO.DataSourceConfiguration withoutValidation()

Disables validation of connection parameters prior to pipeline submission.

Returns:

buildDatasource

public javax.sql.DataSource buildDatasource()

Builds SnowflakeBasicDataSource based on the current configuration.