Class BaseRDBMSActionStrategy

java.lang.Object

com.kingsrook.qqq.backend.module.rdbms.strategy.BaseRDBMSActionStrategy

All Implemented Interfaces:

RDBMSActionStrategyInterface

Direct Known Subclasses:

MySQLFullTextIndexFieldStrategy, PostgreSQLRDBMSActionStrategy, SQLiteRDBMSActionStrategy

public class BaseRDBMSActionStrategy
extends Object
implements RDBMSActionStrategyInterface

Note that much of this class came from the old (old) QueryManager class.

Nested Class Summary

Nested classes/interfaces inherited from interface com.kingsrook.qqq.backend.module.rdbms.strategy.RDBMSActionStrategyInterface

RDBMSActionStrategyInterface.ResultSetProcessor

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PAGE_SIZE
static int	PAGE_SIZE
static final String	STAT_BATCHES_RAN
static final String	STAT_QUERIES_RAN

Constructor Summary

Constructors

Constructor	Description
BaseRDBMSActionStrategy()

Method Summary

Modifier and Type	Method	Description
Integer	appendCriterionToWhereClause(QFilterCriteria criterion, StringBuilder clause, String column, List<Serializable> values, QFieldMetaData field)	modifies the clause StringBuilder (appending to it) returning the number of expected number of params to bind
ConsistentReadStart	beginConsistentRead(Connection connection, ConsistentReadInput input)	MySQL/MariaDB (InnoDB): START TRANSACTION WITH CONSISTENT SNAPSHOT (READ ONLY).
protected void	bindParam(PreparedStatement statement, int index, byte[] value)
protected void	bindParam(PreparedStatement statement, int index, Boolean value)
protected void	bindParam(PreparedStatement statement, int index, Double value)
protected void	bindParam(PreparedStatement statement, int index, Integer value)
protected void	bindParam(PreparedStatement statement, int index, Long value)
protected void	bindParam(PreparedStatement statement, int index, String value)
protected void	bindParam(PreparedStatement statement, int index, BigDecimal value)
protected void	bindParam(PreparedStatement statement, int index, Date value)
protected void	bindParam(PreparedStatement statement, int index, Timestamp value)
protected void	bindParam(PreparedStatement statement, int index, LocalDate value)
protected void	bindParam(PreparedStatement statement, int index, LocalDateTime value)
protected void	bindParam(PreparedStatement statement, int index, Calendar value)
protected void	bindParamNull(PreparedStatement statement, int index)
protected int	bindParamObject(PreparedStatement statement, int index, Object value)	index is 1-based!!
protected void	bindParams(Object[] params, PreparedStatement statement)
void	executeBatchUpdate(Connection connection, String updateSQL, List<List<Serializable>> values)
List<Serializable>	executeInsertForGeneratedIds(Connection connection, String sql, List<Object> params, QFieldMetaData primaryKeyField)
void	executeStatement(PreparedStatement statement, CharSequence sql, RDBMSActionStrategyInterface.ResultSetProcessor processor, Object... params)
PreparedStatement	executeUpdate(Connection connection, String sql, List<Object> params)
Integer	executeUpdateForRowCount(Connection connection, String sql, Object... params)
String	getAggregateExpression(AggregateOperator operator, String column, String otherColumn, Aggregate aggregate, RDBMSBackendMetaData backend, List<Serializable> params)	ANSI aggregate functions used by H2 and MySQL where supported.
protected String	getBucketTimeZone(ZoneId zone)	SQL offset parameters use ISO signs and an explicit zero offset instead of Z.
protected String	getColumnName(QFieldMetaData field)	Get the column name to use for a field in the RDBMS, from the fieldMetaData.
Serializable	getFieldValueFromResultSet(QFieldType type, ResultSet resultSet, int i)
String	getGroupByBucketExpression(GroupBy group, String column, QFieldType sourceType, RDBMSBackendMetaData backend, List<Serializable> params)	Equal-width bins with max included in the last bin, and session-local date buckets.
Integer	getPageSize(AbstractActionInput actionInput)
String	getSampledTableExpression(String table, String alias, BigDecimal percent, List<Serializable> params)	Sample the main relation before joining.
Map<String,Integer>	getStatistics()	Getter for statistics
Set<AggregateCapability>	getSupportedAggregateCapabilities(AggregateInput input)	H2 supports ordered-set aggregates; MySQL supports the remaining extensions.
protected void	incrementStatistic(String statName)	Increment a statistic
protected boolean	isH2(RDBMSBackendMetaData backend)	Use explicit backend metadata to identify H2.
protected PreparedStatement	prepareStatementAndBindParams(Connection connection, String sql, Object[] params)
void	resetStatistics()	clear the map of statistics
void	setCollectStatistics(boolean collectStatistics)	Setter for collectStatistics
void	setPageSize(int pageSize)	Setter for pageSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.module.rdbms.strategy.RDBMSActionStrategyInterface

configureStatementForLargeResults, getIdentifierQuoteString, getInsertDefaultValuesClause, jsonMergeAssignment, jsonObjectPlaceholder, jsonPathExpression, jsonPathPredicate, supportsForUpdateSkipLocked

Field Details

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

• Constant Field Values

PAGE_SIZE

public static int PAGE_SIZE

STAT_QUERIES_RAN

public static final String STAT_QUERIES_RAN

See Also:

• Constant Field Values

STAT_BATCHES_RAN

public static final String STAT_BATCHES_RAN

See Also:

• Constant Field Values

Constructor Details

BaseRDBMSActionStrategy

public BaseRDBMSActionStrategy()

Method Details

appendCriterionToWhereClause

public Integer appendCriterionToWhereClause(QFilterCriteria criterion,
 StringBuilder clause,
 String column,
 List<Serializable> values,
 QFieldMetaData field)

Description copied from interface: RDBMSActionStrategyInterface

modifies the clause StringBuilder (appending to it) returning the number of expected number of params to bind

Specified by:

appendCriterionToWhereClause in interface RDBMSActionStrategyInterface

getFieldValueFromResultSet

public Serializable getFieldValueFromResultSet(QFieldType type,
 ResultSet resultSet,
 int i)
                                        throws SQLException

Specified by:

getFieldValueFromResultSet in interface RDBMSActionStrategyInterface

Throws:

SQLException

executeUpdate

public PreparedStatement executeUpdate(Connection connection,
 String sql,
 List<Object> params)
                                throws SQLException

Specified by:

executeUpdate in interface RDBMSActionStrategyInterface

Throws:

SQLException

executeBatchUpdate

public void executeBatchUpdate(Connection connection,
 String updateSQL,
 List<List<Serializable>> values)
                        throws SQLException

Specified by:

executeBatchUpdate in interface RDBMSActionStrategyInterface

Throws:

SQLException

executeInsertForGeneratedIds

public List<Serializable> executeInsertForGeneratedIds(Connection connection,
 String sql,
 List<Object> params,
 QFieldMetaData primaryKeyField)
                                                throws SQLException

Specified by:

executeInsertForGeneratedIds in interface RDBMSActionStrategyInterface

Throws:

SQLException

executeUpdateForRowCount

public Integer executeUpdateForRowCount(Connection connection,
 String sql,
 Object... params)
                                 throws SQLException

Specified by:

executeUpdateForRowCount in interface RDBMSActionStrategyInterface

Throws:

SQLException

executeStatement

public void executeStatement(PreparedStatement statement,
 CharSequence sql,
 RDBMSActionStrategyInterface.ResultSetProcessor processor,
 Object... params)
                      throws SQLException,
QException

Specified by:

executeStatement in interface RDBMSActionStrategyInterface

Throws:

SQLException

QException

getPageSize

public Integer getPageSize(AbstractActionInput actionInput)

Specified by:

getPageSize in interface RDBMSActionStrategyInterface

prepareStatementAndBindParams

protected PreparedStatement prepareStatementAndBindParams(Connection connection,
 String sql,
 Object[] params)
                                                   throws SQLException

Throws:

SQLException

bindParams

protected void bindParams(Object[] params,
 PreparedStatement statement)
                   throws SQLException

Throws:

SQLException

bindParamObject

protected int bindParamObject(PreparedStatement statement,
 int index,
 Object value)
                       throws SQLException

index is 1-based!!

Throws:

SQLException

bindParam

protected void bindParam(PreparedStatement statement,
 int index,
 Integer value)
                  throws SQLException

Throws:

SQLException

bindParam

protected void bindParam(PreparedStatement statement,
 int index,
 Long value)
                  throws SQLException

Throws:

SQLException

bindParam

protected void bindParam(PreparedStatement statement,
 int index,
 Double value)
                  throws SQLException

Throws:

SQLException

bindParam

protected void bindParam(PreparedStatement statement,
 int index,
 String value)
                  throws SQLException

Throws:

SQLException

bindParam

protected void bindParam(PreparedStatement statement,
 int index,
 Boolean value)
                  throws SQLException

Throws:

SQLException

bindParam

protected void bindParam(PreparedStatement statement,
 int index,
 Date value)
                  throws SQLException

Throws:

SQLException

bindParam

protected void bindParam(PreparedStatement statement,
 int index,
 Timestamp value)
                  throws SQLException

Throws:

SQLException

bindParam

protected void bindParam(PreparedStatement statement,
 int index,
 Calendar value)
                  throws SQLException

Throws:

SQLException

bindParam

protected void bindParam(PreparedStatement statement,
 int index,
 LocalDate value)
                  throws SQLException

Throws:

SQLException

bindParam

protected void bindParam(PreparedStatement statement,
 int index,
 LocalDateTime value)
                  throws SQLException

Throws:

SQLException

bindParam

protected void bindParam(PreparedStatement statement,
 int index,
 BigDecimal value)
                  throws SQLException

Throws:

SQLException

bindParam

protected void bindParam(PreparedStatement statement,
 int index,
 byte[] value)
                  throws SQLException

Throws:

SQLException

bindParamNull

protected void bindParamNull(PreparedStatement statement,
 int index)
                      throws SQLException

Throws:

SQLException

incrementStatistic

protected void incrementStatistic(String statName)

Increment a statistic

setCollectStatistics

public void setCollectStatistics(boolean collectStatistics)

Setter for collectStatistics

resetStatistics

public void resetStatistics()

clear the map of statistics

getStatistics

public Map<String,Integer> getStatistics()

Getter for statistics

setPageSize

public void setPageSize(int pageSize)

Setter for pageSize

getColumnName

protected String getColumnName(QFieldMetaData field)

Get the column name to use for a field in the RDBMS, from the fieldMetaData. That is, field.backendName if set -- else, field.name

beginConsistentRead

public ConsistentReadStart beginConsistentRead(Connection connection,
 ConsistentReadInput input)
                                        throws SQLException

MySQL/MariaDB (InnoDB): START TRANSACTION WITH CONSISTENT SNAPSHOT (READ ONLY). Tables on other engines (e.g., MyISAM) aren't covered by the snapshot, and are reported as BEST_EFFORT. H2: REPEATABLE READ (MVCC), pinned by a first read. Other databases: as the interface default.

Specified by:

beginConsistentRead in interface RDBMSActionStrategyInterface

Throws:

SQLException

getSupportedAggregateCapabilities

public Set<AggregateCapability> getSupportedAggregateCapabilities(AggregateInput input)

H2 supports ordered-set aggregates; MySQL supports the remaining extensions.

Specified by:

getSupportedAggregateCapabilities in interface RDBMSActionStrategyInterface

getBucketTimeZone

protected String getBucketTimeZone(ZoneId zone)

SQL offset parameters use ISO signs and an explicit zero offset instead of Z.

isH2

protected boolean isH2(RDBMSBackendMetaData backend)

Use explicit backend metadata to identify H2.

getAggregateExpression

public String getAggregateExpression(AggregateOperator operator,
 String column,
 String otherColumn,
 Aggregate aggregate,
 RDBMSBackendMetaData backend,
 List<Serializable> params)

ANSI aggregate functions used by H2 and MySQL where supported.

Specified by:

getAggregateExpression in interface RDBMSActionStrategyInterface

getSampledTableExpression

public String getSampledTableExpression(String table,
 String alias,
 BigDecimal percent,
 List<Serializable> params)

Sample the main relation before joining. RAND is supported by H2 and MySQL.

Specified by:

getSampledTableExpression in interface RDBMSActionStrategyInterface

getGroupByBucketExpression

public String getGroupByBucketExpression(GroupBy group,
 String column,
 QFieldType sourceType,
 RDBMSBackendMetaData backend,
 List<Serializable> params)

Equal-width bins with max included in the last bin, and session-local date buckets.

Specified by:

getGroupByBucketExpression in interface RDBMSActionStrategyInterface