Package-level declarations

Types

Link copied to clipboard

Represents an arithmetic addition or subtraction expression

Link copied to clipboard

Describes a type of additive operation

Link copied to clipboard
interface AndExpr : BooleanExpr

Represents an AND expression as described in DynamoDB's logical evaluations documentation. This expression will be true if (operand[0] && operand[1] && ... && operand[n - 1]).

Link copied to clipboard
interface Attr

Provides access to top-level attributes on an item or in an item filter

Link copied to clipboard

Represents an expression that consists of an attribute. Attributes are referenced by attribute paths, analogous to document paths in DynamoDB. Attribute paths consist of one or more elements, which are either names (e.g., of a top-level attribute or a nested key in a map attribute) or indices (i.e., into a list). The first (and often only) element of an attribute path is a name.

Link copied to clipboard
Link copied to clipboard
sealed interface AttrPathElement

Represents an element in an AttributePath

Link copied to clipboard

Represents a BETWEEN expression as described in DynamoDB's making comparisons documentation. This expression will be true if value >= min && value <= max.

Link copied to clipboard
sealed interface BooleanExpr : Expression

A subtype of Expression that represents a condition with a boolean value, such as would be used for filtering items. This is a marker interface which adds no additional declarations.

Link copied to clipboard

Identifies a DynamoDB expression function which returns a boolean value

Link copied to clipboard

Represents a function expression that yields a boolean result as described in DynamoDB's function documentation

Link copied to clipboard

Identifies a comparison operator to use in an expression

Link copied to clipboard

Represents a comparison expression as described in DynamoDB's making comparisons documentation. The specific type of comparison is identified by the comparator field.

Link copied to clipboard
sealed interface Expression

Represents any kind of expression. This is an abstract top-level interface and describes no details about an expression on its own. Expressions may be of various specific types (e.g., AttributePath, ComparisonExpr, AndExpr, etc.) each of which have specific data detailing the expression.

Link copied to clipboard
interface ExpressionVisitor<T>

A visitor that can traverse an Expression

Link copied to clipboard
interface FilterDsl

A DSL interface providing support for "low-level" DynamoDB filter/condition expressions. The methods and properties in this interface create boolean expressions to filter item results (e.g., in Scan or Query operations). Expressions are typically formed by getting a reference to an attribute path via the attr property and then exercising some operation or function upon it.

Link copied to clipboard
interface InExpr : BooleanExpr

Represents an IN expression as described in DynamoDB's making comparisons documentation. This expression will be true if value in set (or, equivalently, if set.contains(value)).

Link copied to clipboard
interface KeyFilter

Represents a filter which limits a Query operation to a specific partition key and optional sort key criteria (if applicable)

Link copied to clipboard

Represents an expression that consists of a single literal value

Link copied to clipboard
interface NotExpr : BooleanExpr

Represents a NOT expression as described in DynamoDB's logical evaluations documentation. This expression will be true if !operand (i.e., operand evaluates to false).

Link copied to clipboard
interface OrExpr : BooleanExpr

Represents an OR expression as described in DynamoDB's logical evaluations documentation. This expression will be true if (operand[0] || operand[1] || ... || operand[n - 1]).

Link copied to clipboard

Identifies a DynamoDB expression function which returns a non-boolean value

Link copied to clipboard

Represents a function expression that yields a non-boolean result as described in DynamoDB's function documentation

Link copied to clipboard
interface SortKey

Represents a sort key independent of schema

Link copied to clipboard
sealed interface SortKeyExpr : Expression

A subtype of Expression that represents a key condition on a sort key, such as would be used for specifying a Query key. This is a marker interface which adds no additional declarations.

Link copied to clipboard

A DSL interface providing support for "low-level" sort key filter expressions. Implementations of this interface provide methods and properties which create sort key expressions to narrow results in Query operations. Expressions are formed by referencing sortKey and then exercising some function upon it.

Link copied to clipboard

Describes a type of update action. Each entry corresponds to a clause in an update expression.

Link copied to clipboard

Represents an update action inside an update expression clause

Link copied to clipboard
interface UpdateDsl

A DSL interface providing support for creating "low-level" DynamoDB update expressions. The methods and properties in this interface specify how a matching item should be modified in an UpdateItem operation.

Link copied to clipboard

Represents an update expression used in an UpdateItem operation, which consists of four clauses: SET, REMOVE, ADD, and DELETE

Functions

Link copied to clipboard

Creates a new additive expression

Link copied to clipboard
fun AndExpr(operands: List<BooleanExpr>): AndExpr

Creates a new AndExpr with the given operands

Link copied to clipboard

Creates a new AttributePath reference with the given index and parent path

fun AttributePath(name: String, parent: AttributePath? = null): AttributePath

Creates a new AttributePath reference with the given name and optional parent path

Link copied to clipboard

Creates a new BetweenExpr for the given value and range bounded by min and max

Link copied to clipboard
fun BooleanFuncExpr(func: BooleanFunc, path: AttributePath, additionalOperands: List<Expression> = listOf()): BooleanFuncExpr
fun BooleanFuncExpr(func: BooleanFunc, path: AttributePath, vararg additionalOperands: Expression): BooleanFuncExpr

Creates a new boolean function expression

Link copied to clipboard

Creates a new comparison expression

Link copied to clipboard

Creates a new IN expression

Link copied to clipboard
fun KeyFilter(partitionKey: KeyType, vararg sortKeyExpressions: SortKeyFilterDsl.() -> SortKeyExpr): KeyFilter
fun KeyFilter(partitionKey: Byte, vararg sortKeyExpressions: SortKeyFilterDsl.() -> SortKeyExpr): KeyFilter
fun KeyFilter(partitionKey: ByteArray, vararg sortKeyExpressions: SortKeyFilterDsl.() -> SortKeyExpr): KeyFilter
fun KeyFilter(partitionKey: Int, vararg sortKeyExpressions: SortKeyFilterDsl.() -> SortKeyExpr): KeyFilter
fun KeyFilter(partitionKey: Long, vararg sortKeyExpressions: SortKeyFilterDsl.() -> SortKeyExpr): KeyFilter
fun KeyFilter(partitionKey: Short, vararg sortKeyExpressions: SortKeyFilterDsl.() -> SortKeyExpr): KeyFilter
fun KeyFilter(partitionKey: String, vararg sortKeyExpressions: SortKeyFilterDsl.() -> SortKeyExpr): KeyFilter

Creates a new KeyFilter implementation for the given partition key value and optional sort key expressions

Link copied to clipboard
@JvmName(name = "LiteralExprSetByteArray")
fun LiteralExpr(value: Set<ByteArray>?): LiteralExpr
@JvmName(name = "LiteralExprSetNumber")
fun LiteralExpr(value: Set<Number>?): LiteralExpr
@JvmName(name = "LiteralExprSetString")
fun LiteralExpr(value: Set<String>?): LiteralExpr
@JvmName(name = "LiteralExprSetUByte")
fun LiteralExpr(value: Set<UByte>?): LiteralExpr
@JvmName(name = "LiteralExprSetUInt")
fun LiteralExpr(value: Set<UInt>?): LiteralExpr
@JvmName(name = "LiteralExprSetULong")
fun LiteralExpr(value: Set<ULong>?): LiteralExpr
@JvmName(name = "LiteralExprSetUShort")
fun LiteralExpr(value: Set<UShort>?): LiteralExpr

Creates a new literal expression

Link copied to clipboard
fun NotExpr(operand: BooleanExpr): NotExpr

Creates a new NOT expression

Link copied to clipboard
fun OrExpr(operands: List<BooleanExpr>): OrExpr

Creates a new OrExpr with the given operands

Link copied to clipboard
fun ScalarFuncExpr(func: ScalarFunc, initialOperand: Expression, additionalOperands: List<Expression> = listOf()): ScalarFuncExpr
fun ScalarFuncExpr(func: ScalarFunc, initialOperand: Expression, vararg additionalOperands: Expression): ScalarFuncExpr

Creates a new non-boolean function expression

Link copied to clipboard

Create a new update clause expression

Link copied to clipboard

Creates a new update expression