Package org.apache.nifi.util.db

Class JdbcCommon

java.lang.Object

org.apache.nifi.util.db.JdbcCommon

public class JdbcCommon
extends Object

JDBC / SQL common functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JdbcCommon.AvroConversionOptions
static interface	JdbcCommon.ResultSetRowCallback	An interface for callback methods which allows processing of a row during the convertToAvroStream() processing.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PRECISION_VALUE
static final int	DEFAULT_SCALE_VALUE
private static final org.slf4j.Logger	logger
static final Pattern	LONG_PATTERN
static final String	MASKED_LOG_VALUE
static final int	MAX_DIGITS_IN_BIGINT
static final int	MAX_DIGITS_IN_INT
static final String	MIME_TYPE_AVRO_BINARY
static final Pattern	NUMBER_PATTERN
static final Pattern	SQL_TYPE_ATTRIBUTE_PATTERN
private static final DateTimeFormatter	TIME_FORMATTER
private static final DateTimeFormatter	TIMESTAMP_FORMATTER

Constructor Summary

Constructors

Constructor	Description
JdbcCommon()

Method Summary

Modifier and Type	Method	Description
private static void	addNullableField(org.apache.avro.SchemaBuilder.FieldAssembler<org.apache.avro.Schema> builder, String columnName, Function<org.apache.avro.SchemaBuilder.BaseTypeBuilder<org.apache.avro.SchemaBuilder.UnionAccumulator<org.apache.avro.SchemaBuilder.NullDefault<org.apache.avro.Schema>>>,org.apache.avro.SchemaBuilder.UnionAccumulator<org.apache.avro.SchemaBuilder.NullDefault<org.apache.avro.Schema>>> func)
static long	convertToAvroStream(ResultSet rs, OutputStream outStream, boolean convertNames)
static long	convertToAvroStream(ResultSet rs, OutputStream outStream, String recordName, boolean convertNames)
static long	convertToAvroStream(ResultSet rs, OutputStream outStream, String recordName, JdbcCommon.ResultSetRowCallback callback, boolean convertNames)
static long	convertToAvroStream(ResultSet rs, OutputStream outStream, String recordName, JdbcCommon.ResultSetRowCallback callback, int maxRows, boolean convertNames)
static long	convertToAvroStream(ResultSet rs, OutputStream outStream, JdbcCommon.AvroConversionOptions options, JdbcCommon.ResultSetRowCallback callback)
static void	createEmptyAvroStream(OutputStream outStream)
static org.apache.avro.Schema	createSchema(ResultSet rs)
static org.apache.avro.Schema	createSchema(ResultSet rs, String recordName, boolean convertNames)
static org.apache.avro.Schema	createSchema(ResultSet rs, JdbcCommon.AvroConversionOptions options)	Creates an Avro schema from a result set.
static DateTimeFormatter	getDateTimeFormatter(String pattern)
static String	normalizeNameForAvro(String inputName)
static void	setParameter(PreparedStatement stmt, int parameterIndex, String parameterValue, int jdbcType, String valueFormat)	Determines how to map the given value to the appropriate JDBC data type and sets the parameter on the provided PreparedStatement
private static void	setParameterAtIndex(PreparedStatement stmt, Map<String,SensitiveValueWrapper> attributes, String flowFileAttributeKey)
static void	setParameters(PreparedStatement stmt, Map<String,String> attributes)	Sets all of the appropriate parameters on the given PreparedStatement, based on the given FlowFile attributes.
static void	setSensitiveParameters(PreparedStatement stmt, Map<String,SensitiveValueWrapper> attributes)	Sets all of the appropriate parameters on the given PreparedStatement, based on the given FlowFile attributes and masks sensitive values.

Methods inherited from class java.lang.Object

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

Field Details

MAX_DIGITS_IN_BIGINT

public static final int MAX_DIGITS_IN_BIGINT

See Also:

• Constant Field Values

MAX_DIGITS_IN_INT

public static final int MAX_DIGITS_IN_INT

See Also:

• Constant Field Values

DEFAULT_PRECISION_VALUE

public static final int DEFAULT_PRECISION_VALUE

See Also:

• Constant Field Values

DEFAULT_SCALE_VALUE

public static final int DEFAULT_SCALE_VALUE

See Also:

• Constant Field Values

LONG_PATTERN

public static final Pattern LONG_PATTERN

SQL_TYPE_ATTRIBUTE_PATTERN

public static final Pattern SQL_TYPE_ATTRIBUTE_PATTERN

NUMBER_PATTERN

public static final Pattern NUMBER_PATTERN

MIME_TYPE_AVRO_BINARY

public static final String MIME_TYPE_AVRO_BINARY

See Also:

• Constant Field Values

MASKED_LOG_VALUE

public static final String MASKED_LOG_VALUE

See Also:

• Constant Field Values

logger

private static final org.slf4j.Logger logger

TIME_FORMATTER

private static final DateTimeFormatter TIME_FORMATTER

TIMESTAMP_FORMATTER

private static final DateTimeFormatter TIMESTAMP_FORMATTER

Constructor Details

JdbcCommon

public JdbcCommon()

Method Details

convertToAvroStream

public static long convertToAvroStream(ResultSet rs,
 OutputStream outStream,
 boolean convertNames)
                                throws SQLException,
IOException

Throws:

SQLException

IOException

convertToAvroStream

public static long convertToAvroStream(ResultSet rs,
 OutputStream outStream,
 String recordName,
 boolean convertNames)
                                throws SQLException,
IOException

Throws:

SQLException

IOException

convertToAvroStream

public static long convertToAvroStream(ResultSet rs,
 OutputStream outStream,
 String recordName,
 JdbcCommon.ResultSetRowCallback callback,
 boolean convertNames)
                                throws IOException,
SQLException

Throws:

IOException

SQLException

convertToAvroStream

public static long convertToAvroStream(ResultSet rs,
 OutputStream outStream,
 String recordName,
 JdbcCommon.ResultSetRowCallback callback,
 int maxRows,
 boolean convertNames)
                                throws SQLException,
IOException

Throws:

SQLException

IOException

createEmptyAvroStream

public static void createEmptyAvroStream(OutputStream outStream)
                                  throws IOException

Throws:

IOException

convertToAvroStream

public static long convertToAvroStream(ResultSet rs,
 OutputStream outStream,
 JdbcCommon.AvroConversionOptions options,
 JdbcCommon.ResultSetRowCallback callback)
                                throws SQLException,
IOException

Throws:

SQLException

IOException

createSchema

public static org.apache.avro.Schema createSchema(ResultSet rs)
                                           throws SQLException

Throws:

SQLException

createSchema

public static org.apache.avro.Schema createSchema(ResultSet rs,
 String recordName,
 boolean convertNames)
                                           throws SQLException

Throws:

SQLException

addNullableField

private static void addNullableField(org.apache.avro.SchemaBuilder.FieldAssembler<org.apache.avro.Schema> builder,
 String columnName,
 Function<org.apache.avro.SchemaBuilder.BaseTypeBuilder<org.apache.avro.SchemaBuilder.UnionAccumulator<org.apache.avro.SchemaBuilder.NullDefault<org.apache.avro.Schema>>>,org.apache.avro.SchemaBuilder.UnionAccumulator<org.apache.avro.SchemaBuilder.NullDefault<org.apache.avro.Schema>>> func)

createSchema

public static org.apache.avro.Schema createSchema(ResultSet rs,
 JdbcCommon.AvroConversionOptions options)
                                           throws SQLException

Creates an Avro schema from a result set. If the table/record name is known a priori and provided, use that as a fallback for the record name if it cannot be retrieved from the result set, and finally fall back to a default value.

Parameters:

rs - The result set to convert to Avro

options - Specify various options

Returns:

A Schema object representing the result set converted to an Avro record

Throws:

SQLException - if any error occurs during conversion

normalizeNameForAvro

public static String normalizeNameForAvro(String inputName)

setParameters

public static void setParameters(PreparedStatement stmt,
 Map<String,String> attributes)
                          throws SQLException

Sets all of the appropriate parameters on the given PreparedStatement, based on the given FlowFile attributes.

Parameters:

stmt - the statement to set the parameters on

attributes - the attributes from which to derive parameter indices, values, and types

Throws:

SQLException - if the PreparedStatement throws a SQLException when the appropriate setter is called

setSensitiveParameters

public static void setSensitiveParameters(PreparedStatement stmt,
 Map<String,SensitiveValueWrapper> attributes)
                                   throws SQLException

Sets all of the appropriate parameters on the given PreparedStatement, based on the given FlowFile attributes and masks sensitive values.

Parameters:

stmt - the statement to set the parameters on

attributes - the attributes from which to derive parameter indices, values, and types

Throws:

SQLException - if the PreparedStatement throws a SQLException when the appropriate setter is called

setParameterAtIndex

private static void setParameterAtIndex(PreparedStatement stmt,
 Map<String,SensitiveValueWrapper> attributes,
 String flowFileAttributeKey)
                                 throws SQLException

Throws:

SQLException

setParameter

public static void setParameter(PreparedStatement stmt,
 int parameterIndex,
 String parameterValue,
 int jdbcType,
 String valueFormat)
                         throws SQLException,
UnsupportedEncodingException,
ParseException

Determines how to map the given value to the appropriate JDBC data type and sets the parameter on the provided PreparedStatement

Parameters:

stmt - the PreparedStatement to set the parameter on

parameterIndex - the index of the SQL parameter to set

parameterValue - the value of the SQL parameter to set

jdbcType - the JDBC Type of the SQL parameter to set

Throws:

SQLException - if the PreparedStatement throws a SQLException when calling the appropriate setter

UnsupportedEncodingException

ParseException

getDateTimeFormatter

public static DateTimeFormatter getDateTimeFormatter(String pattern)