Package com.d3x.morpheus.db

Class DbSourceOptions<R>

java.lang.Object

com.d3x.morpheus.db.DbSourceOptions<R>

Type Parameters:

R - the row key type

This is open source software released under the Apache 2.0 License

All Implemented Interfaces:

com.d3x.morpheus.frame.DataFrameSource.Options<R,java.lang.String>

public class DbSourceOptions<R>
extends java.lang.Object
implements com.d3x.morpheus.frame.DataFrameSource.Options<R,java.lang.String>

A DataFrameRequest used to load a DataFrame from a SQL Database.

Author:

Xavier Witdouck

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	autoCommit
private java.sql.Connection	connection
private java.util.Set<java.lang.String>	excludeColumnSet
private java.util.Map<java.lang.String,com.d3x.morpheus.util.sql.SQLExtractor>	extractorMap
private int	fetchSize
private java.lang.Object[]	parameters
private boolean	readOnly
private int	rowCapacity
private java.util.function.Function<java.sql.ResultSet,R>	rowKeyFunction
private java.lang.String	sql

Constructor Summary

Constructors

Constructor	Description
DbSourceOptions()	Constructor

Method Summary

Modifier and Type	Method	Description
(package private) java.sql.Connection	getConnection()	Returns the connection for this request
(package private) java.util.Set<java.lang.String>	getExcludeColumnSet()	Returns the set of columns to exclude
(package private) java.util.Map<java.lang.String,com.d3x.morpheus.util.sql.SQLExtractor>	getExtractors()	Returns the apply of extractors for this request
(package private) java.util.Optional<java.lang.Integer>	getFetchSize()	Returns the statement fetch size for queries
(package private) java.util.Optional<java.lang.Object[]>	getParameters()	Returns the parameters for this request
(package private) int	getRowCapacity()	Returns the initial row capacity to size the resulting DataFrame
(package private) java.util.function.Function<java.sql.ResultSet,R>	getRowKeyFunction()	Returns the row key generating function for this request
java.lang.String	getSql()	Returns the SQL query for this request
(package private) boolean	isAutoCommit()	Returns the connection auto commit preference
(package private) boolean	isReadOnly()	Returns the connection read only setting
void	validate()
DbSourceOptions<R>	withAutoCommit(boolean autoCommit)	Sets the connection auto commit state
DbSourceOptions<R>	withConnection(java.lang.String url, java.lang.String username, java.lang.String password)	Sets the JDBC connection URL and optional credentials This method should ideally only be used for testing, a connection pool is preferable for production
DbSourceOptions<R>	withConnection(java.sql.Connection connection)	Sets the JDBC connection for this request
DbSourceOptions<R>	withConnection(javax.sql.DataSource dataSource)	Sets the JDBC connection for this request
DbSourceOptions<R>	withExcludeColumns(java.lang.String... columns)	Sets the names of columns not to include in the resulting DataFrame
DbSourceOptions<R>	withExtractor(java.lang.String colName, com.d3x.morpheus.util.sql.SQLExtractor extractor)	Sets the extractor to use for the column name
DbSourceOptions<R>	withFetchSize(int fetchSize)	Sets the fetch size for the statement when executing queries
DbSourceOptions<R>	withParameters(java.lang.Object... parameters)	Sets the parameters for the SQL expression
DbSourceOptions<R>	withReadOnly(boolean readOnly)	Sets the connection read only setting
DbSourceOptions<R>	withRowCapacity(int rowCapacity)	Sets the initial row capacity to size the DataFrame
DbSourceOptions<R>	withRowKeyFunction(java.util.function.Function<java.sql.ResultSet,R> rowKeyFunction)	Sets the row key function for this request
DbSourceOptions<R>	withSql(java.lang.String sql)	Sets the SQL query for this request

Methods inherited from class java.lang.Object

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

Field Detail

sql

private java.lang.String sql

rowCapacity

private int rowCapacity

fetchSize

private int fetchSize

connection

private java.sql.Connection connection

parameters

private java.lang.Object[] parameters

autoCommit

private boolean autoCommit

readOnly

private boolean readOnly

excludeColumnSet

private java.util.Set<java.lang.String> excludeColumnSet

rowKeyFunction

private java.util.function.Function<java.sql.ResultSet,R> rowKeyFunction

extractorMap

private java.util.Map<java.lang.String,com.d3x.morpheus.util.sql.SQLExtractor> extractorMap

Constructor Detail

DbSourceOptions

public DbSourceOptions()

Constructor

Method Detail

validate

public void validate()

Specified by:

validate in interface com.d3x.morpheus.frame.DataFrameSource.Options<R,java.lang.String>

withSql

public DbSourceOptions<R> withSql(java.lang.String sql)

Sets the SQL query for this request

Parameters:

sql - the sql for this request

Returns:

this request

withParameters

public DbSourceOptions<R> withParameters(java.lang.Object... parameters)

Sets the parameters for the SQL expression

Parameters:

parameters - the SQL parameters

Returns:

this request

withConnection

public DbSourceOptions<R> withConnection(java.sql.Connection connection)

Sets the JDBC connection for this request

Parameters:

connection - the connection for this request

Returns:

this request

withConnection

public DbSourceOptions<R> withConnection(javax.sql.DataSource dataSource)

Sets the JDBC connection for this request

Parameters:

dataSource - the DataSource the grab a connection from

Returns:

this request

withConnection

public DbSourceOptions<R> withConnection(java.lang.String url,
                                         java.lang.String username,
                                         java.lang.String password)

Sets the JDBC connection URL and optional credentials This method should ideally only be used for testing, a connection pool is preferable for production

Parameters:

url - the JDBC connection url

username - the JDBC connection username, can be null

password - the JDBC connection password, can be null

Returns:

this request

withExcludeColumns

public DbSourceOptions<R> withExcludeColumns(java.lang.String... columns)

Sets the names of columns not to include in the resulting DataFrame

Parameters:

columns - the columns to exlcude from DataFrame

Returns:

this request

withRowKeyFunction

public DbSourceOptions<R> withRowKeyFunction(java.util.function.Function<java.sql.ResultSet,R> rowKeyFunction)

Sets the row key function for this request

Parameters:

rowKeyFunction - the row key function

Returns:

this request

withRowCapacity

public DbSourceOptions<R> withRowCapacity(int rowCapacity)

Sets the initial row capacity to size the DataFrame

Parameters:

rowCapacity - the initial roe capacity

Returns:

this request

withFetchSize

public DbSourceOptions<R> withFetchSize(int fetchSize)

Sets the fetch size for the statement when executing queries

Parameters:

fetchSize - the fetch size

Returns:

these options

withAutoCommit

public DbSourceOptions<R> withAutoCommit(boolean autoCommit)

Sets the connection auto commit state

Parameters:

autoCommit - true to enable auto commit

Returns:

these options

withReadOnly

public DbSourceOptions<R> withReadOnly(boolean readOnly)

Sets the connection read only setting

Parameters:

readOnly - true for read only

Returns:

these options

withExtractor

public DbSourceOptions<R> withExtractor(java.lang.String colName,
                                        com.d3x.morpheus.util.sql.SQLExtractor extractor)

Sets the extractor to use for the column name

Parameters:

colName - the JDBC column name

extractor - the extractor to use for column

Returns:

this reader

getSql

public java.lang.String getSql()

Returns the SQL query for this request

Returns:

the sql query

getParameters

java.util.Optional<java.lang.Object[]> getParameters()

Returns the parameters for this request

Returns:

the parameters for request

getConnection

java.sql.Connection getConnection()

Returns the connection for this request

Returns:

the connection for this request

getRowCapacity

int getRowCapacity()

Returns the initial row capacity to size the resulting DataFrame

Returns:

the row capacity

isAutoCommit

boolean isAutoCommit()

Returns the connection auto commit preference

Returns:

true for auto commit

isReadOnly

boolean isReadOnly()

Returns the connection read only setting

Returns:

true for read only

getExcludeColumnSet

java.util.Set<java.lang.String> getExcludeColumnSet()

Returns the set of columns to exclude

Returns:

the set of columns to exclude

getFetchSize

java.util.Optional<java.lang.Integer> getFetchSize()

Returns the statement fetch size for queries

Returns:

the statement fetch size

getRowKeyFunction

java.util.function.Function<java.sql.ResultSet,R> getRowKeyFunction()

Returns the row key generating function for this request

Returns:

the row query generating function

getExtractors

java.util.Map<java.lang.String,com.d3x.morpheus.util.sql.SQLExtractor> getExtractors()

Returns the apply of extractors for this request

Returns:

the apply of extractors