Package-level declarations

Types

Link copied to clipboard

How a Predicate.Compare compares. There is no NE; see Predicate.

Link copied to clipboard
class Explain

How a query would be answered.

Link copied to clipboard

One index source of a plan, with what it would actually admit.

Link copied to clipboard
class IndexUse

One index a plan used, and how far it reached at this snapshot.

Link copied to clipboard
class PathRef

A path a predicate is being written about.

Link copied to clipboard
sealed interface Predicate

What a query asks of a document.

Link copied to clipboard

What a query returns for each document it matches.

Link copied to clipboard
class Query

A predicate, what to return for each match, and how much of the store to look at.

Link copied to clipboard

The rows a query matched, in key order.

Link copied to clipboard
class QueryEngine(store: DocumentStore, indexes: IndexCatalog, schema: InferredSchema? = null)

Answers queries against a store, using the indexes that exist and scanning what they do not cover.

Link copied to clipboard

What a query found and what it cost.

Link copied to clipboard
sealed interface QueryValue

A literal a predicate compares against.

Link copied to clipboard
class Row

One result: a key, and whatever the projection asked for.

Functions

Link copied to clipboard
fun allOf(operands: List<Predicate>): Predicate

Every operand holds.

Link copied to clipboard
fun and(vararg operands: Predicate): Predicate

Every operand holds.

Link copied to clipboard
infix fun Predicate.and(other: Predicate): Predicate

Both hold.

Link copied to clipboard
fun anyOf(operands: List<Predicate>): Predicate

At least one operand holds.

Link copied to clipboard
fun elemMatch(path: PathRef, operand: Predicate): Predicate

One element at path satisfies operand, whose paths are relative to the element.

fun elemMatch(expression: String, operand: Predicate): Predicate

The same, from an expression: elemMatch("$.items[*]", …).

Link copied to clipboard
fun not(operand: Predicate): Predicate

The operand does not hold, of the document. See Predicate for what that means at a path.

Link copied to clipboard
fun or(vararg operands: Predicate): Predicate

At least one operand holds.

Link copied to clipboard
infix fun Predicate.or(other: Predicate): Predicate

Either holds.

Link copied to clipboard

The path, already parsed.

fun path(expression: String): PathRef

The path written as an expression, in the catalog's grammar: $.user.name, $.tags[*].

Link copied to clipboard

Every path this predicate mentions of the document, deduplicated, in the order first seen.