Package com.couchbase.client.java.query.dsl.functions

Class ArrayFunctions

  • @Experimental
@Public
public class ArrayFunctions
extends Object
    DSL for N1QL functions in the Array category. You can use array functions to evaluate arrays, perform computations on elements in an array, and to return a new array based on a transformation.
    Since:
    2.2
    Author:
    Simon Baslé

    • Method Detail

      • arrayAppend

        public static Expression arrayAppend​(Expression expression,
                                     Expression value)
        Returned expression results in new array with value appended.

      • arrayAppend

        public static Expression arrayAppend​(String expression,
                                     Expression value)
        Returned expression results in new array with value appended.

      • arrayAppend

        public static Expression arrayAppend​(JsonArray array,
                                     Expression value)
        Returned expression results in new array with value appended.

      • arrayAvg

        public static Expression arrayAvg​(Expression expression)
        Returned expression results in arithmetic mean (average) of all the non-NULL number values in the array, or NULL if there are no such values.

      • arrayAvg

        public static Expression arrayAvg​(String expression)
        Returned expression results in arithmetic mean (average) of all the non-NULL number values in the array, or NULL if there are no such values.

      • arrayAvg

        public static Expression arrayAvg​(JsonArray array)
        Returned expression results in arithmetic mean (average) of all the non-NULL number values in the array, or NULL if there are no such values.

      • arrayConcat

        public static Expression arrayConcat​(Expression expression1,
                                     Expression expression2)
        Returned expression results in new array with the concatenation of the input arrays.

      • arrayConcat

        public static Expression arrayConcat​(String expression1,
                                     String expression2)
        Returned expression results in new array with the concatenation of the input arrays.

      • arrayConcat

        public static Expression arrayConcat​(JsonArray array1,
                                     JsonArray array2)
        Returned expression results in new array with the concatenation of the input arrays.

      • arrayContains

        public static Expression arrayContains​(Expression expression,
                                       Expression value)
        Returned expression results in true if the array contains value.

      • arrayContains

        public static Expression arrayContains​(String expression,
                                       Expression value)
        Returned expression results in true if the array contains value.

      • arrayContains

        public static Expression arrayContains​(JsonArray array,
                                       Expression value)
        Returned expression results in true if the array contains value.

      • arrayCount

        public static Expression arrayCount​(Expression expression)
        Returned expression results in count of all the non-NULL values in the array, or zero if there are no such values.

      • arrayCount

        public static Expression arrayCount​(String expression)
        Returned expression results in count of all the non-NULL values in the array, or zero if there are no such values.

      • arrayCount

        public static Expression arrayCount​(JsonArray array)
        Returned expression results in count of all the non-NULL values in the array, or zero if there are no such values.

      • arrayDistinct

        public static Expression arrayDistinct​(Expression expression)
        Returned expression results in new array with distinct elements of input array.

      • arrayDistinct

        public static Expression arrayDistinct​(String expression)
        Returned expression results in new array with distinct elements of input array.

      • arrayDistinct

        public static Expression arrayDistinct​(JsonArray array)
        Returned expression results in new array with distinct elements of input array.

      • arrayIfNull

        public static Expression arrayIfNull​(Expression expression)
        Returned expression results in the first non-NULL value in the array, or NULL.

      • arrayIfNull

        public static Expression arrayIfNull​(String expression)
        Returned expression results in the first non-NULL value in the array, or NULL.

      • arrayIfNull

        public static Expression arrayIfNull​(JsonArray array)
        Returned expression results in the first non-NULL value in the array, or NULL.

      • arrayLength

        public static Expression arrayLength​(Expression expression)
        Returned expression results in the number of elements in the array.

      • arrayLength

        public static Expression arrayLength​(String expression)
        Returned expression results in the number of elements in the array.

      • arrayLength

        public static Expression arrayLength​(JsonArray array)
        Returned expression results in the number of elements in the array.

      • arrayMax

        public static Expression arrayMax​(Expression expression)
        Returned expression results in the largest non-NULL, non-MISSING array element, in N1QL collation order.

      • arrayMax

        public static Expression arrayMax​(String expression)
        Returned expression results in the largest non-NULL, non-MISSING array element, in N1QL collation order.

      • arrayMax

        public static Expression arrayMax​(JsonArray array)
        Returned expression results in the largest non-NULL, non-MISSING array element, in N1QL collation order.

      • arrayMin

        public static Expression arrayMin​(Expression expression)
        Returned expression results in the smallest non-NULL, non-MISSING array element, in N1QL collation order.

      • arrayMin

        public static Expression arrayMin​(String expression)
        Returned expression results in the smallest non-NULL, non-MISSING array element, in N1QL collation order.

      • arrayMin

        public static Expression arrayMin​(JsonArray array)
        Returned expression results in the smallest non-NULL, non-MISSING array element, in N1QL collation order.

      • arrayPosition

        public static Expression arrayPosition​(Expression expression,
                                       Expression value)
        Returned expression results in the first position of value within the array, or -1. Array position is zero-based, i.e. the first position is 0.

      • arrayPosition

        public static Expression arrayPosition​(String expression,
                                       Expression value)
        Returned expression results in the first position of value within the array, or -1. Array position is zero-based, i.e. the first position is 0.

      • arrayPosition

        public static Expression arrayPosition​(JsonArray array,
                                       Expression value)
        Returned expression results in the first position of value within the array, or -1. Array position is zero-based, i.e. the first position is 0.

      • arrayPrepend

        public static Expression arrayPrepend​(Expression expression,
                                      Expression value)
        Returned expression results in the new array with value pre-pended.

      • arrayPrepend

        public static Expression arrayPrepend​(String expression,
                                      Expression value)
        Returned expression results in the new array with value pre-pended.

      • arrayPrepend

        public static Expression arrayPrepend​(JsonArray array,
                                      Expression value)
        Returned expression results in the new array with value pre-pended.

      • arrayPut

        public static Expression arrayPut​(Expression expression,
                                  Expression value)
        Returned expression results in new array with value appended, if value is not already present, otherwise the unmodified input array.

      • arrayPut

        public static Expression arrayPut​(String expression,
                                  Expression value)
        Returned expression results in new array with value appended, if value is not already present, otherwise the unmodified input array.

      • arrayPut

        public static Expression arrayPut​(JsonArray array,
                                  Expression value)
        Returned expression results in new array with value appended, if value is not already present, otherwise the unmodified input array.

      • arrayRange

        public static Expression arrayRange​(long start,
                                    long end,
                                    long step)
        Returned expression results in new array of numbers, from start until the largest number less than end. Successive numbers are incremented by step. If step is omitted, the default is 1. If step is negative, decrements until the smallest number greater than end.

      • arrayRange

        public static Expression arrayRange​(long start,
                                    long end)
        Returned expression results in new array of numbers, from start until the largest number less than end. Successive numbers are incremented by 1.

      • arrayRemove

        public static Expression arrayRemove​(Expression expression,
                                     Expression value)
        Returned expression results in new array with all occurrences of value removed.

      • arrayRemove

        public static Expression arrayRemove​(String expression,
                                     Expression value)
        Returned expression results in new array with all occurrences of value removed.

      • arrayRemove

        public static Expression arrayRemove​(JsonArray array,
                                     Expression value)
        Returned expression results in new array with all occurrences of value removed.

      • arrayRepeat

        public static Expression arrayRepeat​(Expression value,
                                     long n)
        Returned expression results in new array with value repeated n times.

      • arrayRepeat

        public static Expression arrayRepeat​(String value,
                                     long n)
        Returned expression results in new array with the string "value" repeated n times.

      • arrayRepeat

        public static Expression arrayRepeat​(Number value,
                                     long n)
        Returned expression results in new array with value repeated n times.

      • arrayRepeat

        public static Expression arrayRepeat​(boolean value,
                                     long n)
        Returned expression results in new array with value repeated n times.

      • arrayReplace

        public static Expression arrayReplace​(Expression expression,
                                      Expression value1,
                                      Expression value2)
        Returned expression results in new array with all occurrences of value1 replaced by value2.

      • arrayReplace

        public static Expression arrayReplace​(String expression,
                                      Expression value1,
                                      Expression value2)
        Returned expression results in new array with all occurrences of value1 replaced by value2.

      • arrayReplace

        public static Expression arrayReplace​(JsonArray array,
                                      Expression value1,
                                      Expression value2)
        Returned expression results in new array with all occurrences of value1 replaced by value2.

      • arrayReplace

        public static Expression arrayReplace​(Expression expression,
                                      Expression value1,
                                      Expression value2,
                                      long n)
        Returned expression results in new array with at most n occurrences of value1 replaced with value2.

      • arrayReplace

        public static Expression arrayReplace​(String expression,
                                      Expression value1,
                                      Expression value2,
                                      long n)
        Returned expression results in new array with at most n occurrences of value1 replaced with value2.

      • arrayReplace

        public static Expression arrayReplace​(JsonArray array,
                                      Expression value1,
                                      Expression value2,
                                      long n)
        Returned expression results in new array with at most n occurrences of value1 replaced with value2.

      • arrayReverse

        public static Expression arrayReverse​(Expression expression)
        Returned expression results in new array with all elements in reverse order.

      • arrayReverse

        public static Expression arrayReverse​(String expression)
        Returned expression results in new array with all elements in reverse order.

      • arrayReverse

        public static Expression arrayReverse​(JsonArray array)
        Returned expression results in new array with all elements in reverse order.

      • arraySort

        public static Expression arraySort​(Expression expression)
        Returned expression results in new array with elements sorted in N1QL collation order.

      • arraySort

        public static Expression arraySort​(String expression)
        Returned expression results in new array with elements sorted in N1QL collation order.

      • arraySort

        public static Expression arraySort​(JsonArray array)
        Returned expression results in new array with elements sorted in N1QL collation order.

      • arraySum

        public static Expression arraySum​(Expression expression)
        Returned expression results in the sum of all the non-NULL number values in the array, or zero if there are no such values.

      • arraySum

        public static Expression arraySum​(String expression)
        Returned expression results in the sum of all the non-NULL number values in the array, or zero if there are no such values.

      • arraySum

        public static Expression arraySum​(JsonArray array)
        Returned expression results in the sum of all the non-NULL number values in the array, or zero if there are no such values.