Class JdbcUtil

java.lang.Object

org.frankframework.util.JdbcUtil

public class JdbcUtil
extends Object

Database-oriented utility functions.

Since:

4.1

Author:

Gerrit van Brakel

Field Summary

Fields

Modifier and Type	Field	Description
static final DateTimeFormatter	DATEFORMAT_DATE_TIME_FORMATTER
static final DateTimeFormatter	TIMESTAMP_DATE_TIME_FORMATTER

Method Summary

Modifier and Type	Method	Description
static void	applyParameters(@NonNull IDbmsSupport dbmsSupport, @NonNull PreparedStatement statement, @NonNull ParameterValueList parameters)
static void	applyParameters(@NonNull IDbmsSupport dbmsSupport, @NonNull PreparedStatement statement, @Nullable ParameterList parameters, Message message, PipeLineSession session)
static void	close(@Nullable Connection connection)
static void	fullClose(@Nullable Connection connection, @Nullable ResultSet rs)
static void	fullClose(@Nullable Connection connection, @Nullable Statement statement)	Note: Depending on the connect pool used (for example with Tomcat 7) the connection retrieved from the statement will be the direct connection instead of the proxied connection.
static @Nullable String	getBlobAsString(@NonNull IDbmsSupport dbmsSupport, @NonNull ResultSet rs, int column, String charset, boolean blobIsCompressed, boolean blobSmartGet, boolean encodeBlobBase64)
static String	getBlobAsString(@NonNull IDbmsSupport dbmsSupport, @NonNull ResultSet rs, String column, String charset, boolean blobIsCompressed, boolean blobSmartGet, boolean encodeBlobBase64)
static @Nullable InputStream	getBlobInputStream(@NonNull IDbmsSupport dbmsSupport, @NonNull ResultSet rs, int column, boolean blobIsCompressed)
static @Nullable InputStream	getBlobInputStream(@NonNull IDbmsSupport dbmsSupport, @NonNull ResultSet rs, String column, boolean blobIsCompressed)
static OutputStream	getBlobOutputStream(@NonNull IDbmsSupport dbmsSupport, @NonNull Object blobUpdateHandle, @NonNull ResultSet rs, int columnIndex, boolean compressBlob)
static Reader	getBlobReader(@NonNull IDbmsSupport dbmsSupport, @NonNull ResultSet rs, int column, @Nullable String charset, boolean blobIsCompressed)
static String	getClobAsString(@NonNull IDbmsSupport dbmsSupport, @NonNull ResultSet rs, int columnIndex, boolean xmlEncode)
static @Nullable String	getValue(@NonNull IDbmsSupport dbmsSupport, @NonNull ResultSet rs, int colNum, @NonNull ResultSetMetaData rsmeta, @Nullable String blobCharset, boolean decompressBlobs, String nullValue, boolean trimSpaces, boolean getBlobSmart, boolean encodeBlobBase64)	Deprecated. Where possible prefer to use the new method getValueAsMessage(IDbmsSupport, ResultSet, int, ResultSetMetaData, String, boolean) because it is more flexible, and the result can always still be turned into a String value with Message.asString().
static @NonNull Message	getValueAsMessage(IDbmsSupport dbmsSupport, ResultSet rs, int colNum, ResultSetMetaData rsmeta, String blobCharset, boolean decompressBlobs)
static @NonNull Message	getValueAsMessage(IDbmsSupport dbmsSupport, ResultSet rs, int colNum, ResultSetMetaData rsmeta, String blobCharset, boolean decompressBlobs, boolean trimSpaces, boolean blobSmartGet, boolean blobEncodeBase64)
static boolean	isQueryResultEmpty(@NonNull Connection connection, @NonNull String query)
static SQLType	mapParameterTypeToSqlType(@NonNull IDbmsSupport dbmsSupport, @NonNull ParameterType parameterType)
static void	setParameter(@NonNull PreparedStatement statement, int parameterIndex, @Nullable String value, boolean parameterTypeMatchRequired, @Nullable ParameterMetaData parameterMetaData)	Set a parameter in a prepared statement.
static void	setParameter(PreparedStatement statement, int parameterIndex, String value, boolean parameterTypeMatchRequired)	Set a parameter in a prepared statement.
static void	streamBlob(@NonNull IDbmsSupport dbmsSupport, @NonNull ResultSet rs, int columnIndex, @Nullable String charset, boolean blobIsCompressed, Base64Pipe.Direction blobBase64Direction, MessageBuilder msgBuilder)
static void	streamClob(@NonNull IDbmsSupport dbmsSupport, @NonNull ResultSet rs, int column, @NonNull MessageBuilder target)
static @Nullable String	warningsToString(@Nullable SQLWarning warnings)	Deprecated.
static void	warningsToXml(@Nullable SQLWarning warnings, @NonNull XmlBuilder parent)	Deprecated.
static @Nullable XmlBuilder	warningsToXmlBuilder(@Nullable SQLWarning warnings)	Deprecated.

Methods inherited from class Object

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

Field Details

DATEFORMAT_DATE_TIME_FORMATTER

public static final DateTimeFormatter DATEFORMAT_DATE_TIME_FORMATTER

TIMESTAMP_DATE_TIME_FORMATTER

public static final DateTimeFormatter TIMESTAMP_DATE_TIME_FORMATTER

Method Details

warningsToString

@Deprecated
public static @Nullable String warningsToString(@Nullable SQLWarning warnings)

Deprecated.

warningsToXml

@Deprecated
public static void warningsToXml(@Nullable SQLWarning warnings,
 @NonNull XmlBuilder parent)

Deprecated.

warningsToXmlBuilder

@Deprecated
public static @Nullable XmlBuilder warningsToXmlBuilder(@Nullable SQLWarning warnings)

Deprecated.

getValueAsMessage

public static @NonNull Message getValueAsMessage(IDbmsSupport dbmsSupport,
 ResultSet rs,
 int colNum,
 ResultSetMetaData rsmeta,
 String blobCharset,
 boolean decompressBlobs)
                                          throws SQLException,
IOException

Throws:

SQLException

IOException

getValueAsMessage

public static @NonNull Message getValueAsMessage(IDbmsSupport dbmsSupport,
 ResultSet rs,
 int colNum,
 ResultSetMetaData rsmeta,
 String blobCharset,
 boolean decompressBlobs,
 boolean trimSpaces,
 boolean blobSmartGet,
 boolean blobEncodeBase64)
                                          throws SQLException,
IOException

Throws:

SQLException

IOException

getValue

@Deprecated(since="10.3")
public static @Nullable String getValue(@NonNull IDbmsSupport dbmsSupport,
 @NonNull ResultSet rs,
 int colNum,
 @NonNull ResultSetMetaData rsmeta,
 @Nullable String blobCharset,
 boolean decompressBlobs,
 String nullValue,
 boolean trimSpaces,
 boolean getBlobSmart,
 boolean encodeBlobBase64)
                                 throws IOException,
SQLException

Deprecated.

Where possible prefer to use the new method getValueAsMessage(IDbmsSupport, ResultSet, int, ResultSetMetaData, String, boolean) because it is more flexible, and the result can always still be turned into a String value with Message.asString(). If flags missing from the old method are needed on the new method, they can be added as needed.

Get value of column-nr from record-set current record and return it as String.

Throws:

IOException

SQLException

getBlobInputStream

public static @Nullable InputStream getBlobInputStream(@NonNull IDbmsSupport dbmsSupport,
 @NonNull ResultSet rs,
 int column,
 boolean blobIsCompressed)
                                                throws SQLException,
JdbcException

Throws:

SQLException

JdbcException

getBlobInputStream

public static @Nullable InputStream getBlobInputStream(@NonNull IDbmsSupport dbmsSupport,
 @NonNull ResultSet rs,
 String column,
 boolean blobIsCompressed)
                                                throws SQLException,
JdbcException

Throws:

SQLException

JdbcException

getBlobReader

public static Reader getBlobReader(@NonNull IDbmsSupport dbmsSupport,
 @NonNull ResultSet rs,
 int column,
 @Nullable String charset,
 boolean blobIsCompressed)
                            throws IOException,
JdbcException,
SQLException

Throws:

IOException

JdbcException

SQLException

streamBlob

public static void streamBlob(@NonNull IDbmsSupport dbmsSupport,
 @NonNull ResultSet rs,
 int columnIndex,
 @Nullable String charset,
 boolean blobIsCompressed,
 Base64Pipe.Direction blobBase64Direction,
 MessageBuilder msgBuilder)
                       throws JdbcException,
SQLException,
IOException

Throws:

JdbcException

SQLException

IOException

streamClob

public static void streamClob(@NonNull IDbmsSupport dbmsSupport,
 @NonNull ResultSet rs,
 int column,
 @NonNull MessageBuilder target)
                       throws DbmsException,
SQLException,
IOException

Throws:

DbmsException

SQLException

IOException

getBlobAsString

public static @Nullable String getBlobAsString(@NonNull IDbmsSupport dbmsSupport,
 @NonNull ResultSet rs,
 int column,
 String charset,
 boolean blobIsCompressed,
 boolean blobSmartGet,
 boolean encodeBlobBase64)
                                        throws IOException,
JdbcException,
SQLException

Throws:

IOException

JdbcException

SQLException

getBlobAsString

public static String getBlobAsString(@NonNull IDbmsSupport dbmsSupport,
 @NonNull ResultSet rs,
 String column,
 String charset,
 boolean blobIsCompressed,
 boolean blobSmartGet,
 boolean encodeBlobBase64)
                              throws IOException,
JdbcException,
SQLException

Throws:

IOException

JdbcException

SQLException

getBlobOutputStream

public static OutputStream getBlobOutputStream(@NonNull IDbmsSupport dbmsSupport,
 @NonNull Object blobUpdateHandle,
 @NonNull ResultSet rs,
 int columnIndex,
 boolean compressBlob)
                                        throws SQLException,
DbmsException

Throws:

SQLException

DbmsException

getClobAsString

public static String getClobAsString(@NonNull IDbmsSupport dbmsSupport,
 @NonNull ResultSet rs,
 int columnIndex,
 boolean xmlEncode)
                              throws IOException,
JdbcException,
SQLException

Throws:

IOException

JdbcException

SQLException

fullClose

public static void fullClose(@Nullable Connection connection,
 @Nullable ResultSet rs)

fullClose

public static void fullClose(@Nullable Connection connection,
 @Nullable Statement statement)

Note: Depending on the connect pool used (for example with Tomcat 7) the connection retrieved from the statement will be the direct connection instead of the proxied connection. After a close on this (unproxied) connection the transaction manager isn't able to do a commit anymore. Hence, this method doesn't get it from the statement but has an extra connection parameter.

Parameters:

connection - the proxied/original connection the statement was created with

statement - the statement to close

close

public static void close(@Nullable Connection connection)

isQueryResultEmpty

public static boolean isQueryResultEmpty(@NonNull Connection connection,
 @NonNull String query)
                                  throws JdbcException

Throws:

JdbcException

applyParameters

public static void applyParameters(@NonNull IDbmsSupport dbmsSupport,
 @NonNull PreparedStatement statement,
 @Nullable ParameterList parameters,
 Message message,
 PipeLineSession session)
                            throws JdbcException,
ParameterException

Throws:

JdbcException

ParameterException

applyParameters

public static void applyParameters(@NonNull IDbmsSupport dbmsSupport,
 @NonNull PreparedStatement statement,
 @NonNull ParameterValueList parameters)
                            throws JdbcException

Throws:

JdbcException

mapParameterTypeToSqlType

public static SQLType mapParameterTypeToSqlType(@NonNull IDbmsSupport dbmsSupport,
 @NonNull ParameterType parameterType)

setParameter

public static void setParameter(PreparedStatement statement,
 int parameterIndex,
 String value,
 boolean parameterTypeMatchRequired)
                         throws SQLException

Set a parameter in a prepared statement. Optimized for single-parameter statements

Throws:

SQLException

setParameter

public static void setParameter(@NonNull PreparedStatement statement,
 int parameterIndex,
 @Nullable String value,
 boolean parameterTypeMatchRequired,
 @Nullable ParameterMetaData parameterMetaData)
                         throws SQLException

Set a parameter in a prepared statement. If parameterTypeMatchRequired = true then you should also pass ParameterMetaData. Intended for use when multiple parameters need to be set in the prepared statement, so that ParameterMetaData is fetched only once. (For some databases every time this is accessed from the statement can mean another network-access and fetching it once for all parameters reduces the network overhead for those).

Throws:

SQLException