Query - Klyn API

Query

classin packageklyn.data

public final class Query<T> implements Queryable<T>, RelationalQuerySource, PolicyAwareQuerySource:

Query

All Implemented Interfaces: Queryable, RelationalQuerySource, PolicyAwareQuerySource

Immutable, lazy and re-executable typed KQL query.

A query is not a collection. Execution occurs only through an explicit terminal operation such as toList(), count(), or stream().

Example

active = query:
from users user
where user.active
rows = active.toList()

Properties

Modifier and Type	Member	Description
public readonly property	plan `plan as QueryPlanView:`	Returns the provider-safe immutable plan summary.
public readonly property	relationalPushdown `relationalPushdown as Boolean:`	True when the wrapped source supports complete relational pushdown.

Constructors

Modifier and Type	Member	Description
public	Query `Query(source as QuerySource, plan as QueryPlanBase, description as String = "query"):`	Creates a lazy query from a provider source and immutable typed plan.

Methods

Modifier and Type	Member	Description
public	asQuery `asQuery() as Query<T>:`	Returns this immutable query.
public	count `count() as Long:`	Counts result rows through the provider count operation.
public	countPlan `countPlan(plan as QueryPlanBase) as Long:`	Counts rows produced by an outer plan.
public	entityPolicies `entityPolicies() as IList<QirEntityPolicy>:`	Propagates manager policies through query and join composition.
public	executePlan `executePlan(plan as QueryPlanBase) as Object:`	Applies an outer typed plan to this query.
public	exists `exists() as Boolean:`	Tests whether at least one row exists.
public	existsPlan `existsPlan(plan as QueryPlanBase) as Boolean:`	Tests whether an outer plan produces a row.
public	explain `explain() as QueryExplanation:`	Returns a typed, redacted query explanation.
public	first `first() as T throws NoResultException:`	Returns the first row using a one-row provider window.
public	firstOrNull `firstOrNull() as Object:`	Returns the first row or `null`.
public	openStream `openStream(plan as QueryPlanBase) as Object:`	Opens an outer plan as an independent sequential stream.
public	page `page(request as PageRequest) as Page<T>:`	Materializes one page and obtains an exact total count.
public	planExecutionMode `planExecutionMode(plan as QueryPlanBase) as ProviderExecutionMode:`	Classifies an outer composed plan through the retained provider root.
public	planWarnings `planWarnings(plan as QueryPlanBase) as IList<String>:`	Returns warnings for the complete retained provider plan.
public	providerCapabilities `providerCapabilities() as ProviderCapabilities:`	Delegates machine-readable capabilities to the retained provider root.
public	providerDomain `providerDomain() as Object:`	Returns the underlying provider-instance execution domain.
public	providerName `providerName() as String:`	Returns the underlying provider identifier.
public	providerText `providerText(plan as QueryPlanBase) as String:`	Returns provider text and explicitly identifies composed memory work.
public	relationalRoot `relationalRoot() as QuerySource:`	Returns the provider root retained by this immutable query.
public	single `single() as T throws NoResultException, NonUniqueResultException:`	Returns the sole result row.
public	singleOrNull `singleOrNull() as Object throws NonUniqueResultException:`	Returns the sole row or `null`.
public	slice `slice(request as PageRequest) as Slice<T>:`	Materializes one page window without executing an exact count.
public	stream `stream() as QueryStream<T>:`	Opens one independent forward-only result stream.
public	toList `toList() as List<T>:`	Executes and materializes the query into the standard list type.
public	toProviderText `toProviderText() as String:`	Returns the privileged provider representation for diagnostics.
public	toSet `toSet() as Set<T>:`	Executes and materializes unique result rows.

Inherited Methods

methodInherited Methods from Queryable: asQuery