firebase-firestore/com.google.firebase.firestore.pipeline/BooleanExpression

BooleanExpression

abstract class BooleanExpression : Expression(source)

An expression that evaluates to a boolean: a condition of the where stage, of conditional and of countIf.

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun abs(): Expression

The abs function of this expression.

Link copied to clipboard
fun add(second: Expression): Expression
fun add(second: Number): Expression

The add function of this expression and second.

Link copied to clipboard
fun alias(alias: String): AliasedExpression

This expression under the alias alias: its name in the output documents.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun arrayConcat(secondArray: Expression, vararg otherArrays: Any): Expression
fun arrayConcat(secondArray: Any, vararg otherArrays: Any): Expression

The array_concat function of this expression, secondArray and otherArrays.

Link copied to clipboard
fun arrayContains(element: Expression): BooleanExpression
fun arrayContains(element: Any): BooleanExpression

The array_contains condition of this expression and element.

Link copied to clipboard
fun arrayContainsAll(arrayExpression: Expression): BooleanExpression

The array_contains_all condition of this expression and arrayExpression.

fun arrayContainsAll(values: List<Any>): BooleanExpression

arrayContainsAll of this expression and the array values.

Link copied to clipboard
fun arrayContainsAny(arrayExpression: Expression): BooleanExpression

The array_contains_any condition of this expression and arrayExpression.

fun arrayContainsAny(values: List<Any>): BooleanExpression

The array_contains_any condition of this expression and the array values.

Link copied to clipboard
fun arrayFilter(alias: String, filter: BooleanExpression): Expression

The array_filter function of this expression, alias and filter.

Link copied to clipboard
fun arrayFirst(): Expression

The array_first function of this expression.

Link copied to clipboard
fun arrayFirstN(n: Expression): Expression
fun arrayFirstN(n: Int): Expression

The array_first_n function of this expression and n.

Link copied to clipboard
fun arrayGet(offset: Expression): Expression
fun arrayGet(offset: Int): Expression

The array_get function of this expression and offset.

Link copied to clipboard
fun arrayIndexOf(value: Any?): Expression

The array_index_of function of this expression, value and "first".

Link copied to clipboard
fun arrayIndexOfAll(value: Any?): Expression

The array_index_of_all function of this expression and value.

Link copied to clipboard
fun arrayLast(): Expression

The array_last function of this expression.

Link copied to clipboard
fun arrayLastIndexOf(value: Any?): Expression

The array_index_of function of this expression, value and "last".

Link copied to clipboard
fun arrayLastN(n: Expression): Expression
fun arrayLastN(n: Int): Expression

The array_last_n function of this expression and n.

Link copied to clipboard
fun arrayLength(): Expression

The array_length function of this expression.

Link copied to clipboard
fun arrayMaximum(): Expression

The maximum function of this expression.

Link copied to clipboard
fun arrayMaximumN(n: Expression): Expression
fun arrayMaximumN(n: Int): Expression

The maximum_n function of this expression and n.

Link copied to clipboard
fun arrayMinimum(): Expression

The minimum function of this expression.

Link copied to clipboard
fun arrayMinimumN(n: Expression): Expression
fun arrayMinimumN(n: Int): Expression

The minimum_n function of this expression and n.

Link copied to clipboard
fun arrayReverse(): Expression

The array_reverse function of this expression.

Link copied to clipboard
fun arraySlice(offset: Expression, length: Expression): Expression
fun arraySlice(offset: Int, length: Int): Expression

The array_slice function of this expression, offset and length.

Link copied to clipboard
fun arraySliceToEnd(offset: Expression): Expression
fun arraySliceToEnd(offset: Int): Expression

The array_slice function of this expression and offset.

Link copied to clipboard
fun arraySum(): Expression

The sum function of this expression.

Link copied to clipboard
fun arrayTransform(elementAlias: String, transform: Expression): Expression

The array_transform function of this expression, elementAlias and transform.

Link copied to clipboard
fun arrayTransformWithIndex(elementAlias: String, indexAlias: String, transform: Expression): Expression

The array_transform function of this expression, elementAlias, indexAlias and transform.

Link copied to clipboard
fun asBoolean(): BooleanExpression

This expression as a condition: unchanged if it is one, otherwise evaluated as a boolean.

Link copied to clipboard
fun ascending(): Ordering

Ordering.ascending of this expression.

Link copied to clipboard
Link copied to clipboard
fun bitAnd(bitsOther: Expression): Expression
fun bitAnd(bitsOther: ByteArray): Expression

The bit_and function of this expression and bitsOther.

Link copied to clipboard
fun bitLeftShift(numberExpr: Expression): Expression

The bit_left_shift function of this expression and numberExpr.

fun bitLeftShift(number: Int): Expression

The bit_left_shift function of this expression and number.

Link copied to clipboard
fun bitNot(): Expression

The bit_not function of this expression.

Link copied to clipboard
fun bitOr(bitsOther: Expression): Expression
fun bitOr(bitsOther: ByteArray): Expression

The bit_or function of this expression and bitsOther.

Link copied to clipboard
fun bitRightShift(numberExpr: Expression): Expression

The bit_right_shift function of this expression and numberExpr.

fun bitRightShift(number: Int): Expression

The bit_right_shift function of this expression and number.

Link copied to clipboard
fun bitXor(bitsOther: Expression): Expression
fun bitXor(bitsOther: ByteArray): Expression

The bit_xor function of this expression and bitsOther.

Link copied to clipboard
fun byteLength(): Expression

The byte_length function of this expression.

Link copied to clipboard
fun ceil(): Expression

The ceil function of this expression.

Link copied to clipboard
fun charLength(): Expression

The char_length function of this expression.

Link copied to clipboard
fun coalesce(replacement: Any, vararg others: Any): Expression

The coalesce function of this expression, replacement and others.

Link copied to clipboard
fun collectionId(): Expression

The collection_id function of this expression.

Link copied to clipboard
fun concat(second: Expression, vararg others: Any): Expression
fun concat(second: Any, vararg others: Any): Expression

The concat function of this expression, second and others.

Link copied to clipboard
fun conditional(thenExpr: Expression, elseExpr: Expression): Expression

thenExpr where this condition is true, otherwise elseExpr.

fun conditional(thenValue: Any, elseValue: Any): Expression

thenValue where this condition is true, otherwise elseValue.

Link copied to clipboard
fun cosineDistance(vector: VectorValue): Expression
fun cosineDistance(vector: Expression): Expression

The cosine_distance function of this expression and vector.

fun cosineDistance(vector: DoubleArray): Expression

The cosine_distance function of this expression and the vector vector.

Link copied to clipboard
fun count(): AggregateFunction

AggregateFunction.count of this expression.

Link copied to clipboard
Link copied to clipboard
fun countIf(): AggregateFunction

An aggregate counting the documents for which this condition is true.

Link copied to clipboard
fun descending(): Ordering

Ordering.descending of this expression.

Link copied to clipboard
fun divide(divisor: Expression): Expression
fun divide(divisor: Number): Expression

The divide function of this expression and divisor.

Link copied to clipboard
fun documentId(): Expression

The document_id function of this expression.

Link copied to clipboard
fun dotProduct(vector: VectorValue): Expression
fun dotProduct(vector: Expression): Expression

The dot_product function of this expression and vector.

fun dotProduct(vector: DoubleArray): Expression

The dot_product function of this expression and the vector vector.

Link copied to clipboard
fun endsWith(suffix: Expression): BooleanExpression
fun endsWith(suffix: String): BooleanExpression

The ends_with condition of this expression and suffix.

Link copied to clipboard
fun equal(other: Expression): BooleanExpression

The equal condition of this expression and other.

fun equal(value: Any): BooleanExpression

The equal condition of this expression and value.

Link copied to clipboard
fun equalAny(arrayExpression: Expression): BooleanExpression

The equal_any condition of this expression and arrayExpression.

fun equalAny(values: List<Any>): BooleanExpression

equalAny of this expression and the array values.

Link copied to clipboard
fun euclideanDistance(vector: VectorValue): Expression
fun euclideanDistance(vector: Expression): Expression

The euclidean_distance function of this expression and vector.

fun euclideanDistance(vector: DoubleArray): Expression

The euclidean_distance function of this expression and the vector vector.

Link copied to clipboard
fun exists(): BooleanExpression

The exists condition of this expression.

Link copied to clipboard
fun exp(): Expression

The exp function of this expression.

Link copied to clipboard
fun first(): AggregateFunction

AggregateFunction.first of this expression.

Link copied to clipboard
fun floor(): Expression

The floor function of this expression.

Link copied to clipboard
fun getField(keyExpression: Expression): Expression

The get_field function of this expression and keyExpression.

fun getField(key: String): Expression

The get_field function of this expression and key.

Link copied to clipboard
fun greaterThan(other: Expression): BooleanExpression

The greater_than condition of this expression and other.

fun greaterThan(value: Any): BooleanExpression

The greater_than condition of this expression and value.

Link copied to clipboard
fun greaterThanOrEqual(other: Expression): BooleanExpression

The greater_than_or_equal condition of this expression and other.

fun greaterThanOrEqual(value: Any): BooleanExpression

The greater_than_or_equal condition of this expression and value.

Link copied to clipboard
fun ifAbsent(elseExpr: Expression): Expression

The if_absent function of this expression and elseExpr.

fun ifAbsent(elseValue: Any): Expression

The if_absent function of this expression and elseValue.

Link copied to clipboard
fun ifError(catchExpr: Expression): Expression

The if_error function of this expression and catchExpr.

fun ifError(catchValue: Any): Expression

The if_error function of this expression and catchValue.

Link copied to clipboard
fun ifNull(elseExpression: Expression): Expression

The if_null function of this expression and elseExpression.

fun ifNull(elseValue: Any): Expression

The if_null function of this expression and elseValue.

Link copied to clipboard
fun isAbsent(): BooleanExpression

The is_absent condition of this expression.

Link copied to clipboard
fun isError(): BooleanExpression

The is_error condition of this expression.

Link copied to clipboard
fun isType(type: String): BooleanExpression

The is_type condition of this expression and type.

Link copied to clipboard
fun join(delimiterExpression: Expression): Expression

The join function of this expression and delimiterExpression.

fun join(delimiter: String): Expression

The join function of this expression and delimiter.

Link copied to clipboard
fun last(): AggregateFunction

AggregateFunction.last of this expression.

Link copied to clipboard
fun length(): Expression

The length function of this expression.

Link copied to clipboard
fun lessThan(other: Expression): BooleanExpression

The less_than condition of this expression and other.

fun lessThan(value: Any): BooleanExpression

The less_than condition of this expression and value.

Link copied to clipboard
fun lessThanOrEqual(other: Expression): BooleanExpression

The less_than_or_equal condition of this expression and other.

fun lessThanOrEqual(value: Any): BooleanExpression

The less_than_or_equal condition of this expression and value.

Link copied to clipboard
fun like(pattern: Expression): BooleanExpression
fun like(pattern: String): BooleanExpression

The like condition of this expression and pattern.

Link copied to clipboard
fun ln(): Expression

The ln function of this expression.

Link copied to clipboard
fun log10(): Expression

The log10 function of this expression.

Link copied to clipboard
fun logicalMaximum(vararg others: Expression): Expression

logicalMaximum of this expression and others.

fun logicalMaximum(vararg others: Any): Expression

The maximum function of this expression and others.

Link copied to clipboard
fun logicalMinimum(vararg others: Expression): Expression

logicalMinimum of this expression and others.

fun logicalMinimum(vararg others: Any): Expression

The minimum function of this expression and others.

Link copied to clipboard
fun ltrim(): Expression

The ltrim function of this expression.

Link copied to clipboard
fun ltrimValue(valuesToTrim: Expression): Expression
fun ltrimValue(valuesToTrim: String): Expression

The ltrim function of this expression and valuesToTrim.

Link copied to clipboard
fun mapEntries(): Expression

The map_entries function of this expression.

Link copied to clipboard
fun mapGet(keyExpression: Expression): Expression

The map_get function of this expression and keyExpression.

fun mapGet(key: String): Expression

The map_get function of this expression and key.

Link copied to clipboard
fun mapKeys(): Expression

The map_keys function of this expression.

Link copied to clipboard
fun mapMerge(mapExpr: Expression, vararg otherMaps: Expression): Expression

The map_merge function of this expression, mapExpr and otherMaps.

Link copied to clipboard
fun mapRemove(keyExpression: Expression): Expression

The map_remove function of this expression and keyExpression.

fun mapRemove(key: String): Expression

The map_remove function of this expression and key.

Link copied to clipboard
fun mapSet(key: Expression, value: Expression, vararg moreKeyValues: Expression): Expression
fun mapSet(key: String, value: Any?, vararg moreKeyValues: Any): Expression

The map_set function of this expression, key, value and moreKeyValues.

Link copied to clipboard
fun mapValues(): Expression

The map_values function of this expression.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun mod(divisor: Expression): Expression
fun mod(divisor: Number): Expression

The mod function of this expression and divisor.

Link copied to clipboard
fun multiply(second: Expression): Expression
fun multiply(second: Number): Expression

The multiply function of this expression and second.

Link copied to clipboard
fun not(): BooleanExpression

The negation of this condition.

Link copied to clipboard
fun notEqual(other: Expression): BooleanExpression

The not_equal condition of this expression and other.

fun notEqual(value: Any): BooleanExpression

The not_equal condition of this expression and value.

Link copied to clipboard
fun notEqualAny(arrayExpression: Expression): BooleanExpression

The not_equal_any condition of this expression and arrayExpression.

fun notEqualAny(values: List<Any>): BooleanExpression

notEqualAny of this expression and the array values.

Link copied to clipboard
fun parent(): Expression

The parent function of this expression.

Link copied to clipboard
fun pow(exponent: Expression): Expression
fun pow(exponent: Number): Expression

The pow function of this expression and exponent.

Link copied to clipboard
fun regexContains(pattern: Expression): BooleanExpression
fun regexContains(pattern: String): BooleanExpression

The regex_contains condition of this expression and pattern.

Link copied to clipboard
fun regexMatch(pattern: Expression): BooleanExpression
fun regexMatch(pattern: String): BooleanExpression

The regex_match condition of this expression and pattern.

Link copied to clipboard
fun reverse(): Expression

The reverse function of this expression.

Link copied to clipboard
fun round(): Expression

The round function of this expression.

Link copied to clipboard
fun roundToPrecision(decimalPlace: Expression): Expression
fun roundToPrecision(decimalPlace: Int): Expression

The round function of this expression and decimalPlace.

Link copied to clipboard
fun rtrim(): Expression

The rtrim function of this expression.

Link copied to clipboard
fun rtrimValue(valuesToTrim: Expression): Expression
fun rtrimValue(valuesToTrim: String): Expression

The rtrim function of this expression and valuesToTrim.

Link copied to clipboard
fun split(delimiter: Blob): Expression
fun split(delimiter: Expression): Expression
fun split(delimiter: String): Expression

The split function of this expression and delimiter.

Link copied to clipboard
fun sqrt(): Expression

The sqrt function of this expression.

Link copied to clipboard
fun startsWith(prefix: Expression): BooleanExpression
fun startsWith(prefix: String): BooleanExpression

The starts_with condition of this expression and prefix.

Link copied to clipboard
fun stringConcat(vararg stringExpressions: Expression): Expression

The string_concat function of this expression and stringExpressions.

fun stringConcat(vararg strings: Any): Expression

The string_concat function of this expression and strings.

fun stringConcat(vararg strings: String): Expression

stringConcat of this expression and strings.

Link copied to clipboard
fun stringContains(substring: Expression): BooleanExpression
fun stringContains(substring: String): BooleanExpression

The string_contains condition of this expression and substring.

Link copied to clipboard
fun stringIndexOf(substring: Expression): Expression
fun stringIndexOf(substring: String): Expression

The string_index_of function of this expression and substring.

Link copied to clipboard
fun stringRepeat(count: Expression): Expression
fun stringRepeat(count: Int): Expression

The string_repeat function of this expression and count.

Link copied to clipboard
fun stringReplaceAll(oldValue: Expression, newValue: Expression): Expression
fun stringReplaceAll(oldValue: String, newValue: String): Expression

The string_replace_all function of this expression, oldValue and newValue.

Link copied to clipboard
fun stringReplaceOne(oldValue: Expression, newValue: Expression): Expression
fun stringReplaceOne(oldValue: String, newValue: String): Expression

The string_replace_one function of this expression, oldValue and newValue.

Link copied to clipboard
fun stringReverse(): Expression

The string_reverse function of this expression.

Link copied to clipboard
fun substring(start: Expression, length: Expression): Expression

The substring function of this expression, start and length.

fun substring(start: Int, length: Int): Expression

The substring function of this expression, constant(start) and constant(length).

Link copied to clipboard
fun subtract(subtrahend: Expression): Expression
fun subtract(subtrahend: Number): Expression

The subtract function of this expression and subtrahend.

Link copied to clipboard
fun sum(): AggregateFunction

AggregateFunction.sum of this expression.

Link copied to clipboard
fun timestampAdd(unit: Expression, amount: Expression): Expression
fun timestampAdd(unit: String, amount: Long): Expression

The timestamp_add function of this expression, unit and amount.

Link copied to clipboard
fun timestampDiff(start: Expression, unit: Expression): Expression

The timestamp_diff function of this expression, start and unit.

fun timestampDiff(start: Expression, unit: String): Expression

timestampDiff of this expression, start and unit.

fun timestampDiff(startFieldName: String, unit: String): Expression

timestampDiff of this expression, the field startFieldName and unit.

Link copied to clipboard
fun timestampExtract(part: Expression): Expression

The timestamp_extract function of this expression and part.

fun timestampExtract(part: String): Expression

timestampExtract of this expression and part.

Link copied to clipboard
fun timestampExtractWithTimezone(part: Expression, timezone: Expression): Expression

The timestamp_extract function of this expression, part and timezone.

fun timestampExtractWithTimezone(part: Expression, timezone: String): Expression
fun timestampExtractWithTimezone(part: String, timezone: Expression): Expression
fun timestampExtractWithTimezone(part: String, timezone: String): Expression

timestampExtractWithTimezone of this expression, part and timezone.

Link copied to clipboard
fun timestampSubtract(unit: Expression, amount: Expression): Expression
fun timestampSubtract(unit: String, amount: Long): Expression

The timestamp_subtract function of this expression, unit and amount.

Link copied to clipboard
fun timestampToUnixMicros(): Expression

The timestamp_to_unix_micros function of this expression.

Link copied to clipboard
fun timestampToUnixMillis(): Expression

The timestamp_to_unix_millis function of this expression.

Link copied to clipboard
fun timestampToUnixSeconds(): Expression

The timestamp_to_unix_seconds function of this expression.

Link copied to clipboard
fun timestampTruncate(granularity: Expression): Expression
fun timestampTruncate(granularity: String): Expression

The timestamp_trunc function of this expression and granularity.

Link copied to clipboard
fun timestampTruncateWithTimezone(granularity: Expression, timezone: Expression): Expression
fun timestampTruncateWithTimezone(granularity: Expression, timezone: String): Expression
fun timestampTruncateWithTimezone(granularity: String, timezone: Expression): Expression
fun timestampTruncateWithTimezone(granularity: String, timezone: String): Expression

The timestamp_trunc function of this expression, granularity and timezone.

Link copied to clipboard
fun toLower(): Expression

The to_lower function of this expression.

Link copied to clipboard
fun toUpper(): Expression

The to_upper function of this expression.

Link copied to clipboard
fun trim(): Expression

The trim function of this expression.

Link copied to clipboard
fun trimValue(valueToTrim: Expression): Expression

The trim function of this expression and valueToTrim.

fun trimValue(valueToTrim: String): Expression

The trim function of this expression and constant(valueToTrim).

Link copied to clipboard
fun trunc(): Expression

The trunc function of this expression.

Link copied to clipboard
fun truncToPrecision(decimalPlace: Expression): Expression
fun truncToPrecision(decimalPlace: Int): Expression

The trunc function of this expression and decimalPlace.

Link copied to clipboard
fun type(): Expression

The type function of this expression.

Link copied to clipboard
fun unixMicrosToTimestamp(): Expression

The unix_micros_to_timestamp function of this expression.

Link copied to clipboard
fun unixMillisToTimestamp(): Expression

The unix_millis_to_timestamp function of this expression.

Link copied to clipboard
fun unixSecondsToTimestamp(): Expression

The unix_seconds_to_timestamp function of this expression.

Link copied to clipboard
fun vectorLength(): Expression

The vector_length function of this expression.

Generated by Dokka
firebase-multiplatform, Apache License 2.0. Based on GitLive's firebase-kotlin-sdk.