Class RDBMSBackendModule

java.lang.Object

com.kingsrook.qqq.backend.module.rdbms.RDBMSBackendModule

All Implemented Interfaces:

QBackendModuleInterface

Direct Known Subclasses:

PostgreSQLBackendModule, SQLiteBackendModule

public class RDBMSBackendModule
extends Object
implements QBackendModuleInterface

QQQ Backend module for working with Relational Databases (RDBMS's).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
RDBMSBackendModule()

Method Summary

Modifier and Type	Method	Description
AggregateInterface	getAggregateInterface()
Class<? extends QBackendMetaData>	getBackendMetaDataClass()	Method to identify the class used for backend meta data for this module.
String	getBackendType()	Method where a backend module must be able to provide its type (name).
ConditionalUpdateInterface	getConditionalUpdateInterface()	Atomic conditional updates (CONDITIONAL_UPDATE), plus the database clock.
CountInterface	getCountInterface()
DeleteInterface	getDeleteInterface()
HealthCheck	getHealthCheck(QBackendMetaData backend)	A read-only readiness probe; connection configuration never becomes details.
InsertInterface	getInsertInterface()
QueryInterface	getQueryInterface()
Class<? extends QTableBackendDetails>	getTableBackendDetailsClass()	Method to identify the class used for table-backend details for this module.
UpdateInterface	getUpdateInterface()
Optional<QBackendTransaction>	openConsistentReadTransaction(ConsistentReadInput input)	Open a transaction whose reads all see one snapshot of the database - in the vendor's way (see RDBMSActionStrategyInterface.beginConsistentRead).
QBackendTransaction	openTransaction(AbstractTableActionInput input)
List<SequenceResyncResult>	resyncKeySequences(QBackendMetaData backend, Collection<QTableMetaData> tables)	Advance each table's key sequence past its largest key, per vendor: - postgres: setval on the column's serial/identity sequence
boolean	supportsQueryLockMode(QBackendMetaData backendMetaData, QueryLockMode lockMode)	Row locks, as the backend's SQL dialect (action strategy) supports them.
boolean	supportsSubQueries(QBackendMetaData backend)	RDBMS actions translate same-backend sub-queries into SQL.

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.core.modules.backend.QBackendModuleInterface

getGetInterface, getStorageInterface, getUnsupportedCapabilities

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

RDBMSBackendModule

public RDBMSBackendModule()

Method Details

getHealthCheck

public HealthCheck getHealthCheck(QBackendMetaData backend)

A read-only readiness probe; connection configuration never becomes details.

Specified by:

getHealthCheck in interface QBackendModuleInterface

supportsSubQueries

public boolean supportsSubQueries(QBackendMetaData backend)

RDBMS actions translate same-backend sub-queries into SQL.

Specified by:

supportsSubQueries in interface QBackendModuleInterface

getBackendType

public String getBackendType()

Method where a backend module must be able to provide its type (name).

Specified by:

getBackendType in interface QBackendModuleInterface

getBackendMetaDataClass

public Class<? extends QBackendMetaData> getBackendMetaDataClass()

Method to identify the class used for backend meta data for this module.

Specified by:

getBackendMetaDataClass in interface QBackendModuleInterface

getTableBackendDetailsClass

public Class<? extends QTableBackendDetails> getTableBackendDetailsClass()

Method to identify the class used for table-backend details for this module.

Specified by:

getTableBackendDetailsClass in interface QBackendModuleInterface

getCountInterface

public CountInterface getCountInterface()

Specified by:

getCountInterface in interface QBackendModuleInterface

getQueryInterface

public QueryInterface getQueryInterface()

Specified by:

getQueryInterface in interface QBackendModuleInterface

getInsertInterface

public InsertInterface getInsertInterface()

Specified by:

getInsertInterface in interface QBackendModuleInterface

getUpdateInterface

public UpdateInterface getUpdateInterface()

Specified by:

getUpdateInterface in interface QBackendModuleInterface

getDeleteInterface

public DeleteInterface getDeleteInterface()

Specified by:

getDeleteInterface in interface QBackendModuleInterface

getAggregateInterface

public AggregateInterface getAggregateInterface()

Specified by:

getAggregateInterface in interface QBackendModuleInterface

openTransaction

public QBackendTransaction openTransaction(AbstractTableActionInput input)
                                    throws QException

Specified by:

openTransaction in interface QBackendModuleInterface

Throws:

QException

openConsistentReadTransaction

public Optional<QBackendTransaction> openConsistentReadTransaction(ConsistentReadInput input)
                                                            throws QException

Open a transaction whose reads all see one snapshot of the database - in the vendor's way (see RDBMSActionStrategyInterface.beginConsistentRead). With useReadReplica, and a read-only backend configured, it's on that backend.

Specified by:

openConsistentReadTransaction in interface QBackendModuleInterface

Throws:

QException

resyncKeySequences

public List<SequenceResyncResult> resyncKeySequences(QBackendMetaData backend,
 Collection<QTableMetaData> tables)
                                              throws QException

Advance each table's key sequence past its largest key, per vendor: - postgres: setval on the column's serial/identity sequence. - h2: ALTER TABLE ... RESTART WITH max+1 on an identity column. - mysql, mariadb, sqlite: the engine does this itself on explicit inserts. - anything else (or no integer key, or no sequence): not applicable.

Specified by:

resyncKeySequences in interface QBackendModuleInterface

Throws:

QException

getConditionalUpdateInterface

public ConditionalUpdateInterface getConditionalUpdateInterface()

Atomic conditional updates (CONDITIONAL_UPDATE), plus the database clock.

Specified by:

getConditionalUpdateInterface in interface QBackendModuleInterface

supportsQueryLockMode

public boolean supportsQueryLockMode(QBackendMetaData backendMetaData,
 QueryLockMode lockMode)

Row locks, as the backend's SQL dialect (action strategy) supports them.

Specified by:

supportsQueryLockMode in interface QBackendModuleInterface