Package com.faunadb.client.query

Class Language

  • public final class Language
extends Object
    The Language class contains static constructors for the FaunaDB Query Language expressions. This class is intended to be statically imported into your code with: import static com.faunadb.client.query.Language.*;

    Each method in the Language class constructs a new Expr instance. No computation is executed until the expression is evaluated by the FaunaDB server.

    Example: 
    
   // Creates a new expression that, once executed, it will create a new instance
   // of the user collection with an username and password fields.
   Expr createUserExpr = Create(Collection("user"), Obj("data", Obj(
     "username", Value("bob"),
     "password", Value("abc123"),
   )));

   // Executes the expression created above and get its result.
   Value result = client.query(createUserExpr).get();
    See Also:
    FaunaDB Query API

    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static Expr Abort​(Expr msg)
      Aborts the current transaction with a given message.
      static Expr Abort​(String msg)
      Aborts the current transaction with a given message.
      static Expr Abs​(Expr value)
      Computes the abs of a number.
      static Expr Abs​(Double value)
      Computes the abs of a number.
      static Expr Abs​(Long value)
      Computes the abs of a number.
      static Expr AccessProvider​(Expr name)
      Creates a reference for the access provider name.
      static Expr AccessProvider​(Expr name, Expr database)
      Creates a reference for the given access provider name, scoped to the database provided.
      static Expr AccessProvider​(String name)
      Creates a reference for the access provider name.
      static Expr AccessProvider​(String name, Expr database)
      Creates a reference for the given access provider name, scoped to the database provided.
      static Expr AccessProviders()
      Returns a reference to a set of all access providers in the database.
      static Expr AccessProviders​(Expr scope)
      Returns a reference to a set of all access providers in the database.
      static Expr Acos​(Expr value)
      Computes the acos of a numbers.
      static Expr Acos​(Double value)
      Computes the acos of a numbers.
      static Expr Add​(Expr... values)
      Computes the sum of a list of numbers.
      static Expr Add​(List<? extends Expr> values)
      Computes the sum of a list of numbers.
      static Expr All​(Expr collection)
      Evaluates to true if all elements of the collection is true.
      static Expr And​(Expr... values)
      Returns true if all elements in the given collection are true, and false otherwise.
      static Expr And​(List<? extends Expr> values)
      Returns true if all elements in the given collection are true, and false otherwise.
      static Expr Any​(Expr collection)
      Evaluates to true if any element of the collection is true.
      static Expr Append​(Expr elements, Expr collection)
      Returns a new collection with the given elements appended to the provided collection.
      static Expr Arr​(Expr... values)
      Creates a new array containing with the values provided.
      static Expr Arr​(List<? extends Expr> values)
      Creates a new array wrapping the provided List.
      static Expr Asin​(Expr value)
      Computes the asin of a numbers.
      static Expr Asin​(Double value)
      Computes the asin of a numbers.
      static Expr At​(Expr timestamp, Expr expr)
      Execute the reads associated with the given expression at the timestamp provided.
      static Expr At​(Instant timestamp, Expr expr)
      Execute the reads associated with the given expression at the timestamp provided.
      static Expr Atan​(Expr value)
      Computes the atan of a numbers.
      static Expr Atan​(Double value)
      Computes the atan of a numbers.
      static Expr BitAnd​(Expr... values)
      Computes the bitwise and of a list of numbers.
      static Expr BitAnd​(List<? extends Expr> values)
      Computes the bitwise and of a list of numbers.
      static Expr BitNot​(Expr value)
      Computes the bitwise NOT of a numbers.
      static Expr BitNot​(Long value)
      Computes the bitwise NOT of a numbers.
      static Expr BitOr​(Expr... values)
      Computes the bitwise OR of a list of numbers.
      static Expr BitOr​(List<? extends Expr> values)
      Computes the bitwise OR of a list of numbers.
      static Expr BitXor​(Expr... values)
      Computes the bitwise XOR of a list of numbers.
      static Expr BitXor​(List<? extends Expr> values)
      Computes the bitwise XOR of a list of numbers.
      static Expr Call​(Expr ref, Expr... args)
      Calls the given user defined function with the arguments provided.
      static Expr Call​(Expr ref, List<? extends Expr> args)
      Calls the given user defined function with the arguments provided.
      static Expr Casefold​(Expr str)
      Normalizes strings according to the Unicode Standard, section 5.18 "Case Mappings".
      static Expr Casefold​(Expr str, Expr normalizer)
      Normalizes strings according to the Unicode Standard, section 5.18 "Case Mappings", and the normalizer provided.
      static Expr Casefold​(Expr str, Language.Normalizer normalizer)
      Normalizes strings according to the Unicode Standard, section 5.18 "Case Mappings", and the normalizer provided.
      static Expr Casefold​(String str)
      Normalizes strings according to the Unicode Standard, section 5.18 "Case Mappings".
      static Expr Casefold​(String str, Expr normalizer)
      Normalizes strings according to the Unicode Standard, section 5.18 "Case Mappings", and the normalizer provided.
      static Expr Casefold​(String str, Language.Normalizer normalizer)
      Normalizes strings according to the Unicode Standard, section 5.18 "Case Mappings", and the normalizer provided.
      static Expr Ceil​(Expr value)
      Computes the Ceil of a number.
      static Expr Ceil​(Double value)
      Computes the Ceil of a number.
      static Expr Ceil​(Long value)
      Computes the Ceil of a number.
      static Expr Class​(Expr name)
      Deprecated.
      use Collection instead
      static Expr Class​(Expr name, Expr database)
      Deprecated.
      use Collection instead
      static Expr Class​(String name)
      Deprecated.
      use Collection instead
      static Expr Class​(String name, Expr database)
      Deprecated.
      use Collection instead
      static Expr Classes()
      Deprecated.
      use Collections instead
      static Expr Classes​(Expr scope)
      Deprecated.
      use Collection instead
      static Expr Collection​(Expr name)
      Creates a new reference for the given collection name.
      static Expr Collection​(Expr name, Expr database)
      Creates a reference for the given collection name, scoped to the database provided.
      static Expr Collection​(String name)
      Creates a new reference for the given collection name.
      static Expr Collection​(String name, Expr database)
      Creates a reference for the given collection name, scoped to the database provided.
      static Expr Collections()
      Returns a reference to a set of all collections in the database.
      static Expr Collections​(Expr scope)
      Returns a reference to a set of all collections in the specified database.
      static Expr Concat​(Expr terms)
      Concatenates a list of strings into a single string value.
      static Expr Concat​(Expr terms, Expr separator)
      Concatenates a list of strings into a single string value using the separator provided.
      static Expr Contains​(Expr path, Expr in)
      Deprecated.
      use ContainsPath instead
      static Expr Contains​(Language.Path path, Expr in)
      Deprecated.
      use ContainsPath instead
      static Expr ContainsField​(Expr field, Expr in)
      Returns true if the target Expr contains the given field, and false otherwise.
      static Expr ContainsPath​(Expr path, Expr in)
      Returns true if the target value contains the given path, and false otherwise.
      static Expr ContainsPath​(Language.Path path, Expr in)
      Returns true if the target value contains the given path, and false otherwise.
      static Expr ContainsStr​(Expr value, Expr search)
      Returns true if the string contains the given substring, or false if otherwise
      static Expr ContainsStr​(Expr value, String search)
      Returns true if the string contains the given substring, or false if otherwise
      static Expr ContainsStr​(String value, Expr search)
      Returns true if the string contains the given substring, or false if otherwise
      static Expr ContainsStr​(String value, String search)
      Returns true if the string contains the given substring, or false if otherwise
      static Expr ContainsStrRegex​(Expr value, Expr pattern)
      Returns true if the string contains the given pattern, or false if otherwise
      static Expr ContainsStrRegex​(Expr value, String pattern)
      Returns true if the string contains the given pattern, or false if otherwise
      static Expr ContainsStrRegex​(String value, Expr pattern)
      Returns true if the string contains the given pattern, or false if otherwise
      static Expr ContainsStrRegex​(String value, String pattern)
      Returns true if the string contains the given pattern, or false if otherwise
      static Expr ContainsValue​(Expr value, Expr in)
      Returns true if the target Expr contains the given value, and false otherwise.
      static Expr Cos​(Expr value)
      Computes the cosine of a numbers.
      static Expr Cos​(Double value)
      Computes the cosine of a numbers.
      static Expr Cosh​(Expr value)
      Computes the hyperbolic cosine of a numbers.
      static Expr Cosh​(Double value)
      Computes the hyperbolic cosine of a numbers.
      static Expr Count​(Expr collection)
      Count the number of elements in the collection.
      static Expr Create​(Expr ref, Expr params)
      Creates a new document of the given collection with the parameters provided.
      static Expr CreateAccessProvider​(Expr params)
      Creates a new access provider given the params.
      static Expr CreateClass​(Expr params)
      Deprecated.
      use CreateCollection instead.
      static Expr CreateCollection​(Expr params)
      Creates a new collection in the current database.
      static Expr CreateDatabase​(Expr params)
      Creates a new database.
      static Expr CreateFunction​(Expr params)
      Creates a new user defined function in the current database.
      static Expr CreateIndex​(Expr params)
      Creates a new index in the current database.
      static Expr CreateKey​(Expr params)
      Create a new key in the current database.
      static Expr CreateRole​(Expr params)
      Creates a new user role in the current database.
      static Expr Credentials()
      Returns a reference to a set of all credentials in the database.
      static Expr Credentials​(Expr scope)
      Returns a reference to a set of all credentials in the specified database.
      static Expr CurrentIdentity()
      Returns the reference associated with the authentication token used for the current request.
      static Expr CurrentToken()
      Returns current token used for the request.
      static Expr Database​(Expr name)
      Creates a reference for the given database name.
      static Expr Database​(Expr name, Expr database)
      Creates a reference for the given database name, scoped to the database provided.
      static Expr Database​(String name)
      Creates a reference for the given database name.
      static Expr Database​(String name, Expr database)
      Creates a reference for the given database name, scoped to the database provided.
      static Expr Databases()
      Returns a reference to a set of all databases.
      static Expr Databases​(Expr scope)
      Returns a reference to a set of all databases in the specified database.
      static Expr Date​(Expr str)
      Creates a date from an ISO-8601 formatted date string.
      static Expr Date​(String str)
      Creates a date from an ISO-8601 formatted date string.
      static Expr DayOfMonth​(Expr expr)
      Returns a time expression's day of the month, from 1 to 31.
      static Expr DayOfWeek​(Expr expr)
      Returns a time expression's day of the week following ISO-8601 convention, from 1 (Monday) to 7 (Sunday).
      static Expr DayOfYear​(Expr expr)
      Returns a time expression's day of the year, from 1 to 365, or 366 in a leap year.
      static Expr Degrees​(Expr value)
      Computes the degrees of a numbers.
      static Expr Degrees​(Double value)
      Computes the degrees of a numbers.
      static Expr Degrees​(Long value)
      Computes the degrees of a numbers.
      static Expr Delete​(Expr ref)
      Delete the resource identified by the given reference.
      static Expr Difference​(Expr... sets)
      Returns the set of resources present in the first set and not in any other set provided.
      static Expr Difference​(List<? extends Expr> sets)
      Returns the set of resources present in the first set and not in any other set provided.
      static Expr Distinct​(Expr set)
      Returns a new set after removing all duplicated values.
      static Expr Divide​(Expr... values)
      Computes the quotient of a list of numbers.
      static Expr Divide​(List<? extends Expr> values)  
      static Expr Do​(Expr... exprs)
      Evaluates the given expressions sequentially evaluates its arguments, and returns the result of the last expression.
      static Expr Do​(List<? extends Expr> exprs)
      Evaluates the given expressions sequentially evaluates its arguments, and returns the result of the last expression.
      static Expr Documents​(Expr collection)
      Returns a set of all documents in the given collection.
      static Expr Drop​(long num, Expr collection)
      Returns a new collection containing after dropping the given number of elements from the provided collection.
      static Expr Drop​(Expr num, Expr collection)
      Returns a new collection containing after dropping the given number of elements from the provided collection.
      static Expr EndsWith​(Expr value, Expr search)
      Returns true if the string ends with the given suffix value, or false if otherwise
      static Expr EndsWith​(Expr value, String search)
      Returns true if the string ends with the given suffix value, or false if otherwise
      static Expr EndsWith​(String value, Expr search)
      Returns true if the string ends with the given suffix value, or false if otherwise
      static Expr EndsWith​(String value, String search)
      Returns true if the string ends with the given suffix value, or false if otherwise
      static Expr Epoch​(long num, Expr unit)
      Constructs a timestamp relative to the epoch "1970-01-01T00:00:00Z" given a unit type and a number of units.
      static Expr Epoch​(long num, Language.TimeUnit unit)
      Constructs a timestamp relative to the epoch "1970-01-01T00:00:00Z" given a unit type and a number of units.
      static Expr Epoch​(long num, String unit)
      Constructs a timestamp relative to the epoch "1970-01-01T00:00:00Z" given a unit type and a number of units.
      static Expr Epoch​(Expr num, Expr unit)
      Constructs a timestamp relative to the epoch "1970-01-01T00:00:00Z" given a unit type and a number of units.
      static Expr Epoch​(Expr num, Language.TimeUnit unit)
      Constructs a timestamp relative to the epoch "1970-01-01T00:00:00Z" given a unit type and a number of units.
      static Expr Epoch​(Expr num, String unit)
      Constructs a timestamp relative to the epoch "1970-01-01T00:00:00Z" given a unit type and a number of units.
      static Expr Equals​(Expr... values)
      Tests equivalence between a list of values.
      static Expr Equals​(List<? extends Expr> values)
      Tests equivalence between a list of values.
      static Expr Events​(Expr refSet)
      Returns the history of an document's data for the given reference.
      static Expr Exists​(Expr ref)
      Returns true if the provided reference exists, or false otherwise.
      static Expr Exists​(Expr ref, Expr timestamp)
      Returns true if the provided reference exists at a specific point in time, or false otherwise.
      static Expr Exp​(Expr value)
      Computes the exp of a numbers.
      static Expr Exp​(Double value)
      Computes the exp of a numbers.
      static Expr Exp​(Long value)
      Computes the exp of a numbers.
      static Expr Filter​(Expr collection, Expr lambda)
      Applies the given lambda to each element of the collection provided, and returns a new collection containing only the elements for which the lambda returns true.
      static Expr Filter​(Expr collection, UnaryOperator<Expr> lambda)
      Applies the given lambda to each element of the collection provided, and returns a new collection containing only the elements for which the lambda returns true.
      static Expr FindStr​(Expr value, Expr find)
      FindStr function searches a string for a substring and locates the location of the substring in the string
      static Expr FindStr​(Expr value, Expr find, long start)
      FindStr function returns FindStr function searches a string for a substring and locates the location of the substring in the string
      static Expr FindStr​(Expr value, Expr find, Expr start)
      FindStr function searches a string for a substring and locates the location of the substring in the string
      static Expr FindStr​(Expr value, String find)
      FindStr function searches a string for a substring and locates the location of the substring in the string
      static Expr FindStr​(Expr value, String find, Expr start)
      FindStr function used to searches a string for a substring and locates the location of the substring in the string
      static Expr FindStr​(String value, Expr find)
      FindStr function searches a string for a substring and locates the location of the substring in the string
      static Expr FindStr​(String value, Expr find, long start)
      FindStr function searches a string for a substring and locates the location of the substring in the string
      static Expr FindStr​(String value, String find)
      FindStr function searches a string for a substring and locates the location of the substring in the string
      static Expr FindStr​(String value, String find, long start)
      FindStr function searches a string for a substring and locates the location of the substring in the string
      static Expr FindStr​(String value, String find, Expr start)
      FindStr function searches a string for a substring and locates the location of the substring in the string
      static Expr FindStrRegex​(Expr value, Expr pattern)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(Expr value, Expr pattern, long start)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(Expr value, Expr pattern, long start, long numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(Expr value, Expr pattern, long start, Expr numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(Expr value, Expr pattern, Expr start)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(Expr value, Expr pattern, Expr start, long numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(Expr value, Expr pattern, Expr start, Expr numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(Expr value, String pattern)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(Expr value, String pattern, long start)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(Expr value, String pattern, long start, long numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(Expr value, String pattern, long start, Expr numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(Expr value, String pattern, Expr start)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(Expr value, String pattern, Expr start, long numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(Expr value, String pattern, Expr start, Expr numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, Expr pattern)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, Expr pattern, long start)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, Expr pattern, long start, long numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, Expr pattern, long start, Expr numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, Expr pattern, Expr start)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, Expr pattern, Expr start, long numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, Expr pattern, Expr start, Expr numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, String pattern)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, String pattern, long start)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, String pattern, long start, long numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, String pattern, long start, Expr numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, String pattern, Expr start)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, String pattern, Expr start, long numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr FindStrRegex​(String value, String pattern, Expr start, Expr numResults)
      FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
      static Expr Floor​(Expr value)
      Computes the floor of a numbers.
      static Expr Floor​(Double value)
      Computes the floor of a numbers.
      static Expr Floor​(Long value)
      Computes the floor of a numbers.
      static Expr Foreach​(Expr collection, Expr lambda)
      Applies the given lambda to each element of the provided collection.
      static Expr Foreach​(Expr collection, UnaryOperator<Expr> lambda)
      Applies the given lambda to each element of the provided collection.
      static Expr Format​(Expr format, Expr... values)
      Format values into a string.
      static Expr Format​(String format, Expr... values)
      Format values into a string.
      static Expr Function​(Expr name)
      Creates a reference for the given user defined function name.
      static Expr Function​(Expr name, Expr database)
      Creates a reference for the given user defined function name, scoped to the database provided.
      static Expr Function​(String name)
      Creates a reference for the given user defined function name.
      static Expr Function​(String name, Expr database)
      Creates a reference for the given user defined function name, scoped to the database provided.
      static Expr Functions()
      Returns a reference to a set of all user defined functions in the database.
      static Expr Functions​(Expr scope)
      Returns a reference to a set of all user defined functions in the specified database.
      static Expr Get​(Expr ref)
      Retrieves the document identified by the given reference.
      static Expr Get​(Expr ref, Expr timestamp)
      Retrieves the document identified by the given reference at a specific point in time.
      static Expr Get​(Expr ref, Instant timestamp)
      Retrieves the document identified by the given reference at a specific point in time.
      static Expr GT​(Expr... values)
      Returns true if the first element of the given collection is greater than the ones following, and false otherwise.
      static Expr GT​(List<? extends Expr> values)
      Returns true if the first element of the given collection is greater than the ones following, and false otherwise.
      static Expr GTE​(Expr... values)
      Returns true if the first element of the given collection is greater than or equal to the ones following, and false otherwise.
      static Expr GTE​(List<? extends Expr> values)
      Returns true if the first element of the given collection is greater than or equal to the ones following, and false otherwise.
      static Expr HasCurrentIdentity()
      Returns true if the authentication used for the request has an identity.
      static Expr HasCurrentToken()
      Returns true if the authentication used for the request has a token.
      static Expr HasIdentity()
      Deprecated.
      Use HasCurrentIdentity() instead.
      static Expr Hour​(Expr expr)
      Returns a time expression's hour of the day, from 0 to 23.
      static Expr Hypot​(Expr num)
      Hypot to calculate a hypotenuse of a isosceles right triangle give side
      static Expr Hypot​(Expr num, Expr exp)
      Hypot to calculate a hypotenuse of a right triangle give the 2 sides
      static Expr Hypot​(Expr num, Double exp)
      Hypot to calculate a hypotenuse of a right triangle give the 2 sides
      static Expr Hypot​(Double num)
      Hypot to calculate a hypotenuse of a isosceles right triangle give side
      static Expr Hypot​(Double num, Expr exp)
      Hypot to calculate a hypotenuse of a right triangle give the 2 sides
      static Expr Hypot​(Double num, Double exp)
      Hypot to calculate a hypotenuse of a right triangle give the 2 sides
      static Expr Identify​(Expr ref, Expr password)
      Checks the given password against the reference's credentials, retuning true if valid, or false otherwise.
      static Expr Identify​(Expr ref, String password)
      Checks the given password against the reference's credentials, retuning true if valid, or false otherwise.
      static Expr Identity()
      Deprecated.
      Use CurrentIdentity() instead.
      static Expr If​(Expr condition, Expr thenExpr, Expr elseExpr)
      Evaluates the then or else branch according to the given condition.
      static Expr Index​(Expr name)
      Creates a reference for the given index name.
      static Expr Index​(Expr name, Expr database)
      Creates a reference for the given index name, scoped to the database provided.
      static Expr Index​(String name)
      Creates a reference for the given index name.
      static Expr Index​(String name, Expr database)
      Creates a reference for the given index name, scoped to the database provided.
      static Expr Indexes()
      Returns a reference to a set of all indexes in the database.
      static Expr Indexes​(Expr scope)
      Returns a reference to a set of all indexes in the specified database.
      static Expr Insert​(Expr ref, Expr timestamp, Expr action, Expr params)
      Inserts a new event in the document's history.
      static Expr Insert​(Expr ref, Expr timestamp, Language.Action action, Expr params)
      Inserts a new event in the document's history.
      static Expr Intersection​(Expr... sets)
      Returns the set of resources present in all sets provided.
      static Expr Intersection​(List<? extends Expr> sets)
      Returns the set of resources present in all sets provided.
      static Expr IsArray​(Expr expr)
      Check if the expression is an array.
      static Expr IsBoolean​(Expr expr)
      Check if the expression is a boolean.
      static Expr IsBytes​(Expr expr)
      Check if the expression is a byte array.
      static Expr IsCollection​(Expr expr)
      Check if the expression is a collection.
      static Expr IsCredentials​(Expr expr)
      Check if the expression is a credentials.
      static Expr IsDatabase​(Expr expr)
      Check if the expression is a database.
      static Expr IsDate​(Expr expr)
      Check if the expression is a date.
      static Expr IsDoc​(Expr expr)
      Check if the expression is a document (either a reference or an instance).
      static Expr IsDouble​(Expr expr)
      Check if the expression is a double.
      static Expr IsEmpty​(Expr collection)
      Returns true if the given collection is empty, or false otherwise.
      static Expr IsFunction​(Expr expr)
      Check if the expression is a function.
      static Expr IsIndex​(Expr expr)
      Check if the expression is an index.
      static Expr IsInteger​(Expr expr)
      Check if the expression is an integer.
      static Expr IsKey​(Expr expr)
      Check if the expression is a key.
      static Expr IsLambda​(Expr expr)
      Check if the expression is a lambda.
      static Expr IsNonEmpty​(Expr collection)
      Returns true if the given collection is not empty, or false otherwise.
      static Expr IsNull​(Expr expr)
      Check if the expression is null.
      static Expr IsNumber​(Expr expr)
      Check if the expression is a number.
      static Expr IsObject​(Expr expr)
      Check if the expression is an object.
      static Expr IsRef​(Expr expr)
      Check if the expression is a reference.
      static Expr IsRole​(Expr expr)
      Check if the expression is a role.
      static Expr IsSet​(Expr expr)
      Check if the expression is a set.
      static Expr IsString​(Expr expr)
      Check if the expression is a string.
      static Expr IsTimestamp​(Expr expr)
      Check if the expression is a timestamp.
      static Expr IsToken​(Expr expr)
      Check if the expression is a token.
      static Expr Join​(Expr source, Expr target)
      Derives a set of resources from applying each document of the source set to the target parameter.
      static Expr Join​(Expr source, UnaryOperator<Expr> lambda)
      Derives a set of resources from applying each document of the source set to the target parameter.
      static Expr KeyFromSecret​(Expr secret)
      Retrieves the key object given the key's secret string.
      static Expr KeyFromSecret​(String secret)
      Retrieves the key object given the key's secret string.
      static Expr Keys()
      Returns a reference to a set of all keys in the database.
      static Expr Keys​(Expr scope)
      Returns a reference to a set of all keys in the specified database.
      static Expr Lambda​(Expr var, Expr expr)
      Creates an anonymous function that binds one or more variables in the expression provided.
      static Expr Lambda​(String var, Expr expr)
      Creates an anonymous function that binds one or more variables in the expression provided.
      static Expr Length​(Expr value)
      Length function returns the number of characters (codepoints) in the string
      static Expr Length​(String value)
      Length function returns the number of characters (codepoints) in the string
      static Language.LetBinding Let​(String v1, Expr d1)
      Bind values to one or more variables.
      static Language.LetBinding Let​(String v1, Expr d1, String v2, Expr d2)
      Bind values to one or more variables.
      static Language.LetBinding Let​(String v1, Expr d1, String v2, Expr d2, String v3, Expr d3)
      Bind values to one or more variables.
      static Language.LetBinding Let​(String v1, Expr d1, String v2, Expr d2, String v3, Expr d3, String v4, Expr d4)
      Bind values to one or more variables.
      static Language.LetBinding Let​(String v1, Expr d1, String v2, Expr d2, String v3, Expr d3, String v4, Expr d4, String v5, Expr d5)
      Bind values to one or more variables.
      static Language.LetBinding Let​(String v1, Expr d1, String v2, Expr d2, String v3, Expr d3, String v4, Expr d4, String v5, Expr d5, String v6, Expr d6)
      Bind values to one or more variables.
      static Language.LetBinding Let​(String v1, Expr d1, String v2, Expr d2, String v3, Expr d3, String v4, Expr d4, String v5, Expr d5, String v6, Expr d6, String v7, Expr d7)
      Bind values to one or more variables.
      static Language.LetBinding Let​(String v1, Expr d1, String v2, Expr d2, String v3, Expr d3, String v4, Expr d4, String v5, Expr d5, String v6, Expr d6, String v7, Expr d7, String v8, Expr d8)
      Bind values to one or more variables.
      static Language.LetBinding Let​(Map<String,​? extends Expr> bindings)
      Deprecated.
      As of release 2.6.0, use alternate Let forms.
      static Expr Ln​(Expr value)
      Computes the ln of a numbers.
      static Expr Ln​(Double value)
      Computes the ln of a numbers.
      static Expr Log​(Expr value)
      Computes the log of a numbers.
      static Expr Log​(Double value)
      Computes the log of a numbers.
      static Expr Login​(Expr ref, Expr params)
      Creates a new authentication token for the provided reference.
      static Expr Logout​(boolean invalidateAll)
      Delete authentication tokens.
      static Expr Logout​(Expr invalidateAll)
      Delete authentication tokens.
      static Expr LowerCase​(Expr value)
      Lower function returns all letters in the string in lowercase
      static Expr LowerCase​(String value)
      Lower function returns all letters in the string in lowercase
      static Expr LT​(Expr... values)
      Returns true if the first element of the given collection is less than the ones following, and false otherwise.
      static Expr LT​(List<? extends Expr> values)
      Returns true if the first element of the given collection is less than the ones following, and false otherwise.
      static Expr LTE​(Expr... values)
      Returns true if the first element of the given collection is less than or equal to the ones following, and false otherwise.
      static Expr LTE​(List<? extends Expr> values)
      Returns true if the first element of the given collection is less than or equal to the ones following, and false otherwise.
      static Expr LTrim​(Expr value)
      LTrim function returns a new string with leading white space removed
      static Expr LTrim​(String value)
      LTrim function returns a new string with leading white space removed
      static Expr Map​(Expr collection, Expr lambda)
      Applies the given lambda to each element of the provided collection, and returns the results of each application in a new collection of the same type.
      static Expr Map​(Expr collection, UnaryOperator<Expr> lambda)
      Applies the given lambda to each element of the provided collections, and returns the results of each application in a new collection of the same type.
      static Expr Match​(Expr index)
      Returns the set of resources for the given index.
      static Expr Match​(Expr index, Expr term)
      Returns the set of resources that match the terms for the given index.
      static Expr Max​(Expr... values)
      Computes the max in a list of numbers.
      static Expr Max​(List<? extends Expr> values)
      Computes the max in a list of numbers.
      static Expr Mean​(Expr collection)
      Returns the mean of all elements in the collection.
      static Expr Merge​(Expr merge, Expr with)
      Merge two or more objects.
      static Expr Merge​(Expr merge, Expr with, Expr lambda)
      Merge two or more objects.
      static Expr Min​(Expr... values)
      Computes the min in a list of numbers.
      static Expr Min​(List<? extends Expr> values)
      Computes the min in a list of numbers.
      static Expr Minute​(Expr expr)
      Returns a time expression's minute of the hour, from 0 to 59.
      static Expr Modulo​(Expr... values)
      Computes the remainder after division of a list of numbers.
      static Expr Modulo​(List<? extends Expr> values)
      Computes the remainder after division of a list of numbers.
      static Expr Month​(Expr expr)
      Returns a time expression's month of the year, from 1 to 12.
      static Expr MoveDatabase​(Expr from, Expr to)
      Move database to a new hierarchy.
      static Expr Multiply​(Expr... values)
      Computes the product of a list of numbers.
      static Expr Multiply​(List<? extends Expr> values)
      Computes the product of a list of numbers.
      static Expr NewId()
      Returns a new string identifier suitable for use when constructing references.
      static Expr NextId()
      Deprecated.
      Use NewId() instead.
      static Expr NGram​(Expr term)
      Tokenize the input into n-grams of the 1 and 2 elements in size.
      static Expr NGram​(Expr terms, long min, long max)
      Tokenize the input into n-grams of the given sizes.
      static Expr NGram​(Expr terms, long min, Expr max)
      Tokenize the input into n-grams of the given sizes.
      static Expr NGram​(Expr terms, Expr min, long max)
      Tokenize the input into n-grams of the given sizes.
      static Expr NGram​(Expr terms, Expr min, Expr max)
      Tokenize the input into n-grams of the given sizes.
      static Expr NGram​(String term)
      Tokenize the input into n-grams of the 1 and 2 elements in size.
      static Expr NGram​(String terms, long min, long max)
      Tokenize the input into n-grams of the given sizes.
      static Expr NGram​(String terms, long min, Expr max)
      Tokenize the input into n-grams of the given sizes.
      static Expr NGram​(String terms, Expr min, long max)
      Tokenize the input into n-grams of the given sizes.
      static Expr NGram​(String terms, Expr min, Expr max)
      Tokenize the input into n-grams of the given sizes.
      static Expr NGram​(List<Expr> terms)
      Tokenize the input into n-grams of the 1 and 2 elements in size.
      static Expr NGram​(List<Expr> terms, Expr min, Expr max)
      Tokenize the input into n-grams of the given sizes.
      static Expr Not​(Expr bool)
      Returns true if the given boolean parameter is false, or false if the boolean parameter is true.
      static Expr Now()
      Returns the current snapshot time.
      static Expr Null()
      Creates a new expression representing a null value.
      static Expr Obj()
      Creates an empty object.
      static Expr Obj​(String k1, Expr v1)
      Creates a new object with the provided key and value.
      static Expr Obj​(String k1, Expr v1, String k2, Expr v2)
      Creates a new object with two key/value pairs.
      static Expr Obj​(String k1, Expr v1, String k2, Expr v2, String k3, Expr v3)
      Creates a new object with three key/value pairs.
      static Expr Obj​(String k1, Expr v1, String k2, Expr v2, String k3, Expr v3, String k4, Expr v4)
      Creates a new object with four key/value pairs.
      static Expr Obj​(String k1, Expr v1, String k2, Expr v2, String k3, Expr v3, String k4, Expr v4, String k5, Expr v5)
      Creates a new object with five key/value pairs.
      static Expr Obj​(Map<String,​? extends Expr> values)
      Creates a new object wrapping the Map provided.
      static Expr Or​(Expr... values)
      Returns true if any element in the given collection is true, and false otherwise.
      static Expr Or​(List<? extends Expr> values)
      Returns true if any element in the given collection is true, and false otherwise.
      static Pagination Paginate​(Expr resource)
      Returns a Page object that groups a page of results and cursors for retrieving pages before or after the current page.
      static Language.Path Path​(int... segments)
      Constructs a path matching array indexes.
      static Language.Path Path​(String... segments)
      Constructs a path matching object keys.
      static Expr Pow​(Expr num)
      Pow to calculate a number raise to the power of some other number
      static Expr Pow​(Expr num, Expr exp)
      Pow to calculate a number raise to the power of some other number
      static Expr Pow​(Expr num, Double exp)
      Pow to calculate a number raise to the power of some other number
      static Expr Pow​(Double num, Expr exp)
      Pow to calculate a number raise to the power of some other number
      static Expr Pow​(Double num, Double exp)
      Pow to calculate a number raise to the power of some other number
      static Expr Prepend​(Expr elements, Expr collection)
      Returns a new collection with the given elements prepended to the provided collection.
      static Expr Query​(Expr lambda)
      Creates a new query expression with the given lambda.
      static Expr Radians​(Expr value)
      Computes the radians of a number.
      static Expr Radians​(Double value)
      Computes the radians of a number.
      static Expr Range​(Expr set, Expr from, Expr to)
      Filter the set based on the lower/upper bounds (inclusive).
      static Expr Reduce​(Expr lambda, Expr initial, Expr collection)
      Reduce the collection.
      static Expr Ref​(Expr collectionRef, Expr id)
      Creates a new scoped reference.
      static Expr Ref​(Expr collectionRef, String id)
      Creates a new scoped reference.
      static Expr Ref​(String ref)
      Creates a new reference.
      static Expr RegexEscape​(Expr value)
      It takes a string and returns a regex which matches the input string verbatim.
      static Expr RegexEscape​(String value)
      It takes a string and returns a regex which matches the input string verbatim.
      static Expr Remove​(Expr ref, Expr timestamp, Expr action)
      Removes an event from an document's history.
      static Expr Remove​(Expr ref, Expr timestamp, Language.Action action)
      Removes an event from an document's history.
      static Expr Repeat​(Expr value)
      Repeat function returns a string the specified number of times
      static Expr Repeat​(Expr value, long number)
      Repeat function returns a string concatenanted the specified number of times
      static Expr Repeat​(Expr value, Expr number)
      Repeat function returns a string concatenanted the specified number of times
      static Expr Repeat​(String value)
      Repeat function returns a string the specified number of times
      static Expr Repeat​(String value, long number)
      Repeat function returns a string concatenanted the specified number of times
      static Expr Repeat​(String value, Expr number)
      Repeat function returns a string concatenanted the specified number of times
      static Expr Replace​(Expr ref, Expr params)
      Replaces the resource identified by the given reference.
      static Expr ReplaceStr​(Expr value, Expr find, Expr replace)
      ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
      static Expr ReplaceStr​(Expr value, Expr find, String replace)
      ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
      static Expr ReplaceStr​(Expr value, String find, Expr replace)
      ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
      static Expr ReplaceStr​(Expr value, String find, String replace)
      ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
      static Expr ReplaceStr​(String value, Expr find, Expr replace)
      ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
      static Expr ReplaceStr​(String value, Expr find, String replace)
      ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
      static Expr ReplaceStr​(String value, String find, Expr replace)
      ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
      static Expr ReplaceStr​(String value, String find, String replace)
      ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
      static Expr ReplaceStrRegex​(Expr value, Expr pattern, Expr replace)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(Expr value, Expr pattern, Expr replace, Expr first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(Expr value, Expr pattern, Expr replace, Boolean first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(Expr value, Expr pattern, String replace)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(Expr value, Expr pattern, String replace, boolean first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(Expr value, Expr pattern, String replace, Expr first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(Expr value, String pattern, Expr replace)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(Expr value, String pattern, Expr replace, boolean first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(Expr value, String pattern, Expr replace, Expr first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(Expr value, String pattern, String replace)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(Expr value, String pattern, String replace, boolean first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(Expr value, String pattern, String replace, Expr first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(String value, Expr pattern, Expr replace)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(String value, Expr pattern, Expr replace, boolean first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(String value, Expr pattern, Expr replace, Expr first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(String value, Expr pattern, String replace)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(String value, Expr pattern, String replace, boolean first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(String value, Expr pattern, String replace, Expr first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(String value, String pattern, Expr replace)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(String value, String pattern, Expr replace, boolean first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(String value, String pattern, Expr replace, Expr first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(String value, String pattern, String replace)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(String value, String pattern, String replace, boolean first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr ReplaceStrRegex​(String value, String pattern, String replace, Expr first)
      ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
      static Expr Reverse​(Expr source)
      Reverse the order of the given source.
      static Expr Role​(Expr name)
      Creates a reference for the given role name.
      static Expr Role​(Expr name, Expr database)
      Creates a reference for the given role name, scoped to the database provided.
      static Expr Role​(String name)
      Creates a reference for the given role name.
      static Expr Role​(String name, Expr database)
      Creates a reference for the given role name, scoped to the database provided.
      static Expr Roles()
      Returns a reference to a set of all roles in the database.
      static Expr Roles​(Expr scope)
      Returns a reference to a set of all roles in the specified database.
      static Expr Round​(Expr num)
      Round to a given precision
      static Expr Round​(Expr num, Expr precision)
      Round to a given precision
      static Expr Round​(Expr num, Long precision)
      Round to a given precision
      static Expr Round​(Double num)
      Round to a given precision
      static Expr Round​(Double num, Expr precision)
      Round to a given precision
      static Expr Round​(Double num, Long precision)
      Round to a given precision
      static Expr Round​(Long num, Expr precision)
      Round to a given precision
      static Expr Round​(Long num, Long precision)
      Round to a given precision
      static Expr RTrim​(Expr value)
      RTrim function returns a new string with trailing whitespace removed
      static Expr RTrim​(String value)
      RTrim function returns a new string with trailing whitespace removed
      static Expr Second​(Expr expr)
      Returns a time expression's second of the minute, from 0 to 59.
      static Expr Select​(Expr path, Expr from)
      Traverses target resource returning the value under the given path.
      static Expr Select​(Expr path, Expr from, Expr defaultValue)
      Traverses target resource returning the value under the given path.
      static Expr Select​(Language.Path path, Expr from)
      Traverses target resource returning the value under the given path.
      static Expr Select​(Language.Path path, Expr from, Expr defaultValue)
      Traverses target resource returning the value under the given path.
      static Expr SelectAll​(Expr path, Expr from)
      Deprecated.
      use SelectAsIndex instead
      static Expr SelectAll​(Language.Path path, Expr from)
      Deprecated.
      use SelectAsIndex instead
      static Expr SelectAsIndex​(Expr path, Expr from)
      Selects the desired path for each element in the given array.
      static Expr SelectAsIndex​(Language.Path path, Expr from)
      Selects the desired path for each element in the given array.
      static Expr Sign​(Expr value)
      Computes the sign of a number.
      static Expr Sign​(Double value)
      Computes the sign of a number.
      static Expr Sign​(Long value)
      Computes the sign of a number.
      static Expr Sin​(Expr value)
      Computes the Sin of a number.
      static Expr Sin​(Double value)
      Computes the Sin of a number.
      static Expr Singleton​(Expr ref)
      Returns the history of an instance's presence for the given reference.
      static Expr Sinh​(Expr value)
      Computes the Sinh of a number.
      static Expr Sinh​(Double value)
      Computes the Sinh of a number.
      static Expr Space​(Expr value)
      Space function returns "N" number of spaces
      static Expr Space​(Integer value)
      Space function returns
      static Expr Space​(Long value)
      Space function returns "N" number of spaces
      static Expr Sqrt​(Expr value)
      Computes the square root of a numbers.
      static Expr Sqrt​(Double value)
      Computes the square root of a numbers.
      static Expr StartsWith​(Expr value, Expr search)
      Returns true if the string starts with the given prefix value, or false if otherwise
      static Expr StartsWith​(Expr value, String search)
      Returns true if the string starts with the given prefix value, or false if otherwise
      static Expr StartsWith​(String value, Expr search)
      Returns true if the string starts with the given prefix value, or false if otherwise
      static Expr StartsWith​(String value, String search)
      Returns true if the string starts with the given prefix value, or false if otherwise
      static Expr SubString​(Expr value)
      SubString function returns a subset of the source string
      static Expr SubString​(Expr value, long start)
      SubString function returns a subset of the source string
      static Expr SubString​(Expr value, long start, long length)
      SubString function returns a subset of the source string
      static Expr SubString​(Expr value, long start, Expr length)
      SubString function returns a subset of the source string
      static Expr SubString​(Expr value, Expr start)
      SubString function returns a subset of the source string
      static Expr SubString​(Expr value, Expr start, long length)
      SubString function returns a subset of the source string
      static Expr SubString​(Expr value, Expr start, Expr length)
      SubString function returns a subset of the source string
      static Expr SubString​(String value)
      SubString function returns a subset of the source string
      static Expr SubString​(String value, long start)
      SubString function returns a subset of the source string
      static Expr SubString​(String value, long start, long length)
      SubString function returns a subset of the source string
      static Expr SubString​(String value, long start, Expr length)
      SubString function returns a subset of the source string
      static Expr SubString​(String value, Expr start)
      SubString function returns a subset of the source string
      static Expr SubString​(String value, Expr start, long length)
      SubString function returns a subset of the source string
      static Expr SubString​(String value, Expr start, Expr length)
      SubString function returns a subset of the source string
      static Expr Subtract​(Expr... values)
      Computes the difference of a list of numbers.
      static Expr Subtract​(List<? extends Expr> values)
      Computes the difference of a list of numbers.
      static Expr Sum​(Expr collection)
      Sum the elements in the collection.
      static Expr Take​(long num, Expr collection)
      Returns a new collection containing the given number of elements taken from the provided collection.
      static Expr Take​(Expr num, Expr collection)
      Returns a new collection containing the given number of elements taken from the provided collection.
      static Expr Tan​(Expr value)
      Computes the tangent of a numbers.
      static Expr Tan​(Double value)
      Computes the tangent of a numbers.
      static Expr Tanh​(Expr value)
      Computes the hyperbolic tangent of a numbers.
      static Expr Tanh​(Double value)
      Computes the hyperbolic tangent of a numbers.
      static Expr Time​(Expr str)
      Creates a new timestamp from an ISO-8601 offset date/time string.
      static Expr Time​(String str)
      Creates a new timestamp from an ISO-8601 offset date/time string.
      static Expr TimeAdd​(Expr base, long offset, Expr unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(Expr base, long offset, Language.TimeUnit unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(Expr base, long offset, String unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(Expr base, Expr offset, Expr unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(Expr base, Expr offset, Language.TimeUnit unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(Expr base, Expr offset, String unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(Instant base, long offset, Expr unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(Instant base, long offset, Language.TimeUnit unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(Instant base, long offset, String unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(Instant base, Expr offset, Expr unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(Instant base, Expr offset, Language.TimeUnit unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(Instant base, Expr offset, String unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(LocalDate base, long offset, Expr unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(LocalDate base, long offset, Language.TimeUnit unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(LocalDate base, long offset, String unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(LocalDate base, Expr offset, Expr unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(LocalDate base, Expr offset, Language.TimeUnit unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeAdd​(LocalDate base, Expr offset, String unit)
      Returns a new time or date with the offset in terms of the unit added.
      static Expr TimeDiff​(Expr start, Expr finish, Expr unit)
      Returns the number of intervals in terms of the unit between two times or dates.
      static Expr TimeDiff​(Expr start, Expr finish, Language.TimeUnit unit)
      Returns the number of intervals in terms of the unit between two times or dates.
      static Expr TimeDiff​(Expr start, Expr finish, String unit)
      Returns the number of intervals in terms of the unit between two times or dates.
      static Expr TimeDiff​(Instant start, Expr finish, Expr unit)
      Returns the number of intervals in terms of the unit between two times.
      static Expr TimeDiff​(Instant start, Expr finish, Language.TimeUnit unit)
      Returns the number of intervals in terms of the unit between two times.
      static Expr TimeDiff​(Instant start, Expr finish, String unit)
      Returns the number of intervals in terms of the unit between two times.
      static Expr TimeDiff​(Instant start, Instant finish, Expr unit)
      Returns the number of intervals in terms of the unit between two times.
      static Expr TimeDiff​(Instant start, Instant finish, Language.TimeUnit unit)
      Returns the number of intervals in terms of the unit between two times.
      static Expr TimeDiff​(Instant start, Instant finish, String unit)
      Returns the number of intervals in terms of the unit between two times.
      static Expr TimeDiff​(LocalDate start, Expr finish, Expr unit)
      Returns the number of intervals in terms of the unit between two dates.
      static Expr TimeDiff​(LocalDate start, Expr finish, Language.TimeUnit unit)
      Returns the number of intervals in terms of the unit between two dates.
      static Expr TimeDiff​(LocalDate start, Expr finish, String unit)
      Returns the number of intervals in terms of the unit between two dates.
      static Expr TimeDiff​(LocalDate start, LocalDate finish, Expr unit)
      Returns the number of intervals in terms of the unit between two dates.
      static Expr TimeDiff​(LocalDate start, LocalDate finish, Language.TimeUnit unit)
      Returns the number of intervals in terms of the unit between two dates.
      static Expr TimeDiff​(LocalDate start, LocalDate finish, String unit)
      Returns the number of intervals in terms of the unit between two dates.
      static Expr TimeSubtract​(Expr base, long offset, Expr unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(Expr base, long offset, Language.TimeUnit unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(Expr base, long offset, String unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(Expr base, Expr offset, Expr unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(Expr base, Expr offset, Language.TimeUnit unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(Expr base, Expr offset, String unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(Instant base, long offset, Expr unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(Instant base, long offset, Language.TimeUnit unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(Instant base, long offset, String unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(Instant base, Expr offset, Expr unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(Instant base, Expr offset, Language.TimeUnit unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(Instant base, Expr offset, String unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(LocalDate base, long offset, Expr unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(LocalDate base, long offset, Language.TimeUnit unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(LocalDate base, long offset, String unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(LocalDate base, Expr offset, Expr unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(LocalDate base, Expr offset, Language.TimeUnit unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TimeSubtract​(LocalDate base, Expr offset, String unit)
      Returns a new time or date with the offset in terms of the unit subtracted.
      static Expr TitleCase​(Expr value)
      TitleCase function returns a string with the first letter in each word capitalized
      static Expr TitleCase​(String value)
      TitleCase function returns a string with the first letter in each word capitalized
      static Expr ToArray​(Expr object)
      Try to convert an object into an array of (field, value).
      static Expr ToDate​(Expr value)
      Casts an expression to a date value, if possible.
      static Expr ToDouble​(double value)
      Casts an expression to a double value, if possible.
      static Expr ToDouble​(long value)
      Casts an expression to a double value, if possible.
      static Expr ToDouble​(Expr value)
      Casts an expression to a double value, if possible.
      static Expr ToDouble​(String value)
      Casts an expression to a double value, if possible.
      static Expr ToInteger​(double value)
      Casts an expression to an integer value, if possible.
      static Expr ToInteger​(long value)
      Casts an expression to an integer value, if possible.
      static Expr ToInteger​(Expr value)
      Casts an expression to an integer value, if possible.
      static Expr ToInteger​(String value)
      Casts an expression to an integer value, if possible.
      static Expr Tokens()
      Returns a reference to a set of all tokens in the database.
      static Expr Tokens​(Expr scope)
      Returns a reference to a set of all tokens in the specified database.
      static Expr ToMicros​(Expr value)
      Converts a time expression to microseconds since the UNIX epoch.
      static Expr ToMillis​(Expr value)
      Converts a time expression to milliseconds since the UNIX epoch.
      static Expr ToNumber​(Expr value)
      Casts an expression to a numeric value, if possible.
      static Expr ToObject​(Expr fields)
      Try to convert an array of (field, value) into an object.
      static Expr ToSeconds​(Expr value)
      Converts a time expression to seconds since the UNIX epoch.
      static Expr ToString​(Expr value)
      Casts an expression to a string value, if possible.
      static Expr ToTime​(Expr value)
      Casts an expression to a time value, if possible.
      static Expr Trim​(Expr value)
      Trim function returns a new string with leading and trailing whitespace removed
      static Expr Trim​(String value)
      Trim function returns a new string with leading and trailing whitespace removed
      static Expr Trunc​(Expr num)
      Truncate to a given precision
      static Expr Trunc​(Expr num, Expr precision)
      Truncate to a given precision
      static Expr Trunc​(Expr num, Long precision)
      Truncate to a given precision
      static Expr Trunc​(Double num)
      Truncate to a given precision
      static Expr Trunc​(Double num, Expr precision)
      Truncate to a given precision
      static Expr Trunc​(Double num, Long precision)
      Truncate to a given precision
      static Expr Trunc​(Long num, Expr precision)
      Truncate to a given precision
      static Expr Trunc​(Long num, Long precision)
      Truncate to a given precision
      static Expr Union​(Expr... sets)
      Returns the set of resources present in at least on of the sets provided.
      static Expr Union​(List<? extends Expr> sets)
      Returns the set of resources present in at least on of the sets provided.
      static Expr Update​(Expr ref, Expr params)
      Updates the resource identified by the given reference.
      static Expr UpperCase​(Expr value)
      UpperCase function returns all letters in the string in uppercase
      static Expr UpperCase​(String value)
      UpperCase function returns all letters in the string in uppercase
      static Expr Value​(boolean value)
      Encodes the given Boolean as an Expr instance.
      static Expr Value​(byte[] bytes)
      Encodes the given Byte array as an Expr instance.
      static Expr Value​(double value)
      Encodes the given Double as an Expr instance.
      static Expr Value​(long value)
      Encodes the given Long as an Expr instance.
      static Expr Value​(Object value)
      Encodes the given object using the reflection Encoder.
      static Expr Value​(String value)
      Encodes the given String as an Expr instance.
      static Expr Value​(Instant value)
      Encodes the given Instant as an Expr instance.
      static Expr Value​(LocalDate value)
      Encodes the given LocalDate as an Expr instance.
      static Expr Var​(String name)
      Creates a expression that refers to the value of the given variable name in the current lexical scope.
      static Expr Year​(Expr expr)
      Returns the time expression's year, following the ISO-8601 standard.

    • Method Detail

      • Classes

        @Deprecated
public static Expr Classes()
        Deprecated.
        use Collections instead
        Returns a reference to a set of all classes in the database. A reference set must be paginated in order to retrieve its values.
        Returns:
        a new Expr instance
        See Also:
        Paginate(Expr)

      • Collections

        public static Expr Collections()
        Returns a reference to a set of all collections in the database. A reference set must be paginated in order to retrieve its values.
        Returns:
        a new Expr instance
        See Also:
        Paginate(Expr)

      • Classes

        @Deprecated
public static Expr Classes​(Expr scope)
        Deprecated.
        use Collection instead
        Returns a reference to a set of all classes in the specified database. A reference set must be paginated in order to retrieve its values.
        Parameters:
        scope - a reference to a database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        Database(String), Paginate(Expr)

      • Collections

        public static Expr Collections​(Expr scope)
        Returns a reference to a set of all collections in the specified database. A reference set must be paginated in order to retrieve its values.
        Parameters:
        scope - a reference to a database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        Database(String), Paginate(Expr)

      • Databases

        public static Expr Databases()
        Returns a reference to a set of all databases. A reference set must be paginated in order to retrieve its values.
        Returns:
        a new Expr instance
        See Also:
        Paginate(Expr)

      • Databases

        public static Expr Databases​(Expr scope)
        Returns a reference to a set of all databases in the specified database. A reference set must be paginated in order to retrieve its values.
        Parameters:
        scope - a reference to a database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        Database(String), Paginate(Expr)

      • Indexes

        public static Expr Indexes()
        Returns a reference to a set of all indexes in the database. A reference set must be paginated in order to retrieve its values.
        Returns:
        a new Expr instance
        See Also:
        Paginate(Expr)

      • Indexes

        public static Expr Indexes​(Expr scope)
        Returns a reference to a set of all indexes in the specified database. A reference set must be paginated in order to retrieve its values.
        Parameters:
        scope - a reference to a database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        Paginate(Expr)

      • Functions

        public static Expr Functions()
        Returns a reference to a set of all user defined functions in the database. A reference set must be paginated in order to retrieve its values.
        Returns:
        a new Expr instance
        See Also:
        Paginate(Expr)

      • Functions

        public static Expr Functions​(Expr scope)
        Returns a reference to a set of all user defined functions in the specified database. A reference set must be paginated in order to retrieve its values.
        Parameters:
        scope - a reference to a database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        Ref(Expr, String), Database(String), Paginate(Expr)

      • Keys

        public static Expr Keys()
        Returns a reference to a set of all keys in the database. A reference set must be paginated in order to retrieve its values.
        Returns:
        a new Expr instance
        See Also:
        Paginate(Expr)

      • Keys

        public static Expr Keys​(Expr scope)
        Returns a reference to a set of all keys in the specified database. A reference set must be paginated in order to retrieve its values.
        Parameters:
        scope - a reference to a database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        Ref(Expr, String), Database(String), Paginate(Expr)

      • Tokens

        public static Expr Tokens()
        Returns a reference to a set of all tokens in the database. A reference set must be paginated in order to retrieve its values.
        Returns:
        a new Expr instance
        See Also:
        Paginate(Expr)

      • Tokens

        public static Expr Tokens​(Expr scope)
        Returns a reference to a set of all tokens in the specified database. A reference set must be paginated in order to retrieve its values.
        Parameters:
        scope - a reference to a database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        Ref(Expr, String), Database(String), Paginate(Expr)

      • Credentials

        public static Expr Credentials()
        Returns a reference to a set of all credentials in the database. A reference set must be paginated in order to retrieve its values.
        Returns:
        a new Expr instance
        See Also:
        Paginate(Expr)

      • Credentials

        public static Expr Credentials​(Expr scope)
        Returns a reference to a set of all credentials in the specified database. A reference set must be paginated in order to retrieve its values.
        Parameters:
        scope - a reference to a database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        Ref(Expr, String), Database(String), Paginate(Expr)

      • Roles

        public static Expr Roles()
        Returns a reference to a set of all roles in the database. A reference set must be paginated in order to retrieve its values.
        Returns:
        a new Expr instance
        See Also:
        Paginate(Expr)

      • Roles

        public static Expr Roles​(Expr scope)
        Returns a reference to a set of all roles in the specified database. A reference set must be paginated in order to retrieve its values.
        Parameters:
        scope - a reference to a database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        Ref(Expr, String), Database(String), Paginate(Expr)

      • Documents

        public static Expr Documents​(Expr collection)
        Returns a set of all documents in the given collection. A set must be paginated in order to retrieve its values.
        Parameters:
        collection - a reference to the collection. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        Paginate(Expr)

      • Value

        public static Expr Value​(Object value)
        Encodes the given object using the reflection Encoder.
        Parameters:
        value - the object to be encoded
        Returns:
        a new Expr instance
        See Also:
        Encoder

      • Value

        public static Expr Value​(String value)
        Encodes the given String as an Expr instance.
        Parameters:
        value - the string to be encoded
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Value

        public static Expr Value​(long value)
        Encodes the given Long as an Expr instance.
        Parameters:
        value - the number to be encoded
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Value

        public static Expr Value​(double value)
        Encodes the given Double as an Expr instance.
        Parameters:
        value - the number to be encoded
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Value

        public static Expr Value​(boolean value)
        Encodes the given Boolean as an Expr instance.
        Parameters:
        value - the boolean value to be encoded
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Value

        public static Expr Value​(byte[] bytes)
        Encodes the given Byte array as an Expr instance.
        Parameters:
        bytes - the byte array to be encoded
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Null

        public static Expr Null()
        Creates a new expression representing a null value.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Obj

        public static Expr Obj()
        Creates an empty object.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Obj

        public static Expr Obj​(String k1,
                       Expr v1)
        Creates a new object with the provided key and value.
        Parameters:
        k1 - a key
        v1 - a value
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Obj

        public static Expr Obj​(String k1,
                       Expr v1,
                       String k2,
                       Expr v2)
        Creates a new object with two key/value pairs.
        Parameters:
        k1 - the first key
        v1 - the first value
        k2 - the second key
        v2 - the second value
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Obj

        public static Expr Obj​(String k1,
                       Expr v1,
                       String k2,
                       Expr v2,
                       String k3,
                       Expr v3)
        Creates a new object with three key/value pairs.
        Parameters:
        k1 - the first key
        v1 - the first value
        k2 - the second key
        v2 - the second value
        k3 - the third key
        v3 - the third value
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Obj

        public static Expr Obj​(String k1,
                       Expr v1,
                       String k2,
                       Expr v2,
                       String k3,
                       Expr v3,
                       String k4,
                       Expr v4)
        Creates a new object with four key/value pairs.
        Parameters:
        k1 - the first key
        v1 - the first value
        k2 - the second key
        v2 - the second value
        k3 - the third key
        v3 - the third value
        k4 - the fourth key
        v4 - the fourth value
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Obj

        public static Expr Obj​(String k1,
                       Expr v1,
                       String k2,
                       Expr v2,
                       String k3,
                       Expr v3,
                       String k4,
                       Expr v4,
                       String k5,
                       Expr v5)
        Creates a new object with five key/value pairs.
        Parameters:
        k1 - the first key
        v1 - the first value
        k2 - the second key
        v2 - the second value
        k3 - the third key
        v3 - the third value
        k4 - the fourth key
        v4 - the fourth value
        k5 - the fifth key
        v5 - the fifth value
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Arr

        public static Expr Arr​(List<? extends Expr> values)
        Creates a new array wrapping the provided List. For convenience, see the Arr(Expr...) helper.
        Parameters:
        values - the List instance to be wrapped
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Arr

        public static Expr Arr​(Expr... values)
        Creates a new array containing with the values provided.
        Parameters:
        values - the elements of the new array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Values

      • Abort

        public static Expr Abort​(String msg)
        Aborts the current transaction with a given message.
        Parameters:
        msg - a message to be used when aborting the transaction
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Basic Forms

      • Abort

        public static Expr Abort​(Expr msg)
        Aborts the current transaction with a given message.
        Parameters:
        msg - a message to be used when aborting the transaction. Type: String
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Basic Forms

      • Call

        public static Expr Call​(Expr ref,
                        List<? extends Expr> args)
        Calls the given user defined function with the arguments provided.
        Parameters:
        ref - the reference to the user defined function to be called. Type: Reference
        args - the list of arguments for the given user defined function
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Basic Forms

      • Call

        public static Expr Call​(Expr ref,
                        Expr... args)
        Calls the given user defined function with the arguments provided.
        Parameters:
        ref - the reference to the user defined function to be called. Type: Reference
        args - the arguments for the given user defined function
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Basic Forms

      • At

        public static Expr At​(Expr timestamp,
                      Expr expr)
        Execute the reads associated with the given expression at the timestamp provided. Writes are still executed at the current transaction time.
        Parameters:
        timestamp - the read timestamp. Type: Timestamp
        expr - the scoped expression
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Basic Forms, Time(Expr), Value(Instant)

      • At

        public static Expr At​(Instant timestamp,
                      Expr expr)
        Execute the reads associated with the given expression at the timestamp provided. Writes are still executed at the current transaction time.
        Parameters:
        timestamp - the read timestamp.
        expr - the scoped expression
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Basic Forms

      • Let

        @Deprecated
public static Language.LetBinding Let​(Map<String,​? extends Expr> bindings)
        Deprecated.
        As of release 2.6.0, use alternate Let forms.
        Bind values to one or more variables. Variables must be accessed using the Var(String) function.

        Example:

        
 // Creates a binding map of variable names and their values,
 // then use the binding map to build a let expression where
 // the values can be referenced to by the expression provided
 // using their given names.
 Map<String, Expr> bindings = new HashMap<>();
 bindings.add("name", Value("Bob"));
 bindings.add("age", Value(53));

 client.query(
   Let(bindings).in(
     Create(Collection("users"), Obj("data", Obj(
       "name", Var("name"),
       "age", Var("age"),
     )))
   )
 ).get();
        Parameters:
        bindings - a Map of variable names to values.
        Returns:
        a new Language.LetBinding instance
        See Also:
        FaunaDB Basic Forms, Var(String), Language.LetBinding

      • Let

        public static Language.LetBinding Let​(String v1,
                                      Expr d1,
                                      String v2,
                                      Expr d2,
                                      String v3,
                                      Expr d3,
                                      String v4,
                                      Expr d4)
        Bind values to one or more variables. Variables must be accessed using the Var(String) function.

        Example:

        
 client.query(
   Let(
     "a", Value(1),
     "b", Value(2),
     "c", Value(3),
     "d", Value(4),
   ).in(
     Add(Var("a"), Var("b"), Var("c"), Var("d"))
   )
 ).get();
        Parameters:
        v1 - the first variable name
        d1 - the first variable value
        v2 - the second variable name
        d2 - the second variable value
        v3 - the third variable name
        d3 - the third variable value
        v4 - the fourth variable name
        d4 - the fourth variable value
        Returns:
        a new Language.LetBinding instance
        See Also:
        FaunaDB Basic Forms, Var(String), Language.LetBinding

      • Let

        public static Language.LetBinding Let​(String v1,
                                      Expr d1,
                                      String v2,
                                      Expr d2,
                                      String v3,
                                      Expr d3,
                                      String v4,
                                      Expr d4,
                                      String v5,
                                      Expr d5)
        Bind values to one or more variables. Variables must be accessed using the Var(String) function.

        Example:

        
 client.query(
   Let(
     "a", Value(1),
     "b", Value(2),
     "c", Value(3),
     "d", Value(4),
     "e", Value(5),
   ).in(
     Add(Var("a"), Var("b"), Var("c"), Var("d"), Var("e"))
   )
 ).get()
        Parameters:
        v1 - the first variable name
        d1 - the first variable value
        v2 - the second variable name
        d2 - the second variable value
        v3 - the third variable name
        d3 - the third variable value
        v4 - the fourth variable name
        d4 - the fourth variable value
        v5 - the fifth variable name
        d5 - the fitfh variable value
        Returns:
        a new Language.LetBinding instance
        See Also:
        FaunaDB Basic Forms, Var(String), Language.LetBinding

      • Let

        public static Language.LetBinding Let​(String v1,
                                      Expr d1,
                                      String v2,
                                      Expr d2,
                                      String v3,
                                      Expr d3,
                                      String v4,
                                      Expr d4,
                                      String v5,
                                      Expr d5,
                                      String v6,
                                      Expr d6)
        Bind values to one or more variables. Variables must be accessed using the Var(String) function.

        Example:

        
 client.query(
   Let(
     "a", Value(1),
     "b", Value(2),
     "c", Value(3),
     "d", Value(4),
     "e", Value(5),
     "f", Value(6),
   ).in(
     Add(Var("a"), Var("b"), Var("c"), Var("d"), Var("e"), Var("f"))
   )
 ).get()
        Parameters:
        v1 - the first variable name
        d1 - the first variable value
        v2 - the second variable name
        d2 - the second variable value
        v3 - the third variable name
        d3 - the third variable value
        v4 - the fourth variable name
        d4 - the fourth variable value
        v5 - the fifth variable name
        d5 - the fitfh variable value
        v6 - the sixth variable name
        d6 - the sixth variable value
        Returns:
        a new Language.LetBinding instance
        See Also:
        FaunaDB Basic Forms, Var(String), Language.LetBinding

      • Let

        public static Language.LetBinding Let​(String v1,
                                      Expr d1,
                                      String v2,
                                      Expr d2,
                                      String v3,
                                      Expr d3,
                                      String v4,
                                      Expr d4,
                                      String v5,
                                      Expr d5,
                                      String v6,
                                      Expr d6,
                                      String v7,
                                      Expr d7)
        Bind values to one or more variables. Variables must be accessed using the Var(String) function.

        Example:

        
 client.query(
   Let(
     "a", Value(1),
     "b", Value(2),
     "c", Value(3),
     "d", Value(4),
     "e", Value(5),
     "f", Value(6),
     "g", Value(7),
   ).in(
     Add(Var("a"), Var("b"), Var("c"), Var("d"), Var("e"), Var("f"), Var("g"))
   )
 ).get()
        Parameters:
        v1 - the first variable name
        d1 - the first variable value
        v2 - the second variable name
        d2 - the second variable value
        v3 - the third variable name
        d3 - the third variable value
        v4 - the fourth variable name
        d4 - the fourth variable value
        v5 - the fifth variable name
        d5 - the fitfh variable value
        v6 - the sixth variable name
        d6 - the sixth variable value
        v7 - the seventh variable name
        d7 - the seventh variable value
        Returns:
        a new Language.LetBinding instance
        See Also:
        FaunaDB Basic Forms, Var(String), Language.LetBinding

      • Let

        public static Language.LetBinding Let​(String v1,
                                      Expr d1,
                                      String v2,
                                      Expr d2,
                                      String v3,
                                      Expr d3,
                                      String v4,
                                      Expr d4,
                                      String v5,
                                      Expr d5,
                                      String v6,
                                      Expr d6,
                                      String v7,
                                      Expr d7,
                                      String v8,
                                      Expr d8)
        Bind values to one or more variables. Variables must be accessed using the Var(String) function.

        Example:

        
 client.query(
   Let(
     "a", Value(1),
     "b", Value(2),
     "c", Value(3),
     "d", Value(4),
     "e", Value(5),
     "f", Value(6),
     "g", Value(7),
     "g", Value(8),
   ).in(
     Add(Var("a"), Var("b"), Var("c"), Var("d"), Var("e"), Var("f"), Var("g"), Var("h"))
   )
 ).get()
        Parameters:
        v1 - the first variable name
        d1 - the first variable value
        v2 - the second variable name
        d2 - the second variable value
        v3 - the third variable name
        d3 - the third variable value
        v4 - the fourth variable name
        d4 - the fourth variable value
        v5 - the fifth variable name
        d5 - the fitfh variable value
        v6 - the sixth variable name
        d6 - the sixth variable value
        v7 - the seventh variable name
        d7 - the seventh variable value
        v8 - the eighth variable name
        d8 - the eighth variable value
        Returns:
        a new Language.LetBinding instance
        See Also:
        FaunaDB Basic Forms, Var(String), Language.LetBinding

      • If

        public static Expr If​(Expr condition,
                      Expr thenExpr,
                      Expr elseExpr)
        Evaluates the then or else branch according to the given condition.
        Parameters:
        condition - the if condition. Type: Boolean
        thenExpr - the then branch for the if expression
        elseExpr - the else branch for the if expression
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Basic Forms

      • Do

        public static Expr Do​(List<? extends Expr> exprs)
        Evaluates the given expressions sequentially evaluates its arguments, and returns the result of the last expression.
        Parameters:
        exprs - a list of expressions to be evaluated sequentially
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Basic Forms

      • Do

        public static Expr Do​(Expr... exprs)
        Evaluates the given expressions sequentially evaluates its arguments, and returns the result of the last expression.
        Parameters:
        exprs - a list of expressions to be evaluated sequentially
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Basic Forms

      • Lambda

        public static Expr Lambda​(Expr var,
                          Expr expr)
        Creates an anonymous function that binds one or more variables in the expression provided.

        Example:

        
 client.query(
   Map(userNames, Lambda(Value("name"),
     Create(Collection("user"), Obj("data", Obj(
       "name", Var("name")
     )))
   ))
 ).get();

        An array of variable names can be provided to match multiple variables at once. For example:

        
 // Assuming the variable userFullNames has the following format:
 // [
 //   ["name", "surname"],
 //   ["name", "surname"]
 // ]
 client.query(
   Map(userFullNames,
     Lambda(
       Arr(
         Value("name"),
         Value("surname")
       ),
       Create(Collection("user"), Obj("data", Obj(
         "fullName", Concat(
           Var("name"),
           Var("surname")
         )
       )))
     )
   )
 ).get();
        Parameters:
        var - the lambda's parameter binding. Type: String or an Array of strings
        expr - the lambda's function body. Type: An expression.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Basic Forms, Map(Expr, Expr), Foreach(Expr, Expr), Filter(Expr, Expr), Query(Expr), Value(String), Arr(List)

      • Lambda

        public static Expr Lambda​(String var,
                          Expr expr)
        Creates an anonymous function that binds one or more variables in the expression provided.
        Parameters:
        var - the lambda's parameter binding.
        expr - the lambda's function body. Type: An expression.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Basic Forms, Lambda(Expr, Expr)

      • Map

        public static Expr Map​(Expr collection,
                       Expr lambda)
        Applies the given lambda to each element of the provided collection, and returns the results of each application in a new collection of the same type. Map applies the lambda function concurrently to each element in the collection. Side-effects do not affect evaluation of other lambda applications. The order of possible refs being generated within the lambda are non-deterministic.
        Parameters:
        collection - the source collection. Type: Collection.
        lambda - the lambda function to be applied for each element in the given collection. Type: A lambda function.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions, Lambda(Expr, Expr)

      • Map

        public static Expr Map​(Expr collection,
                       UnaryOperator<Expr> lambda)
        Applies the given lambda to each element of the provided collections, and returns the results of each application in a new collection of the same type. Map applies the lambda function concurrently to each element in the collection. Side-effects do not affect evaluation of other lambda applications. The order of possible refs being generated within the lambda are non-deterministic.
        Parameters:
        collection - the source collection. Type: Collection.
        lambda - the lambda function to be applied for each element in the given collection.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions

      • Foreach

        public static Expr Foreach​(Expr collection,
                           Expr lambda)
        Applies the given lambda to each element of the provided collection. Foreach applies the lambda function concurrently to each element in the collection. Side-effects do not affect evaluation of other lambda applications. The order of possible refs being generated within the lambda are non-deterministic.
        Parameters:
        collection - the source collection. Type: Collection.
        lambda - the lambda function to be applied for each element in the given collection. Type: A lambda function.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions, Lambda(Expr, Expr)

      • Foreach

        public static Expr Foreach​(Expr collection,
                           UnaryOperator<Expr> lambda)
        Applies the given lambda to each element of the provided collection. Foreach applies the lambda function concurrently to each element in the collection. Side-effects do not affect evaluation of other lambda applications. The order of possible refs being generated within the lambda are non-deterministic.
        Parameters:
        collection - the source collection. Type: Collection.
        lambda - the lambda function to be applied for each element in the given collection.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions

      • Filter

        public static Expr Filter​(Expr collection,
                          Expr lambda)
        Applies the given lambda to each element of the collection provided, and returns a new collection containing only the elements for which the lambda returns true.
        Parameters:
        collection - the source collection. Type: Collection
        lambda - the filter lambda. Type: A lambda expression that returns a boolean value
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions, Lambda(Expr, Expr)

      • Filter

        public static Expr Filter​(Expr collection,
                          UnaryOperator<Expr> lambda)
        Applies the given lambda to each element of the collection provided, and returns a new collection containing only the elements for which the lambda returns true.
        Parameters:
        collection - the source collection. Type: Collection
        lambda - the filter lambda. Type: A lambda expression that returns a boolean value
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions

      • Take

        public static Expr Take​(Expr num,
                        Expr collection)
        Returns a new collection containing the given number of elements taken from the provided collection.
        Parameters:
        num - the number of elements to be taken from the source collection. Type: Number
        collection - the source collection. Type: Collection
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions

      • Take

        public static Expr Take​(long num,
                        Expr collection)
        Returns a new collection containing the given number of elements taken from the provided collection.
        Parameters:
        num - the number of elements to be taken from the source collection.
        collection - the source collection. Type: Collection
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions

      • Drop

        public static Expr Drop​(Expr num,
                        Expr collection)
        Returns a new collection containing after dropping the given number of elements from the provided collection.
        Parameters:
        num - the number of elements to be dropped from the source collection. Type: Number
        collection - the source collection. Type: Collection
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions

      • Drop

        public static Expr Drop​(long num,
                        Expr collection)
        Returns a new collection containing after dropping the given number of elements from the provided collection.
        Parameters:
        num - the number of elements to be dropped from the source collection.
        collection - the source collection. Type: Collection
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions

      • Prepend

        public static Expr Prepend​(Expr elements,
                           Expr collection)
        Returns a new collection with the given elements prepended to the provided collection.
        Parameters:
        elements - the elements to be prepended to the source collection. Type: Array
        collection - the source collection. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions

      • Append

        public static Expr Append​(Expr elements,
                          Expr collection)
        Returns a new collection with the given elements appended to the provided collection.
        Parameters:
        elements - the elements to be appended to the source collection. Type: Array
        collection - the source collection. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions

      • IsEmpty

        public static Expr IsEmpty​(Expr collection)
        Returns true if the given collection is empty, or false otherwise.
        Parameters:
        collection - the source collection to check for emptiness. Type: Collection
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions

      • IsNonEmpty

        public static Expr IsNonEmpty​(Expr collection)
        Returns true if the given collection is not empty, or false otherwise.
        Parameters:
        collection - the source collection to check for non-emptiness. Type: Collection
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Collection Functions

      • KeyFromSecret

        public static Expr KeyFromSecret​(Expr secret)
        Retrieves the key object given the key's secret string.
        Parameters:
        secret - the key's secret string. Type: String
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Read Functions

      • KeyFromSecret

        public static Expr KeyFromSecret​(String secret)
        Retrieves the key object given the key's secret string.
        Parameters:
        secret - the key's secret string.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Read Functions

      • Reduce

        public static Expr Reduce​(Expr lambda,
                          Expr initial,
                          Expr collection)
        Reduce the collection.
        Parameters:
        lambda - the accumulator lambda
        initial - the initial value for the accumulator.
        collection - the collection to be reduced.
        Returns:
        a new Expr instance
        See Also:
        Reduce Function

      • Reverse

        public static Expr Reverse​(Expr source)
        Reverse the order of the given source.
        Parameters:
        source - the source set. Type: Array, Set, or Page.
        Returns:
        a new Expr instance
        See Also:
        Reverse Function

      • Paginate

        public static Pagination Paginate​(Expr resource)
        Returns a Page object that groups a page of results and cursors for retrieving pages before or after the current page. Pages are collections and can be passed directly to some functions such as Map(Expr, Expr), Foreach(Expr, Expr), or Filter(Expr, Expr). Transformations are applied to the Page's data array; cursors are passed through.

        Example:

        
 Pagination paginateUsersQuery = Paginate(Match(Index("all_users_refs"))).withSize(20);
 Optional<Value> nextPageCursor = Optional.absent();

 do {
   if (nextPageCursor.isPresent()) {
     paginateUsersQuery.after(nextPageCursor);
   }

   Value result = client.query(
     Map(
       paginateUsersQuery,
       Lambda(
         Value("ref"),
         Get(Var("ref"))
       )
     )
   ).get();

   Collection<User> allUsers = result.at("data")
     .asCollectionOf(User.class)
     .get();

   // The before and after cursors must be considered opaque values.
   // There is no need to convert them to different types. However,
   // this call will safe guard our code from the absence of a cursor.
   nextPageCursor = result.at("after")
     .to(Value.class)
     .getOptional();

   doSomething(allUsers);

 } while(nextPageCursor.isPresent());
        Parameters:
        resource - the resource to paginate
        Returns:
        a Pagination builder
        See Also:
        Pagination, FaunaDB Read Functions, Match(Expr), Map(Expr, Expr), Foreach(Expr, Expr), Filter(Expr, Expr)

      • Exists

        public static Expr Exists​(Expr ref)
        Returns true if the provided reference exists, or false otherwise.
        Parameters:
        ref - the reference to check for existence. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Read Functions, Ref(Expr, String)

      • Exists

        public static Expr Exists​(Expr ref,
                          Expr timestamp)
        Returns true if the provided reference exists at a specific point in time, or false otherwise.
        Parameters:
        ref - the reference to check for existence. Type: Reference
        timestamp - a timestamp to check for ref's existence. Type: Timestamp
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Read Functions, Ref(Expr, String)

      • Create

        public static Expr Create​(Expr ref,
                          Expr params)
        Creates a new document of the given collection with the parameters provided.
        Parameters:
        ref - the collection reference for which a new document will be created. Type: Reference
        params - the parameters used to create the new document. Type: Object
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Write Functions, Collection(Expr), Ref(Expr, String), Obj(Map)

      • Update

        public static Expr Update​(Expr ref,
                          Expr params)
        Updates the resource identified by the given reference. Updates are partial, and only modify values specified. Scalar values or arrays are replaced by new versions, objects are merged, and null removes a value.
        Parameters:
        ref - the resource reference to update. Type: Reference
        params - the parameters used to update the new document. Type: Object
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Write Functions, Ref(Expr, String), Obj(Map)

      • Replace

        public static Expr Replace​(Expr ref,
                           Expr params)
        Replaces the resource identified by the given reference.
        Parameters:
        ref - the resource reference to be replaced. Type: Reference
        params - the parameters used to replace the resource's old values. Type: Object
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Write Functions, Ref(Expr, String), Obj(Map)

      • CreateClass

        @Deprecated
public static Expr CreateClass​(Expr params)
        Deprecated.
        use CreateCollection instead.
        Creates a new class in the current database.
        Parameters:
        params - the class's configuration parameters. Type: Object
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Write Functions, Obj(Map)

      • CreateCollection

        public static Expr CreateCollection​(Expr params)
        Creates a new collection in the current database.
        Parameters:
        params - the collection's configuration parameters. Type: Object
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Write Functions, Obj(Map)

      • CreateDatabase

        public static Expr CreateDatabase​(Expr params)
        Creates a new database.

        Example:

        
 client.query(
   CreateDatabase(Obj(
     "name", Value("my_database")
   ))
 ).get()
        Parameters:
        params - the database's configuration parameters. Type: Object
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Write Functions, Obj(Map)

      • CreateKey

        public static Expr CreateKey​(Expr params)
        Create a new key in the current database.
        Parameters:
        params - the key's configuration parameters: Type Object
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Write Functions, Obj(Map)

      • CreateIndex

        public static Expr CreateIndex​(Expr params)
        Creates a new index in the current database.
        Parameters:
        params - the index's configuration parameter. Type: Object
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Write Functions, Obj(Map)

      • CreateFunction

        public static Expr CreateFunction​(Expr params)
        Creates a new user defined function in the current database.
        Parameters:
        params - the function's configuration parameters. Type: Object
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Write Functions, Obj(Map)

      • CreateRole

        public static Expr CreateRole​(Expr params)
        Creates a new user role in the current database.
        Parameters:
        params - the role's configuration parameters. Type: Object
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Write Functions, Obj(Map)

      • MoveDatabase

        public static Expr MoveDatabase​(Expr from,
                                Expr to)
        Move database to a new hierarchy.
        Parameters:
        from - database reference to be moved.
        to - new parent database reference.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Write Functions

      • Singleton

        public static Expr Singleton​(Expr ref)
        Returns the history of an instance's presence for the given reference.
        Parameters:
        ref - the document's reference to retrieve the singleton history. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Set Functions, Ref(Expr, String)

      • Events

        public static Expr Events​(Expr refSet)
        Returns the history of an document's data for the given reference.
        Parameters:
        refSet - the resource to retrieve events for. Type: Reference or set reference.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Set Functions, Ref(Expr, String)

      • Match

        public static Expr Match​(Expr index,
                         Expr term)
        Returns the set of resources that match the terms for the given index. Sets must be paginated with the function Paginate(Expr) in order to retrieve their values.
        Parameters:
        index - an index reference. Type: Reference
        term - a value to search in the index provided. Type: any value
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Set Functions, Index(String), Paginate(Expr)

      • Union

        public static Expr Union​(List<? extends Expr> sets)
        Returns the set of resources present in at least on of the sets provided.
        Parameters:
        sets - the sets to execute the union operation
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Set Functions, Match(Expr)

      • Union

        public static Expr Union​(Expr... sets)
        Returns the set of resources present in at least on of the sets provided.
        Parameters:
        sets - the sets to execute the union operation. Type: Array of sets
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Set Functions, Match(Expr)

      • Intersection

        public static Expr Intersection​(List<? extends Expr> sets)
        Returns the set of resources present in all sets provided.
        Parameters:
        sets - the sets to execute the intersection
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Set Functions, Match(Expr)

      • Intersection

        public static Expr Intersection​(Expr... sets)
        Returns the set of resources present in all sets provided.
        Parameters:
        sets - the sets to execute the intersection. Type: Array of sets
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Set Functions, Match(Expr)

      • Difference

        public static Expr Difference​(List<? extends Expr> sets)
        Returns the set of resources present in the first set and not in any other set provided.
        Parameters:
        sets - the sets to take the difference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Set Functions, Match(Expr)

      • Difference

        public static Expr Difference​(Expr... sets)
        Returns the set of resources present in the first set and not in any other set provided.
        Parameters:
        sets - the sets to take the difference. Type: Array of sets
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Set Functions, Match(Expr)

      • Distinct

        public static Expr Distinct​(Expr set)
        Returns a new set after removing all duplicated values.
        Parameters:
        set - the set to remove duplicates. Type: Set
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Set Functions, Match(Expr)

      • Join

        public static Expr Join​(Expr source,
                        Expr target)
        Derives a set of resources from applying each document of the source set to the target parameter. The target parameter can assume two forms: a index reference, and a lambda function. When the target is an index reference, Join will match each result of the source set with the target index's terms. When target is a lambda function, each result from the source set will be passed as the lambda's arguments.
        Parameters:
        source - the source set. Type: Array or Set.
        target - the join target. Type: Index reference or Lambda function
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Set Functions, Index(String), Lambda(Expr, Expr)

      • Join

        public static Expr Join​(Expr source,
                        UnaryOperator<Expr> lambda)
        Derives a set of resources from applying each document of the source set to the target parameter. Each document from the source set will be passed as the lambda argument.
        Parameters:
        source - the source set. Type: Array or Set.
        lambda - the join target.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Set Functions

      • Range

        public static Expr Range​(Expr set,
                         Expr from,
                         Expr to)
        Filter the set based on the lower/upper bounds (inclusive).
        Parameters:
        set - set to be filtered
        from - lower bound
        to - upper bound
        Returns:
        a new Expr instance
        See Also:
        Range Function

      • Logout

        public static Expr Logout​(Expr invalidateAll)
        Delete authentication tokens. If invalidateAll is true, deletes all tokens associated with the current session. Otherwise, deletes only the token used for the current request.
        Parameters:
        invalidateAll - if the Logout function should delete all tokens associated with the current session. Type: Boolean
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Authentication Functions, Login(Expr, Expr)

      • Logout

        public static Expr Logout​(boolean invalidateAll)
        Delete authentication tokens. If invalidateAll is true, deletes all tokens associated with the current session. Otherwise, deletes only the token used for the current request.
        Parameters:
        invalidateAll - if the Logout function should delete all tokens associated with the current session.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Authentication Functions, Login(Expr, Expr)

      • Identify

        public static Expr Identify​(Expr ref,
                            Expr password)
        Checks the given password against the reference's credentials, retuning true if valid, or false otherwise.
        Parameters:
        ref - the reference to authenticate. Type: Reference
        password - the authentication password. Type: String
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Authentication Functions

      • Identify

        public static Expr Identify​(Expr ref,
                            String password)
        Checks the given password against the reference's credentials, retuning true if valid, or false otherwise.
        Parameters:
        ref - the reference to authenticate. Type: Reference
        password - the authentication password.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Authentication Functions

      • AccessProviders

        public static Expr AccessProviders​(Expr scope)
        Returns a reference to a set of all access providers in the database. A reference set must be paginated in order to retrieve its values.
        Parameters:
        scope - a reference to a database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        Database(String), Paginate(Expr), FaunaDB Authentication Functions

      • AccessProviders

        public static Expr AccessProviders()
        Returns a reference to a set of all access providers in the database. A reference set must be paginated in order to retrieve its values.
        Returns:
        a new Expr instance
        See Also:
        Paginate(Expr), FaunaDB Authentication Functions

      • AccessProvider

        public static Expr AccessProvider​(Expr name)
        Creates a reference for the access provider name.
        Parameters:
        name - the access provider name. Type: String
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Authentication Functions

      • AccessProvider

        public static Expr AccessProvider​(String name)
        Creates a reference for the access provider name.
        Parameters:
        name - the access provider name
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Authentication Functions

      • AccessProvider

        public static Expr AccessProvider​(Expr name,
                                  Expr database)
        Creates a reference for the given access provider name, scoped to the database provided.
        Parameters:
        name - the access provider name. Type: String
        database - the scope database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Authentication Functions, Database(String)

      • AccessProvider

        public static Expr AccessProvider​(String name,
                                  Expr database)
        Creates a reference for the given access provider name, scoped to the database provided.
        Parameters:
        name - the access provider name
        database - the scope database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Authentication Functions, Database(String)

      • CreateAccessProvider

        public static Expr CreateAccessProvider​(Expr params)
        Creates a new access provider given the params.
        Parameters:
        params - An object of parameters used to create a new access provider. - name: A valid schema name - issuer: A unique string - jwks_uri: A valid HTTPS URI - roles: An array of role/predicate pairs where the predicate returns a boolean. The array can also contain Role references.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Authentication Functions

      • Concat

        public static Expr Concat​(Expr terms,
                          Expr separator)
        Concatenates a list of strings into a single string value using the separator provided.
        Parameters:
        terms - a list of strings. Type: Array of strings
        separator - a string to separate each element in the result. Type: String
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Arr(List), Value(String)

      • ContainsStr

        public static Expr ContainsStr​(Expr value,
                               Expr search)
        Returns true if the string contains the given substring, or false if otherwise
        Parameters:
        value - the string to evaluate
        search - the substring to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB ContainsStr Function, Value(String)

      • ContainsStr

        public static Expr ContainsStr​(String value,
                               Expr search)
        Returns true if the string contains the given substring, or false if otherwise
        Parameters:
        value - the string to evaluate
        search - the substring to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB ContainsStr Function, Value(String)

      • ContainsStr

        public static Expr ContainsStr​(Expr value,
                               String search)
        Returns true if the string contains the given substring, or false if otherwise
        Parameters:
        value - the string to evaluate
        search - the substring to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB ContainsStr Function, Value(String)

      • ContainsStr

        public static Expr ContainsStr​(String value,
                               String search)
        Returns true if the string contains the given substring, or false if otherwise
        Parameters:
        value - the string to evaluate
        search - the substring to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB ContainsStr Function, Value(String)

      • ContainsStrRegex

        public static Expr ContainsStrRegex​(Expr value,
                                    Expr pattern)
        Returns true if the string contains the given pattern, or false if otherwise
        Parameters:
        value - the string to evaluate
        pattern - the pattern to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB ContainsStrRegex Function, Value(String)

      • ContainsStrRegex

        public static Expr ContainsStrRegex​(String value,
                                    Expr pattern)
        Returns true if the string contains the given pattern, or false if otherwise
        Parameters:
        value - the string to evaluate
        pattern - the pattern to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB ContainsStrRegex Function, Value(String)

      • ContainsStrRegex

        public static Expr ContainsStrRegex​(Expr value,
                                    String pattern)
        Returns true if the string contains the given pattern, or false if otherwise
        Parameters:
        value - the string to evaluate
        pattern - the pattern to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB ContainsStrRegex Function, Value(String)

      • ContainsStrRegex

        public static Expr ContainsStrRegex​(String value,
                                    String pattern)
        Returns true if the string contains the given pattern, or false if otherwise
        Parameters:
        value - the string to evaluate
        pattern - the pattern to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB ContainsStrRegex Function, Value(String)

      • EndsWith

        public static Expr EndsWith​(Expr value,
                            Expr search)
        Returns true if the string ends with the given suffix value, or false if otherwise
        Parameters:
        value - the string to evaluate
        search - the suffix to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB EndsWith Function, Value(String)

      • EndsWith

        public static Expr EndsWith​(String value,
                            Expr search)
        Returns true if the string ends with the given suffix value, or false if otherwise
        Parameters:
        value - the string to evaluate
        search - the suffix to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB EndsWith Function, Value(String)

      • EndsWith

        public static Expr EndsWith​(Expr value,
                            String search)
        Returns true if the string ends with the given suffix value, or false if otherwise
        Parameters:
        value - the string to evaluate
        search - the suffix to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB EndsWith Function, Value(String)

      • EndsWith

        public static Expr EndsWith​(String value,
                            String search)
        Returns true if the string ends with the given suffix value, or false if otherwise
        Parameters:
        value - the string to evaluate
        search - the suffix to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB EndsWith Function, Value(String)

      • FindStr

        public static Expr FindStr​(Expr value,
                           Expr find)
        FindStr function searches a string for a substring and locates the location of the substring in the string
        Parameters:
        value - a strings
        find - a substring to locate
        Returns:
        the offset of where the substring starts or -1 if not found
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStr

        public static Expr FindStr​(String value,
                           Expr find)
        FindStr function searches a string for a substring and locates the location of the substring in the string
        Parameters:
        value - a strings
        find - a substring to locate
        Returns:
        the offset of where the substring starts or -1 if not found
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStr

        public static Expr FindStr​(Expr value,
                           String find)
        FindStr function searches a string for a substring and locates the location of the substring in the string
        Parameters:
        value - a strings
        find - a substring to locate
        Returns:
        the offset of where the substring starts or -1 if not found
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStr

        public static Expr FindStr​(String value,
                           String find)
        FindStr function searches a string for a substring and locates the location of the substring in the string
        Parameters:
        value - a strings
        find - a substring to locate
        Returns:
        the offset of where the substring starts or -1 if not found
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStr

        public static Expr FindStr​(Expr value,
                           Expr find,
                           Expr start)
        FindStr function searches a string for a substring and locates the location of the substring in the string
        Parameters:
        value - a strings
        find - a substring to locate
        start - a position to start the search
        Returns:
        the offset of where the substring starts or -1 if not found
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStr

        public static Expr FindStr​(Expr value,
                           Expr find,
                           long start)
        FindStr function returns FindStr function searches a string for a substring and locates the location of the substring in the string
        Parameters:
        value - a strings
        find - a substring to locate
        start - a position to start the search
        Returns:
        the offset of where the substring starts or -1 if not found
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStr

        public static Expr FindStr​(Expr value,
                           String find,
                           Expr start)
        FindStr function used to searches a string for a substring and locates the location of the substring in the string
        Parameters:
        value - a strings
        find - a substring to locate
        start - a position to start the search
        Returns:
        the offset of where the substring starts or -1 if not found
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStr

        public static Expr FindStr​(String value,
                           Expr find,
                           long start)
        FindStr function searches a string for a substring and locates the location of the substring in the string
        Parameters:
        value - a strings
        find - a substring to locate
        start - a position to start the search
        Returns:
        the offset of where the substring starts or -1 if not found
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStr

        public static Expr FindStr​(String value,
                           String find,
                           Expr start)
        FindStr function searches a string for a substring and locates the location of the substring in the string
        Parameters:
        value - a strings
        find - a substring to locate
        start - a position to start the search
        Returns:
        the offset of where the substring starts or -1 if not found
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStr

        public static Expr FindStr​(String value,
                           String find,
                           long start)
        FindStr function searches a string for a substring and locates the location of the substring in the string
        Parameters:
        value - a strings
        find - a substring to locate
        start - a position to start the search
        Returns:
        the offset of where the substring starts or -1 if not found
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                Expr pattern)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                String pattern)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                Expr pattern)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                String pattern)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                Expr pattern,
                                Expr start)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                Expr pattern,
                                Expr start)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                String pattern,
                                Expr start)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                String pattern,
                                Expr start)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                Expr pattern,
                                long start)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                Expr pattern,
                                long start)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                String pattern,
                                long start)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                String pattern,
                                long start)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                Expr pattern,
                                Expr start,
                                Expr numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                Expr pattern,
                                Expr start,
                                Expr numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                String pattern,
                                Expr start,
                                Expr numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                String pattern,
                                Expr start,
                                Expr numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                Expr pattern,
                                long start,
                                Expr numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                Expr pattern,
                                long start,
                                Expr numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                String pattern,
                                long start,
                                Expr numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                String pattern,
                                long start,
                                Expr numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                Expr pattern,
                                Expr start,
                                long numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                Expr pattern,
                                Expr start,
                                long numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                String pattern,
                                Expr start,
                                long numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                String pattern,
                                Expr start,
                                long numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                Expr pattern,
                                long start,
                                long numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                Expr pattern,
                                long start,
                                long numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(Expr value,
                                String pattern,
                                long start,
                                long numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • FindStrRegex

        public static Expr FindStrRegex​(String value,
                                String pattern,
                                long start,
                                long numResults)
        FindStrRegex function searches a string for a java pattern and locates all the locations of the pattern in the string
        Parameters:
        value - a string to search
        pattern - a substring to locate
        start - the offset into the string
        numResults - the maximum number of results
        Returns:
        an array of objects contain the locations of the match [{ "start":s, "end":e, "data"d}]
        See Also:
        FaunaDB String Functions, Value(String)

      • Length

        public static Expr Length​(Expr value)
        Length function returns the number of characters (codepoints) in the string
        Parameters:
        value - a string to determine the length of
        Returns:
        the length of the string as a long
        See Also:
        FaunaDB String Functions, Value(String)

      • Length

        public static Expr Length​(String value)
        Length function returns the number of characters (codepoints) in the string
        Parameters:
        value - a string to determine the length of
        Returns:
        the length of the string as a long
        See Also:
        FaunaDB String Functions, Value(String)

      • LowerCase

        public static Expr LowerCase​(Expr value)
        Lower function returns all letters in the string in lowercase
        Parameters:
        value - a string to lowercase
        Returns:
        a string with all lowercase letters
        See Also:
        FaunaDB String Functions, Value(String)

      • LowerCase

        public static Expr LowerCase​(String value)
        Lower function returns all letters in the string in lowercase
        Parameters:
        value - a string to lowercase
        Returns:
        a string with all lowercase letters
        See Also:
        FaunaDB String Functions, Value(String)

      • LTrim

        public static Expr LTrim​(Expr value)
        LTrim function returns a new string with leading white space removed
        Parameters:
        value - a string to trim leading white space.
        Returns:
        the string with leading white space removed
        See Also:
        FaunaDB String Functions, Value(String)

      • LTrim

        public static Expr LTrim​(String value)
        LTrim function returns a new string with leading white space removed
        Parameters:
        value - a string to trim leading white space.
        Returns:
        the string with leading white space removed
        See Also:
        FaunaDB String Functions, Value(String)

      • NGram

        public static Expr NGram​(Expr terms,
                         Expr min,
                         Expr max)
        Tokenize the input into n-grams of the given sizes.
        Parameters:
        terms - the value to tokenize. Type: String
        min - the minimum size for the n-grams. Type: Number
        max - the maximum size for the n-grams. Type: Number
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String), Value(long)

      • NGram

        public static Expr NGram​(String terms,
                         Expr min,
                         Expr max)
        Tokenize the input into n-grams of the given sizes.
        Parameters:
        terms - the value to tokenize.
        min - the minimum size for the n-grams. Type: Number
        max - the maximum size for the n-grams. Type: Number
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(long)

      • NGram

        public static Expr NGram​(Expr terms,
                         long min,
                         Expr max)
        Tokenize the input into n-grams of the given sizes.
        Parameters:
        terms - the value to tokenize. Type: String
        min - the minimum size for the n-grams.
        max - the maximum size for the n-grams. Type: Number
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String), Value(long)

      • NGram

        public static Expr NGram​(String terms,
                         long min,
                         Expr max)
        Tokenize the input into n-grams of the given sizes.
        Parameters:
        terms - the value to tokenize.
        min - the minimum size for the n-grams.
        max - the maximum size for the n-grams. Type: Number
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(long)

      • NGram

        public static Expr NGram​(Expr terms,
                         Expr min,
                         long max)
        Tokenize the input into n-grams of the given sizes.
        Parameters:
        terms - the value to tokenize. Type: String
        min - the minimum size for the n-grams. Type: Number
        max - the maximum size for the n-grams.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String), Value(long)

      • NGram

        public static Expr NGram​(String terms,
                         Expr min,
                         long max)
        Tokenize the input into n-grams of the given sizes.
        Parameters:
        terms - the value to tokenize.
        min - the minimum size for the n-grams. Type: Number
        max - the maximum size for the n-grams.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String), Value(long)

      • NGram

        public static Expr NGram​(Expr terms,
                         long min,
                         long max)
        Tokenize the input into n-grams of the given sizes.
        Parameters:
        terms - the value to tokenize. Type: String
        min - the minimum size for the n-grams.
        max - the maximum size for the n-grams.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • NGram

        public static Expr NGram​(String terms,
                         long min,
                         long max)
        Tokenize the input into n-grams of the given sizes.
        Parameters:
        terms - the value to tokenize.
        min - the minimum size for the n-grams.
        max - the maximum size for the n-grams.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions

      • NGram

        public static Expr NGram​(List<Expr> terms,
                         Expr min,
                         Expr max)
        Tokenize the input into n-grams of the given sizes.
        Parameters:
        terms - the list of values to tokenize. Type: Array of strings
        min - the minimum size for the n-grams. Type: Number
        max - the maximum size for the n-grams. Type: Number
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Arr(List), Value(String), Value(long)

      • RegexEscape

        public static Expr RegexEscape​(Expr value)
        It takes a string and returns a regex which matches the input string verbatim.
        Parameters:
        value - the string to analyze
        Returns:
        a regex which matches the input string verbatim
        See Also:
        FaunaDB RegexEscape Function, Value(String)

      • RegexEscape

        public static Expr RegexEscape​(String value)
        It takes a string and returns a regex which matches the input string verbatim.
        Parameters:
        value - the string to analyze
        Returns:
        a regex which matches the input string verbatim
        See Also:
        FaunaDB RegexEscape Function, Value(String)

      • Repeat

        public static Expr Repeat​(Expr value,
                          Expr number)
        Repeat function returns a string concatenanted the specified number of times
        Parameters:
        value - a strings
        number - an integer value indicate the number of times to repeat the string
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • Repeat

        public static Expr Repeat​(String value,
                          Expr number)
        Repeat function returns a string concatenanted the specified number of times
        Parameters:
        value - a strings
        number - an integer value indicate the number of times to repeat the string
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • Repeat

        public static Expr Repeat​(Expr value,
                          long number)
        Repeat function returns a string concatenanted the specified number of times
        Parameters:
        value - a strings
        number - an integer value indicate the number of times to repeat the string
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • Repeat

        public static Expr Repeat​(String value,
                          long number)
        Repeat function returns a string concatenanted the specified number of times
        Parameters:
        value - a strings
        number - an integer value indicate the number of times to repeat the string
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStr

        public static Expr ReplaceStr​(Expr value,
                              Expr find,
                              Expr replace)
        ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
        Parameters:
        value - the source string
        find - the substring to locate in in the source string
        replace - the string to replaice the "find" string when located
        Returns:
        the new string with every occurence of the "find" string changed to "replace" string
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStr

        public static Expr ReplaceStr​(String value,
                              Expr find,
                              Expr replace)
        ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
        Parameters:
        value - the source string
        find - the substring to locate in in the source string
        replace - the string to replaice the "find" string when located
        Returns:
        the new string with every occurence of the "find" string changed to "replace" string
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStr

        public static Expr ReplaceStr​(Expr value,
                              String find,
                              Expr replace)
        ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
        Parameters:
        value - the source string
        find - the substring to locate in in the source string
        replace - the string to replaice the "find" string when located
        Returns:
        the new string with every occurence of the "find" string changed to "replace" string
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStr

        public static Expr ReplaceStr​(String value,
                              String find,
                              Expr replace)
        ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
        Parameters:
        value - the source string
        find - the substring to locate in in the source string
        replace - the string to replaice the "find" string when located
        Returns:
        the new string with every occurence of the "find" string changed to "replace" string
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStr

        public static Expr ReplaceStr​(Expr value,
                              Expr find,
                              String replace)
        ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
        Parameters:
        value - the source string
        find - the substring to locate in in the source string
        replace - the string to replaice the "find" string when located
        Returns:
        the new string with every occurence of the "find" string changed to "replace" string
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStr

        public static Expr ReplaceStr​(String value,
                              Expr find,
                              String replace)
        ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
        Parameters:
        value - the source string
        find - the substring to locate in in the source string
        replace - the string to replaice the "find" string when located
        Returns:
        the new string with every occurence of the "find" string changed to "replace" string
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStr

        public static Expr ReplaceStr​(Expr value,
                              String find,
                              String replace)
        ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
        Parameters:
        value - the source string
        find - the substring to locate in in the source string
        replace - the string to replaice the "find" string when located
        Returns:
        the new string with every occurence of the "find" string changed to "replace" string
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStr

        public static Expr ReplaceStr​(String value,
                              String find,
                              String replace)
        ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
        Parameters:
        value - the source string
        find - the substring to locate in in the source string
        replace - the string to replaice the "find" string when located
        Returns:
        the new string with every occurence of the "find" string changed to "replace" string
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(Expr value,
                                   Expr pattern,
                                   Expr replace)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(String value,
                                   Expr pattern,
                                   Expr replace)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(Expr value,
                                   String pattern,
                                   Expr replace)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(String value,
                                   String pattern,
                                   Expr replace)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(Expr value,
                                   Expr pattern,
                                   String replace)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(String value,
                                   Expr pattern,
                                   String replace)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(Expr value,
                                   String pattern,
                                   String replace)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(String value,
                                   String pattern,
                                   String replace)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(Expr value,
                                   Expr pattern,
                                   Expr replace,
                                   Expr first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(String value,
                                   Expr pattern,
                                   Expr replace,
                                   Expr first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(Expr value,
                                   String pattern,
                                   Expr replace,
                                   Expr first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(String value,
                                   String pattern,
                                   Expr replace,
                                   Expr first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(Expr value,
                                   Expr pattern,
                                   String replace,
                                   Expr first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(String value,
                                   Expr pattern,
                                   String replace,
                                   Expr first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(Expr value,
                                   String pattern,
                                   String replace,
                                   Expr first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(String value,
                                   String pattern,
                                   String replace,
                                   Expr first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(Expr value,
                                   Expr pattern,
                                   Expr replace,
                                   Boolean first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(String value,
                                   Expr pattern,
                                   Expr replace,
                                   boolean first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(Expr value,
                                   String pattern,
                                   Expr replace,
                                   boolean first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(String value,
                                   String pattern,
                                   Expr replace,
                                   boolean first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(Expr value,
                                   Expr pattern,
                                   String replace,
                                   boolean first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(String value,
                                   Expr pattern,
                                   String replace,
                                   boolean first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(Expr value,
                                   String pattern,
                                   String replace,
                                   boolean first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • ReplaceStrRegex

        public static Expr ReplaceStrRegex​(String value,
                                   String pattern,
                                   String replace,
                                   boolean first)
        ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
        Parameters:
        value - the source string
        pattern - a java regular expression to locate
        replace - the string to replace the pattern when located
        first - only replace the first found pattern
        Returns:
        a new Expr instance
        See Also:
        FaunaDB String Functions, Value(String)

      • RTrim

        public static Expr RTrim​(Expr value)
        RTrim function returns a new string with trailing whitespace removed
        Parameters:
        value - a string to trim whitespace.
        Returns:
        the string with trailing whitespace removed
        See Also:
        FaunaDB String Functions, Value(String)

      • RTrim

        public static Expr RTrim​(String value)
        RTrim function returns a new string with trailing whitespace removed
        Parameters:
        value - a string to trim whitespace.
        Returns:
        the string with trailing whitespace removed
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(Expr value)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(String value)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(Expr value,
                             Expr start)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        start - the position in the source string where SubString starts extracting characters
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(String value,
                             Expr start)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        start - the position in the source string where SubString starts extracting characters
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(Expr value,
                             long start)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        start - the position in the source string where SubString starts extracting characters
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(String value,
                             long start)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        start - the position in the source string where SubString starts extracting characters
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(Expr value,
                             Expr start,
                             Expr length)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        start - the position in the source string where SubString starts extracting characters
        length - the number of characters to be returned
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(String value,
                             Expr start,
                             Expr length)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        start - the position in the source string where SubString starts extracting characters
        length - the number of characters to be returned
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(Expr value,
                             long start,
                             Expr length)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        start - the position in the source string where SubString starts extracting characters
        length - the number of characters to be returned
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(String value,
                             long start,
                             Expr length)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        start - the position in the source string where SubString starts extracting characters
        length - the number of characters to be returned
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(Expr value,
                             long start,
                             long length)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        start - the position in the source string where SubString starts extracting characters
        length - the number of characters to be returned
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(Expr value,
                             Expr start,
                             long length)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        start - the position in the source string where SubString starts extracting characters
        length - the number of characters to be returned
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(String value,
                             Expr start,
                             long length)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        start - the position in the source string where SubString starts extracting characters
        length - the number of characters to be returned
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • SubString

        public static Expr SubString​(String value,
                             long start,
                             long length)
        SubString function returns a subset of the source string
        Parameters:
        value - the source string
        start - the position in the source string where SubString starts extracting characters
        length - the number of characters to be returned
        Returns:
        a new string contain a subset of the source string
        See Also:
        FaunaDB String Functions, Value(String)

      • TitleCase

        public static Expr TitleCase​(Expr value)
        TitleCase function returns a string with the first letter in each word capitalized
        Parameters:
        value - a strings to TitleCase
        Returns:
        a new string in TitleCase
        See Also:
        FaunaDB String Functions, Value(String)

      • TitleCase

        public static Expr TitleCase​(String value)
        TitleCase function returns a string with the first letter in each word capitalized
        Parameters:
        value - a strings to TitleCase
        Returns:
        a new string in TitleCase
        See Also:
        FaunaDB String Functions, Value(String)

      • Trim

        public static Expr Trim​(Expr value)
        Trim function returns a new string with leading and trailing whitespace removed
        Parameters:
        value - a string to trim white space.
        Returns:
        the string with leading and trailing whitespace removed Trim function returns
        See Also:
        FaunaDB String Functions, Value(String)

      • Trim

        public static Expr Trim​(String value)
        Trim function returns a new string with leading and trailing whitespace removed
        Parameters:
        value - a string to trim white space.
        Returns:
        the string with leading and trailing whitespace removed
        See Also:
        FaunaDB String Functions, Value(String)

      • UpperCase

        public static Expr UpperCase​(Expr value)
        UpperCase function returns all letters in the string in uppercase
        Parameters:
        value - a string to uppercase
        Returns:
        a string with all uppercase letters
        See Also:
        FaunaDB String Functions, Value(String)

      • UpperCase

        public static Expr UpperCase​(String value)
        UpperCase function returns all letters in the string in uppercase
        Parameters:
        value - a string to uppercase
        Returns:
        a string with all uppercase letters
        See Also:
        FaunaDB String Functions, Value(String)

      • Format

        public static Expr Format​(Expr format,
                          Expr... values)
        Format values into a string.
        Parameters:
        format - a string with format specifiers
        values - a list of values to format
        Returns:
        a string
        See Also:
        FaunaDB String Functions, Value(String)

      • Format

        public static Expr Format​(String format,
                          Expr... values)
        Format values into a string.
        Parameters:
        format - a string with format specifiers
        values - a list of values to format
        Returns:
        a string
        See Also:
        FaunaDB String Functions

      • StartsWith

        public static Expr StartsWith​(Expr value,
                              Expr search)
        Returns true if the string starts with the given prefix value, or false if otherwise
        Parameters:
        value - the string to evaluate
        search - the prefix to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB StartsWith Function, Value(String)

      • StartsWith

        public static Expr StartsWith​(String value,
                              Expr search)
        Returns true if the string starts with the given prefix value, or false if otherwise
        Parameters:
        value - the string to evaluate
        search - the prefix to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB StartsWith Function, Value(String)

      • StartsWith

        public static Expr StartsWith​(Expr value,
                              String search)
        Returns true if the string starts with the given prefix value, or false if otherwise
        Parameters:
        value - the string to evaluate
        search - the prefix to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB StartsWith Function, Value(String)

      • StartsWith

        public static Expr StartsWith​(String value,
                              String search)
        Returns true if the string starts with the given prefix value, or false if otherwise
        Parameters:
        value - the string to evaluate
        search - the prefix to search for
        Returns:
        a Expr instance with the evaluation result
        See Also:
        FaunaDB StartsWith Function, Value(String)

      • Time

        public static Expr Time​(Expr str)
        Creates a new timestamp from an ISO-8601 offset date/time string. A special string "now" can be used to get the current transaction time. Multiple references to "now" within the same query will be equal.
        Parameters:
        str - an ISO-8601 formatted string or the string literal "now". Type: String
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Time and Date Functions, Value(String)

      • Time

        public static Expr Time​(String str)
        Creates a new timestamp from an ISO-8601 offset date/time string. A special string "now" can be used to get the current transaction time. Multiple references to "now" within the same query will be equal.
        Parameters:
        str - an ISO-8601 formatted string or the string literal "now"
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Time and Date Functions

      • Epoch

        public static Expr Epoch​(Expr num,
                         Expr unit)
        Constructs a timestamp relative to the epoch "1970-01-01T00:00:00Z" given a unit type and a number of units. Possible unit types are:
        • day
        • half day
        • hour
        • minute
        • second
        • millisecond
        • microsecond
        • nanosecond
        Parameters:
        num - the number of units. Type: Number
        unit - the unit type. Type: String
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Time and Date Functions, Value(long)

      • Epoch

        public static Expr Epoch​(Expr num,
                         String unit)
        Constructs a timestamp relative to the epoch "1970-01-01T00:00:00Z" given a unit type and a number of units.
        Parameters:
        num - the number of units. Type: Number
        unit - the unit type.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Time and Date Functions, Value(long)

      • Epoch

        public static Expr Epoch​(long num,
                         Expr unit)
        Constructs a timestamp relative to the epoch "1970-01-01T00:00:00Z" given a unit type and a number of units.
        Parameters:
        num - the number of units.
        unit - the unit type. Type: String
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Time and Date Functions, Value(String)

      • Epoch

        public static Expr Epoch​(long num,
                         String unit)
        Constructs a timestamp relative to the epoch "1970-01-01T00:00:00Z" given a unit type and a number of units.
        Parameters:
        num - the number of units.
        unit - the unit type.
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Time and Date Functions

      • TimeAdd

        public static Expr TimeAdd​(Expr base,
                           Expr offset,
                           Expr unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data. Type: Time or Date
        offset - the number of units. Type: Number
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(Expr base,
                           Expr offset,
                           Language.TimeUnit unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data. Type: Time or Date
        offset - the number of units. Type: Number
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(Expr base,
                           Expr offset,
                           String unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data. Type: Time or Date
        offset - the number of units. Type: Number
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(Expr base,
                           long offset,
                           Expr unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data. Type: Time or Date
        offset - the number of units.
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(Expr base,
                           long offset,
                           Language.TimeUnit unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data. Type: Time or Date
        offset - the number of units.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(Expr base,
                           long offset,
                           String unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data. Type: Time or Date
        offset - the number of units.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(Instant base,
                           Expr offset,
                           Expr unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data.
        offset - the number of units. Type: Number
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(Instant base,
                           Expr offset,
                           Language.TimeUnit unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data.
        offset - the number of units. Type: Number
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(Instant base,
                           Expr offset,
                           String unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data.
        offset - the number of units. Type: Number
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(Instant base,
                           long offset,
                           Expr unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data.
        offset - the number of units.
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(Instant base,
                           long offset,
                           Language.TimeUnit unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data.
        offset - the number of units.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(Instant base,
                           long offset,
                           String unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data.
        offset - the number of units.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(LocalDate base,
                           Expr offset,
                           Expr unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data.
        offset - the number of units. Type: Number
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(LocalDate base,
                           long offset,
                           Expr unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data.
        offset - the number of units.
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(LocalDate base,
                           long offset,
                           Language.TimeUnit unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data.
        offset - the number of units.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(LocalDate base,
                           long offset,
                           String unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data.
        offset - the number of units.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(LocalDate base,
                           Expr offset,
                           Language.TimeUnit unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data.
        offset - the number of units. Type: Number
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeAdd

        public static Expr TimeAdd​(LocalDate base,
                           Expr offset,
                           String unit)
        Returns a new time or date with the offset in terms of the unit added.
        Parameters:
        base - the base time or data.
        offset - the number of units. Type: Number
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(Expr base,
                                Expr offset,
                                Expr unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data. Type: Time or Date
        offset - the number of units. Type: Number
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(Expr base,
                                Expr offset,
                                Language.TimeUnit unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data. Type: Time or Date
        offset - the number of units. Type: Number
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(Expr base,
                                Expr offset,
                                String unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data. Type: Time or Date
        offset - the number of units. Type: Number
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(Expr base,
                                long offset,
                                Expr unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data. Type: Time or Date
        offset - the number of units.
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(Expr base,
                                long offset,
                                Language.TimeUnit unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data. Type: Time or Date
        offset - the number of units.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(Expr base,
                                long offset,
                                String unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data. Type: Time or Date
        offset - the number of units.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(Instant base,
                                Expr offset,
                                Expr unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data.
        offset - the number of units. Type: Number
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(Instant base,
                                Expr offset,
                                Language.TimeUnit unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data.
        offset - the number of units. Type: Number
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(Instant base,
                                Expr offset,
                                String unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data.
        offset - the number of units. Type: Number
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(Instant base,
                                long offset,
                                Expr unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data.
        offset - the number of units.
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(Instant base,
                                long offset,
                                Language.TimeUnit unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data.
        offset - the number of units.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(Instant base,
                                long offset,
                                String unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data.
        offset - the number of units.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(LocalDate base,
                                Expr offset,
                                Expr unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data.
        offset - the number of units. Type: Number
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(LocalDate base,
                                Expr offset,
                                Language.TimeUnit unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data.
        offset - the number of units. Type: Number
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(LocalDate base,
                                Expr offset,
                                String unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data.
        offset - the number of units. Type: Number
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(LocalDate base,
                                long offset,
                                Expr unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data.
        offset - the number of units.
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(LocalDate base,
                                long offset,
                                Language.TimeUnit unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data.
        offset - the number of units.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeSubtract

        public static Expr TimeSubtract​(LocalDate base,
                                long offset,
                                String unit)
        Returns a new time or date with the offset in terms of the unit subtracted.
        Parameters:
        base - the base time or data.
        offset - the number of units.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(Expr start,
                            Expr finish,
                            Expr unit)
        Returns the number of intervals in terms of the unit between two times or dates. Both start and finish must be of the same type.
        Parameters:
        start - the starting time or date, inclusive. Type: Time or Date
        finish - the ending time or date, exclusive. Type: Time or Date
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(Expr start,
                            Expr finish,
                            Language.TimeUnit unit)
        Returns the number of intervals in terms of the unit between two times or dates. Both start and finish must be of the same type.
        Parameters:
        start - the starting time or date, inclusive. Type: Time or Date
        finish - the ending time or date, exclusive. Type: Time or Date
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(Expr start,
                            Expr finish,
                            String unit)
        Returns the number of intervals in terms of the unit between two times or dates. Both start and finish must be of the same type.
        Parameters:
        start - the starting time or date, inclusive. Type: Time or Date
        finish - the ending time or date, exclusive. Type: Time or Date
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(Instant start,
                            Expr finish,
                            Expr unit)
        Returns the number of intervals in terms of the unit between two times.
        Parameters:
        start - the starting time, inclusive.
        finish - the ending time, exclusive. Type: Time
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(Instant start,
                            Expr finish,
                            Language.TimeUnit unit)
        Returns the number of intervals in terms of the unit between two times.
        Parameters:
        start - the starting time, inclusive.
        finish - the ending time, exclusive. Type: Time
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(Instant start,
                            Expr finish,
                            String unit)
        Returns the number of intervals in terms of the unit between two times.
        Parameters:
        start - the starting time, inclusive.
        finish - the ending time, exclusive. Type: Time
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(Instant start,
                            Instant finish,
                            Expr unit)
        Returns the number of intervals in terms of the unit between two times.
        Parameters:
        start - the starting time, inclusive.
        finish - the ending time, exclusive.
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(Instant start,
                            Instant finish,
                            Language.TimeUnit unit)
        Returns the number of intervals in terms of the unit between two times.
        Parameters:
        start - the starting time, inclusive.
        finish - the ending time, exclusive.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(Instant start,
                            Instant finish,
                            String unit)
        Returns the number of intervals in terms of the unit between two times.
        Parameters:
        start - the starting time, inclusive.
        finish - the ending time, exclusive.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(LocalDate start,
                            Expr finish,
                            Expr unit)
        Returns the number of intervals in terms of the unit between two dates.
        Parameters:
        start - the starting date, inclusive.
        finish - the ending date, exclusive. Type: Date
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(LocalDate start,
                            Expr finish,
                            Language.TimeUnit unit)
        Returns the number of intervals in terms of the unit between two dates.
        Parameters:
        start - the starting date, inclusive.
        finish - the ending date, exclusive. Type: Date
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(LocalDate start,
                            Expr finish,
                            String unit)
        Returns the number of intervals in terms of the unit between two dates.
        Parameters:
        start - the starting date, inclusive.
        finish - the ending date, exclusive. Type: Date
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(LocalDate start,
                            LocalDate finish,
                            Expr unit)
        Returns the number of intervals in terms of the unit between two dates.
        Parameters:
        start - the starting date, inclusive.
        finish - the ending date, exclusive.
        unit - the unit type. Type: String
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(LocalDate start,
                            LocalDate finish,
                            Language.TimeUnit unit)
        Returns the number of intervals in terms of the unit between two dates.
        Parameters:
        start - the starting date, inclusive.
        finish - the ending date, exclusive.
        unit - the unit type.
        Returns:
        a new Expr instance

      • TimeDiff

        public static Expr TimeDiff​(LocalDate start,
                            LocalDate finish,
                            String unit)
        Returns the number of intervals in terms of the unit between two dates.
        Parameters:
        start - the starting date, inclusive.
        finish - the ending date, exclusive.
        unit - the unit type.
        Returns:
        a new Expr instance

      • Date

        public static Expr Date​(String str)
        Creates a date from an ISO-8601 formatted date string.
        Parameters:
        str - an ISO-8601 formatted date string
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Time and Date Functions

      • Now

        public static Expr Now()
        Returns the current snapshot time.
        Returns:
        a new Expr instance
        See Also:
        Now function

      • Class

        @Deprecated
public static Expr Class​(Expr name,
                         Expr database)
        Deprecated.
        use Collection instead
        Creates a reference for the given class name, scoped to the database provided.
        Parameters:
        name - the class name. Type: String
        database - the scope database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions, Database(String)

      • Collection

        public static Expr Collection​(Expr name)
        Creates a new reference for the given collection name.
        Parameters:
        name - the collection name. Type: String
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Collection

        public static Expr Collection​(String name)
        Creates a new reference for the given collection name.
        Parameters:
        name - the collection name
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Collection

        public static Expr Collection​(Expr name,
                              Expr database)
        Creates a reference for the given collection name, scoped to the database provided.
        Parameters:
        name - the collection name. Type: String
        database - the scope database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions, Database(String)

      • Collection

        public static Expr Collection​(String name,
                              Expr database)
        Creates a reference for the given collection name, scoped to the database provided.
        Parameters:
        name - the collection name
        database - the scope database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions, Database(String)

      • Database

        public static Expr Database​(Expr name)
        Creates a reference for the given database name.
        Parameters:
        name - the database name. Type: String
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Database

        public static Expr Database​(Expr name,
                            Expr database)
        Creates a reference for the given database name, scoped to the database provided.
        Parameters:
        name - the database name. Type: String
        database - the scope database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Database

        public static Expr Database​(String name,
                            Expr database)
        Creates a reference for the given database name, scoped to the database provided.
        Parameters:
        name - the database name
        database - the scope database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Index

        public static Expr Index​(Expr name,
                         Expr database)
        Creates a reference for the given index name, scoped to the database provided.
        Parameters:
        name - the index name. Type: String
        database - the scope database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Index

        public static Expr Index​(String name,
                         Expr database)
        Creates a reference for the given index name, scoped to the database provided.
        Parameters:
        name - the index name
        database - the scope database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Function

        public static Expr Function​(Expr name)
        Creates a reference for the given user defined function name.
        Parameters:
        name - the user defined function name. Type: String
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Function

        public static Expr Function​(String name)
        Creates a reference for the given user defined function name.
        Parameters:
        name - the user defined function name
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Function

        public static Expr Function​(Expr name,
                            Expr database)
        Creates a reference for the given user defined function name, scoped to the database provided.
        Parameters:
        name - the user defined function name. Type: String
        database - the scope database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Function

        public static Expr Function​(String name,
                            Expr database)
        Creates a reference for the given user defined function name, scoped to the database provided.
        Parameters:
        name - the user defined function name
        database - the scope database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Role

        public static Expr Role​(Expr name,
                        Expr database)
        Creates a reference for the given role name, scoped to the database provided.
        Parameters:
        name - the role name. Type: String
        database - the scope database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Role

        public static Expr Role​(String name,
                        Expr database)
        Creates a reference for the given role name, scoped to the database provided.
        Parameters:
        name - the role name.
        database - the scope database. Type: Reference
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Equals

        public static Expr Equals​(List<? extends Expr> values)
        Tests equivalence between a list of values.
        Parameters:
        values - the values to test equivalence for
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Equals

        public static Expr Equals​(Expr... values)
        Tests equivalence between a list of values.
        Parameters:
        values - the values to test equivalence for
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Contains

        @Deprecated
public static Expr Contains​(Expr path,
                            Expr in)
        Deprecated.
        use ContainsPath instead
        Returns true if the target value contains the given path, and false otherwise. The path must be an array in which each element can be either a string, or a number. If a string, the path segment refers to an object key. If a number, the path segment refers to an array index. For convenience, a path builder is available at the Contains(Path, Expr) function.
        Parameters:
        path - the desired path to check for presence. Type: Array
        in - the target value. Type: Object or Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions, Contains(Path, Expr)

      • Contains

        @Deprecated
public static Expr Contains​(Language.Path path,
                            Expr in)
        Deprecated.
        use ContainsPath instead
        Returns true if the target value contains the given path, and false otherwise.
        Parameters:
        path - the desired path to check for presence
        in - the target value. Type: Object or Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • ContainsField

        public static Expr ContainsField​(Expr field,
                                 Expr in)
        Returns true if the target Expr contains the given field, and false otherwise.
        Parameters:
        field - the desired value to field for presence.
        in - the target value. Type: Object or Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • ContainsPath

        public static Expr ContainsPath​(Expr path,
                                Expr in)
        Returns true if the target value contains the given path, and false otherwise. The path must be an array in which each element can be either a string, or a number. If a string, the path segment refers to an object key. If a number, the path segment refers to an array index. For convenience, a path builder is available at the ContainsPath(Path, Expr) function.
        Parameters:
        path - the desired path to check for presence. Type: Array
        in - the target value. Type: Object or Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions, ContainsPath(Path, Expr)

      • ContainsPath

        public static Expr ContainsPath​(Language.Path path,
                                Expr in)
        Returns true if the target value contains the given path, and false otherwise.
        Parameters:
        path - the desired path to check for presence
        in - the target value. Type: Object or Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • ContainsValue

        public static Expr ContainsValue​(Expr value,
                                 Expr in)
        Returns true if the target Expr contains the given value, and false otherwise.
        Parameters:
        value - the desired value to check for presence.
        in - the target value. Type: Ref, Object, Array or Set
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Miscellaneous Functions

      • Select

        public static Expr Select​(Expr path,
                          Expr from)
        Traverses target resource returning the value under the given path. Returns an error if the path doesn't exist. The path must be an array in which each element can be either a string, or a number. If a string, the path segment refers to an object key. If a number, the path segment refers to an array index. For convenience, a path builder is available at the Select(Path, Expr) function.
        Parameters:
        path - the path to the desired value. Type: Array
        from - the target resource. Type: Object or Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Read Functions, Select(Path, Expr)

      • Select

        public static Expr Select​(Expr path,
                          Expr from,
                          Expr defaultValue)
        Traverses target resource returning the value under the given path. Returns the default value provided if the path doesn't exist. The path must be an array in which each element can be either a string, or a number. If a string, the path segment refers to an object key. If a number, the path segment refers to an array index. For convenience, a path builder is available at the Select(Path, Expr, Expr) function.
        Parameters:
        path - the path to the desired value. Type: Array
        from - the target resource. Type: Object or Array
        defaultValue - the default value to return if the desired path doesn't exist
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Read Functions, Select(Path, Expr, Expr)

      • Select

        public static Expr Select​(Language.Path path,
                          Expr from)
        Traverses target resource returning the value under the given path. Returns an error if the path doesn't exist.
        Parameters:
        path - the path to the desired value
        from - the target resource. Type: Object or Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Read Functions

      • Select

        public static Expr Select​(Language.Path path,
                          Expr from,
                          Expr defaultValue)
        Traverses target resource returning the value under the given path. Returns the default value provided if the path doesn't exist.
        Parameters:
        path - the path to the desired value
        from - the target resource. Type: Object or Array
        defaultValue - the default value to return if the desired path doesn't exist
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Read Functions

      • SelectAll

        @Deprecated
public static Expr SelectAll​(Expr path,
                             Expr from)
        Deprecated.
        use SelectAsIndex instead
        Selects the desired path for each element in the given array. The path must be an array in which each element can be either a string, or a number. If a string, the path segment refers to an object key. If a number, the path segment refers to an array index. For convenience, a path builder is available at the SelectAll(Path, Expr) function.
        Parameters:
        path - the path to the desired value. Type: Array
        from - the collection to traverse. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Read Functions, Select(Path, Expr)

      • SelectAll

        @Deprecated
public static Expr SelectAll​(Language.Path path,
                             Expr from)
        Deprecated.
        use SelectAsIndex instead
        Selects the desired path for each element in the given array.
        Parameters:
        path - the path to the desired value
        from - the collection to traverse. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Read Functions

      • SelectAsIndex

        public static Expr SelectAsIndex​(Expr path,
                                 Expr from)
        Selects the desired path for each element in the given array. The path must be an array in which each element can be either a string, or a number. If a string, the path segment refers to an object key. If a number, the path segment refers to an array index. For convenience, a path builder is available at the SelectAsIndex(Path, Expr) function.
        Parameters:
        path - the path to the desired value. Type: Array
        from - the collection to traverse. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB SelectAsIndex Function, Select(Path, Expr)

      • SelectAsIndex

        public static Expr SelectAsIndex​(Language.Path path,
                                 Expr from)
        Selects the desired path for each element in the given array.
        Parameters:
        path - the path to the desired value
        from - the collection to traverse. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB SelectAsIndex Function

      • BitAnd

        public static Expr BitAnd​(List<? extends Expr> values)
        Computes the bitwise and of a list of numbers.
        Parameters:
        values - the list of numbers. Type: Array
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • BitAnd

        public static Expr BitAnd​(Expr... values)
        Computes the bitwise and of a list of numbers.
        Parameters:
        values - the list of numbers. Type: Array
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • BitNot

        public static Expr BitNot​(Expr value)
        Computes the bitwise NOT of a numbers.
        Parameters:
        value - The operand to atan. Type: Number
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • BitNot

        public static Expr BitNot​(Long value)
        Computes the bitwise NOT of a numbers.
        Parameters:
        value - The operand to atan. Type: Number
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • BitOr

        public static Expr BitOr​(List<? extends Expr> values)
        Computes the bitwise OR of a list of numbers.
        Parameters:
        values - the list of numbers. Type: Array
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • BitOr

        public static Expr BitOr​(Expr... values)
        Computes the bitwise OR of a list of numbers.
        Parameters:
        values - the list of numbers. Type: Array
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • BitXor

        public static Expr BitXor​(List<? extends Expr> values)
        Computes the bitwise XOR of a list of numbers.
        Parameters:
        values - the list of numbers. Type: Array
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • BitXor

        public static Expr BitXor​(Expr... values)
        Computes the bitwise XOR of a list of numbers.
        Parameters:
        values - the list of numbers. Type: Array
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Cosh

        public static Expr Cosh​(Expr value)
        Computes the hyperbolic cosine of a numbers.
        Parameters:
        value - The operand to cosh. Type: Number
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Degrees

        public static Expr Degrees​(Expr value)
        Computes the degrees of a numbers.
        Parameters:
        value - The operand to degrees. Type: Number
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Degrees

        public static Expr Degrees​(Long value)
        Computes the degrees of a numbers.
        Parameters:
        value - The operand to degrees. Type: Number
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Divide

        public static Expr Divide​(List<? extends Expr> values)

      • Divide

        public static Expr Divide​(Expr... values)
        Computes the quotient of a list of numbers.
        Parameters:
        values - the list of numbers. Type: Array
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Modulo

        public static Expr Modulo​(List<? extends Expr> values)
        Computes the remainder after division of a list of numbers.
        Parameters:
        values - the list of numbers. Type: Array
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Modulo

        public static Expr Modulo​(Expr... values)
        Computes the remainder after division of a list of numbers.
        Parameters:
        values - the list of numbers. Type: Array
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Multiply

        public static Expr Multiply​(List<? extends Expr> values)
        Computes the product of a list of numbers.
        Parameters:
        values - the list of numbers. Type: Array
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Multiply

        public static Expr Multiply​(Expr... values)
        Computes the product of a list of numbers.
        Parameters:
        values - the list of numbers. Type: Array
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Radians

        public static Expr Radians​(Expr value)
        Computes the radians of a number.
        Parameters:
        value - The operand to radians. Type: Number
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Sinh

        public static Expr Sinh​(Expr value)
        Computes the Sinh of a number.
        Parameters:
        value - The operand to hyperbolic sine. Type: Number
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Subtract

        public static Expr Subtract​(List<? extends Expr> values)
        Computes the difference of a list of numbers.
        Parameters:
        values - the list of numbers. Type: Array
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Subtract

        public static Expr Subtract​(Expr... values)
        Computes the difference of a list of numbers.
        Parameters:
        values - the list of numbers. Type: Array
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Tanh

        public static Expr Tanh​(Expr value)
        Computes the hyperbolic tangent of a numbers.
        Parameters:
        value - The operand to tanh. Type: Number
        Returns:
        a Expr instance
        See Also:
        FaunaDB Mathematical Functions

      • Count

        public static Expr Count​(Expr collection)
        Count the number of elements in the collection.
        Parameters:
        collection - the collection
        Returns:
        a new Expr instance
        See Also:
        Count function

      • Sum

        public static Expr Sum​(Expr collection)
        Sum the elements in the collection.
        Parameters:
        collection - the collection
        Returns:
        a new Expr instance
        See Also:
        Sum function

      • Mean

        public static Expr Mean​(Expr collection)
        Returns the mean of all elements in the collection.
        Parameters:
        collection - the collection
        Returns:
        a new Expr instance
        See Also:
        Mean function

      • All

        public static Expr All​(Expr collection)
        Evaluates to true if all elements of the collection is true.
        Parameters:
        collection - the collection
        Returns:
        a new Expr instance
        See Also:
        All function

      • Any

        public static Expr Any​(Expr collection)
        Evaluates to true if any element of the collection is true.
        Parameters:
        collection - the collection
        Returns:
        a new Expr instance
        See Also:
        Any function

      • LT

        public static Expr LT​(List<? extends Expr> values)
        Returns true if the first element of the given collection is less than the ones following, and false otherwise.
        Parameters:
        values - the list of numbers to compare. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Logical Functions

      • LT

        public static Expr LT​(Expr... values)
        Returns true if the first element of the given collection is less than the ones following, and false otherwise.
        Parameters:
        values - the list of numbers to compare. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Logical Functions

      • LTE

        public static Expr LTE​(List<? extends Expr> values)
        Returns true if the first element of the given collection is less than or equal to the ones following, and false otherwise.
        Parameters:
        values - the list of numbers to compare. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Logical Functions

      • LTE

        public static Expr LTE​(Expr... values)
        Returns true if the first element of the given collection is less than or equal to the ones following, and false otherwise.
        Parameters:
        values - the list of numbers to compare. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Logical Functions

      • GT

        public static Expr GT​(List<? extends Expr> values)
        Returns true if the first element of the given collection is greater than the ones following, and false otherwise.
        Parameters:
        values - the list of numbers to compare. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Logical Functions

      • GT

        public static Expr GT​(Expr... values)
        Returns true if the first element of the given collection is greater than the ones following, and false otherwise.
        Parameters:
        values - the list of numbers to compare. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Logical Functions

      • GTE

        public static Expr GTE​(List<? extends Expr> values)
        Returns true if the first element of the given collection is greater than or equal to the ones following, and false otherwise.
        Parameters:
        values - the list of numbers to compare. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Logical Functions

      • GTE

        public static Expr GTE​(Expr... values)
        Returns true if the first element of the given collection is greater than or equal to the ones following, and false otherwise.
        Parameters:
        values - the list of numbers to compare. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Logical Functions

      • And

        public static Expr And​(List<? extends Expr> values)
        Returns true if all elements in the given collection are true, and false otherwise.
        Parameters:
        values - a collection of boolean values. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Logical Functions

      • And

        public static Expr And​(Expr... values)
        Returns true if all elements in the given collection are true, and false otherwise.
        Parameters:
        values - a collection of boolean values. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Logical Functions

      • Or

        public static Expr Or​(List<? extends Expr> values)
        Returns true if any element in the given collection is true, and false otherwise.
        Parameters:
        values - a collection of boolean values. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Logical Functions

      • Or

        public static Expr Or​(Expr... values)
        Returns true if any element in the given collection is true, and false otherwise.
        Parameters:
        values - a collection of boolean values. Type: Array
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Logical Functions

      • Not

        public static Expr Not​(Expr bool)
        Returns true if the given boolean parameter is false, or false if the boolean parameter is true.
        Parameters:
        bool - a boolean value. Type: Boolean
        Returns:
        a new Expr instance
        See Also:
        FaunaDB Logical Functions

      • ToString

        public static Expr ToString​(Expr value)
        Casts an expression to a string value, if possible.
        Parameters:
        value - an expression. Type: Any
        Returns:
        a new Expr

      • ToNumber

        public static Expr ToNumber​(Expr value)
        Casts an expression to a numeric value, if possible.
        Parameters:
        value - an expression. Type: Any
        Returns:
        a new Expr

      • ToDouble

        public static Expr ToDouble​(Expr value)
        Casts an expression to a double value, if possible.
        Parameters:
        value - an expression. Type: Any
        Returns:
        a new Expr

      • ToDouble

        public static Expr ToDouble​(String value)
        Casts an expression to a double value, if possible.
        Parameters:
        value - a string
        Returns:
        a new Expr

      • ToDouble

        public static Expr ToDouble​(double value)
        Casts an expression to a double value, if possible.
        Parameters:
        value - a double value.
        Returns:
        a new Expr

      • ToDouble

        public static Expr ToDouble​(long value)
        Casts an expression to a double value, if possible.
        Parameters:
        value - a long value
        Returns:
        a new Expr

      • ToInteger

        public static Expr ToInteger​(Expr value)
        Casts an expression to an integer value, if possible.
        Parameters:
        value - an expression. Type: Any
        Returns:
        a new Expr

      • ToInteger

        public static Expr ToInteger​(String value)
        Casts an expression to an integer value, if possible.
        Parameters:
        value - a string.
        Returns:
        a new Expr

      • ToInteger

        public static Expr ToInteger​(double value)
        Casts an expression to an integer value, if possible.
        Parameters:
        value - a double value
        Returns:
        a new Expr

      • ToInteger

        public static Expr ToInteger​(long value)
        Casts an expression to an integer value, if possible.
        Parameters:
        value - a long value
        Returns:
        a new Expr

      • ToTime

        public static Expr ToTime​(Expr value)
        Casts an expression to a time value, if possible.
        Parameters:
        value - an expression. Type: Any
        Returns:
        a new Expr

      • ToSeconds

        public static Expr ToSeconds​(Expr value)
        Converts a time expression to seconds since the UNIX epoch.
        Parameters:
        value - an expression. Type: Any
        Returns:
        a new Expr

      • ToMillis

        public static Expr ToMillis​(Expr value)
        Converts a time expression to milliseconds since the UNIX epoch.
        Parameters:
        value - an expression. Type: Any
        Returns:
        a new Expr

      • ToMicros

        public static Expr ToMicros​(Expr value)
        Converts a time expression to microseconds since the UNIX epoch.
        Parameters:
        value - an expression. Type: Any
        Returns:
        a new Expr

      • DayOfMonth

        public static Expr DayOfMonth​(Expr expr)
        Returns a time expression's day of the month, from 1 to 31.
        Parameters:
        expr - an expression. Type: Any
        Returns:
        a new Expr

      • DayOfWeek

        public static Expr DayOfWeek​(Expr expr)
        Returns a time expression's day of the week following ISO-8601 convention, from 1 (Monday) to 7 (Sunday).
        Parameters:
        expr - an expression. Type: Any
        Returns:
        a new Expr

      • DayOfYear

        public static Expr DayOfYear​(Expr expr)
        Returns a time expression's day of the year, from 1 to 365, or 366 in a leap year.
        Parameters:
        expr - an expression. Type: Any
        Returns:
        a new Expr

      • Year

        public static Expr Year​(Expr expr)
        Returns the time expression's year, following the ISO-8601 standard.
        Parameters:
        expr - an expression. Type: Any
        Returns:
        a new Expr

      • Month

        public static Expr Month​(Expr expr)
        Returns a time expression's month of the year, from 1 to 12.
        Parameters:
        expr - an expression. Type: Any
        Returns:
        a new Expr

      • Hour

        public static Expr Hour​(Expr expr)
        Returns a time expression's hour of the day, from 0 to 23.
        Parameters:
        expr - an expression. Type: Any
        Returns:
        a new Expr

      • Minute

        public static Expr Minute​(Expr expr)
        Returns a time expression's minute of the hour, from 0 to 59.
        Parameters:
        expr - an expression. Type: Any
        Returns:
        a new Expr

      • Second

        public static Expr Second​(Expr expr)
        Returns a time expression's second of the minute, from 0 to 59.
        Parameters:
        expr - an expression. Type: Any
        Returns:
        a new Expr

      • ToDate

        public static Expr ToDate​(Expr value)
        Casts an expression to a date value, if possible.
        Parameters:
        value - an expression. Type: Any
        Returns:
        a new Expr

      • Merge

        public static Expr Merge​(Expr merge,
                         Expr with)
        Merge two or more objects.
        Parameters:
        merge - the first object. Type: Object
        with - the second object or a list of objects: Type: Object or Array of Objects
        Returns:
        a new Expr

      • Merge

        public static Expr Merge​(Expr merge,
                         Expr with,
                         Expr lambda)
        Merge two or more objects.
        Parameters:
        merge - the first object. Type: Object
        with - the second object or a list of objects: Type: Object or Array of Objects
        lambda - a lambda to resolve possible conflicts: Type: A lambda function
        Returns:
        a new Expr

      • ToObject

        public static Expr ToObject​(Expr fields)
        Try to convert an array of (field, value) into an object.
        Parameters:
        fields - an expr that result into an array of (field, value)
        Returns:
        a new Expr

      • ToArray

        public static Expr ToArray​(Expr object)
        Try to convert an object into an array of (field, value).
        Parameters:
        object - the object to convert.
        Returns:
        a new Expr

      • IsNumber

        public static Expr IsNumber​(Expr expr)
        Check if the expression is a number.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsNumber

      • IsDouble

        public static Expr IsDouble​(Expr expr)
        Check if the expression is a double.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsDouble

      • IsInteger

        public static Expr IsInteger​(Expr expr)
        Check if the expression is an integer.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsInteger

      • IsBoolean

        public static Expr IsBoolean​(Expr expr)
        Check if the expression is a boolean.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsBoolean

      • IsNull

        public static Expr IsNull​(Expr expr)
        Check if the expression is null.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsNull

      • IsBytes

        public static Expr IsBytes​(Expr expr)
        Check if the expression is a byte array.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsBytes

      • IsTimestamp

        public static Expr IsTimestamp​(Expr expr)
        Check if the expression is a timestamp.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsTimestamp

      • IsDate

        public static Expr IsDate​(Expr expr)
        Check if the expression is a date.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsDate

      • IsString

        public static Expr IsString​(Expr expr)
        Check if the expression is a string.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsString

      • IsArray

        public static Expr IsArray​(Expr expr)
        Check if the expression is an array.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsArray

      • IsObject

        public static Expr IsObject​(Expr expr)
        Check if the expression is an object.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsObject

      • IsRef

        public static Expr IsRef​(Expr expr)
        Check if the expression is a reference.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsRef

      • IsSet

        public static Expr IsSet​(Expr expr)
        Check if the expression is a set.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsSet

      • IsDoc

        public static Expr IsDoc​(Expr expr)
        Check if the expression is a document (either a reference or an instance).
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsDoc

      • IsLambda

        public static Expr IsLambda​(Expr expr)
        Check if the expression is a lambda.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsLambda

      • IsCollection

        public static Expr IsCollection​(Expr expr)
        Check if the expression is a collection.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsCollection

      • IsDatabase

        public static Expr IsDatabase​(Expr expr)
        Check if the expression is a database.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsDatabase

      • IsIndex

        public static Expr IsIndex​(Expr expr)
        Check if the expression is an index.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsIndex

      • IsFunction

        public static Expr IsFunction​(Expr expr)
        Check if the expression is a function.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsFunction

      • IsKey

        public static Expr IsKey​(Expr expr)
        Check if the expression is a key.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsKey

      • IsToken

        public static Expr IsToken​(Expr expr)
        Check if the expression is a token.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsToken

      • IsCredentials

        public static Expr IsCredentials​(Expr expr)
        Check if the expression is a credentials.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsCredentials

      • IsRole

        public static Expr IsRole​(Expr expr)
        Check if the expression is a role.
        Parameters:
        expr - the expression to check
        Returns:
        a new Expr
        See Also:
        IsRole