firebase-firestore/com.google.firebase.firestore.pipeline/Expression/Companion

Companion

object Companion(source)

Functions

abs

@JvmStatic

fun abs(numericExpr: Expression): Expression

The abs function of numericExpr.

@JvmStatic

fun abs(numericField: String): Expression

The abs function of the field numericField.

add

@JvmStatic

fun add(first: Expression, second: Expression): Expression

@JvmStatic

fun add(first: Expression, second: Number): Expression

The add function of first and second.

@JvmStatic

fun add(numericFieldName: String, second: Expression): Expression

@JvmStatic

fun add(numericFieldName: String, second: Number): Expression

The add function of the field numericFieldName and second.

and

@JvmStatic

fun and(condition: BooleanExpression, vararg conditions: BooleanExpression): BooleanExpression

The and condition of condition and conditions.

array

@JvmStatic

fun array(elements: List<Any?>): Expression

The array function of elements.map(::toExprOrConstant).toTypedArray().

@JvmStatic

fun array(vararg elements: Any?): Expression

The array function of elements.map(::toExprOrConstant).toTypedArray<Expression>().

arrayConcat

@JvmStatic

fun arrayConcat(firstArray: Expression, secondArray: Expression, vararg otherArrays: Any): Expression

@JvmStatic

fun arrayConcat(firstArray: Expression, secondArray: Any, vararg otherArrays: Any): Expression

The array_concat function of firstArray, secondArray and otherArrays.

@JvmStatic

fun arrayConcat(firstArrayField: String, secondArray: Expression, vararg otherArrays: Any): Expression

@JvmStatic

fun arrayConcat(firstArrayField: String, secondArray: Any, vararg otherArrays: Any): Expression

The array_concat function of the field firstArrayField, secondArray and otherArrays.

arrayContains

@JvmStatic

fun arrayContains(array: Expression, element: Expression): BooleanExpression

@JvmStatic

fun arrayContains(array: Expression, element: Any): BooleanExpression

The array_contains condition of array and element.

@JvmStatic

fun arrayContains(arrayFieldName: String, element: Expression): BooleanExpression

@JvmStatic

fun arrayContains(arrayFieldName: String, element: Any): BooleanExpression

The array_contains condition of the field arrayFieldName and element.

arrayContainsAll

@JvmStatic

fun arrayContainsAll(array: Expression, arrayExpression: Expression): BooleanExpression

The array_contains_all condition of array and arrayExpression.

@JvmStatic

fun arrayContainsAll(array: Expression, values: List<Any>): BooleanExpression

arrayContainsAll of array and the array values.

@JvmStatic

fun arrayContainsAll(arrayFieldName: String, arrayExpression: Expression): BooleanExpression

The array_contains_all condition of the field arrayFieldName and arrayExpression.

@JvmStatic

fun arrayContainsAll(arrayFieldName: String, values: List<Any>): BooleanExpression

The array_contains_all condition of the field arrayFieldName and the array values.

arrayContainsAny

@JvmStatic

fun arrayContainsAny(array: Expression, arrayExpression: Expression): BooleanExpression

The array_contains_any condition of array and arrayExpression.

@JvmStatic

fun arrayContainsAny(array: Expression, values: List<Any>): BooleanExpression

The array_contains_any condition of array and the array values.

@JvmStatic

fun arrayContainsAny(arrayFieldName: String, arrayExpression: Expression): BooleanExpression

The array_contains_any condition of the field arrayFieldName and arrayExpression.

@JvmStatic

fun arrayContainsAny(arrayFieldName: String, values: List<Any>): BooleanExpression

The array_contains_any condition of the field arrayFieldName and the array values.

arrayFilter

@JvmStatic

fun arrayFilter(array: Expression, alias: String, filter: BooleanExpression): Expression

The array_filter function of array, alias and filter.

@JvmStatic

fun arrayFilter(arrayFieldName: String, alias: String, filter: BooleanExpression): Expression

The array_filter function of the field arrayFieldName, alias and filter.

arrayFirst

@JvmStatic

fun arrayFirst(array: Expression): Expression

The array_first function of array.

@JvmStatic

fun arrayFirst(arrayFieldName: String): Expression

The array_first function of the field arrayFieldName.

arrayFirstN

@JvmStatic

fun arrayFirstN(array: Expression, n: Expression): Expression

@JvmStatic

fun arrayFirstN(array: Expression, n: Int): Expression

The array_first_n function of array and n.

@JvmStatic

fun arrayFirstN(arrayFieldName: String, n: Expression): Expression

@JvmStatic

fun arrayFirstN(arrayFieldName: String, n: Int): Expression

The array_first_n function of the field arrayFieldName and n.

arrayGet

@JvmStatic

fun arrayGet(array: Expression, offset: Expression): Expression

@JvmStatic

fun arrayGet(array: Expression, offset: Int): Expression

The array_get function of array and offset.

@JvmStatic

fun arrayGet(arrayFieldName: String, offset: Expression): Expression

@JvmStatic

fun arrayGet(arrayFieldName: String, offset: Int): Expression

The array_get function of the field arrayFieldName and offset.

arrayIndexOf

@JvmStatic

fun arrayIndexOf(array: Expression, value: Any?): Expression

The array_index_of function of array, value and "first".

@JvmStatic

fun arrayIndexOf(arrayFieldName: String, value: Any?): Expression

The array_index_of function of the field arrayFieldName, value and "first".

arrayIndexOfAll

@JvmStatic

fun arrayIndexOfAll(array: Expression, value: Any?): Expression

The array_index_of_all function of array and value.

@JvmStatic

fun arrayIndexOfAll(arrayFieldName: String, value: Any?): Expression

The array_index_of_all function of the field arrayFieldName and value.

arrayLast

@JvmStatic

fun arrayLast(array: Expression): Expression

The array_last function of array.

@JvmStatic

fun arrayLast(arrayFieldName: String): Expression

The array_last function of the field arrayFieldName.

arrayLastIndexOf

@JvmStatic

fun arrayLastIndexOf(array: Expression, value: Any?): Expression

The array_index_of function of array, value and "last".

@JvmStatic

fun arrayLastIndexOf(arrayFieldName: String, value: Any?): Expression

The array_index_of function of the field arrayFieldName, value and "last".

arrayLastN

@JvmStatic

fun arrayLastN(array: Expression, n: Expression): Expression

@JvmStatic

fun arrayLastN(array: Expression, n: Int): Expression

The array_last_n function of array and n.

@JvmStatic

fun arrayLastN(arrayFieldName: String, n: Expression): Expression

@JvmStatic

fun arrayLastN(arrayFieldName: String, n: Int): Expression

The array_last_n function of the field arrayFieldName and n.

arrayLength

@JvmStatic

fun arrayLength(array: Expression): Expression

The array_length function of array.

@JvmStatic

fun arrayLength(arrayFieldName: String): Expression

The array_length function of the field arrayFieldName.

arrayMaximum

@JvmStatic

fun arrayMaximum(array: Expression): Expression

The maximum function of array.

@JvmStatic

fun arrayMaximum(arrayFieldName: String): Expression

The maximum function of the field arrayFieldName.

arrayMaximumN

@JvmStatic

fun arrayMaximumN(array: Expression, n: Expression): Expression

@JvmStatic

fun arrayMaximumN(array: Expression, n: Int): Expression

The maximum_n function of array and n.

@JvmStatic

fun arrayMaximumN(arrayFieldName: String, n: Expression): Expression

@JvmStatic

fun arrayMaximumN(arrayFieldName: String, n: Int): Expression

The maximum_n function of the field arrayFieldName and n.

arrayMinimum

@JvmStatic

fun arrayMinimum(array: Expression): Expression

The minimum function of array.

@JvmStatic

fun arrayMinimum(arrayFieldName: String): Expression

The minimum function of the field arrayFieldName.

arrayMinimumN

@JvmStatic

fun arrayMinimumN(array: Expression, n: Expression): Expression

@JvmStatic

fun arrayMinimumN(array: Expression, n: Int): Expression

The minimum_n function of array and n.

@JvmStatic

fun arrayMinimumN(arrayFieldName: String, n: Expression): Expression

@JvmStatic

fun arrayMinimumN(arrayFieldName: String, n: Int): Expression

The minimum_n function of the field arrayFieldName and n.

arrayReverse

@JvmStatic

fun arrayReverse(array: Expression): Expression

The array_reverse function of array.

@JvmStatic

fun arrayReverse(arrayFieldName: String): Expression

The array_reverse function of the field arrayFieldName.

arraySlice

@JvmStatic

fun arraySlice(array: Expression, offset: Expression, length: Expression): Expression

@JvmStatic

fun arraySlice(array: Expression, offset: Int, length: Int): Expression

The array_slice function of array, offset and length.

@JvmStatic

fun arraySlice(arrayFieldName: String, offset: Expression, length: Expression): Expression

@JvmStatic

fun arraySlice(arrayFieldName: String, offset: Int, length: Int): Expression

The array_slice function of the field arrayFieldName, offset and length.

arraySliceToEnd

@JvmStatic

fun arraySliceToEnd(array: Expression, offset: Expression): Expression

@JvmStatic

fun arraySliceToEnd(array: Expression, offset: Int): Expression

The array_slice function of array and offset.

@JvmStatic

fun arraySliceToEnd(arrayFieldName: String, offset: Expression): Expression

@JvmStatic

fun arraySliceToEnd(arrayFieldName: String, offset: Int): Expression

The array_slice function of the field arrayFieldName and offset.

arraySum

@JvmStatic

fun arraySum(array: Expression): Expression

The sum function of array.

@JvmStatic

fun arraySum(arrayFieldName: String): Expression

The sum function of the field arrayFieldName.

arrayTransform

@JvmStatic

fun arrayTransform(array: Expression, elementAlias: String, transform: Expression): Expression

The array_transform function of array, elementAlias and transform.

@JvmStatic

fun arrayTransform(arrayFieldName: String, elementAlias: String, transform: Expression): Expression

The array_transform function of the field arrayFieldName, elementAlias and transform.

arrayTransformWithIndex

@JvmStatic

fun arrayTransformWithIndex(array: Expression, elementAlias: String, indexAlias: String, transform: Expression): Expression

The array_transform function of array, elementAlias, indexAlias and transform.

@JvmStatic

fun arrayTransformWithIndex(arrayFieldName: String, elementAlias: String, indexAlias: String, transform: Expression): Expression

The array_transform function of the field arrayFieldName, elementAlias, indexAlias and transform.

bitAnd

@JvmStatic

fun bitAnd(bits: Expression, bitsOther: Expression): Expression

@JvmStatic

fun bitAnd(bits: Expression, bitsOther: ByteArray): Expression

The bit_and function of bits and bitsOther.

@JvmStatic

fun bitAnd(bitsFieldName: String, bitsOther: Expression): Expression

@JvmStatic

fun bitAnd(bitsFieldName: String, bitsOther: ByteArray): Expression

The bit_and function of the field bitsFieldName and bitsOther.

bitLeftShift

@JvmStatic

fun bitLeftShift(bits: Expression, numberExpr: Expression): Expression

The bit_left_shift function of bits and numberExpr.

@JvmStatic

fun bitLeftShift(bits: Expression, number: Int): Expression

The bit_left_shift function of bits and number.

@JvmStatic

fun bitLeftShift(bitsFieldName: String, numberExpr: Expression): Expression

The bit_left_shift function of the field bitsFieldName and numberExpr.

@JvmStatic

fun bitLeftShift(bitsFieldName: String, number: Int): Expression

The bit_left_shift function of the field bitsFieldName and number.

bitNot

@JvmStatic

fun bitNot(bits: Expression): Expression

The bit_not function of bits.

@JvmStatic

fun bitNot(bitsFieldName: String): Expression

The bit_not function of the field bitsFieldName.

bitOr

@JvmStatic

fun bitOr(bits: Expression, bitsOther: Expression): Expression

@JvmStatic

fun bitOr(bits: Expression, bitsOther: ByteArray): Expression

The bit_or function of bits and bitsOther.

@JvmStatic

fun bitOr(bitsFieldName: String, bitsOther: Expression): Expression

@JvmStatic

fun bitOr(bitsFieldName: String, bitsOther: ByteArray): Expression

The bit_or function of the field bitsFieldName and bitsOther.

bitRightShift

@JvmStatic

fun bitRightShift(bits: Expression, numberExpr: Expression): Expression

The bit_right_shift function of bits and numberExpr.

@JvmStatic

fun bitRightShift(bits: Expression, number: Int): Expression

The bit_right_shift function of bits and number.

@JvmStatic

fun bitRightShift(bitsFieldName: String, numberExpr: Expression): Expression

The bit_right_shift function of the field bitsFieldName and numberExpr.

@JvmStatic

fun bitRightShift(bitsFieldName: String, number: Int): Expression

The bit_right_shift function of the field bitsFieldName and number.

bitXor

@JvmStatic

fun bitXor(bits: Expression, bitsOther: Expression): Expression

@JvmStatic

fun bitXor(bits: Expression, bitsOther: ByteArray): Expression

The bit_xor function of bits and bitsOther.

@JvmStatic

fun bitXor(bitsFieldName: String, bitsOther: Expression): Expression

@JvmStatic

fun bitXor(bitsFieldName: String, bitsOther: ByteArray): Expression

The bit_xor function of the field bitsFieldName and bitsOther.

byteLength

@JvmStatic

fun byteLength(value: Expression): Expression

The byte_length function of value.

@JvmStatic

fun byteLength(fieldName: String): Expression

The byte_length function of the field fieldName.

ceil

@JvmStatic

fun ceil(numericExpr: Expression): Expression

The ceil function of numericExpr.

@JvmStatic

fun ceil(numericField: String): Expression

The ceil function of the field numericField.

charLength

@JvmStatic

fun charLength(expr: Expression): Expression

The char_length function of expr.

@JvmStatic

fun charLength(fieldName: String): Expression

The char_length function of the field fieldName.

coalesce

@JvmStatic

fun coalesce(expression: Expression, replacement: Any, vararg others: Any): Expression

The coalesce function of expression, replacement and others.

@JvmStatic

fun coalesce(fieldName: String, replacement: Any, vararg others: Any): Expression

The coalesce function of the field fieldName, replacement and others.

collectionId

@JvmStatic

fun collectionId(path: Expression): Expression

The collection_id function of path.

@JvmStatic

fun collectionId(pathField: String): Expression

collectionId of the field pathField.

concat

@JvmStatic

fun concat(first: Expression, second: Expression, vararg others: Any): Expression

@JvmStatic

fun concat(first: Expression, second: Any, vararg others: Any): Expression

The concat function of first, second and others.

@JvmStatic

fun concat(first: String, second: Expression, vararg others: Any): Expression

@JvmStatic

fun concat(first: String, second: Any, vararg others: Any): Expression

The concat function of the field first, second and others.

conditional

@JvmStatic

fun conditional(condition: BooleanExpression, thenExpr: Expression, elseExpr: Expression): Expression

The conditional function of condition, thenExpr and elseExpr.

@JvmStatic

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

The conditional function of condition, thenValue and elseValue.

constant

@JvmStatic

fun constant(value: Timestamp): Expression

A constant timestamp.

@JvmStatic

fun constant(value: Blob): Expression

@JvmStatic

fun constant(value: ByteArray): Expression

Constant bytes.

@JvmStatic

fun constant(ref: DocumentReference): Expression

A constant document reference.

@JvmStatic

fun constant(value: GeoPoint): Expression

A constant geographic point.

@JvmStatic

fun constant(value: VectorValue): Expression

A constant vector.

@JvmStatic

fun constant(value: Boolean): BooleanExpression

A constant boolean, which is a condition.

@JvmStatic

fun constant(value: Number): Expression

A constant number: an integer for Byte, Short, Int and Long, a double otherwise.

@JvmStatic

fun constant(value: String): Expression

A constant string.

cosineDistance

@JvmStatic

fun cosineDistance(vector1: Expression, vector2: VectorValue): Expression

@JvmStatic

fun cosineDistance(vector1: Expression, vector2: Expression): Expression

The cosine_distance function of vector1 and vector2.

@JvmStatic

fun cosineDistance(vector1: Expression, vector2: DoubleArray): Expression

The cosine_distance function of vector1 and the vector vector2.

@JvmStatic

fun cosineDistance(vectorFieldName: String, vector: VectorValue): Expression

@JvmStatic

fun cosineDistance(vectorFieldName: String, vector: Expression): Expression

The cosine_distance function of the field vectorFieldName and vector.

@JvmStatic

fun cosineDistance(vectorFieldName: String, vector: DoubleArray): Expression

The cosine_distance function of the field vectorFieldName and the vector vector.

currentDocument

@JvmStatic

fun currentDocument(): Expression

The current_document function.

currentTimestamp

@JvmStatic

fun currentTimestamp(): Expression

The current_timestamp function.

divide

@JvmStatic

fun divide(dividend: Expression, divisor: Expression): Expression

@JvmStatic

fun divide(dividend: Expression, divisor: Number): Expression

The divide function of dividend and divisor.

@JvmStatic

fun divide(dividendFieldName: String, divisor: Expression): Expression

@JvmStatic

fun divide(dividendFieldName: String, divisor: Number): Expression

The divide function of the field dividendFieldName and divisor.

documentId

@JvmStatic

fun documentId(docRef: DocumentReference): Expression

documentId of docRef.

@JvmStatic

fun documentId(documentPath: Expression): Expression

The document_id function of documentPath.

@JvmStatic

fun documentId(documentPath: String): Expression

documentId of documentPath.

documentMatches

@JvmStatic

fun documentMatches(rquery: String): BooleanExpression

The document_matches condition of rquery. Beta in the Android SDK.

dotProduct

@JvmStatic

fun dotProduct(vector1: Expression, vector2: VectorValue): Expression

@JvmStatic

fun dotProduct(vector1: Expression, vector2: Expression): Expression

The dot_product function of vector1 and vector2.

@JvmStatic

fun dotProduct(vector1: Expression, vector2: DoubleArray): Expression

The dot_product function of vector1 and the vector vector2.

@JvmStatic

fun dotProduct(vectorFieldName: String, vector: VectorValue): Expression

@JvmStatic

fun dotProduct(vectorFieldName: String, vector: Expression): Expression

The dot_product function of the field vectorFieldName and vector.

@JvmStatic

fun dotProduct(vectorFieldName: String, vector: DoubleArray): Expression

The dot_product function of the field vectorFieldName and the vector vector.

endsWith

@JvmStatic

fun endsWith(stringExpr: Expression, suffix: Expression): BooleanExpression

@JvmStatic

fun endsWith(stringExpr: Expression, suffix: String): BooleanExpression

The ends_with condition of stringExpr and suffix.

@JvmStatic

fun endsWith(fieldName: String, suffix: Expression): BooleanExpression

@JvmStatic

fun endsWith(fieldName: String, suffix: String): BooleanExpression

The ends_with condition of the field fieldName and suffix.

equal

@JvmStatic

fun equal(left: Expression, right: Expression): BooleanExpression

@JvmStatic

fun equal(left: Expression, right: Any): BooleanExpression

The equal condition of left and right.

@JvmStatic

fun equal(fieldName: String, expression: Expression): BooleanExpression

The equal condition of the field fieldName and expression.

@JvmStatic

fun equal(fieldName: String, value: Any): BooleanExpression

The equal condition of the field fieldName and value.

equalAny

@JvmStatic

fun equalAny(expression: Expression, arrayExpression: Expression): BooleanExpression

The equal_any condition of expression and arrayExpression.

@JvmStatic

fun equalAny(expression: Expression, values: List<Any>): BooleanExpression

equalAny of expression and the array values.

@JvmStatic

fun equalAny(fieldName: String, arrayExpression: Expression): BooleanExpression

The equal_any condition of the field fieldName and arrayExpression.

@JvmStatic

fun equalAny(fieldName: String, values: List<Any>): BooleanExpression

equalAny of fieldName and the array values.

euclideanDistance

@JvmStatic

fun euclideanDistance(vector1: Expression, vector2: VectorValue): Expression

@JvmStatic

fun euclideanDistance(vector1: Expression, vector2: Expression): Expression

The euclidean_distance function of vector1 and vector2.

@JvmStatic

fun euclideanDistance(vector1: Expression, vector2: DoubleArray): Expression

The euclidean_distance function of vector1 and the vector vector2.

@JvmStatic

fun euclideanDistance(vectorFieldName: String, vector: VectorValue): Expression

@JvmStatic

fun euclideanDistance(vectorFieldName: String, vector: Expression): Expression

The euclidean_distance function of the field vectorFieldName and vector.

@JvmStatic

fun euclideanDistance(vectorFieldName: String, vector: DoubleArray): Expression

The euclidean_distance function of the field vectorFieldName and the vector vector.

exists

@JvmStatic

fun exists(value: Expression): BooleanExpression

The exists condition of value.

@JvmStatic

fun exists(fieldName: String): BooleanExpression

The exists condition of the field fieldName.

exp

@JvmStatic

fun exp(numericExpr: Expression): Expression

The exp function of numericExpr.

@JvmStatic

fun exp(numericField: String): Expression

The exp function of the field numericField.

field

@JvmStatic

fun field(fieldPath: FieldPath): Field

A reference to the field at fieldPath.

@JvmStatic

fun field(name: String): Field

A reference to the field at the .-separated path name (__name__, __create_time__ and __update_time__ are the document's name and times).

floor

@JvmStatic

fun floor(numericExpr: Expression): Expression

The floor function of numericExpr.

@JvmStatic

fun floor(numericField: String): Expression

The floor function of the field numericField.

geoDistance

@JvmStatic

fun geoDistance(field: Field, location: GeoPoint): Expression

The geo_distance function of field and location. Beta in the Android SDK.

@JvmStatic

fun geoDistance(fieldName: String, location: GeoPoint): Expression

geoDistance of the field fieldName and location. Beta in the Android SDK.

getField

@JvmStatic

fun getField(expression: Expression, keyExpression: Expression): Expression

The get_field function of expression and keyExpression.

@JvmStatic

fun getField(expression: Expression, key: String): Expression

The get_field function of expression and key.

@JvmStatic

fun getField(fieldName: String, keyExpression: Expression): Expression

The get_field function of the field fieldName and keyExpression.

@JvmStatic

fun getField(fieldName: String, key: String): Expression

The get_field function of the field fieldName and key.

greaterThan

@JvmStatic

fun greaterThan(left: Expression, right: Expression): BooleanExpression

@JvmStatic

fun greaterThan(left: Expression, right: Any): BooleanExpression

The greater_than condition of left and right.

@JvmStatic

fun greaterThan(fieldName: String, expression: Expression): BooleanExpression

The greater_than condition of the field fieldName and expression.

@JvmStatic

fun greaterThan(fieldName: String, value: Any): BooleanExpression

The greater_than condition of the field fieldName and value.

greaterThanOrEqual

@JvmStatic

fun greaterThanOrEqual(left: Expression, right: Expression): BooleanExpression

@JvmStatic

fun greaterThanOrEqual(left: Expression, right: Any): BooleanExpression

The greater_than_or_equal condition of left and right.

@JvmStatic

fun greaterThanOrEqual(fieldName: String, expression: Expression): BooleanExpression

The greater_than_or_equal condition of the field fieldName and expression.

@JvmStatic

fun greaterThanOrEqual(fieldName: String, value: Any): BooleanExpression

The greater_than_or_equal condition of the field fieldName and value.

ifAbsent

@JvmStatic

fun ifAbsent(ifExpr: Expression, elseExpr: Expression): Expression

The if_absent function of ifExpr and elseExpr.

@JvmStatic

fun ifAbsent(ifExpr: Expression, elseValue: Any): Expression

The if_absent function of ifExpr and elseValue.

@JvmStatic

fun ifAbsent(ifFieldName: String, elseExpr: Expression): Expression

The if_absent function of the field ifFieldName and elseExpr.

@JvmStatic

fun ifAbsent(ifFieldName: String, elseValue: Any): Expression

The if_absent function of the field ifFieldName and elseValue.

ifError

@JvmStatic

fun ifError(tryExpr: BooleanExpression, catchExpr: BooleanExpression): BooleanExpression

The if_error condition of tryExpr and catchExpr.

@JvmStatic

fun ifError(tryExpr: Expression, catchExpr: Expression): Expression

The if_error function of tryExpr and catchExpr.

@JvmStatic

fun ifError(tryExpr: Expression, catchValue: Any): Expression

The if_error function of tryExpr and catchValue.

ifNull

@JvmStatic

fun ifNull(ifExpr: Expression, elseExpr: Expression): Expression

The if_null function of ifExpr and elseExpr.

@JvmStatic

fun ifNull(ifExpr: Expression, elseValue: Any): Expression

The if_null function of ifExpr and elseValue.

@JvmStatic

fun ifNull(ifFieldName: String, elseExpr: Expression): Expression

The if_null function of the field ifFieldName and elseExpr.

@JvmStatic

fun ifNull(ifFieldName: String, elseValue: Any): Expression

The if_null function of the field ifFieldName and elseValue.

isAbsent

@JvmStatic

fun isAbsent(value: Expression): BooleanExpression

The is_absent condition of value.

@JvmStatic

fun isAbsent(fieldName: String): BooleanExpression

The is_absent condition of the field fieldName.

isError

@JvmStatic

fun isError(expr: Expression): BooleanExpression

The is_error condition of expr.

isType

@JvmStatic

fun isType(expr: Expression, type: String): BooleanExpression

The is_type condition of expr and type.

@JvmStatic

fun isType(fieldName: String, type: String): BooleanExpression

The is_type condition of the field fieldName and type.

join

@JvmStatic

fun join(arrayExpression: Expression, delimiterExpression: Expression): Expression

The join function of arrayExpression and delimiterExpression.

@JvmStatic

fun join(arrayExpression: Expression, delimiter: String): Expression

The join function of arrayExpression and delimiter.

@JvmStatic

fun join(arrayFieldName: String, delimiterExpression: Expression): Expression

The join function of the field arrayFieldName and delimiterExpression.

@JvmStatic

fun join(arrayFieldName: String, delimiter: String): Expression

The join function of the field arrayFieldName and delimiter.

length

@JvmStatic

fun length(expr: Expression): Expression

The length function of expr.

@JvmStatic

fun length(fieldName: String): Expression

The length function of the field fieldName.

lessThan

@JvmStatic

fun lessThan(left: Expression, right: Expression): BooleanExpression

@JvmStatic

fun lessThan(left: Expression, right: Any): BooleanExpression

The less_than condition of left and right.

@JvmStatic

fun lessThan(fieldName: String, expression: Expression): BooleanExpression

The less_than condition of the field fieldName and expression.

@JvmStatic

fun lessThan(fieldName: String, value: Any): BooleanExpression

The less_than condition of the field fieldName and value.

lessThanOrEqual

@JvmStatic

fun lessThanOrEqual(left: Expression, right: Expression): BooleanExpression

@JvmStatic

fun lessThanOrEqual(left: Expression, right: Any): BooleanExpression

The less_than_or_equal condition of left and right.

@JvmStatic

fun lessThanOrEqual(fieldName: String, expression: Expression): BooleanExpression

The less_than_or_equal condition of the field fieldName and expression.

@JvmStatic

fun lessThanOrEqual(fieldName: String, value: Any): BooleanExpression

The less_than_or_equal condition of the field fieldName and value.

@JvmStatic

fun like(stringExpression: Expression, pattern: Expression): BooleanExpression

@JvmStatic

fun like(stringExpression: Expression, pattern: String): BooleanExpression

The like condition of stringExpression and pattern.

@JvmStatic

fun like(fieldName: String, pattern: Expression): BooleanExpression

@JvmStatic

fun like(fieldName: String, pattern: String): BooleanExpression

The like condition of the field fieldName and pattern.

@JvmStatic

fun ln(numericExpr: Expression): Expression

The ln function of numericExpr.

@JvmStatic

fun ln(numericField: String): Expression

The ln function of the field numericField.

log

@JvmStatic

fun log(numericExpr: Expression, base: Expression): Expression

@JvmStatic

fun log(numericExpr: Expression, base: Number): Expression

The log function of numericExpr and base.

@JvmStatic

fun log(numericField: String, base: Expression): Expression

@JvmStatic

fun log(numericField: String, base: Number): Expression

The log function of the field numericField and base.

log10

@JvmStatic

fun log10(numericExpr: Expression): Expression

The log10 function of numericExpr.

@JvmStatic

fun log10(numericField: String): Expression

The log10 function of the field numericField.

logicalMaximum

@JvmStatic

fun logicalMaximum(expr: Expression, vararg others: Any): Expression

The maximum function of expr and others.

@JvmStatic

fun logicalMaximum(fieldName: String, vararg others: Any): Expression

The maximum function of the field fieldName and others.

logicalMinimum

@JvmStatic

fun logicalMinimum(expr: Expression, vararg others: Any): Expression

The minimum function of expr and others.

@JvmStatic

fun logicalMinimum(fieldName: String, vararg others: Any): Expression

The minimum function of the field fieldName and others.

ltrim

@JvmStatic

fun ltrim(stringExpression: Expression): Expression

The ltrim function of stringExpression.

@JvmStatic

fun ltrim(fieldName: String): Expression

The ltrim function of the field fieldName.

ltrimValue

@JvmStatic

fun ltrimValue(stringExpression: Expression, valuesToTrim: Expression): Expression

@JvmStatic

fun ltrimValue(stringExpression: Expression, valuesToTrim: String): Expression

The ltrim function of stringExpression and valuesToTrim.

@JvmStatic

fun ltrimValue(fieldName: String, valuesToTrim: Expression): Expression

@JvmStatic

fun ltrimValue(fieldName: String, valuesToTrim: String): Expression

The ltrim function of the field fieldName and valuesToTrim.

map

@JvmStatic

fun map(elements: Map<String, Any>): Expression

map of elements.flatMap { listOf(constant(it.key), toExprOrConstant(it.value)) }.toTypedArray().

mapEntries

@JvmStatic

fun mapEntries(mapExpr: Expression): Expression

The map_entries function of mapExpr.

@JvmStatic

fun mapEntries(mapField: String): Expression

The map_entries function of the field mapField.

mapGet

@JvmStatic

fun mapGet(mapExpression: Expression, keyExpression: Expression): Expression

The map_get function of mapExpression and keyExpression.

@JvmStatic

fun mapGet(mapExpression: Expression, key: String): Expression

The map_get function of mapExpression and key.

@JvmStatic

fun mapGet(fieldName: String, keyExpression: Expression): Expression

The map_get function of the field fieldName and keyExpression.

@JvmStatic

fun mapGet(fieldName: String, key: String): Expression

The map_get function of the field fieldName and key.

mapKeys

@JvmStatic

fun mapKeys(mapExpr: Expression): Expression

The map_keys function of mapExpr.

@JvmStatic

fun mapKeys(mapField: String): Expression

The map_keys function of the field mapField.

mapMerge

@JvmStatic

fun mapMerge(firstMap: Expression, secondMap: Expression, vararg otherMaps: Expression): Expression

The map_merge function of firstMap, secondMap and otherMaps.

@JvmStatic

fun mapMerge(firstMapFieldName: String, secondMap: Expression, vararg otherMaps: Expression): Expression

The map_merge function of the field firstMapFieldName, secondMap and otherMaps.

mapRemove

@JvmStatic

fun mapRemove(mapExpr: Expression, key: Expression): Expression

@JvmStatic

fun mapRemove(mapExpr: Expression, key: String): Expression

The map_remove function of mapExpr and key.

@JvmStatic

fun mapRemove(mapField: String, key: Expression): Expression

@JvmStatic

fun mapRemove(mapField: String, key: String): Expression

The map_remove function of the field mapField and key.

mapSet

@JvmStatic

fun mapSet(mapExpr: Expression, key: Expression, value: Expression, vararg moreKeyValues: Expression): Expression

@JvmStatic

fun mapSet(mapExpr: Expression, key: String, value: Any?, vararg moreKeyValues: Any): Expression

The map_set function of mapExpr, key, value and moreKeyValues.

@JvmStatic

fun mapSet(mapField: String, key: Expression, value: Expression, vararg moreKeyValues: Expression): Expression

@JvmStatic

fun mapSet(mapField: String, key: String, value: Any?, vararg moreKeyValues: Any): Expression

The map_set function of the field mapField, key, value and moreKeyValues.

mapValues

@JvmStatic

fun mapValues(mapExpr: Expression): Expression

The map_values function of mapExpr.

@JvmStatic

fun mapValues(mapField: String): Expression

The map_values function of the field mapField.

mod

@JvmStatic

fun mod(dividend: Expression, divisor: Expression): Expression

@JvmStatic

fun mod(dividend: Expression, divisor: Number): Expression

The mod function of dividend and divisor.

@JvmStatic

fun mod(dividendFieldName: String, divisor: Expression): Expression

@JvmStatic

fun mod(dividendFieldName: String, divisor: Number): Expression

The mod function of the field dividendFieldName and divisor.

multiply

@JvmStatic

fun multiply(first: Expression, second: Expression): Expression

@JvmStatic

fun multiply(first: Expression, second: Number): Expression

The multiply function of first and second.

@JvmStatic

fun multiply(numericFieldName: String, second: Expression): Expression

@JvmStatic

fun multiply(numericFieldName: String, second: Number): Expression

The multiply function of the field numericFieldName and second.

nor

@JvmStatic

fun nor(condition: BooleanExpression, vararg conditions: BooleanExpression): BooleanExpression

The nor condition of condition and conditions.

not

@JvmStatic

fun not(condition: BooleanExpression): BooleanExpression

The not condition of condition.

notEqual

@JvmStatic

fun notEqual(left: Expression, right: Expression): BooleanExpression

@JvmStatic

fun notEqual(left: Expression, right: Any): BooleanExpression

The not_equal condition of left and right.

@JvmStatic

fun notEqual(fieldName: String, expression: Expression): BooleanExpression

The not_equal condition of the field fieldName and expression.

@JvmStatic

fun notEqual(fieldName: String, value: Any): BooleanExpression

The not_equal condition of the field fieldName and value.

notEqualAny

@JvmStatic

fun notEqualAny(expression: Expression, arrayExpression: Expression): BooleanExpression

The not_equal_any condition of expression and arrayExpression.

@JvmStatic

fun notEqualAny(expression: Expression, values: List<Any>): BooleanExpression

notEqualAny of expression and the array values.

@JvmStatic

fun notEqualAny(fieldName: String, arrayExpression: Expression): BooleanExpression

The not_equal_any condition of the field fieldName and arrayExpression.

@JvmStatic

fun notEqualAny(fieldName: String, values: List<Any>): BooleanExpression

notEqualAny of fieldName and the array values.

nullValue

@JvmStatic

fun nullValue(): Expression

The constant null.

@JvmStatic

fun or(condition: BooleanExpression, vararg conditions: BooleanExpression): BooleanExpression

The or condition of condition and conditions.

parent

@JvmStatic

fun parent(docRef: DocumentReference): Expression

parent of docRef.

@JvmStatic

fun parent(documentPath: Expression): Expression

The parent function of documentPath.

@JvmStatic

fun parent(documentPath: String): Expression

parent of documentPath.

pow

@JvmStatic

fun pow(numericExpr: Expression, exponent: Expression): Expression

@JvmStatic

fun pow(numericExpr: Expression, exponent: Number): Expression

The pow function of numericExpr and exponent.

@JvmStatic

fun pow(numericField: String, exponent: Expression): Expression

@JvmStatic

fun pow(numericField: String, exponent: Number): Expression

The pow function of the field numericField and exponent.

rand

@JvmStatic

fun rand(): Expression

The rand function.

rawFunction

@JvmStatic

fun rawFunction(name: String, vararg expr: Expression): Expression

The backend function name of expr.

regexContains

@JvmStatic

fun regexContains(stringExpression: Expression, pattern: Expression): BooleanExpression

@JvmStatic

fun regexContains(stringExpression: Expression, pattern: String): BooleanExpression

The regex_contains condition of stringExpression and pattern.

@JvmStatic

fun regexContains(fieldName: String, pattern: Expression): BooleanExpression

@JvmStatic

fun regexContains(fieldName: String, pattern: String): BooleanExpression

The regex_contains condition of the field fieldName and pattern.

regexFind

@JvmStatic

fun regexFind(stringExpression: Expression, pattern: Expression): Expression

@JvmStatic

fun regexFind(stringExpression: Expression, pattern: String): Expression

The regex_find function of stringExpression and pattern.

@JvmStatic

fun regexFind(fieldName: String, pattern: Expression): Expression

@JvmStatic

fun regexFind(fieldName: String, pattern: String): Expression

The regex_find function of the field fieldName and pattern.

regexFindAll

@JvmStatic

fun regexFindAll(stringExpression: Expression, pattern: Expression): Expression

@JvmStatic

fun regexFindAll(stringExpression: Expression, pattern: String): Expression

The regex_find_all function of stringExpression and pattern.

@JvmStatic

fun regexFindAll(fieldName: String, pattern: Expression): Expression

@JvmStatic

fun regexFindAll(fieldName: String, pattern: String): Expression

The regex_find_all function of the field fieldName and pattern.

regexMatch

@JvmStatic

fun regexMatch(stringExpression: Expression, pattern: Expression): BooleanExpression

@JvmStatic

fun regexMatch(stringExpression: Expression, pattern: String): BooleanExpression

The regex_match condition of stringExpression and pattern.

@JvmStatic

fun regexMatch(fieldName: String, pattern: Expression): BooleanExpression

@JvmStatic

fun regexMatch(fieldName: String, pattern: String): BooleanExpression

The regex_match condition of the field fieldName and pattern.

reverse

@JvmStatic

fun reverse(stringExpression: Expression): Expression

The reverse function of stringExpression.

@JvmStatic

fun reverse(fieldName: String): Expression

The reverse function of the field fieldName.

round

@JvmStatic

fun round(numericExpr: Expression): Expression

The round function of numericExpr.

@JvmStatic

fun round(numericField: String): Expression

The round function of the field numericField.

roundToPrecision

@JvmStatic

fun roundToPrecision(numericExpr: Expression, decimalPlace: Expression): Expression

@JvmStatic

fun roundToPrecision(numericExpr: Expression, decimalPlace: Int): Expression

The round function of numericExpr and decimalPlace.

@JvmStatic

fun roundToPrecision(numericField: String, decimalPlace: Expression): Expression

@JvmStatic

fun roundToPrecision(numericField: String, decimalPlace: Int): Expression

The round function of the field numericField and decimalPlace.

rtrim

@JvmStatic

fun rtrim(stringExpression: Expression): Expression

The rtrim function of stringExpression.

@JvmStatic

fun rtrim(fieldName: String): Expression

The rtrim function of the field fieldName.

rtrimValue

@JvmStatic

fun rtrimValue(stringExpression: Expression, valuesToTrim: Expression): Expression

@JvmStatic

fun rtrimValue(stringExpression: Expression, valuesToTrim: String): Expression

The rtrim function of stringExpression and valuesToTrim.

@JvmStatic

fun rtrimValue(fieldName: String, valuesToTrim: Expression): Expression

@JvmStatic

fun rtrimValue(fieldName: String, valuesToTrim: String): Expression

The rtrim function of the field fieldName and valuesToTrim.

score

@JvmStatic

fun score(): Expression

The score function. Beta in the Android SDK.

split

@JvmStatic

fun split(value: Expression, delimiter: Blob): Expression

@JvmStatic

fun split(value: Expression, delimiter: Expression): Expression

@JvmStatic

fun split(value: Expression, delimiter: String): Expression

The split function of value and delimiter.

@JvmStatic

fun split(fieldName: String, delimiter: Blob): Expression

@JvmStatic

fun split(fieldName: String, delimiter: Expression): Expression

@JvmStatic

fun split(fieldName: String, delimiter: String): Expression

The split function of the field fieldName and delimiter.

sqrt

@JvmStatic

fun sqrt(numericExpr: Expression): Expression

The sqrt function of numericExpr.

@JvmStatic

fun sqrt(numericField: String): Expression

The sqrt function of the field numericField.

startsWith

@JvmStatic

fun startsWith(stringExpr: Expression, prefix: Expression): BooleanExpression

@JvmStatic

fun startsWith(stringExpr: Expression, prefix: String): BooleanExpression

The starts_with condition of stringExpr and prefix.

@JvmStatic

fun startsWith(fieldName: String, prefix: Expression): BooleanExpression

@JvmStatic

fun startsWith(fieldName: String, prefix: String): BooleanExpression

The starts_with condition of the field fieldName and prefix.

stringConcat

@JvmStatic

fun stringConcat(firstString: Expression, vararg otherStrings: Expression): Expression

@JvmStatic

fun stringConcat(firstString: Expression, vararg otherStrings: Any): Expression

The string_concat function of firstString and otherStrings.

@JvmStatic

fun stringConcat(fieldName: String, vararg otherStrings: Expression): Expression

@JvmStatic

fun stringConcat(fieldName: String, vararg otherStrings: Any): Expression

The string_concat function of the field fieldName and otherStrings.

stringContains

@JvmStatic

fun stringContains(stringExpression: Expression, substring: Expression): BooleanExpression

@JvmStatic

fun stringContains(stringExpression: Expression, substring: String): BooleanExpression

The string_contains condition of stringExpression and substring.

@JvmStatic

fun stringContains(fieldName: String, substring: Expression): BooleanExpression

@JvmStatic

fun stringContains(fieldName: String, substring: String): BooleanExpression

The string_contains condition of the field fieldName and substring.

stringIndexOf

@JvmStatic

fun stringIndexOf(stringExpression: Expression, substring: Expression): Expression

@JvmStatic

fun stringIndexOf(stringExpression: Expression, substring: String): Expression

The string_index_of function of stringExpression and substring.

@JvmStatic

fun stringIndexOf(fieldName: String, substring: Expression): Expression

@JvmStatic

fun stringIndexOf(fieldName: String, substring: String): Expression

The string_index_of function of the field fieldName and substring.

stringRepeat

@JvmStatic

fun stringRepeat(stringExpression: Expression, count: Expression): Expression

@JvmStatic

fun stringRepeat(stringExpression: Expression, count: Int): Expression

The string_repeat function of stringExpression and count.

@JvmStatic

fun stringRepeat(fieldName: String, count: Expression): Expression

@JvmStatic

fun stringRepeat(fieldName: String, count: Int): Expression

The string_repeat function of the field fieldName and count.

stringReplaceAll

@JvmStatic

fun stringReplaceAll(stringExpression: Expression, oldValue: Expression, newValue: Expression): Expression

@JvmStatic

fun stringReplaceAll(stringExpression: Expression, oldValue: String, newValue: String): Expression

The string_replace_all function of stringExpression, oldValue and newValue.

@JvmStatic

fun stringReplaceAll(fieldName: String, oldValue: Expression, newValue: Expression): Expression

@JvmStatic

fun stringReplaceAll(fieldName: String, oldValue: String, newValue: String): Expression

The string_replace_all function of the field fieldName, oldValue and newValue.

stringReplaceOne

@JvmStatic

fun stringReplaceOne(stringExpression: Expression, oldValue: Expression, newValue: Expression): Expression

@JvmStatic

fun stringReplaceOne(stringExpression: Expression, oldValue: String, newValue: String): Expression

The string_replace_one function of stringExpression, oldValue and newValue.

@JvmStatic

fun stringReplaceOne(fieldName: String, oldValue: Expression, newValue: Expression): Expression

@JvmStatic

fun stringReplaceOne(fieldName: String, oldValue: String, newValue: String): Expression

The string_replace_one function of the field fieldName, oldValue and newValue.

stringReverse

@JvmStatic

fun stringReverse(str: Expression): Expression

The string_reverse function of str.

@JvmStatic

fun stringReverse(fieldName: String): Expression

The string_reverse function of the field fieldName.

substring

@JvmStatic

fun substring(stringExpression: Expression, index: Expression, length: Expression): Expression

The substring function of stringExpression, index and length.

@JvmStatic

fun substring(fieldName: String, index: Int, length: Int): Expression

The substring function of the field fieldName, index and length.

subtract

@JvmStatic

fun subtract(minuend: Expression, subtrahend: Expression): Expression

@JvmStatic

fun subtract(minuend: Expression, subtrahend: Number): Expression

The subtract function of minuend and subtrahend.

@JvmStatic

fun subtract(numericFieldName: String, subtrahend: Expression): Expression

@JvmStatic

fun subtract(numericFieldName: String, subtrahend: Number): Expression

The subtract function of the field numericFieldName and subtrahend.

switchOn

@JvmStatic

fun switchOn(condition: BooleanExpression, result: Any, vararg others: Any): Expression

The switch_on function of condition, result and others.

timestampAdd

@JvmStatic

fun timestampAdd(timestamp: Expression, unit: Expression, amount: Expression): Expression

@JvmStatic

fun timestampAdd(timestamp: Expression, unit: String, amount: Long): Expression

The timestamp_add function of timestamp, unit and amount.

@JvmStatic

fun timestampAdd(fieldName: String, unit: Expression, amount: Expression): Expression

@JvmStatic

fun timestampAdd(fieldName: String, unit: String, amount: Long): Expression

The timestamp_add function of the field fieldName, unit and amount.

timestampDiff

@JvmStatic

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

The timestamp_diff function of end, start and unit.

@JvmStatic

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

timestampDiff of end, start and unit.

@JvmStatic

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

timestampDiff of end, the field startFieldName and unit.

@JvmStatic

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

timestampDiff of the field endFieldName, start and unit.

@JvmStatic

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

timestampDiff of the field endFieldName, the field startFieldName and unit.

timestampExtract

@JvmStatic

fun timestampExtract(timestamp: Expression, part: Expression): Expression

The timestamp_extract function of timestamp and part.

@JvmStatic

fun timestampExtract(timestamp: Expression, part: String): Expression

timestampExtract of timestamp and part.

@JvmStatic

fun timestampExtract(fieldName: String, part: Expression): Expression

@JvmStatic

fun timestampExtract(fieldName: String, part: String): Expression

timestampExtract of the field fieldName and part.

timestampExtractWithTimezone

@JvmStatic

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

The timestamp_extract function of timestamp, part and timezone.

@JvmStatic

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

@JvmStatic

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

@JvmStatic

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

timestampExtractWithTimezone of timestamp, part and timezone.

@JvmStatic

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

@JvmStatic

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

@JvmStatic

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

@JvmStatic

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

timestampExtractWithTimezone of the field fieldName, part and timezone.

timestampSubtract

@JvmStatic

fun timestampSubtract(timestamp: Expression, unit: Expression, amount: Expression): Expression

@JvmStatic

fun timestampSubtract(timestamp: Expression, unit: String, amount: Long): Expression

The timestamp_subtract function of timestamp, unit and amount.

@JvmStatic

fun timestampSubtract(fieldName: String, unit: Expression, amount: Expression): Expression

@JvmStatic

fun timestampSubtract(fieldName: String, unit: String, amount: Long): Expression

The timestamp_subtract function of the field fieldName, unit and amount.

timestampToUnixMicros

@JvmStatic

fun timestampToUnixMicros(expr: Expression): Expression

The timestamp_to_unix_micros function of expr.

@JvmStatic

fun timestampToUnixMicros(fieldName: String): Expression

The timestamp_to_unix_micros function of the field fieldName.

timestampToUnixMillis

@JvmStatic

fun timestampToUnixMillis(expr: Expression): Expression

The timestamp_to_unix_millis function of expr.

@JvmStatic

fun timestampToUnixMillis(fieldName: String): Expression

The timestamp_to_unix_millis function of the field fieldName.

timestampToUnixSeconds

@JvmStatic

fun timestampToUnixSeconds(expr: Expression): Expression

The timestamp_to_unix_seconds function of expr.

@JvmStatic

fun timestampToUnixSeconds(fieldName: String): Expression

The timestamp_to_unix_seconds function of the field fieldName.

timestampTruncate

@JvmStatic

fun timestampTruncate(timestamp: Expression, granularity: Expression): Expression

@JvmStatic

fun timestampTruncate(timestamp: Expression, granularity: String): Expression

The timestamp_trunc function of timestamp and granularity.

@JvmStatic

fun timestampTruncate(fieldName: String, granularity: Expression): Expression

@JvmStatic

fun timestampTruncate(fieldName: String, granularity: String): Expression

The timestamp_trunc function of the field fieldName and granularity.

timestampTruncateWithTimezone

@JvmStatic

fun timestampTruncateWithTimezone(timestamp: Expression, granularity: Expression, timezone: Expression): Expression

@JvmStatic

fun timestampTruncateWithTimezone(timestamp: Expression, granularity: Expression, timezone: String): Expression

@JvmStatic

fun timestampTruncateWithTimezone(timestamp: Expression, granularity: String, timezone: Expression): Expression

@JvmStatic

fun timestampTruncateWithTimezone(timestamp: Expression, granularity: String, timezone: String): Expression

The timestamp_trunc function of timestamp, granularity and timezone.

@JvmStatic

fun timestampTruncateWithTimezone(fieldName: String, granularity: Expression, timezone: Expression): Expression

@JvmStatic

fun timestampTruncateWithTimezone(fieldName: String, granularity: Expression, timezone: String): Expression

@JvmStatic

fun timestampTruncateWithTimezone(fieldName: String, granularity: String, timezone: Expression): Expression

@JvmStatic

fun timestampTruncateWithTimezone(fieldName: String, granularity: String, timezone: String): Expression

The timestamp_trunc function of the field fieldName, granularity and timezone.

toLower

@JvmStatic

fun toLower(stringExpression: Expression): Expression

The to_lower function of stringExpression.

@JvmStatic

fun toLower(fieldName: String): Expression

The to_lower function of the field fieldName.

toUpper

@JvmStatic

fun toUpper(stringExpression: Expression): Expression

The to_upper function of stringExpression.

@JvmStatic

fun toUpper(fieldName: String): Expression

The to_upper function of the field fieldName.

trim

@JvmStatic

fun trim(stringExpression: Expression): Expression

The trim function of stringExpression.

@JvmStatic

fun trim(fieldName: String): Expression

The trim function of the field fieldName.

trimValue

@JvmStatic

fun trimValue(stringExpression: Expression, valueToTrim: Expression): Expression

The trim function of stringExpression and valueToTrim.

@JvmStatic

fun trimValue(fieldName: String, valueToTrim: String): Expression

The trim function of the field fieldName and valueToTrim.

trunc

@JvmStatic

fun trunc(numericExpr: Expression): Expression

The trunc function of numericExpr.

@JvmStatic

fun trunc(numericField: String): Expression

The trunc function of the field numericField.

truncToPrecision

@JvmStatic

fun truncToPrecision(numericExpr: Expression, decimalPlace: Expression): Expression

@JvmStatic

fun truncToPrecision(numericExpr: Expression, decimalPlace: Int): Expression

The trunc function of numericExpr and decimalPlace.

@JvmStatic

fun truncToPrecision(numericField: String, decimalPlace: Expression): Expression

@JvmStatic

fun truncToPrecision(numericField: String, decimalPlace: Int): Expression

The trunc function of the field numericField and decimalPlace.

type

@JvmStatic

fun type(expr: Expression): Expression

The type function of expr.

@JvmStatic

fun type(fieldName: String): Expression

The type function of the field fieldName.

unixMicrosToTimestamp

@JvmStatic

fun unixMicrosToTimestamp(expr: Expression): Expression

The unix_micros_to_timestamp function of expr.

@JvmStatic

fun unixMicrosToTimestamp(fieldName: String): Expression

The unix_micros_to_timestamp function of the field fieldName.

unixMillisToTimestamp

@JvmStatic

fun unixMillisToTimestamp(expr: Expression): Expression

The unix_millis_to_timestamp function of expr.

@JvmStatic

fun unixMillisToTimestamp(fieldName: String): Expression

The unix_millis_to_timestamp function of the field fieldName.

unixSecondsToTimestamp

@JvmStatic

fun unixSecondsToTimestamp(expr: Expression): Expression

The unix_seconds_to_timestamp function of expr.

@JvmStatic

fun unixSecondsToTimestamp(fieldName: String): Expression

The unix_seconds_to_timestamp function of the field fieldName.

variable

@JvmStatic

fun variable(name: String): Expression

A reference to the variable name, bound by the define stage or by arrayFilter and arrayTransform.

vector

@JvmStatic

fun vector(vector: VectorValue): Expression

The constant vector vector.

@JvmStatic

fun vector(vector: DoubleArray): Expression

A constant vector of vector.

vectorLength

@JvmStatic

fun vectorLength(vectorExpression: Expression): Expression

The vector_length function of vectorExpression.

@JvmStatic

fun vectorLength(fieldName: String): Expression

The vector_length function of the field fieldName.

xor

@JvmStatic

fun xor(condition: BooleanExpression, vararg conditions: BooleanExpression): BooleanExpression

The xor condition of condition and conditions.