Package com.d3x.morpheus.db

Class DbSink

java.lang.Object

com.d3x.morpheus.db.DbSink

public class DbSink
extends java.lang.Object

A DataFrameSink implementation that writes DataFrames to a SQL database table.

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	DbSink.ColumnAdapter<R,C>	A convenience base class for building an adapter that maps DataFrame content to a SQL column of a well defined type
private class	DbSink.RowKeyAdapter<R,C>	A ColumnAdapter implementation that applies a row key from a DataFrameRow to the INSERT PreparedStatement
private class	DbSink.ValueAdapter<R,C>	A ColumnAdapter implementation that applies a value extracted from a DataFrameRow to the INSERT PreparedStatement

Field Summary

Fields

Modifier and Type	Field	Description
private static java.util.Map<java.lang.Class<?>,com.d3x.morpheus.util.sql.SQLType>	sqlTypeMap

Constructor Summary

Constructors

Constructor	Description
DbSink()	Constructor

Method Summary

Modifier and Type	Method	Description
private <R,C> void	createTable(com.d3x.morpheus.frame.DataFrame<R,C> frame, DbSinkOptions<R,C> options)	Creates the target table if it does not already exist in the database
private <R,C> java.util.List<DbSink.ColumnAdapter>	getColumnAdapters(com.d3x.morpheus.frame.DataFrame<R,C> frame, DbSinkOptions<R,C> options)	Returns a apply of column type info for the target table
private <R,C> java.lang.String	getCreateTableSql(com.d3x.morpheus.frame.DataFrame<R,C> frame, DbSinkOptions<R,C> options)	Returns the SQL DDL statement to create a table for the DataFrame specified
private <R,C> java.lang.String	getInsertSql(java.util.List<DbSink.ColumnAdapter> columnList, DbSinkOptions<R,C> options)	Constructs the SQL insert statement for the column list specified
private java.lang.String	getSqlTypeString(java.lang.Class<?> sqlClass)	Returns the SQL type string for a CREATE TABLE statement
private <R,C> void	insertData(com.d3x.morpheus.frame.DataFrame<R,C> frame, DbSinkOptions<R,C> options)	Called to insert data from the DataFrame to the target table
<R,C> void	write(com.d3x.morpheus.frame.DataFrame<R,C> frame, java.util.function.Consumer<DbSinkOptions<R,C>> configurator)

Methods inherited from class java.lang.Object

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

Field Detail

sqlTypeMap

private static final java.util.Map<java.lang.Class<?>,com.d3x.morpheus.util.sql.SQLType> sqlTypeMap

Constructor Detail

DbSink

public DbSink()

Constructor

Method Detail

write

public <R,C> void write(com.d3x.morpheus.frame.DataFrame<R,C> frame,
                        java.util.function.Consumer<DbSinkOptions<R,C>> configurator)

createTable

private <R,C> void createTable(com.d3x.morpheus.frame.DataFrame<R,C> frame,
                               DbSinkOptions<R,C> options)

Creates the target table if it does not already exist in the database

Parameters:

frame - the DataFrame to create a table for

options - the sink options

Throws:

com.d3x.morpheus.frame.DataFrameException - if this operation fails

insertData

private <R,C> void insertData(com.d3x.morpheus.frame.DataFrame<R,C> frame,
                              DbSinkOptions<R,C> options)

Called to insert data from the DataFrame to the target table

Parameters:

frame - the DataFrame to load data from

options - the sink options

Throws:

com.d3x.morpheus.frame.DataFrameException - if this operation fails

getInsertSql

private <R,C> java.lang.String getInsertSql(java.util.List<DbSink.ColumnAdapter> columnList,
                                            DbSinkOptions<R,C> options)

Constructs the SQL insert statement for the column list specified

Parameters:

columnList - the column list

options - the DB sink options

Returns:

the sql insert statement

getColumnAdapters

private <R,C> java.util.List<DbSink.ColumnAdapter> getColumnAdapters(com.d3x.morpheus.frame.DataFrame<R,C> frame,
                                                                     DbSinkOptions<R,C> options)

Returns a apply of column type info for the target table

Parameters:

frame - the DataFrame reference

Returns:

the apply of column type info

getCreateTableSql

private <R,C> java.lang.String getCreateTableSql(com.d3x.morpheus.frame.DataFrame<R,C> frame,
                                                 DbSinkOptions<R,C> options)

Returns the SQL DDL statement to create a table for the DataFrame specified

Parameters:

frame - the frame instance

options - the sink options

Returns:

the create table statement

getSqlTypeString

private java.lang.String getSqlTypeString(java.lang.Class<?> sqlClass)

Returns the SQL type string for a CREATE TABLE statement

Parameters:

sqlClass - the SQL class

Returns:

the type string