Warning:
Fauna is decommissioning FQL v4 on June 30, 2025.
This driver is not compatible with FQL v10, the latest version. Fauna accounts created after August 21, 2024 must use FQL v10.
Ensure you migrate existing projects to the official v10 driver by the v4 EOL date: https://github.com/fauna/fauna-jvm.
For more information, see the v4 end of life (EOL) announcement and related FAQ.
public final class Language
extends java.lang.Object
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.
// Creates a new expression that, once executed, it will create a new instance
// of the user class with an username and password fields.
Expr createUserExpr = Create(Class("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();
Modifier and Type | Class and Description |
---|---|
static class |
Language.Action
Enumeration for event action types.
|
static class |
Language.LetBinding
Builder for let expressions.
|
static class |
Language.Normalizer
Enumeration for casefold normalizers.
|
static class |
Language.Path
Builder for path selectors.
|
static class |
Language.TimeUnit
Enumeration for time units.
|
Modifier and Type | Method and Description |
---|---|
static Expr |
Abort(Expr msg)
Aborts the current transaction with a given message.
|
static Expr |
Abort(java.lang.String msg)
Aborts the current transaction with a given message.
|
static Expr |
Abs(java.lang.Double value)
Computes the abs of a number.
|
static Expr |
Abs(Expr value)
Computes the abs of a number.
|
static Expr |
Abs(java.lang.Long value)
Computes the abs of a number.
|
static Expr |
Acos(java.lang.Double value)
Computes the acos of a numbers.
|
static Expr |
Acos(Expr value)
Computes the acos of a numbers.
|
static Expr |
Add(Expr... values)
Computes the sum of a list of numbers.
|
static Expr |
Add(java.util.List<? extends Expr> values)
Computes the sum of a list of numbers.
|
static Expr |
And(Expr... values)
Returns true if all elements in the given collection are true, and false otherwise.
|
static Expr |
And(java.util.List<? extends Expr> values)
Returns true if all elements in the given collection are true, and false otherwise.
|
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(java.util.List<? extends Expr> values)
Creates a new array wrapping the provided
List . |
static Expr |
Asin(java.lang.Double value)
Computes the asin of a numbers.
|
static Expr |
Asin(Expr 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(java.time.Instant timestamp,
Expr expr)
Execute the reads associated with the given expression at the timestamp provided.
|
static Expr |
Atan(java.lang.Double value)
Computes the atan of a numbers.
|
static Expr |
Atan(Expr value)
Computes the atan of a numbers.
|
static Expr |
BitAnd(Expr... values)
Computes the bitwise and of a list of numbers.
|
static Expr |
BitAnd(java.util.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(java.lang.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(java.util.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(java.util.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,
java.util.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(java.lang.String str)
Normalizes strings according to the Unicode Standard, section 5.18 "Case Mappings".
|
static Expr |
Casefold(java.lang.String str,
Expr normalizer)
Normalizes strings according to the Unicode Standard, section 5.18 "Case Mappings", and the normalizer provided.
|
static Expr |
Casefold(java.lang.String str,
Language.Normalizer normalizer)
Normalizes strings according to the Unicode Standard, section 5.18 "Case Mappings", and the normalizer provided.
|
static Expr |
Ceil(java.lang.Double value)
Computes the Ceil of a number.
|
static Expr |
Ceil(Expr value)
Computes the Ceil of a number.
|
static Expr |
Ceil(java.lang.Long value)
Computes the Ceil of a number.
|
static Expr |
Class(Expr name)
Creates a new reference for the given class name.
|
static Expr |
Class(Expr name,
Expr database)
Creates a reference for the given class name, scoped to the database provided.
|
static Expr |
Class(java.lang.String name)
Creates a new reference for the given class name.
|
static Expr |
Class(java.lang.String name,
Expr database)
Creates a reference for the given class name, scoped to the database provided.
|
static Expr |
Classes()
Returns a reference to a set of all classes in the database.
|
static Expr |
Classes(Expr scope)
Returns a reference to a set of all classes 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)
Returns true if the target value contains the given path, and false otherwise.
|
static Expr |
Contains(Language.Path path,
Expr in)
Returns true if the target value contains the given path, and false otherwise.
|
static Expr |
Cos(java.lang.Double value)
Computes the cosine of a numbers.
|
static Expr |
Cos(Expr value)
Computes the cosine of a numbers.
|
static Expr |
Cosh(java.lang.Double value)
Computes the hyperbolic cosine of a numbers.
|
static Expr |
Cosh(Expr value)
Computes the hyperbolic cosine of a numbers.
|
static Expr |
Create(Expr ref,
Expr params)
Creates a new instance of the given class with the parameters provided.
|
static Expr |
CreateClass(Expr params)
Creates a new class 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 |
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 |
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(java.lang.String name)
Creates a reference for the given database name.
|
static Expr |
Database(java.lang.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(java.lang.String str)
Creates a date from an ISO-8601 formatted date string.
|
static Expr |
Degrees(java.lang.Double value)
Computes the degrees of a numbers.
|
static Expr |
Degrees(Expr value)
Computes the degrees of a numbers.
|
static Expr |
Degrees(java.lang.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(java.util.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(java.util.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(java.util.List<? extends Expr> exprs)
Evaluates the given expressions sequentially evaluates its arguments,
and returns the result of the last expression.
|
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 |
Drop(long num,
Expr collection)
Returns a new collection containing after dropping the given number of elements from the provided collection.
|
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,
java.lang.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(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,
java.lang.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(java.util.List<? extends Expr> values)
Tests equivalence between a list of values.
|
static Expr |
Events(Expr refSet)
Returns the history of an instance'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(java.lang.Double value)
Computes the exp of a numbers.
|
static Expr |
Exp(Expr value)
Computes the exp of a numbers.
|
static Expr |
Exp(java.lang.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,
java.util.function.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,
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,
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,
java.lang.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,
java.lang.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(java.lang.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(java.lang.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(java.lang.String value,
java.lang.String find)
FindStr function searches a string for a substring and locates the location of the substring in the string
|
static Expr |
FindStr(java.lang.String value,
java.lang.String find,
Expr start)
FindStr function searches a string for a substring and locates the location of the substring in the string
|
static Expr |
FindStr(java.lang.String value,
java.lang.String find,
long 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,
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,
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,
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)
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,
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,
java.lang.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,
java.lang.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,
java.lang.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(Expr value,
java.lang.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,
java.lang.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,
java.lang.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,
java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String value,
java.lang.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(java.lang.String value,
java.lang.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(java.lang.String value,
java.lang.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(java.lang.String value,
java.lang.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(java.lang.String value,
java.lang.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(java.lang.String value,
java.lang.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(java.lang.String value,
java.lang.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 |
Floor(java.lang.Double value)
Computes the floor of a numbers.
|
static Expr |
Floor(Expr value)
Computes the floor of a numbers.
|
static Expr |
Floor(java.lang.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,
java.util.function.UnaryOperator<Expr> lambda)
Applies the given lambda to each element of the provided
collection.
|
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(java.lang.String name)
Creates a reference for the given user defined function name.
|
static Expr |
Function(java.lang.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 instance identified by the given reference.
|
static Expr |
Get(Expr ref,
Expr timestamp)
Retrieves the instance identified by the given reference at a specific point in time.
|
static Expr |
Get(Expr ref,
java.time.Instant timestamp)
Retrieves the instance 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(java.util.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(java.util.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 |
HasIdentity()
Returns true if the authentication used for the request has an identity.
|
static Expr |
Hypot(java.lang.Double num)
Hypot to calculate a hypotenuse of a isosceles right triangle give side
|
static Expr |
Hypot(java.lang.Double num,
java.lang.Double exp)
Hypot to calculate a hypotenuse of a right triangle give the 2 sides
|
static Expr |
Hypot(java.lang.Double num,
Expr exp)
Hypot to calculate a hypotenuse of a right triangle give the 2 sides
|
static Expr |
Hypot(Expr num)
Hypot to calculate a hypotenuse of a isosceles right triangle give side
|
static Expr |
Hypot(Expr num,
java.lang.Double exp)
Hypot to calculate a hypotenuse of a right triangle give the 2 sides
|
static Expr |
Hypot(Expr num,
Expr 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,
java.lang.String password)
Checks the given password against the reference's credentials, retuning true if valid, or false otherwise.
|
static Expr |
Identity()
Returns the reference associated with the authentication token used for the current request.
|
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(java.lang.String name)
Creates a reference for the given index name.
|
static Expr |
Index(java.lang.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 instance's history.
|
static Expr |
Insert(Expr ref,
Expr timestamp,
Language.Action action,
Expr params)
Inserts a new event in the instance's history.
|
static Expr |
Intersection(Expr... sets)
Returns the set of resources present in all sets provided.
|
static Expr |
Intersection(java.util.List<? extends Expr> sets)
Returns the set of resources present in all sets provided.
|
static Expr |
IsEmpty(Expr collection)
Returns true if the given collection is empty, or false otherwise.
|
static Expr |
IsNonEmpty(Expr collection)
Returns true if the given collection is not empty, or false otherwise.
|
static Expr |
Join(Expr source,
Expr target)
Derives a set of resources from applying each instance of the source set to the target parameter.
|
static Expr |
Join(Expr source,
java.util.function.UnaryOperator<Expr> lambda)
Derives a set of resources from applying each instance 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(java.lang.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(java.lang.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(java.lang.String value)
Length function returns the number of characters (codepoints) in the string
|
static Language.LetBinding |
Let(java.util.Map<java.lang.String,? extends Expr> bindings)
Deprecated.
As of release 2.6.0, use alternate Let forms.
|
static Language.LetBinding |
Let(java.lang.String v1,
Expr d1)
Bind values to one or more variables.
|
static Language.LetBinding |
Let(java.lang.String v1,
Expr d1,
java.lang.String v2,
Expr d2)
Bind values to one or more variables.
|
static Language.LetBinding |
Let(java.lang.String v1,
Expr d1,
java.lang.String v2,
Expr d2,
java.lang.String v3,
Expr d3)
Bind values to one or more variables.
|
static Language.LetBinding |
Let(java.lang.String v1,
Expr d1,
java.lang.String v2,
Expr d2,
java.lang.String v3,
Expr d3,
java.lang.String v4,
Expr d4)
Bind values to one or more variables.
|
static Language.LetBinding |
Let(java.lang.String v1,
Expr d1,
java.lang.String v2,
Expr d2,
java.lang.String v3,
Expr d3,
java.lang.String v4,
Expr d4,
java.lang.String v5,
Expr d5)
Bind values to one or more variables.
|
static Language.LetBinding |
Let(java.lang.String v1,
Expr d1,
java.lang.String v2,
Expr d2,
java.lang.String v3,
Expr d3,
java.lang.String v4,
Expr d4,
java.lang.String v5,
Expr d5,
java.lang.String v6,
Expr d6)
Bind values to one or more variables.
|
static Language.LetBinding |
Let(java.lang.String v1,
Expr d1,
java.lang.String v2,
Expr d2,
java.lang.String v3,
Expr d3,
java.lang.String v4,
Expr d4,
java.lang.String v5,
Expr d5,
java.lang.String v6,
Expr d6,
java.lang.String v7,
Expr d7)
Bind values to one or more variables.
|
static Language.LetBinding |
Let(java.lang.String v1,
Expr d1,
java.lang.String v2,
Expr d2,
java.lang.String v3,
Expr d3,
java.lang.String v4,
Expr d4,
java.lang.String v5,
Expr d5,
java.lang.String v6,
Expr d6,
java.lang.String v7,
Expr d7,
java.lang.String v8,
Expr d8)
Bind values to one or more variables.
|
static Expr |
Ln(java.lang.Double value)
Computes the ln of a numbers.
|
static Expr |
Ln(Expr value)
Computes the ln of a numbers.
|
static Expr |
Log(java.lang.Double value)
Computes the log of a numbers.
|
static Expr |
Log(Expr 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(java.lang.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(java.util.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(java.util.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(java.lang.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,
java.util.function.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(java.util.List<? extends Expr> values)
Computes the max in a list of numbers.
|
static Expr |
Min(Expr... values)
Computes the min in a list of numbers.
|
static Expr |
Min(java.util.List<? extends Expr> values)
Computes the min in a list of numbers.
|
static Expr |
Modulo(Expr... values)
Computes the remainder after division of a list of numbers.
|
static Expr |
Modulo(java.util.List<? extends Expr> values)
Computes the remainder after division of a list of numbers.
|
static Expr |
Multiply(Expr... values)
Computes the product of a list of numbers.
|
static Expr |
Multiply(java.util.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,
Expr 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,
long min,
Expr max)
Tokenize the input into n-grams of the given sizes.
|
static Expr |
NGram(Expr terms,
long min,
long max)
Tokenize the input into n-grams of the given sizes.
|
static Expr |
NGram(java.util.List<Expr> terms)
Tokenize the input into n-grams of the 1 and 2 elements in size.
|
static Expr |
NGram(java.util.List<Expr> terms,
Expr min,
Expr max)
Tokenize the input into n-grams of the given sizes.
|
static Expr |
NGram(java.lang.String term)
Tokenize the input into n-grams of the 1 and 2 elements in size.
|
static Expr |
NGram(java.lang.String terms,
Expr min,
Expr max)
Tokenize the input into n-grams of the given sizes.
|
static Expr |
NGram(java.lang.String terms,
Expr min,
long max)
Tokenize the input into n-grams of the given sizes.
|
static Expr |
NGram(java.lang.String terms,
long min,
Expr max)
Tokenize the input into n-grams of the given sizes.
|
static Expr |
NGram(java.lang.String terms,
long min,
long 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 |
Null()
Creates a new expression representing a null value.
|
static Expr |
Obj()
Creates an empty object.
|
static Expr |
Obj(java.util.Map<java.lang.String,? extends Expr> values)
Creates a new object wrapping the
Map provided. |
static Expr |
Obj(java.lang.String k1,
Expr v1)
Creates a new object with the provided key and value.
|
static Expr |
Obj(java.lang.String k1,
Expr v1,
java.lang.String k2,
Expr v2)
Creates a new object with two key/value pairs.
|
static Expr |
Obj(java.lang.String k1,
Expr v1,
java.lang.String k2,
Expr v2,
java.lang.String k3,
Expr v3)
Creates a new object with three key/value pairs.
|
static Expr |
Obj(java.lang.String k1,
Expr v1,
java.lang.String k2,
Expr v2,
java.lang.String k3,
Expr v3,
java.lang.String k4,
Expr v4)
Creates a new object with four key/value pairs.
|
static Expr |
Obj(java.lang.String k1,
Expr v1,
java.lang.String k2,
Expr v2,
java.lang.String k3,
Expr v3,
java.lang.String k4,
Expr v4,
java.lang.String k5,
Expr v5)
Creates a new object with five key/value pairs.
|
static Expr |
Or(Expr... values)
Returns true if any element in the given collection is true, and false otherwise.
|
static Expr |
Or(java.util.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(java.lang.String... segments)
Constructs a path matching object keys.
|
static Expr |
Pow(java.lang.Double num,
java.lang.Double exp)
Pow to calculate a number raise to the power of some other number
|
static Expr |
Pow(java.lang.Double num,
Expr exp)
Pow to calculate a number raise to the power of some other number
|
static Expr |
Pow(Expr num)
Pow to calculate a number raise to the power of some other number
|
static Expr |
Pow(Expr num,
java.lang.Double exp)
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 |
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(java.lang.Double value)
Computes the radians of a number.
|
static Expr |
Radians(Expr value)
Computes the radians of a number.
|
static Expr |
Ref(Expr classRef,
Expr id)
Creates a new scoped reference.
|
static Expr |
Ref(Expr classRef,
java.lang.String id)
Creates a new scoped reference.
|
static Expr |
Ref(java.lang.String ref)
Creates a new reference.
|
static Expr |
Remove(Expr ref,
Expr timestamp,
Expr action)
Removes an event from an instance's history.
|
static Expr |
Remove(Expr ref,
Expr timestamp,
Language.Action action)
Removes an event from an instance's history.
|
static Expr |
Repeat(Expr value)
Repeat function returns a string 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(Expr value,
long number)
Repeat function returns a string concatenanted the specified number of times
|
static Expr |
Repeat(java.lang.String value)
Repeat function returns a string the specified number of times
|
static Expr |
Repeat(java.lang.String value,
Expr number)
Repeat function returns a string concatenanted the specified number of times
|
static Expr |
Repeat(java.lang.String value,
long 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,
java.lang.String replace)
ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
|
static Expr |
ReplaceStr(Expr value,
java.lang.String find,
Expr replace)
ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
|
static Expr |
ReplaceStr(Expr value,
java.lang.String find,
java.lang.String replace)
ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
|
static Expr |
ReplaceStr(java.lang.String value,
Expr find,
Expr replace)
ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
|
static Expr |
ReplaceStr(java.lang.String value,
Expr find,
java.lang.String replace)
ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
|
static Expr |
ReplaceStr(java.lang.String value,
java.lang.String find,
Expr replace)
ReplaceStr returns a string with every occurence of the "find" string changed to "replace" string
|
static Expr |
ReplaceStr(java.lang.String value,
java.lang.String find,
java.lang.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,
java.lang.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,
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,
java.lang.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,
java.lang.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,
java.lang.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,
java.lang.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,
java.lang.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,
java.lang.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,
java.lang.String pattern,
java.lang.String replace)
ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
|
static Expr |
ReplaceStrRegex(Expr value,
java.lang.String pattern,
java.lang.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,
java.lang.String pattern,
java.lang.String replace,
Expr first)
ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
|
static Expr |
ReplaceStrRegex(java.lang.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(java.lang.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(java.lang.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(java.lang.String value,
Expr pattern,
java.lang.String replace)
ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
|
static Expr |
ReplaceStrRegex(java.lang.String value,
Expr pattern,
java.lang.String replace,
boolean first)
ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
|
static Expr |
ReplaceStrRegex(java.lang.String value,
Expr pattern,
java.lang.String replace,
Expr first)
ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
|
static Expr |
ReplaceStrRegex(java.lang.String value,
java.lang.String pattern,
Expr replace)
ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
|
static Expr |
ReplaceStrRegex(java.lang.String value,
java.lang.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(java.lang.String value,
java.lang.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(java.lang.String value,
java.lang.String pattern,
java.lang.String replace)
ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
|
static Expr |
ReplaceStrRegex(java.lang.String value,
java.lang.String pattern,
java.lang.String replace,
boolean first)
ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
|
static Expr |
ReplaceStrRegex(java.lang.String value,
java.lang.String pattern,
java.lang.String replace,
Expr first)
ReplaceStrRegex returns a string with occurence(s) of the java regular expression "pattern" changed to "replace" string
|
static Expr |
Round(java.lang.Double num)
Round to a given precision
|
static Expr |
Round(java.lang.Double num,
Expr precision)
Round to a given precision
|
static Expr |
Round(java.lang.Double num,
java.lang.Long precision)
Round to a given precision
|
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,
java.lang.Long precision)
Round to a given precision
|
static Expr |
Round(java.lang.Long num,
Expr precision)
Round to a given precision
|
static Expr |
Round(java.lang.Long num,
java.lang.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(java.lang.String value)
RTrim function returns a new string with trailing whitespace removed
|
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)
Selects the desired path for each element in the given array.
|
static Expr |
SelectAll(Expr path,
Expr from,
Expr defaultValue)
Selects the desired path for each element in the given array.
|
static Expr |
SelectAll(Language.Path path,
Expr from)
Selects the desired path for each element in the given array.
|
static Expr |
SelectAll(Language.Path path,
Expr from,
Expr defaultValue)
Selects the desired path for each element in the given array.
|
static Expr |
Sign(java.lang.Double value)
Computes the sign of a number.
|
static Expr |
Sign(Expr value)
Computes the sign of a number.
|
static Expr |
Sign(java.lang.Long value)
Computes the sign of a number.
|
static Expr |
Sin(java.lang.Double value)
Computes the Sin of a number.
|
static Expr |
Sin(Expr 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(java.lang.Double value)
Computes the Sinh of a number.
|
static Expr |
Sinh(Expr value)
Computes the Sinh of a number.
|
static Expr |
Space(Expr value)
Space function returns "N" number of spaces
|
static Expr |
Space(java.lang.Integer value)
Space function returns
|
static Expr |
Space(java.lang.Long value)
Space function returns "N" number of spaces
|
static Expr |
Sqrt(java.lang.Double value)
Computes the square root of a numbers.
|
static Expr |
Sqrt(Expr value)
Computes the square root of a numbers.
|
static Expr |
SubString(Expr value)
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,
Expr length)
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,
long start)
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,
long start,
long length)
SubString function returns a subset of the source string
|
static Expr |
SubString(java.lang.String value)
SubString function returns a subset of the source string
|
static Expr |
SubString(java.lang.String value,
Expr start)
SubString function returns a subset of the source string
|
static Expr |
SubString(java.lang.String value,
Expr start,
Expr length)
SubString function returns a subset of the source string
|
static Expr |
SubString(java.lang.String value,
Expr start,
long length)
SubString function returns a subset of the source string
|
static Expr |
SubString(java.lang.String value,
long start)
SubString function returns a subset of the source string
|
static Expr |
SubString(java.lang.String value,
long start,
Expr length)
SubString function returns a subset of the source string
|
static Expr |
SubString(java.lang.String value,
long start,
long 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(java.util.List<? extends Expr> values)
Computes the difference of a list of numbers.
|
static Expr |
Take(Expr num,
Expr collection)
Returns a new collection containing the given number of elements taken from the provided 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 |
Tan(java.lang.Double value)
Computes the tangent of a numbers.
|
static Expr |
Tan(Expr value)
Computes the tangent of a numbers.
|
static Expr |
Tanh(java.lang.Double value)
Computes the hyperbolic tangent of a numbers.
|
static Expr |
Tanh(Expr 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(java.lang.String str)
Creates a new timestamp from an ISO-8601 offset date/time string.
|
static Expr |
TitleCase(Expr value)
TitleCase function returns a string with the first letter in each word capitalized
|
static Expr |
TitleCase(java.lang.String value)
TitleCase function returns a string with the first letter in each word capitalized
|
static Expr |
ToDate(Expr value)
Casts an expression to a date 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 |
ToNumber(Expr value)
Casts an expression to a numeric value, if possible.
|
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(java.lang.String value)
Trim function returns a new string with leading and trailing whitespace removed
|
static Expr |
Trunc(java.lang.Double num)
Truncate to a given precision
|
static Expr |
Trunc(java.lang.Double num,
Expr precision)
Truncate to a given precision
|
static Expr |
Trunc(java.lang.Double num,
java.lang.Long precision)
Truncate to a given precision
|
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,
java.lang.Long precision)
Truncate to a given precision
|
static Expr |
Trunc(java.lang.Long num,
Expr precision)
Truncate to a given precision
|
static Expr |
Trunc(java.lang.Long num,
java.lang.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(java.util.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(java.lang.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(java.time.Instant value)
Encodes the given
Instant as an Expr instance. |
static Expr |
Value(java.time.LocalDate value)
Encodes the given
LocalDate as an Expr instance. |
static Expr |
Value(long value)
Encodes the given
Long as an Expr instance. |
static Expr |
Value(java.lang.Object value)
Encodes the given object using the reflection
Encoder . |
static Expr |
Value(java.lang.String value)
Encodes the given
String as an Expr instance. |
static Expr |
Var(java.lang.String name)
Creates a expression that refers to the value of the given variable name in the current lexical scope.
|
public static Expr Ref(java.lang.String ref)
Ref("classes/users/123")
.
The usage of this method is discouraged.
Prefer Ref(Expr, String)
or Ref(Expr, Expr)
.
ref
- the reference idExpr
instanceRef(Expr, String)
public static Expr Ref(Expr classRef, Expr id)
Ref(Class("users"), "123")
.classRef
- the scope reference. Type: Referenceid
- the reference id. Type: StringExpr
instanceClass(String)
,
Database(String)
,
Index(String)
,
Function(String)
public static Expr Ref(Expr classRef, java.lang.String id)
Ref(Class("users"), "123")
.classRef
- the scope reference. Type: Referenceid
- the reference idExpr
instanceClass(String)
,
Database(String)
,
Index(String)
,
Function(String)
public static Expr Classes()
Expr
instancePaginate(Expr)
public static Expr Classes(Expr scope)
scope
- a reference to a database. Type: ReferenceExpr
instanceDatabase(String)
,
Paginate(Expr)
public static Expr Databases()
Expr
instancePaginate(Expr)
public static Expr Databases(Expr scope)
scope
- a reference to a database. Type: ReferenceExpr
instanceDatabase(String)
,
Paginate(Expr)
public static Expr Indexes()
Expr
instancePaginate(Expr)
public static Expr Indexes(Expr scope)
scope
- a reference to a database. Type: ReferenceExpr
instancePaginate(Expr)
public static Expr Functions()
Expr
instancePaginate(Expr)
public static Expr Functions(Expr scope)
scope
- a reference to a database. Type: ReferenceExpr
instanceRef(Expr, String)
,
Database(String)
,
Paginate(Expr)
public static Expr Keys()
Expr
instancePaginate(Expr)
public static Expr Keys(Expr scope)
scope
- a reference to a database. Type: ReferenceExpr
instanceRef(Expr, String)
,
Database(String)
,
Paginate(Expr)
public static Expr Tokens()
Expr
instancePaginate(Expr)
public static Expr Tokens(Expr scope)
scope
- a reference to a database. Type: ReferenceExpr
instanceRef(Expr, String)
,
Database(String)
,
Paginate(Expr)
public static Expr Credentials()
Expr
instancePaginate(Expr)
public static Expr Credentials(Expr scope)
scope
- a reference to a database. Type: ReferenceExpr
instanceRef(Expr, String)
,
Database(String)
,
Paginate(Expr)
public static Expr Value(java.lang.Object value)
Encoder
.public static Expr Value(java.lang.String value)
String
as an Expr
instance.value
- the string to be encodedExpr
instancepublic static Expr Value(long value)
Long
as an Expr
instance.value
- the number to be encodedExpr
instancepublic static Expr Value(double value)
Double
as an Expr
instance.value
- the number to be encodedExpr
instancepublic static Expr Value(boolean value)
Boolean
as an Expr
instance.value
- the boolean value to be encodedExpr
instancepublic static Expr Value(java.time.Instant value)
Instant
as an Expr
instance.value
- the timestamp to be encodedExpr
instanceInstant
public static Expr Value(java.time.LocalDate value)
LocalDate
as an Expr
instance.value
- the date to be encodedExpr
instanceLocalDate
public static Expr Value(byte[] bytes)
Byte
array as an Expr
instance.bytes
- the byte array to be encodedExpr
instancepublic static Expr Null()
Expr
instancepublic static Expr Obj(java.util.Map<java.lang.String,? extends Expr> values)
Map
provided.
For convenience, the following helpers are available:
values
- the key/value Map
to be wrappedExpr
instancepublic static Expr Obj()
Expr
instancepublic static Expr Obj(java.lang.String k1, Expr v1)
k1
- a keyv1
- a valueExpr
instancepublic static Expr Obj(java.lang.String k1, Expr v1, java.lang.String k2, Expr v2)
k1
- the first keyv1
- the first valuek2
- the second keyv2
- the second valueExpr
instancepublic static Expr Obj(java.lang.String k1, Expr v1, java.lang.String k2, Expr v2, java.lang.String k3, Expr v3)
k1
- the first keyv1
- the first valuek2
- the second keyv2
- the second valuek3
- the third keyv3
- the third valueExpr
instancepublic static Expr Obj(java.lang.String k1, Expr v1, java.lang.String k2, Expr v2, java.lang.String k3, Expr v3, java.lang.String k4, Expr v4)
k1
- the first keyv1
- the first valuek2
- the second keyv2
- the second valuek3
- the third keyv3
- the third valuek4
- the fourth keyv4
- the fourth valueExpr
instancepublic static Expr Obj(java.lang.String k1, Expr v1, java.lang.String k2, Expr v2, java.lang.String k3, Expr v3, java.lang.String k4, Expr v4, java.lang.String k5, Expr v5)
k1
- the first keyv1
- the first valuek2
- the second keyv2
- the second valuek3
- the third keyv3
- the third valuek4
- the fourth keyv4
- the fourth valuek5
- the fifth keyv5
- the fifth valueExpr
instancepublic static Expr Arr(java.util.List<? extends Expr> values)
List
.
For convenience, see the Arr(Expr...)
helper.values
- the List
instance to be wrappedExpr
instancepublic static Expr Arr(Expr... values)
values
- the elements of the new arrayExpr
instancepublic static Expr Abort(java.lang.String msg)
msg
- a message to be used when aborting the transactionExpr
instancepublic static Expr Abort(Expr msg)
msg
- a message to be used when aborting the transaction. Type: StringExpr
instancepublic static Expr Call(Expr ref, java.util.List<? extends Expr> args)
ref
- the reference to the user defined function to be called. Type: Referenceargs
- the list of arguments for the given user defined functionExpr
instancepublic static Expr Call(Expr ref, Expr... args)
ref
- the reference to the user defined function to be called. Type: Referenceargs
- the arguments for the given user defined functionExpr
instancepublic static Expr Query(Expr lambda)
lambda
- a lambda typeExpr
instanceCreateFunction(Expr)
,
Lambda(Expr, Expr)
public static Expr At(Expr timestamp, Expr expr)
timestamp
- the read timestamp. Type: Timestampexpr
- the scoped expressionExpr
instanceTime(Expr)
,
Value(Instant)
public static Expr At(java.time.Instant timestamp, Expr expr)
timestamp
- the read timestamp.expr
- the scoped expressionExpr
instance@Deprecated public static Language.LetBinding Let(java.util.Map<java.lang.String,? extends Expr> bindings)
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(Class("users"), Obj("data", Obj(
"name", Var("name"),
"age", Var("age"),
)))
)
).get();
bindings
- a Map
of variable names to values.Language.LetBinding
instanceVar(String)
,
Language.LetBinding
public static Language.LetBinding Let(java.lang.String v1, Expr d1)
Var(String)
function.
Example:
client.query(
Let("a", Value(1)).in(
Add(Value(1), Var("a"))
)
).get();
v1
- the variable named1
- the variable valueLanguage.LetBinding
instanceVar(String)
,
Language.LetBinding
public static Language.LetBinding Let(java.lang.String v1, Expr d1, java.lang.String v2, Expr d2)
Var(String)
function.
Example:
client.query(
Let("a", Value(1), "b", Value(2)).in(
Add(Var("a"), Var("b"))
)
).get();
v1
- the first variable named1
- the first variable valuev2
- the second variable named2
- the second variable valueLanguage.LetBinding
instanceVar(String)
,
Language.LetBinding
public static Language.LetBinding Let(java.lang.String v1, Expr d1, java.lang.String v2, Expr d2, java.lang.String v3, Expr d3)
Var(String)
function.
Example:
client.query(
Let(
"a", Value(1),
"b", Value(2),
"c", Value(3),
).in(
Add(Var("a"), Var("b"), Var("c"))
)
).get();
v1
- the first variable named1
- the first variable valuev2
- the second variable named2
- the second variable valuev3
- the third variable named3
- the third variable valueLanguage.LetBinding
instanceVar(String)
,
Language.LetBinding
public static Language.LetBinding Let(java.lang.String v1, Expr d1, java.lang.String v2, Expr d2, java.lang.String v3, Expr d3, java.lang.String v4, Expr d4)
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();
v1
- the first variable named1
- the first variable valuev2
- the second variable named2
- the second variable valuev3
- the third variable named3
- the third variable valuev4
- the fourth variable named4
- the fourth variable valueLanguage.LetBinding
instanceVar(String)
,
Language.LetBinding
public static Language.LetBinding Let(java.lang.String v1, Expr d1, java.lang.String v2, Expr d2, java.lang.String v3, Expr d3, java.lang.String v4, Expr d4, java.lang.String v5, Expr d5)
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()
v1
- the first variable named1
- the first variable valuev2
- the second variable named2
- the second variable valuev3
- the third variable named3
- the third variable valuev4
- the fourth variable named4
- the fourth variable valuev5
- the fifth variable named5
- the fitfh variable valueLanguage.LetBinding
instanceVar(String)
,
Language.LetBinding
public static Language.LetBinding Let(java.lang.String v1, Expr d1, java.lang.String v2, Expr d2, java.lang.String v3, Expr d3, java.lang.String v4, Expr d4, java.lang.String v5, Expr d5, java.lang.String v6, Expr d6)
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()
v1
- the first variable named1
- the first variable valuev2
- the second variable named2
- the second variable valuev3
- the third variable named3
- the third variable valuev4
- the fourth variable named4
- the fourth variable valuev5
- the fifth variable named5
- the fitfh variable valuev6
- the sixth variable named6
- the sixth variable valueLanguage.LetBinding
instanceVar(String)
,
Language.LetBinding
public static Language.LetBinding Let(java.lang.String v1, Expr d1, java.lang.String v2, Expr d2, java.lang.String v3, Expr d3, java.lang.String v4, Expr d4, java.lang.String v5, Expr d5, java.lang.String v6, Expr d6, java.lang.String v7, Expr d7)
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()
v1
- the first variable named1
- the first variable valuev2
- the second variable named2
- the second variable valuev3
- the third variable named3
- the third variable valuev4
- the fourth variable named4
- the fourth variable valuev5
- the fifth variable named5
- the fitfh variable valuev6
- the sixth variable named6
- the sixth variable valuev7
- the seventh variable named7
- the seventh variable valueLanguage.LetBinding
instanceVar(String)
,
Language.LetBinding
public static Language.LetBinding Let(java.lang.String v1, Expr d1, java.lang.String v2, Expr d2, java.lang.String v3, Expr d3, java.lang.String v4, Expr d4, java.lang.String v5, Expr d5, java.lang.String v6, Expr d6, java.lang.String v7, Expr d7, java.lang.String v8, Expr d8)
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()
v1
- the first variable named1
- the first variable valuev2
- the second variable named2
- the second variable valuev3
- the third variable named3
- the third variable valuev4
- the fourth variable named4
- the fourth variable valuev5
- the fifth variable named5
- the fitfh variable valuev6
- the sixth variable named6
- the sixth variable valuev7
- the seventh variable named7
- the seventh variable valuev8
- the eighth variable named8
- the eighth variable valueLanguage.LetBinding
instanceVar(String)
,
Language.LetBinding
public static Expr Var(java.lang.String name)
name
- the referred variable nameExpr
instanceLet(Map)
,
Lambda(Expr, Expr)
public static Expr If(Expr condition, Expr thenExpr, Expr elseExpr)
condition
- the if condition. Type: BooleanthenExpr
- the then branch for the if expressionelseExpr
- the else branch for the if expressionExpr
instancepublic static Expr Do(java.util.List<? extends Expr> exprs)
exprs
- a list of expressions to be evaluated sequentiallyExpr
instancepublic static Expr Do(Expr... exprs)
exprs
- a list of expressions to be evaluated sequentiallyExpr
instancepublic static Expr Lambda(Expr var, Expr expr)
Example:
client.query(
Map(userNames, Lambda(Value("name"),
Create(Class("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(Class("user"), Obj("data", Obj(
"fullName", Concat(
Var("name"),
Var("surname")
)
)))
)
)
).get();
var
- the lambda's parameter binding. Type: String or an Array of stringsexpr
- the lambda's function body. Type: An expression.Expr
instanceMap(Expr, Expr)
,
Foreach(Expr, Expr)
,
Filter(Expr, Expr)
,
Query(Expr)
,
Value(String)
,
Arr(List)
public static Expr Lambda(java.lang.String var, Expr expr)
var
- the lambda's parameter binding.expr
- the lambda's function body. Type: An expression.Expr
instanceLambda(Expr, Expr)
public static Expr Map(Expr collection, Expr lambda)
collection
- the source collection. Type: Collection.lambda
- the lambda function to be applied for each element in the given collection. Type: A lambda function.Expr
instanceLambda(Expr, Expr)
public static Expr Map(Expr collection, java.util.function.UnaryOperator<Expr> lambda)
collection
- the source collection. Type: Collection.lambda
- the lambda function to be applied for each element in the given collection.Expr
instancepublic static Expr Foreach(Expr collection, Expr lambda)
collection
- the source collection. Type: Collection.lambda
- the lambda function to be applied for each element in the given collection. Type: A lambda function.Expr
instanceLambda(Expr, Expr)
public static Expr Foreach(Expr collection, java.util.function.UnaryOperator<Expr> lambda)
collection
- the source collection. Type: Collection.lambda
- the lambda function to be applied for each element in the given collection.Expr
instancepublic static Expr Filter(Expr collection, Expr lambda)
collection
- the source collection. Type: Collectionlambda
- the filter lambda. Type: A lambda expression that returns a boolean valueExpr
instanceLambda(Expr, Expr)
public static Expr Filter(Expr collection, java.util.function.UnaryOperator<Expr> lambda)
collection
- the source collection. Type: Collectionlambda
- the filter lambda. Type: A lambda expression that returns a boolean valueExpr
instancepublic static Expr Take(Expr num, Expr collection)
num
- the number of elements to be taken from the source collection. Type: Numbercollection
- the source collection. Type: CollectionExpr
instancepublic static Expr Take(long num, Expr collection)
num
- the number of elements to be taken from the source collection.collection
- the source collection. Type: CollectionExpr
instancepublic static Expr Drop(Expr num, Expr collection)
num
- the number of elements to be dropped from the source collection. Type: Numbercollection
- the source collection. Type: CollectionExpr
instancepublic static Expr Drop(long num, Expr collection)
num
- the number of elements to be dropped from the source collection.collection
- the source collection. Type: CollectionExpr
instancepublic static Expr Prepend(Expr elements, Expr collection)
elements
- the elements to be prepended to the source collection. Type: Arraycollection
- the source collection. Type: ArrayExpr
instancepublic static Expr Append(Expr elements, Expr collection)
elements
- the elements to be appended to the source collection. Type: Arraycollection
- the source collection. Type: ArrayExpr
instancepublic static Expr IsEmpty(Expr collection)
collection
- the source collection to check for emptiness. Type: CollectionExpr
instancepublic static Expr IsNonEmpty(Expr collection)
collection
- the source collection to check for non-emptiness. Type: CollectionExpr
instancepublic static Expr Get(Expr ref)
ref
- the reference to be retrieved. Type: ReferenceExpr
instanceRef(Expr, String)
public static Expr Get(Expr ref, Expr timestamp)
ref
- the reference to be retrieved. Type: Referencetimestamp
- the timestamp from which the reference's data will be retrieved. Type: TimestampExpr
instanceRef(Expr, String)
,
Time(Expr)
,
Value(Instant)
,
At(Expr, Expr)
public static Expr Get(Expr ref, java.time.Instant timestamp)
ref
- the reference to be retrieved. Type: Referencetimestamp
- the timestamp from which the reference's data will be retrieved.Expr
instanceRef(Expr, String)
,
Time(Expr)
,
Value(Instant)
,
At(Expr, Expr)
public static Expr KeyFromSecret(Expr secret)
secret
- the key's secret string. Type: StringExpr
instancepublic static Expr KeyFromSecret(java.lang.String secret)
secret
- the key's secret string.Expr
instancepublic static Pagination Paginate(Expr resource)
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());
resource
- the resource to paginatePagination
builderPagination
,
FaunaDB Read Functions,
Match(Expr)
,
Map(Expr, Expr)
,
Foreach(Expr, Expr)
,
Filter(Expr, Expr)
public static Expr Exists(Expr ref)
ref
- the reference to check for existence. Type: ReferenceExpr
instanceRef(Expr, String)
public static Expr Exists(Expr ref, Expr timestamp)
ref
- the reference to check for existence. Type: Referencetimestamp
- a timestamp to check for ref's existence. Type: TimestampExpr
instanceRef(Expr, String)
public static Expr Create(Expr ref, Expr params)
ref
- the class reference for which a new instance will be created. Type: Referenceparams
- the parameters used to create the new instance. Type: ObjectExpr
instanceClass(Expr)
,
Ref(Expr, String)
,
Obj(Map)
public static Expr Update(Expr ref, Expr params)
ref
- the resource reference to update. Type: Referenceparams
- the parameters used to update the new instance. Type: ObjectExpr
instanceRef(Expr, String)
,
Obj(Map)
public static Expr Replace(Expr ref, Expr params)
ref
- the resource reference to be replaced. Type: Referenceparams
- the parameters used to replace the resource's old values. Type: ObjectExpr
instanceRef(Expr, String)
,
Obj(Map)
public static Expr Delete(Expr ref)
ref
- the resource reference to be deleted. Type: ReferenceExpr
instanceRef(Expr, String)
public static Expr Insert(Expr ref, Expr timestamp, Expr action, Expr params)
ref
- the target resource. Type: Referencetimestamp
- the timestamp in which the event will be inserted in the
instance's history. Type: Timestampaction
- the event action. Type: actionparams
- the event's parameters. Type: ObjectExpr
instanceLanguage.Action
,
Ref(Expr, String)
,
Obj(Map)
,
Time(Expr)
,
Value(Instant)
public static Expr Insert(Expr ref, Expr timestamp, Language.Action action, Expr params)
ref
- the target resource. Type: Referencetimestamp
- the timestamp in which the event will be inserted in the
instance's history. Type: Timestampaction
- the event actionparams
- the event's parameters. Type: ObjectExpr
instanceRef(Expr, String)
,
Obj(Map)
,
Time(Expr)
,
Value(Instant)
public static Expr Remove(Expr ref, Expr timestamp, Expr action)
ref
- the target resource. Type: Referencetimestamp
- the timestamp in which the event happened. Type: Timestampaction
- the event's action. Type: event actionExpr
instanceLanguage.Action
,
Ref(Expr, String)
,
Obj(Map)
,
Time(Expr)
,
Value(Instant)
public static Expr Remove(Expr ref, Expr timestamp, Language.Action action)
ref
- the target resource. Type: Referencetimestamp
- the timestamp in which the event happened. Type: Timestampaction
- the event's actionExpr
instanceRef(Expr, String)
,
Obj(Map)
,
Time(Expr)
,
Value(Instant)
public static Expr CreateClass(Expr params)
params
- the class's configuration parameters. Type: ObjectExpr
instanceObj(Map)
public static Expr CreateDatabase(Expr params)
Example:
client.query(
CreateDatabase(Obj(
"name", Value("my_database")
))
).get()
params
- the database's configuration parameters. Type: ObjectExpr
instanceObj(Map)
public static Expr CreateKey(Expr params)
params
- the key's configuration parameters: Type ObjectExpr
instanceObj(Map)
public static Expr CreateIndex(Expr params)
params
- the index's configuration parameter. Type: ObjectExpr
instanceObj(Map)
public static Expr CreateFunction(Expr params)
params
- the function's configuration parameters. Type: ObjectExpr
instnaceObj(Map)
public static Expr Singleton(Expr ref)
ref
- the instance's reference to retrieve the singleton history. Type: ReferenceExpr
instanceRef(Expr, String)
public static Expr Events(Expr refSet)
refSet
- the resource to retrieve events for. Type: Reference or set reference.Expr
instanceRef(Expr, String)
public static Expr Match(Expr index)
Paginate(Expr)
in order to retrieve their values.
If the provided index has terms configured, check the Match(Expr, Expr)
function.index
- an index reference. Type: ReferenceExpr
instanceIndex(String)
,
Paginate(Expr)
public static Expr Match(Expr index, Expr term)
Paginate(Expr)
in order to retrieve their values.index
- an index reference. Type: Referenceterm
- a value to search in the index provided. Type: any valueExpr
instanceIndex(String)
,
Paginate(Expr)
public static Expr Union(java.util.List<? extends Expr> sets)
sets
- the sets to execute the union operationExpr
instanceMatch(Expr)
public static Expr Union(Expr... sets)
sets
- the sets to execute the union operation. Type: Array of setsExpr
instanceMatch(Expr)
public static Expr Intersection(java.util.List<? extends Expr> sets)
sets
- the sets to execute the intersectionExpr
instanceMatch(Expr)
public static Expr Intersection(Expr... sets)
sets
- the sets to execute the intersection. Type: Array of setsExpr
instanceMatch(Expr)
public static Expr Difference(java.util.List<? extends Expr> sets)
sets
- the sets to take the differenceExpr
instanceMatch(Expr)
public static Expr Difference(Expr... sets)
sets
- the sets to take the difference. Type: Array of setsExpr
instanceMatch(Expr)
public static Expr Distinct(Expr set)
set
- the set to remove duplicates. Type: SetExpr
instanceMatch(Expr)
public static Expr Join(Expr source, Expr target)
source
- the source set. Type: Array or Set.target
- the join target. Type: Index reference or Lambda functionExpr
instanceIndex(String)
,
Lambda(Expr, Expr)
public static Expr Join(Expr source, java.util.function.UnaryOperator<Expr> lambda)
source
- the source set. Type: Array or Set.lambda
- the join target.Expr
instancepublic static Expr Login(Expr ref, Expr params)
ref
- the token's owner reference. Type: Referenceparams
- the token's configuration object. Type: ObjectExpr
instanceRef(Expr, String)
,
Obj(Map)
public static Expr Logout(Expr invalidateAll)
invalidateAll
is true, deletes all tokens associated with the current session.
Otherwise, deletes only the token used for the current request.invalidateAll
- if the Logout function should delete all tokens
associated with the current session. Type: BooleanExpr
instanceLogin(Expr, Expr)
public static Expr Logout(boolean invalidateAll)
invalidateAll
is true, deletes all tokens associated with the current session.
Otherwise, deletes only the token used for the current request.invalidateAll
- if the Logout function should delete all tokens
associated with the current session.Expr
instanceLogin(Expr, Expr)
public static Expr Identify(Expr ref, Expr password)
ref
- the reference to authenticate. Type: Referencepassword
- the authentication password. Type: StringExpr
instancepublic static Expr Identify(Expr ref, java.lang.String password)
ref
- the reference to authenticate. Type: Referencepassword
- the authentication password.Expr
instancepublic static Expr Identity()
Expr
instanceLogin(Expr, Expr)
public static Expr HasIdentity()
Expr
instanceIdentity()
,
Identify(Expr, Expr)
,
Login(Expr, Expr)
public static Expr Concat(Expr terms)
terms
- a list of strings. Type: Array of stringsExpr
instanceArr(List)
,
Value(String)
public static Expr Concat(Expr terms, Expr separator)
terms
- a list of strings. Type: Array of stringsseparator
- a string to separate each element in the result. Type: StringExpr
instanceArr(List)
,
Value(String)
public static Expr Casefold(Expr str)
Casefold(Expr, Normalizer)
.str
- the string to be normalized. Type: StringExpr
instanceCasefold(Expr, Normalizer)
public static Expr Casefold(java.lang.String str)
Casefold(Expr, Normalizer)
.str
- the string to be normalized.Expr
instanceCasefold(Expr, Normalizer)
public static Expr Casefold(Expr str, Expr normalizer)
Casefold(Expr, Normalizer)
.str
- the string to be normalized. Type: Stringnormalizer
- the string normalizer to use. Type: StringExpr
instanceCasefold(Expr, Normalizer)
public static Expr Casefold(java.lang.String str, Expr normalizer)
Casefold(Expr, Normalizer)
.str
- the string to be normalized.normalizer
- the string normalizer to use. Type: StringExpr
instanceCasefold(Expr, Normalizer)
public static Expr Casefold(Expr str, Language.Normalizer normalizer)
str
- the string to be normalized. Type: Stringnormalizer
- the string normalizer to useExpr
instancepublic static Expr Casefold(java.lang.String str, Language.Normalizer normalizer)
str
- the string to be normalized.normalizer
- the string normalizer to useExpr
instanceCasefold(Expr, Normalizer)
public static Expr FindStr(Expr value, Expr find)
value
- a stringsfind
- a substring to locateValue(String)
public static Expr FindStr(java.lang.String value, Expr find)
value
- a stringsfind
- a substring to locateValue(String)
public static Expr FindStr(Expr value, java.lang.String find)
value
- a stringsfind
- a substring to locateValue(String)
public static Expr FindStr(java.lang.String value, java.lang.String find)
value
- a stringsfind
- a substring to locateValue(String)
public static Expr FindStr(Expr value, Expr find, Expr start)
value
- a stringsfind
- a substring to locatestart
- a position to start the searchValue(String)
public static Expr FindStr(Expr value, Expr find, long start)
value
- a stringsfind
- a substring to locatestart
- a position to start the searchValue(String)
public static Expr FindStr(Expr value, java.lang.String find, Expr start)
value
- a stringsfind
- a substring to locatestart
- a position to start the searchValue(String)
public static Expr FindStr(java.lang.String value, Expr find, long start)
value
- a stringsfind
- a substring to locatestart
- a position to start the searchValue(String)
public static Expr FindStr(java.lang.String value, java.lang.String find, Expr start)
value
- a stringsfind
- a substring to locatestart
- a position to start the searchValue(String)
public static Expr FindStr(java.lang.String value, java.lang.String find, long start)
value
- a stringsfind
- a substring to locatestart
- a position to start the searchValue(String)
public static Expr FindStrRegex(Expr value, Expr pattern)
value
- a string to searchpattern
- a substring to locateValue(String)
public static Expr FindStrRegex(Expr value, java.lang.String pattern)
value
- a string to searchpattern
- a substring to locateValue(String)
public static Expr FindStrRegex(java.lang.String value, Expr pattern)
value
- a string to searchpattern
- a substring to locateValue(String)
public static Expr FindStrRegex(java.lang.String value, java.lang.String pattern)
value
- a string to searchpattern
- a substring to locateValue(String)
public static Expr FindStrRegex(Expr value, Expr pattern, Expr start)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringValue(String)
public static Expr FindStrRegex(java.lang.String value, Expr pattern, Expr start)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringValue(String)
public static Expr FindStrRegex(Expr value, java.lang.String pattern, Expr start)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringValue(String)
public static Expr FindStrRegex(java.lang.String value, java.lang.String pattern, Expr start)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringValue(String)
public static Expr FindStrRegex(Expr value, Expr pattern, long start)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringValue(String)
public static Expr FindStrRegex(java.lang.String value, Expr pattern, long start)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringValue(String)
public static Expr FindStrRegex(Expr value, java.lang.String pattern, long start)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringValue(String)
public static Expr FindStrRegex(java.lang.String value, java.lang.String pattern, long start)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringValue(String)
public static Expr FindStrRegex(Expr value, Expr pattern, Expr start, Expr numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(java.lang.String value, Expr pattern, Expr start, Expr numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(Expr value, java.lang.String pattern, Expr start, Expr numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(java.lang.String value, java.lang.String pattern, Expr start, Expr numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(Expr value, Expr pattern, long start, Expr numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(java.lang.String value, Expr pattern, long start, Expr numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(Expr value, java.lang.String pattern, long start, Expr numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(java.lang.String value, java.lang.String pattern, long start, Expr numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(Expr value, Expr pattern, Expr start, long numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(java.lang.String value, Expr pattern, Expr start, long numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(Expr value, java.lang.String pattern, Expr start, long numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(java.lang.String value, java.lang.String pattern, Expr start, long numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(Expr value, Expr pattern, long start, long numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(java.lang.String value, Expr pattern, long start, long numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(Expr value, java.lang.String pattern, long start, long numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr FindStrRegex(java.lang.String value, java.lang.String pattern, long start, long numResults)
value
- a string to searchpattern
- a substring to locatestart
- the offset into the stringnumResults
- the maximum number of resultsValue(String)
public static Expr Length(Expr value)
value
- a string to determine the length ofValue(String)
public static Expr Length(java.lang.String value)
value
- a string to determine the length ofValue(String)
public static Expr LowerCase(Expr value)
value
- a string to lowercaseValue(String)
public static Expr LowerCase(java.lang.String value)
value
- a string to lowercaseValue(String)
public static Expr LTrim(Expr value)
value
- a string to trim leading white space.Value(String)
public static Expr LTrim(java.lang.String value)
value
- a string to trim leading white space.Value(String)
public static Expr NGram(Expr terms, Expr min, Expr max)
terms
- the value to tokenize. Type: Stringmin
- the minimum size for the n-grams. Type: Numbermax
- the maximum size for the n-grams. Type: NumberExpr
instanceValue(String)
,
Value(long)
public static Expr NGram(java.lang.String terms, Expr min, Expr max)
terms
- the value to tokenize.min
- the minimum size for the n-grams. Type: Numbermax
- the maximum size for the n-grams. Type: NumberExpr
instanceValue(long)
public static Expr NGram(Expr terms, long min, Expr max)
terms
- the value to tokenize. Type: Stringmin
- the minimum size for the n-grams.max
- the maximum size for the n-grams. Type: NumberExpr
instanceValue(String)
,
Value(long)
public static Expr NGram(java.lang.String terms, long min, Expr max)
terms
- the value to tokenize.min
- the minimum size for the n-grams.max
- the maximum size for the n-grams. Type: NumberExpr
instanceValue(long)
public static Expr NGram(Expr terms, Expr min, long max)
terms
- the value to tokenize. Type: Stringmin
- the minimum size for the n-grams. Type: Numbermax
- the maximum size for the n-grams.Expr
instanceValue(String)
,
Value(long)
public static Expr NGram(java.lang.String terms, Expr min, long max)
terms
- the value to tokenize.min
- the minimum size for the n-grams. Type: Numbermax
- the maximum size for the n-grams.Expr
instanceValue(String)
,
Value(long)
public static Expr NGram(Expr terms, long min, long max)
terms
- the value to tokenize. Type: Stringmin
- the minimum size for the n-grams.max
- the maximum size for the n-grams.Expr
instanceValue(String)
public static Expr NGram(java.lang.String terms, long min, long max)
terms
- the value to tokenize.min
- the minimum size for the n-grams.max
- the maximum size for the n-grams.Expr
instancepublic static Expr NGram(java.util.List<Expr> terms, Expr min, Expr max)
terms
- the list of values to tokenize. Type: Array of stringsmin
- the minimum size for the n-grams. Type: Numbermax
- the maximum size for the n-grams. Type: NumberExpr
instanceArr(List)
,
Value(String)
,
Value(long)
public static Expr NGram(java.util.List<Expr> terms)
terms
- the list of values to tokenize. Type: Array of stringsExpr
instanceArr(List)
,
Value(String)
public static Expr NGram(Expr term)
term
- the term to tokenize. Type: StringExpr
instanceArr(List)
,
Value(String)
public static Expr NGram(java.lang.String term)
term
- the value to tokenize.Expr
instanceArr(List)
public static Expr Repeat(Expr value)
value
- a stringsExpr
instanceValue(String)
public static Expr Repeat(java.lang.String value)
value
- a stringsExpr
instanceValue(String)
public static Expr Repeat(Expr value, Expr number)
value
- a stringsnumber
- an integer value indicate the number of times to repeat the stringExpr
instanceValue(String)
public static Expr Repeat(java.lang.String value, Expr number)
value
- a stringsnumber
- an integer value indicate the number of times to repeat the stringExpr
instanceValue(String)
public static Expr Repeat(Expr value, long number)
value
- a stringsnumber
- an integer value indicate the number of times to repeat the stringExpr
instanceValue(String)
public static Expr Repeat(java.lang.String value, long number)
value
- a stringsnumber
- an integer value indicate the number of times to repeat the stringExpr
instanceValue(String)
public static Expr ReplaceStr(Expr value, Expr find, Expr replace)
value
- the source stringfind
- the substring to locate in in the source stringreplace
- the string to replaice the "find" string when locatedValue(String)
public static Expr ReplaceStr(java.lang.String value, Expr find, Expr replace)
value
- the source stringfind
- the substring to locate in in the source stringreplace
- the string to replaice the "find" string when locatedValue(String)
public static Expr ReplaceStr(Expr value, java.lang.String find, Expr replace)
value
- the source stringfind
- the substring to locate in in the source stringreplace
- the string to replaice the "find" string when locatedValue(String)
public static Expr ReplaceStr(java.lang.String value, java.lang.String find, Expr replace)
value
- the source stringfind
- the substring to locate in in the source stringreplace
- the string to replaice the "find" string when locatedValue(String)
public static Expr ReplaceStr(Expr value, Expr find, java.lang.String replace)
value
- the source stringfind
- the substring to locate in in the source stringreplace
- the string to replaice the "find" string when locatedValue(String)
public static Expr ReplaceStr(java.lang.String value, Expr find, java.lang.String replace)
value
- the source stringfind
- the substring to locate in in the source stringreplace
- the string to replaice the "find" string when locatedValue(String)
public static Expr ReplaceStr(Expr value, java.lang.String find, java.lang.String replace)
value
- the source stringfind
- the substring to locate in in the source stringreplace
- the string to replaice the "find" string when locatedValue(String)
public static Expr ReplaceStr(java.lang.String value, java.lang.String find, java.lang.String replace)
value
- the source stringfind
- the substring to locate in in the source stringreplace
- the string to replaice the "find" string when locatedValue(String)
public static Expr ReplaceStrRegex(Expr value, Expr pattern, Expr replace)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedExpr
instanceValue(String)
public static Expr ReplaceStrRegex(java.lang.String value, Expr pattern, Expr replace)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedExpr
instanceValue(String)
public static Expr ReplaceStrRegex(Expr value, java.lang.String pattern, Expr replace)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedExpr
instanceValue(String)
public static Expr ReplaceStrRegex(java.lang.String value, java.lang.String pattern, Expr replace)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedExpr
instanceValue(String)
public static Expr ReplaceStrRegex(Expr value, Expr pattern, java.lang.String replace)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedExpr
instanceValue(String)
public static Expr ReplaceStrRegex(java.lang.String value, Expr pattern, java.lang.String replace)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedExpr
instanceValue(String)
public static Expr ReplaceStrRegex(Expr value, java.lang.String pattern, java.lang.String replace)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedExpr
instanceValue(String)
public static Expr ReplaceStrRegex(java.lang.String value, java.lang.String pattern, java.lang.String replace)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedExpr
instanceValue(String)
public static Expr ReplaceStrRegex(Expr value, Expr pattern, Expr replace, Expr first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(java.lang.String value, Expr pattern, Expr replace, Expr first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(Expr value, java.lang.String pattern, Expr replace, Expr first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(java.lang.String value, java.lang.String pattern, Expr replace, Expr first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(Expr value, Expr pattern, java.lang.String replace, Expr first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(java.lang.String value, Expr pattern, java.lang.String replace, Expr first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(Expr value, java.lang.String pattern, java.lang.String replace, Expr first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(java.lang.String value, java.lang.String pattern, java.lang.String replace, Expr first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(Expr value, Expr pattern, Expr replace, java.lang.Boolean first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(java.lang.String value, Expr pattern, Expr replace, boolean first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(Expr value, java.lang.String pattern, Expr replace, boolean first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(java.lang.String value, java.lang.String pattern, Expr replace, boolean first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(Expr value, Expr pattern, java.lang.String replace, boolean first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(java.lang.String value, Expr pattern, java.lang.String replace, boolean first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(Expr value, java.lang.String pattern, java.lang.String replace, boolean first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr ReplaceStrRegex(java.lang.String value, java.lang.String pattern, java.lang.String replace, boolean first)
value
- the source stringpattern
- a java regular expression to locatereplace
- the string to replace the pattern when locatedfirst
- only replace the first found patternExpr
instanceValue(String)
public static Expr RTrim(Expr value)
value
- a string to trim whitespace.Value(String)
public static Expr RTrim(java.lang.String value)
value
- a string to trim whitespace.Value(String)
public static Expr Space(Expr value)
value
- the number of spacesValue(String)
public static Expr Space(java.lang.Long value)
value
- the number of spacesValue(String)
public static Expr Space(java.lang.Integer value)
value
- the number of spacesValue(String)
public static Expr SubString(Expr value)
value
- the source stringValue(String)
public static Expr SubString(java.lang.String value)
value
- the source stringValue(String)
public static Expr SubString(Expr value, Expr start)
value
- the source stringstart
- the position in the source string where SubString starts extracting charactersValue(String)
public static Expr SubString(java.lang.String value, Expr start)
value
- the source stringstart
- the position in the source string where SubString starts extracting charactersValue(String)
public static Expr SubString(Expr value, long start)
value
- the source stringstart
- the position in the source string where SubString starts extracting charactersValue(String)
public static Expr SubString(java.lang.String value, long start)
value
- the source stringstart
- the position in the source string where SubString starts extracting charactersValue(String)
public static Expr SubString(Expr value, Expr start, Expr length)
value
- the source stringstart
- the position in the source string where SubString starts extracting characterslength
- the number of characters to be returnedValue(String)
public static Expr SubString(java.lang.String value, Expr start, Expr length)
value
- the source stringstart
- the position in the source string where SubString starts extracting characterslength
- the number of characters to be returnedValue(String)
public static Expr SubString(Expr value, long start, Expr length)
value
- the source stringstart
- the position in the source string where SubString starts extracting characterslength
- the number of characters to be returnedValue(String)
public static Expr SubString(java.lang.String value, long start, Expr length)
value
- the source stringstart
- the position in the source string where SubString starts extracting characterslength
- the number of characters to be returnedValue(String)
public static Expr SubString(Expr value, long start, long length)
value
- the source stringstart
- the position in the source string where SubString starts extracting characterslength
- the number of characters to be returnedValue(String)
public static Expr SubString(Expr value, Expr start, long length)
value
- the source stringstart
- the position in the source string where SubString starts extracting characterslength
- the number of characters to be returnedValue(String)
public static Expr SubString(java.lang.String value, Expr start, long length)
value
- the source stringstart
- the position in the source string where SubString starts extracting characterslength
- the number of characters to be returnedValue(String)
public static Expr SubString(java.lang.String value, long start, long length)
value
- the source stringstart
- the position in the source string where SubString starts extracting characterslength
- the number of characters to be returnedValue(String)
public static Expr TitleCase(Expr value)
value
- a strings to TitleCaseValue(String)
public static Expr TitleCase(java.lang.String value)
value
- a strings to TitleCaseValue(String)
public static Expr Trim(Expr value)
value
- a string to trim white space.value
- a stringsValue(String)
public static Expr Trim(java.lang.String value)
value
- a string to trim white space.Value(String)
public static Expr UpperCase(Expr value)
value
- a string to uppercaseValue(String)
public static Expr UpperCase(java.lang.String value)
value
- a string to uppercaseValue(String)
public static Expr Time(Expr str)
str
- an ISO-8601 formatted string or the string literal "now". Type: StringExpr
instanceValue(String)
public static Expr Time(java.lang.String str)
str
- an ISO-8601 formatted string or the string literal "now"Expr
instancepublic static Expr Epoch(Expr num, Language.TimeUnit unit)
num
- the number of units. Type: Numberunit
- the unit typeExpr
instanceLanguage.TimeUnit
,
Value(long)
public static Expr Epoch(long num, Language.TimeUnit unit)
num
- the number of units.unit
- the unit typeExpr
instanceLanguage.TimeUnit
public static Expr Epoch(Expr num, Expr unit)
num
- the number of units. Type: Numberunit
- the unit type. Type: StringExpr
instanceValue(long)
public static Expr Epoch(Expr num, java.lang.String unit)
num
- the number of units. Type: Numberunit
- the unit type.Expr
instanceValue(long)
public static Expr Epoch(long num, Expr unit)
num
- the number of units.unit
- the unit type. Type: StringExpr
instanceValue(String)
public static Expr Epoch(long num, java.lang.String unit)
num
- the number of units.unit
- the unit type.Expr
instancepublic static Expr Date(Expr str)
str
- an ISO-8601 formatted date string. Type: StringExpr
instanceValue(String)
public static Expr Date(java.lang.String str)
str
- an ISO-8601 formatted date stringExpr
instance@Deprecated public static Expr NextId()
Expr
instanceRef(Expr, Expr)
public static Expr NewId()
Expr
instanceRef(Expr, Expr)
public static Expr Class(Expr name)
name
- the class name. Type: StringExpr
instancepublic static Expr Class(java.lang.String name)
name
- the class nameExpr
instancepublic static Expr Class(Expr name, Expr database)
name
- the class name. Type: Stringdatabase
- the scope database. Type: ReferenceExpr
instanceDatabase(String)
public static Expr Class(java.lang.String name, Expr database)
name
- the class namedatabase
- the scope database. Type: ReferenceExpr
instanceDatabase(String)
public static Expr Database(Expr name)
name
- the database name. Type: StringExpr
instancepublic static Expr Database(java.lang.String name)
name
- the database nameExpr
instancepublic static Expr Database(Expr name, Expr database)
name
- the database name. Type: Stringdatabase
- the scope database. Type: ReferenceExpr
instancepublic static Expr Database(java.lang.String name, Expr database)
name
- the database namedatabase
- the scope database. Type: ReferenceExpr
instancepublic static Expr Index(Expr name)
name
- the index name. Type: StringExpr
instancepublic static Expr Index(java.lang.String name)
name
- the index nameExpr
instancepublic static Expr Index(Expr name, Expr database)
name
- the index name. Type: Stringdatabase
- the scope database. Type: ReferenceExpr
instancepublic static Expr Index(java.lang.String name, Expr database)
name
- the index namedatabase
- the scope database. Type: ReferenceExpr
instancepublic static Expr Function(Expr name)
name
- the user defined function name. Type: StringExpr
instancepublic static Expr Function(java.lang.String name)
name
- the user defined function nameExpr
instancepublic static Expr Function(Expr name, Expr database)
name
- the user defined function name. Type: Stringdatabase
- the scope database. Type: ReferenceExpr
instancepublic static Expr Function(java.lang.String name, Expr database)
name
- the user defined function namedatabase
- the scope database. Type: ReferenceExpr
instancepublic static Expr Equals(java.util.List<? extends Expr> values)
values
- the values to test equivalence forExpr
instancepublic static Expr Equals(Expr... values)
values
- the values to test equivalence forExpr
instancepublic static Expr Contains(Expr path, Expr in)
Contains(Path, Expr)
function.path
- the desired path to check for presence. Type: Arrayin
- the target value. Type: Object or ArrayExpr
instanceContains(Path, Expr)
public static Expr Contains(Language.Path path, Expr in)
path
- the desired path to check for presencein
- the target value. Type: Object or ArrayExpr
instancepublic static Language.Path Path(java.lang.String... segments)
segments
- the object keysLanguage.Path
instanceLanguage.Path
,
Contains(Path, Expr)
,
Select(Path, Expr)
,
Select(Path, Expr, Expr)
,
SelectAll(Path, Expr)
public static Language.Path Path(int... segments)
segments
- the array indexesLanguage.Path
instanceLanguage.Path
,
Contains(Path, Expr)
,
Select(Path, Expr)
,
Select(Path, Expr, Expr)
,
SelectAll(Path, Expr)
public static Expr Select(Expr path, Expr from)
Select(Path, Expr)
function.path
- the path to the desired value. Type: Arrayfrom
- the target resource. Type: Object or ArrayExpr
instanceSelect(Path, Expr)
public static Expr Select(Expr path, Expr from, Expr defaultValue)
Select(Path, Expr, Expr)
function.path
- the path to the desired value. Type: Arrayfrom
- the target resource. Type: Object or ArraydefaultValue
- the default value to return if the desired path doesn't existExpr
instanceSelect(Path, Expr, Expr)
public static Expr Select(Language.Path path, Expr from)
path
- the path to the desired valuefrom
- the target resource. Type: Object or ArrayExpr
instancepublic static Expr Select(Language.Path path, Expr from, Expr defaultValue)
path
- the path to the desired valuefrom
- the target resource. Type: Object or ArraydefaultValue
- the default value to return if the desired path doesn't existExpr
instancepublic static Expr SelectAll(Expr path, Expr from)
SelectAll(Path, Expr)
function.path
- the path to the desired value. Type: Arrayfrom
- the collection to traverse. Type: ArrayExpr
instanceSelect(Path, Expr)
public static Expr SelectAll(Expr path, Expr from, Expr defaultValue)
path
- the path to the desired valuefrom
- the collection to traverse. Type: ArraydefaultValue
- the default value to return if the desired path doesn't existExpr
instancepublic static Expr SelectAll(Language.Path path, Expr from)
path
- the path to the desired valuefrom
- the collection to traverse. Type: ArrayExpr
instancepublic static Expr SelectAll(Language.Path path, Expr from, Expr defaultValue)
path
- the path to the desired valuefrom
- the collection to traverse. Type: ArraydefaultValue
- the default value to return if the desired path doesn't existExpr
instancepublic static Expr Abs(Expr value)
value
- The operand to abs. Type: NumberExpr
instancepublic static Expr Abs(java.lang.Long value)
value
- The operand to abs. Type: NumberExpr
instancepublic static Expr Abs(java.lang.Double value)
value
- The operand to abs. Type: NumberExpr
instancepublic static Expr Acos(Expr value)
value
- The operand to acos. Type: NumberExpr
instancepublic static Expr Acos(java.lang.Double value)
value
- The operand to acos. Type: NumberExpr
instancepublic static Expr Add(java.util.List<? extends Expr> values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Add(Expr... values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Asin(Expr value)
value
- The operand to asin. Type: NumberExpr
instancepublic static Expr Asin(java.lang.Double value)
value
- The operand to asin. Type: NumberExpr
instancepublic static Expr Atan(Expr value)
value
- The operand to atan. Type: NumberExpr
instancepublic static Expr Atan(java.lang.Double value)
value
- The operand to atan. Type: NumberExpr
instancepublic static Expr BitAnd(java.util.List<? extends Expr> values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr BitAnd(Expr... values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr BitNot(Expr value)
value
- The operand to atan. Type: NumberExpr
instancepublic static Expr BitNot(java.lang.Long value)
value
- The operand to atan. Type: NumberExpr
instancepublic static Expr BitOr(java.util.List<? extends Expr> values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr BitOr(Expr... values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr BitXor(java.util.List<? extends Expr> values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr BitXor(Expr... values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Ceil(Expr value)
value
- The operand to ceil. Type: NumberExpr
instancepublic static Expr Ceil(java.lang.Long value)
value
- The operand to ceil. Type: NumberExpr
instancepublic static Expr Ceil(java.lang.Double value)
value
- The operand to ceil. Type: NumberExpr
instancepublic static Expr Cos(Expr value)
value
- The operand to cos. Type: NumberExpr
instancepublic static Expr Cos(java.lang.Double value)
value
- The operand to cos. Type: NumberExpr
instancepublic static Expr Cosh(Expr value)
value
- The operand to cosh. Type: NumberExpr
instancepublic static Expr Cosh(java.lang.Double value)
value
- The operand to cosh. Type: NumberExpr
instancepublic static Expr Degrees(Expr value)
value
- The operand to degrees. Type: NumberExpr
instancepublic static Expr Degrees(java.lang.Double value)
value
- The operand to degrees. Type: NumberExpr
instancepublic static Expr Degrees(java.lang.Long value)
value
- The operand to degrees. Type: NumberExpr
instancepublic static Expr Divide(Expr... values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Exp(Expr value)
value
- The operand to exp. Type: NumberExpr
instancepublic static Expr Exp(java.lang.Long value)
value
- The operand to exp. Type: NumberExpr
instancepublic static Expr Exp(java.lang.Double value)
value
- The operand to exp. Type: NumberExpr
instancepublic static Expr Floor(Expr value)
value
- The operand to floor Type: NumberExpr
instancepublic static Expr Floor(java.lang.Long value)
value
- The operand to floor Type: NumberExpr
instancepublic static Expr Floor(java.lang.Double value)
value
- The operand to floor Type: NumberExpr
instancepublic static Expr Ln(Expr value)
value
- The operand to ln. Type: NumberExpr
instancepublic static Expr Ln(java.lang.Double value)
value
- The operand to ln. Type: NumberExpr
instancepublic static Expr Hypot(Expr num, Expr exp)
num
- the base. Type: Numberexp
- the exponent, default 2Expr
instanceValue(long)
,
Value(double)
public static Expr Hypot(java.lang.Double num, Expr exp)
num
- the base. Type: Numberexp
- the exponent, default 2Expr
instanceValue(long)
,
Value(double)
public static Expr Hypot(Expr num, java.lang.Double exp)
num
- the base. Type: Numberexp
- the exponent, default 2Expr
instanceValue(long)
,
Value(double)
public static Expr Hypot(java.lang.Double num, java.lang.Double exp)
num
- the base. Type: Numberexp
- the exponent, default 2Expr
instanceValue(long)
,
Value(double)
public static Expr Hypot(Expr num)
num
- the base. Type: NumberExpr
instanceValue(long)
,
Value(double)
public static Expr Hypot(java.lang.Double num)
num
- the base. Type: NumberExpr
instanceValue(long)
,
Value(double)
public static Expr Log(Expr value)
value
- The operand to log. Type: NumberExpr
instancepublic static Expr Log(java.lang.Double value)
value
- The operand to log. Type: NumberExpr
instancepublic static Expr Max(java.util.List<? extends Expr> values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Max(Expr... values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Min(java.util.List<? extends Expr> values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Min(Expr... values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Modulo(java.util.List<? extends Expr> values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Modulo(Expr... values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Multiply(java.util.List<? extends Expr> values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Multiply(Expr... values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Pow(Expr num, Expr exp)
num
- the base. Type: Numberexp
- the exponent, default 2Expr
instanceValue(long)
,
Value(double)
public static Expr Pow(java.lang.Double num, Expr exp)
num
- the base. Type: Numberexp
- the exponent, default 2Expr
instanceValue(long)
,
Value(double)
public static Expr Pow(Expr num, java.lang.Double exp)
num
- the base. Type: Numberexp
- the exponent, default 2Expr
instanceValue(long)
,
Value(double)
public static Expr Pow(java.lang.Double num, java.lang.Double exp)
num
- the base. Type: Numberexp
- the exponent, default 2Expr
instanceValue(long)
,
Value(double)
public static Expr Pow(Expr num)
num
- the base. Type: NumberExpr
instanceValue(long)
,
Value(double)
public static Expr Radians(Expr value)
value
- The operand to radians. Type: NumberExpr
instancepublic static Expr Radians(java.lang.Double value)
value
- The operand to radians. Type: NumberExpr
instancepublic static Expr Round(Expr num, Expr precision)
num
- the number to round. Type: Numberprecision
- where to roundExpr
instanceValue(long)
,
Value(double)
public static Expr Round(java.lang.Double num, Expr precision)
num
- the number to round. Type: Numberprecision
- where to roundExpr
instanceValue(long)
,
Value(double)
public static Expr Round(java.lang.Long num, Expr precision)
num
- the number to round. Type: Numberprecision
- where to roundExpr
instanceValue(long)
,
Value(double)
public static Expr Round(Expr num, java.lang.Long precision)
num
- the number to round. Type: Numberprecision
- where to roundExpr
instanceValue(long)
,
Value(double)
public static Expr Round(java.lang.Double num, java.lang.Long precision)
num
- the number to round. Type: Numberprecision
- where to roundExpr
instanceValue(long)
,
Value(double)
public static Expr Round(java.lang.Long num, java.lang.Long precision)
num
- the number to round. Type: Numberprecision
- where to roundExpr
instanceValue(long)
,
Value(double)
public static Expr Round(Expr num)
num
- the number to round to 2 decimal places. Type: NumberExpr
instanceValue(long)
,
Value(double)
public static Expr Round(java.lang.Double num)
num
- the number to round to 2 decimal places. Type: NumberExpr
instanceValue(long)
,
Value(double)
public static Expr Sign(Expr value)
value
- The operand to log. Type: NumberExpr
instancepublic static Expr Sign(java.lang.Double value)
value
- The operand to log. Type: NumberExpr
instancepublic static Expr Sign(java.lang.Long value)
value
- The operand to log. Type: NumberExpr
instancepublic static Expr Sin(Expr value)
value
- The operand to sin. Type: NumberExpr
instancepublic static Expr Sin(java.lang.Double value)
value
- The operand to sin. Type: NumberExpr
instancepublic static Expr Sinh(Expr value)
value
- The operand to hyperbolic sine. Type: NumberExpr
instancepublic static Expr Sinh(java.lang.Double value)
value
- The operand to hyperbolic sine. Type: NumberExpr
instancepublic static Expr Sqrt(Expr value)
value
- The operand to log. Type: NumberExpr
instancepublic static Expr Sqrt(java.lang.Double value)
value
- The operand to log. Type: NumberExpr
instancepublic static Expr Subtract(java.util.List<? extends Expr> values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Subtract(Expr... values)
values
- the list of numbers. Type: ArrayExpr
instancepublic static Expr Tan(Expr value)
value
- The operand to tan. Type: NumberExpr
instancepublic static Expr Tan(java.lang.Double value)
value
- The operand to tan. Type: NumberExpr
instancepublic static Expr Tanh(Expr value)
value
- The operand to tanh. Type: NumberExpr
instancepublic static Expr Tanh(java.lang.Double value)
value
- The operand to tanh. Type: NumberExpr
instancepublic static Expr Trunc(Expr num, Expr precision)
num
- the number to truncate. Type: Numberprecision
- where to truncate, default 2Expr
instanceValue(long)
public static Expr Trunc(java.lang.Double num, Expr precision)
num
- the number to truncate. Type: Numberprecision
- where to truncate, default 2Expr
instanceValue(long)
public static Expr Trunc(java.lang.Long num, Expr precision)
num
- the number to truncate. Type: Numberprecision
- where to truncate, default 2Expr
instanceValue(long)
public static Expr Trunc(Expr num, java.lang.Long precision)
num
- the number to truncate. Type: Numberprecision
- where to truncate, default 2Expr
instanceValue(long)
public static Expr Trunc(java.lang.Double num, java.lang.Long precision)
num
- the number to truncate. Type: Numberprecision
- where to truncate, default 2Expr
instanceValue(long)
public static Expr Trunc(java.lang.Long num, java.lang.Long precision)
num
- the number to truncate. Type: Numberprecision
- where to truncate, default 2Expr
instanceValue(long)
public static Expr Trunc(Expr num)
num
- the number to truncate to 2 decimal places. Type: NumberExpr
instanceValue(long)
public static Expr Trunc(java.lang.Double num)
num
- the number to truncate to 2 decimal places. Type: NumberExpr
instanceValue(long)
public static Expr LT(java.util.List<? extends Expr> values)
values
- the list of numbers to compare. Type: ArrayExpr
instancepublic static Expr LT(Expr... values)
values
- the list of numbers to compare. Type: ArrayExpr
instancepublic static Expr LTE(java.util.List<? extends Expr> values)
values
- the list of numbers to compare. Type: ArrayExpr
instancepublic static Expr LTE(Expr... values)
values
- the list of numbers to compare. Type: ArrayExpr
instancepublic static Expr GT(java.util.List<? extends Expr> values)
values
- the list of numbers to compare. Type: ArrayExpr
instancepublic static Expr GT(Expr... values)
values
- the list of numbers to compare. Type: ArrayExpr
instancepublic static Expr GTE(java.util.List<? extends Expr> values)
values
- the list of numbers to compare. Type: ArrayExpr
instancepublic static Expr GTE(Expr... values)
values
- the list of numbers to compare. Type: ArrayExpr
instancepublic static Expr And(java.util.List<? extends Expr> values)
values
- a collection of boolean values. Type: ArrayExpr
instancepublic static Expr And(Expr... values)
values
- a collection of boolean values. Type: ArrayExpr
instancepublic static Expr Or(java.util.List<? extends Expr> values)
values
- a collection of boolean values. Type: ArrayExpr
instancepublic static Expr Or(Expr... values)
values
- a collection of boolean values. Type: ArrayExpr
instancepublic static Expr Not(Expr bool)
bool
- a boolean value. Type: BooleanExpr
instancepublic static Expr ToString(Expr value)
value
- an expression. Type: AnyExpr
public static Expr ToNumber(Expr value)
value
- an expression. Type: AnyExpr
public static Expr ToTime(Expr value)
value
- an expression. Type: AnyExpr