com.northconcepts.datapipeline.sql.mysql

Class MySqlInsertWriter

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataWriter

com.northconcepts.datapipeline.core.AbstractWriter

com.northconcepts.datapipeline.core.TextWriter

com.northconcepts.datapipeline.sql.mysql.MySqlInsertWriter

Direct Known Subclasses:

MySqlUpsertWriter

public class MySqlInsertWriter
extends TextWriter

Generates MySQL insert statement from records.

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

DataEndpoint.State

Field Summary

Fields

Modifier and Type	Field and Description
protected int	batchedInserts
protected int	batchSize
protected boolean	pretty
protected String	tableName

Fields inherited from class com.northconcepts.datapipeline.core.AbstractWriter

currentRecord

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint

lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEY

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

id, log, name, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
MySqlInsertWriter(String tableName, File file)
MySqlInsertWriter(String tableName, File file, boolean append)
MySqlInsertWriter(String tableName, Writer writer)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
void	close() Indicates that this endpoint has finished reading or writing.
int	getBatchSize()
protected String	getSqlValueLiteral(Field field)
String	getTableName()
boolean	isBatchMode()
boolean	isPretty()
MySqlInsertWriter	setBatchSize(int batchSize) Sets the number of records to chunk together in batch inserts.
MySqlInsertWriter	setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)
MySqlInsertWriter	setPretty(boolean pretty) Indicates if line breaks and indentations should be added to output insert statement (default false). Example output (pretty = true): INSERT INTO `tableName` (`col1`, `col2`, `col3`) VALUES (val1, val2, val3),
protected void	writeRecord(Record record)

Methods inherited from class com.northconcepts.datapipeline.core.TextWriter

getFile, getWriter, isAppend, isAutoCloseWriter, isFieldNamesInFirstRow, isFlushOnWrite, setAutoCloseWriter, setFlushOnWrite, write

Methods inherited from class com.northconcepts.datapipeline.core.AbstractWriter

open, writeImpl

Methods inherited from class com.northconcepts.datapipeline.core.DataWriter

available, getNestedEndpoint, getNestedWriter, getRootEndpoint, getRootWriter, getWriter

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint

decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toString

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint

addElapsedtime, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime, setDescription

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object

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

Field Detail

pretty

protected boolean pretty

batchSize

protected int batchSize

batchedInserts

protected int batchedInserts

tableName

protected final String tableName

Constructor Detail

MySqlInsertWriter

public MySqlInsertWriter(String tableName,
                         File file,
                         boolean append)

MySqlInsertWriter

public MySqlInsertWriter(String tableName,
                         File file)

MySqlInsertWriter

public MySqlInsertWriter(String tableName,
                         Writer writer)

Method Detail

writeRecord

protected void writeRecord(Record record)
                    throws Throwable

Specified by:

writeRecord in class AbstractWriter

Throws:

Throwable

close

public void close()

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class TextWriter

getTableName

public String getTableName()

isPretty

public boolean isPretty()

setPretty

public MySqlInsertWriter setPretty(boolean pretty)

Indicates if line breaks and indentations should be added to output insert statement (default false).

Example output (pretty = true):
INSERT INTO `tableName` (`col1`, `col2`, `col3`)
VALUES (val1, val2, val3),

       (val1, val2, val3),

       (val1, val2, val3),...

Example output (pretty = false):
INSERT INTO `tableName` (`col1`, `col2`, `col3`) VALUES (val1, val2, val3), (val1, val2, val3), (val1, val2, val3),...

getBatchSize

public int getBatchSize()

setBatchSize

public MySqlInsertWriter setBatchSize(int batchSize)

Sets the number of records to chunk together in batch inserts. Inserts are not batched if this value is 1 or less. MySqlInsertWriter defaults to non batching inserts.

Example output (batchSize = 2):
INSERT INTO `tableName` (`col1`, `col2`, `col3`)
VALUES (val1, val2, val3),

       (val1, val2, val3);

Example output (batchSize = 0):
INSERT INTO `tableName` (`col1`, `col2`, `col3`) VALUES (val1, val2, val3);
INSERT INTO `tableName` (`col1`, `col2`, `col3`) VALUES (val1, val2, val3);

isBatchMode

public boolean isBatchMode()

setFieldNamesInFirstRow

public MySqlInsertWriter setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)

Overrides:

setFieldNamesInFirstRow in class AbstractWriter

addExceptionProperties

public DataException addExceptionProperties(DataException exception)

Description copied from class: Endpoint

Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

Overrides:

addExceptionProperties in class TextWriter

getSqlValueLiteral

protected String getSqlValueLiteral(Field field)