Interface QueryInterface

All Superinterfaces:

BaseQueryInterface

All Known Implementing Classes:

APIQueryAction, EnumerationQueryAction, FilesystemQueryAction, MemoryQueryAction, MockQueryAction, MongoDBQueryAction, RDBMSQueryAction, S3QueryAction, SFTPQueryAction

public interface QueryInterface
extends BaseQueryInterface

Interface for the Query action.

Method Summary

Modifier and Type	Method	Description
QueryOutput	execute(QueryInput queryInput)
default QueryOutput	executeForDml(QueryInput queryInput)	Native lookup whose returned identities will drive writes.
default List<Serializable>	findAssociatedPrimaryKeys(AssociatedRecordDiscovery.Input input)	Native structural lookup for associated-write permission preflight.
default List<QRecord>	lookupUniqueKey(UniqueKeyLookup.Input input)	Native, schema-constrained unique-key validation, independent of read visibility.
default List<QRecord>	readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input)	Native, exact-key projection of declared parent association values.

Methods inherited from interface com.kingsrook.qqq.backend.core.actions.interfaces.BaseQueryInterface

cancelAction, getQueryStat, setQueryStat, setQueryStatFirstResultTime

Method Details

execute

QueryOutput execute(QueryInput queryInput)
             throws QException

Throws:

QException

executeForDml

default QueryOutput executeForDml(QueryInput queryInput)
                           throws QException

Native lookup whose returned identities will drive writes. Backends may reject identities that cannot be preserved through their public record form.

Throws:

QException

findAssociatedPrimaryKeys

default List<Serializable> findAssociatedPrimaryKeys(AssociatedRecordDiscovery.Input input)
                                              throws QException

Native structural lookup for associated-write permission preflight.

Throws:

QException

readAssociationValues

default List<QRecord> readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input)
                                     throws QException

Native, exact-key projection of declared parent association values.

Throws:

QException

lookupUniqueKey

default List<QRecord> lookupUniqueKey(UniqueKeyLookup.Input input)
                               throws QException

Native, schema-constrained unique-key validation, independent of read visibility.

Throws:

QException