org.apache.nifi.processors.standard.sql

Class RecordSqlWriter

java.lang.Object

org.apache.nifi.processors.standard.sql.RecordSqlWriter

All Implemented Interfaces:

SqlWriter

public class RecordSqlWriter
extends Object
implements SqlWriter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	RecordSqlWriter.ResultSetRecordSetWithCallback

Field Summary

Fields

Modifier and Type	Field and Description
private ResultSetRecordSet	fullRecordSet
private int	maxRowsPerFlowFile
private String	mimeType
private JdbcCommon.AvroConversionOptions	options
private Map<String,String>	originalAttributes
private RecordSetWriterFactory	recordSetWriterFactory
private AtomicReference<WriteResult>	writeResultRef
private RecordSchema	writeSchema

Constructor Summary

Constructors

Constructor and Description
RecordSqlWriter(RecordSetWriterFactory recordSetWriterFactory, JdbcCommon.AvroConversionOptions options, int maxRowsPerFlowFile, Map<String,String> originalAttributes)

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAttributesToAdd() Returns a map of attribute key/value pairs to be added to any outgoing flow file(s).
String	getMimeType() Returns the MIME type of the output format.
void	updateCounters(ProcessSession session) Updates any session counters as a result of processing result sets.
void	writeEmptyResultSet(OutputStream outputStream, ComponentLog logger) Writes an empty result set to the output stream.
long	writeResultSet(ResultSet resultSet, OutputStream outputStream, ComponentLog logger, JdbcCommon.ResultSetRowCallback callback) Writes the given result set out to the given output stream, possibly applying a callback as each row is processed.

Methods inherited from class java.lang.Object

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

Field Detail

recordSetWriterFactory

private final RecordSetWriterFactory recordSetWriterFactory

writeResultRef

private final AtomicReference<WriteResult> writeResultRef

options

private final JdbcCommon.AvroConversionOptions options

maxRowsPerFlowFile

private final int maxRowsPerFlowFile

originalAttributes

private final Map<String,String> originalAttributes

fullRecordSet

private ResultSetRecordSet fullRecordSet

writeSchema

private RecordSchema writeSchema

mimeType

private String mimeType

Constructor Detail

RecordSqlWriter

public RecordSqlWriter(RecordSetWriterFactory recordSetWriterFactory,
                       JdbcCommon.AvroConversionOptions options,
                       int maxRowsPerFlowFile,
                       Map<String,String> originalAttributes)

Method Detail

writeResultSet

public long writeResultSet(ResultSet resultSet,
                           OutputStream outputStream,
                           ComponentLog logger,
                           JdbcCommon.ResultSetRowCallback callback)
                    throws Exception

Description copied from interface: SqlWriter

Writes the given result set out to the given output stream, possibly applying a callback as each row is processed.

Specified by:

writeResultSet in interface SqlWriter

Parameters:

resultSet - the ResultSet to be written

outputStream - the OutputStream to write the result set to

logger - a common logger that can be used to log messages during write

callback - a MaxValueResultSetRowCollector that may be called as each row in the ResultSet is processed

Returns:

the number of rows written to the output stream

Throws:

Exception - if any errors occur during the writing of the result set to the output stream

getAttributesToAdd

public Map<String,String> getAttributesToAdd()

Description copied from interface: SqlWriter

Returns a map of attribute key/value pairs to be added to any outgoing flow file(s). The default implementation is to return an empty map.

Specified by:

getAttributesToAdd in interface SqlWriter

Returns:

a map of attribute key/value pairs

updateCounters

public void updateCounters(ProcessSession session)

Description copied from interface: SqlWriter

Updates any session counters as a result of processing result sets. The default implementation is empty, no counters will be updated.

Specified by:

updateCounters in interface SqlWriter

Parameters:

session - the session upon which to update counters

writeEmptyResultSet

public void writeEmptyResultSet(OutputStream outputStream,
                                ComponentLog logger)
                         throws IOException

Description copied from interface: SqlWriter

Writes an empty result set to the output stream. In some cases a ResultSet might not have any viable rows, but will throw an error or behave unexpectedly if rows are attempted to be retrieved. This method indicates the implementation should write whatever output is appropriate for a result set with no rows.

Specified by:

writeEmptyResultSet in interface SqlWriter

Parameters:

outputStream - the OutputStream to write the empty result set to

logger - a common logger that can be used to log messages during write

Throws:

IOException - if any errors occur during the writing of an empty result set to the output stream

getMimeType

public String getMimeType()

Description copied from interface: SqlWriter

Returns the MIME type of the output format. This can be used in FlowFile attributes or to perform format-specific processing as necessary.

Specified by:

getMimeType in interface SqlWriter

Returns:

the MIME type string of the output format.