Package com.d3x.morpheus.db

Class DbSource

java.lang.Object

com.d3x.morpheus.db.DbSource

public class DbSource
extends java.lang.Object

A DataFrameSource designed to handle read DataFrames from a SQL data store

This is open source software released under the Apache 2.0 License

Author:

Xavier Witdouck

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	DbSource.ColumnInfo	A class used to capture the meta-data for a column

Constructor Summary

Constructors

Constructor	Description
DbSource()	Constructor

Method Summary

Modifier and Type	Method	Description
private void	close(java.lang.AutoCloseable closeable)	Safely closes the JDBC resource
private <R> com.d3x.morpheus.frame.DataFrame<R,java.lang.String>	createFrame(java.lang.Iterable<R> rowKeys, java.util.List<DbSource.ColumnInfo> columnList)	Returns a newly created DataFrame from the arguments specified
private <R> java.util.List<DbSource.ColumnInfo>	getColumnInfo(java.sql.ResultSetMetaData metaData, com.d3x.morpheus.util.sql.SQLPlatform platform, DbSourceOptions<R> request)	Returns the array of column information from the result-set meta-data
private com.d3x.morpheus.util.sql.SQLPlatform	getPlatform(java.sql.ResultSet resultSet)	Returns the database platform type from the ResultSet
private <R> com.d3x.morpheus.frame.DataFrame<R,java.lang.String>	read(java.sql.ResultSet resultSet, DbSourceOptions<R> request)	Reads all data from the sql ResultSet into a Morpheus DataFrame
<R> com.d3x.morpheus.frame.DataFrame<R,java.lang.String>	read(java.util.function.Consumer<DbSourceOptions<R>> configurator)

Methods inherited from class java.lang.Object

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

Constructor Detail

DbSource

public DbSource()

Constructor

Method Detail

read

public <R> com.d3x.morpheus.frame.DataFrame<R,java.lang.String> read(java.util.function.Consumer<DbSourceOptions<R>> configurator)
                                                              throws com.d3x.morpheus.frame.DataFrameException

Throws:

com.d3x.morpheus.frame.DataFrameException

read

private <R> com.d3x.morpheus.frame.DataFrame<R,java.lang.String> read(java.sql.ResultSet resultSet,
                                                                      DbSourceOptions<R> request)
                                                               throws com.d3x.morpheus.frame.DataFrameException

Reads all data from the sql ResultSet into a Morpheus DataFrame

Parameters:

resultSet - the result set to extract data from

request - the request descriptor

Returns:

the newly created DataFrame

Throws:

com.d3x.morpheus.frame.DataFrameException - if data frame construction from result set fails

getPlatform

private com.d3x.morpheus.util.sql.SQLPlatform getPlatform(java.sql.ResultSet resultSet)

Returns the database platform type from the ResultSet

Parameters:

resultSet - the result set

Returns:

the database type

createFrame

private <R> com.d3x.morpheus.frame.DataFrame<R,java.lang.String> createFrame(java.lang.Iterable<R> rowKeys,
                                                                             java.util.List<DbSource.ColumnInfo> columnList)

Returns a newly created DataFrame from the arguments specified

Parameters:

rowKeys - the row keys

columnList - the column list

Returns:

the newly created DataFrame

getColumnInfo

private <R> java.util.List<DbSource.ColumnInfo> getColumnInfo(java.sql.ResultSetMetaData metaData,
                                                              com.d3x.morpheus.util.sql.SQLPlatform platform,
                                                              DbSourceOptions<R> request)
                                                       throws java.sql.SQLException

Returns the array of column information from the result-set meta-data

Parameters:

metaData - the result set meta data

platform - the database platform

request - the request descriptor

Returns:

the array of column information

Throws:

java.sql.SQLException - if there is a database access error

close

private void close(java.lang.AutoCloseable closeable)

Safely closes the JDBC resource

Parameters:

closeable - the closeable