Methods modeling the FaunaDB query language. This class is intended to be statically imported into your code: More...

Classes
class	Cursor
	Creates a new Cursor to be used with a Paginate expression. More...

struct	LetBinding

struct	PathSelector
	Builder for path selectors. More...

Public Types
enum class	Normalizer { NFD , NFC , NFKD , NFKC , NFKCCaseFold }
	Possible normalizer values accepted by Casefold(Expr, Normalizer). More...

enum class	TimeUnit { Day , HalfDay , Hour , Minute , Second , Millisecond , Microsecond , Nanosecond }
	Possible time units accepted by Epoch(Expr, TimeUnit). More...

enum class	ActionType { Create , Delete }
	Possible actions for functions Insert(Expr, Expr, ActionType, Expr) and Remove(Expr, Expr, ActionType). More...

Static Public Member Functions
static Expr	Login (Expr @ref, Expr @params)
	Creates a new Login expression. More...

static Expr	Logout (Expr deleteTokens)
	Creates a new Logout expression. More...

static Expr	Logout (bool deleteTokens)
	Creates a new Logout expression. More...

static Expr	Identify (Expr @ref, Expr password)
	Creates a new Identify expression. More...

static Expr	Identity ()
	Creates a new Identity expression. More...

static Expr	CurrentIdentity ()
	Creates a new CurrentIdentity expression. More...

static Expr	HasIdentity ()
	Creates a new HasIdentity expression. More...

static Expr	HasCurrentIdentity ()
	Creates a new HasCurrentIdentity expression. More...

static Expr	CurrentToken ()
	Creates a new CurrentToken expression. More...

static Expr	HasCurrentToken ()
	Creates a new HasCurrentToken expression. More...

static Expr	AccessProviders (Expr scope=null)
	Creates a new AccessProviders expression. More...

static Expr	AccessProvider (Expr name, Expr scope=null)
	Creates a new AccessProvider expression. More...

static Expr	CreateAccessProvider (Expr expr)
	Creates a new CreateAccessProvider expression. More...

static Expr	Abort (Expr msg)
	Creates a new Abort expression. More...

static Expr	Call (Expr @ref, params Expr[] arguments)
	Creates a new Call expression. More...

static Expr	Query (Expr lambda)
	Creates a new Query expression. More...

static Expr	At (Expr timestamp, Expr expr)
	Creates a new At expression. More...

static Expr	Let (IReadOnlyDictionary< string, Expr > vars, Expr @in)
	Creates a new Let expression wrapping the provided map of bindings. More...

static Expr	Var (string varName)
	Creates a new Var expression. More...

static Expr	If (Expr @if, Expr @then, Expr @else)
	Creates a new If expression. More...

static Expr	Do (params Expr[] expressions)
	Creates a new Do expression containing the provided expressions. More...

static Expr	Lambda (Expr vars, Expr expr)
	Creates a new Lambda expression. More...

static Expr	Lambda (Func< Expr, Expr > lambda)
	Creates a lambda expression that receives one argument. More...

static Expr	Lambda (Func< Expr, Expr, Expr > lambda)
	Creates a lambda expression that receives two arguments. More...

static Expr	Lambda (Func< Expr, Expr, Expr, Expr > lambda)
	Creates a lambda expression that receives three arguments. More...

static Expr	Lambda (Func< Expr, Expr, Expr, Expr, Expr > lambda)
	Creates a lambda expression that receives four arguments. More...

static Expr	Lambda (Func< Expr, Expr, Expr, Expr, Expr, Expr > lambda)
	Creates a lambda expression that receives five arguments. More...

static Expr	Lambda (Func< Expr, Expr, Expr, Expr, Expr, Expr, Expr > lambda)
	Creates a lambda expression that receives six arguments. More...

static LetBinding	Let (string k0, Expr v0)
	Creates a new Let expression with the provided bindings. More...

static LetBinding	Let (string k0, Expr v0, string k1, Expr v1)
	Creates a new Let expression with the provided bindings. More...

static LetBinding	Let (string k0, Expr v0, string k1, Expr v1, string k2, Expr v2)
	Creates a new Let expression with the provided bindings. More...

static LetBinding	Let (string k0, Expr v0, string k1, Expr v1, string k2, Expr v2, string k3, Expr v3)
	Creates a new Let expression with the provided bindings. More...

static LetBinding	Let (string k0, Expr v0, string k1, Expr v1, string k2, Expr v2, string k3, Expr v3, string k4, Expr v4)
	Creates a new Let expression with the provided bindings. More...

static LetBinding	Let (string k0, Expr v0, string k1, Expr v1, string k2, Expr v2, string k3, Expr v3, string k4, Expr v4, string k5, Expr v5)
	Creates a new Let expression with the provided bindings. More...

static Expr	Map (Expr collection, Expr lambda)
	Creates a new Map expression. More...

static Expr	Foreach (Expr collection, Expr lambda)
	Creates a new Foreach expression. More...

static Expr	Filter (Expr collection, Expr lambda)
	Creates a new Filter expression. More...

static Expr	Take (Expr number, Expr collection)
	Creates a new Take expression. More...

static Expr	Drop (Expr number, Expr collection)
	Creates a new Drop expression. More...

static Expr	Prepend (Expr elements, Expr collection)
	Creates a new Prepend expression. More...

static Expr	Append (Expr elements, Expr collection)
	Creates a new Append expression. More...

static Expr	IsEmpty (Expr collection)
	Creates a new IsEmpty expression. More...

static Expr	IsNonEmpty (Expr collection)
	Creates a new IsNonEmpty expression. More...

static Expr	Reverse (Expr expr)
	Creates a new Reverse expression. More...

static Expr	All (Expr collection)
	Evaluates to true if all elements of the collection is true. More...

static Expr	Any (Expr collection)
	Evaluates to true if any element of the collection is true. More...

static Expr	Filter (Expr collection, Func< Expr, Expr > lambda)
	Creates a new Filter expression with a lambda function that receives one argument. More...

static Expr	Filter (Expr collection, Func< Expr, Expr, Expr > lambda)
	Creates a new Filter expression with a lambda function that receives two arguments. More...

static Expr	Filter (Expr collection, Func< Expr, Expr, Expr, Expr > lambda)
	Creates a new Filter expression with a lambda function that receives three arguments. More...

static Expr	Filter (Expr collection, Func< Expr, Expr, Expr, Expr, Expr > lambda)
	Creates a new Filter expression with a lambda function that receives four arguments. More...

static Expr	Filter (Expr collection, Func< Expr, Expr, Expr, Expr, Expr, Expr > lambda)
	Creates a new Filter expression with a lambda function that receives five arguments. More...

static Expr	Filter (Expr collection, Func< Expr, Expr, Expr, Expr, Expr, Expr, Expr > lambda)
	Creates a new Filter expression with a lambda function that receives six arguments. More...

static Expr	Foreach (Expr collection, Func< Expr, Expr > lambda)
	Creates a new Foreach expression with a lambda function that receives one argument. More...

static Expr	Foreach (Expr collection, Func< Expr, Expr, Expr > lambda)
	Creates a new Foreach expression with a lambda function that receives two arguments. More...

static Expr	Foreach (Expr collection, Func< Expr, Expr, Expr, Expr > lambda)
	Creates a new Foreach expression with a lambda function that receives three arguments. More...

static Expr	Foreach (Expr collection, Func< Expr, Expr, Expr, Expr, Expr > lambda)
	Creates a new Foreach expression with a lambda function that receives four arguments. More...

static Expr	Foreach (Expr collection, Func< Expr, Expr, Expr, Expr, Expr, Expr > lambda)
	Creates a new Foreach expression with a lambda function that receives five arguments. More...

static Expr	Foreach (Expr collection, Func< Expr, Expr, Expr, Expr, Expr, Expr, Expr > lambda)
	Creates a new Foreach expression with a lambda function that receives six arguments. More...

static Expr	Map (Expr collection, Func< Expr, Expr > lambda)
	Creates a new Map expression with a lambda function that receives one argument. More...

static Expr	Map (Expr collection, Func< Expr, Expr, Expr > lambda)
	Creates a new Map expression with a lambda function that receives two arguments. More...

static Expr	Map (Expr collection, Func< Expr, Expr, Expr, Expr > lambda)
	Creates a new Map expression with a lambda function that receives three arguments. More...

static Expr	Map (Expr collection, Func< Expr, Expr, Expr, Expr, Expr > lambda)
	Creates a new Map expression with a lambda function that receives four arguments. More...

static Expr	Map (Expr collection, Func< Expr, Expr, Expr, Expr, Expr, Expr > lambda)
	Creates a new Map expression with a lambda function that receives five arguments. More...

static Expr	Map (Expr collection, Func< Expr, Expr, Expr, Expr, Expr, Expr, Expr > lambda)
	Creates a new Map expression with a lambda function that receives six arguments. More...

static Expr	NextId ()
	Creates a new NextId expression. More...

static Expr	NewId ()
	Creates a new NewId expression. More...

static Expr	Database (Expr db_name, Expr scope=null)
	Creates a new Database expression. More...

static Expr	Index (Expr index_name, Expr scope=null)
	Creates a new Index expression. More...

static Expr	Collection (Expr coll_name, Expr scope=null)
	Creates a new Collection expression. More...

static Expr	Class (Expr class_name, Expr scope=null)
	Creates a new Class expression. More...

static Expr	Function (Expr function_name, Expr scope=null)
	Creates a new Function expression. More...

static Expr	Role (Expr role_name, Expr scope=null)
	Creates a new Role expression. More...

static Expr	Collections (Expr scope=null)
	Returns an internal reference to collections object. Useful to paginate over all classes of a given scope database. More...

static Expr	Classes (Expr scope=null)
	Returns an internal reference to classes object. Useful to paginate over all classes of a given scope database. More...

static Expr	Indexes (Expr scope=null)
	Returns an internal reference to indexes object. Useful to paginate over all indexes of a given scope database. More...

static Expr	Databases (Expr scope=null)
	Returns an internal reference to databases object. Useful to paginate over all databases of a given scope database. More...

static Expr	Functions (Expr scope=null)
	Returns an internal reference to functions object. Useful to paginate over all functions of a given scope database. More...

static Expr	Roles (Expr scope=null)
	Returns an internal reference to roles object. Useful to paginate over all roles of a given scope database. More...

static Expr	Keys (Expr scope=null)
	Returns an internal reference to keys object. Useful to paginate over all keys of a given scope database. More...

static Expr	Tokens (Expr scope=null)
	Returns an internal reference to tokens object. Useful to paginate over all tokens of a given scope database. More...

static Expr	Credentials (Expr scope=null)
	Returns an internal reference to credentials object. Useful to paginate over all credentials of a given scope database. More...

static Expr	EqualsFn (params Expr[] values)
	Creates a new Equals expression. More...

static Expr	Contains (Expr path, Expr @in)
	Creates a new Contains expression. More...

static Expr	ContainsField (Expr path, Expr @in)
	Creates a new ContainsField expression. More...

static Expr	ContainsValue (Expr value, Expr @in)
	Creates a new ContainsValue expression. More...

static Expr	Contains (PathSelector path, Expr @in)
	Creates a new Contains expression. More...

static Expr	ContainsPath (PathSelector path, Expr @in)
	Creates a new ContainsPath expression. More...

static Expr	ContainsPath (Expr expr, Expr @in)
	Creates a new ContainsPath expression. More...

static Expr	Select (Expr path, Expr @from, Expr @default=null)
	Creates a new Select expression. More...

static Expr	Select (PathSelector path, Expr @from, Expr @default=null)
	Creates a new Select expression. More...

static Expr	SelectAll (Expr path, Expr @from)
	Creates a new SelectAll expression. More...

static Expr	SelectAll (PathSelector path, Expr @from)
	Creates a new SelectAll expression. More...

static Expr	Add (params Expr[] values)
	Creates a new Add expression. More...

static Expr	Multiply (params Expr[] values)
	Creates a new Multiply expression. More...

static Expr	Subtract (params Expr[] values)
	Creates a new Subtract expression. More...

static Expr	Divide (params Expr[] values)
	Creates a new Divide expression. More...

static Expr	Modulo (params Expr[] values)
	Creates a new Modulo expression. More...

static Expr	LT (params Expr[] values)
	Creates a new LT expression. More...

static Expr	LTE (params Expr[] values)
	Creates a new LTE expression. More...

static Expr	GT (params Expr[] values)
	Creates a new GT expression. More...

static Expr	GTE (params Expr[] values)
	Creates a new GTE expression. More...

static Expr	And (params Expr[] values)
	Creates a new And expression. More...

static Expr	Or (params Expr[] values)
	Creates a new Or expression. More...

static Expr	Not (Expr boolean)
	Creates a new Not expression. More...

static Expr	ToStringExpr (Expr expr)
	Converts an expression to a string literal. More...

static Expr	ToNumber (Expr expr)
	Converts an expression to a number literal. More...

static Expr	ToTime (Expr expr)
	Converts an expresion to a time literal. More...

static Expr	ToSeconds (Expr expr)
	Converts a time expression to seconds since the UNIX epoch. More...

static Expr	ToMillis (Expr expr)
	Converts a time expression to milliseconds since the UNIX epoch. More...

static Expr	ToMicros (Expr expr)
	Converts a time expression to microseconds since the UNIX epoch. More...

static Expr	DayOfYear (Expr expr)
	Returns a time expression's day of the year, from 1 to 365, or 366 in a leap year. More...

static Expr	DayOfMonth (Expr expr)
	Returns a time expression's day of the month, from 1 to 31. More...

static Expr	DayOfWeek (Expr expr)
	Returns a time expression's day of the week following ISO-8601 convention, from 1 (Monday) to 7 (Sunday). More...

static Expr	Year (Expr expr)
	Returns the time expression's year, following the ISO-8601 standard. More...

static Expr	Month (Expr expr)
	Returns a time expression's month of the year, from 1 to 12. More...

static Expr	Hour (Expr expr)
	Returns a time expression's hour of the day, from 0 to 23. More...

static Expr	Minute (Expr expr)
	Returns a time expression's minute of the hour, from 0 to 59. More...

static Expr	Second (Expr expr)
	Returns a time expression's second of the minute, from 0 to 59. More...

static Expr	ToDate (Expr expr)
	Converts an expression to a date literal. More...

static Expr	Merge (Expr merge, Expr with)
	Merges two or more objects More...

static Expr	Merge (Expr merge, Expr with, Expr lambda)
	Merges two or more objects More...

static Expr	Merge (Expr merge, Expr with, Func< Expr, Expr, Expr, Expr > lambda)
	Merges two or more objects More...

static Expr	Abs (Expr value)
	Creates a new Abs expression. More...

static Expr	Acos (Expr value)
	Creates a new Acos expression. More...

static Expr	Asin (Expr expr)
	Creates a new Asin expression. More...

static Expr	Atan (Expr expr)
	Creates a new Atan expression. More...

static Expr	BitAnd (params Expr[] terms)
	Creates a new BitAnd expression. More...

static Expr	BitNot (Expr expr)
	Creates a new BitNot expression. More...

static Expr	BitOr (params Expr[] terms)
	Creates a new BitOr expression. More...

static Expr	BitXor (params Expr[] terms)
	Creates a new BitXor expression. More...

static Expr	Ceil (Expr expr)
	Creates a new Ceil expression. More...

static Expr	Cos (Expr expr)
	Creates a new Cos expression. More...

static Expr	Cosh (Expr expr)
	Creates a new Cosh expression. More...

static Expr	Degrees (Expr expr)
	Creates a new Degrees expression. More...

static Expr	Exp (Expr expr)
	Creates a new Exp expression. More...

static Expr	Floor (Expr expr)
	Creates a new Floor expression. More...

static Expr	Hypot (Expr value, Expr exp=null)
	Creates a new Hypot expression. More...

static Expr	Ln (Expr expr)
	Creates a new Ln expression. More...

static Expr	Log (Expr expr)
	Creates a new Log expression. More...

static Expr	Max (params Expr[] terms)
	Creates a new Max expression. More...

static Expr	Min (params Expr[] terms)
	Creates a new Min expression. More...

static Expr	Pow (Expr value, Expr exp=null)
	Creates a new Pow expression. More...

static Expr	Radians (Expr expr)
	Creates a new Radians expression. More...

static Expr	Round (Expr expr, Expr precision=null)
	Creates a new Round expression. More...

static Expr	Sign (Expr expr)
	Creates a new Sign expression. More...

static Expr	Sin (Expr expr)
	Creates a new Sin expression. More...

static Expr	Sinh (Expr expr)
	Creates a new Sinh expression. More...

static Expr	Sqrt (Expr expr)
	Creates a new Sqrt expression. More...

static Expr	Tan (Expr expr)
	Creates a new Tan expression. More...

static Expr	Tanh (Expr expr)
	Creates a new Tanh expression. More...

static Expr	Trunc (Expr expr, Expr precision=null)
	Creates a new Trunc expression. More...

static Expr	FindStr (Expr expr, Expr find, Expr start=null)
	Returns the offset position of a string in another string. More...

static Expr	FindStrRegex (Expr expr, Expr pattern, Expr start=null, Expr numResults=null)
	Returns an array of up to 1024 objects describing where the pattern is found in the search string. More...

static Expr	Length (Expr expr)
	Returns the number of code points in the string. More...

static Expr	LowerCase (Expr expr)
	Returns a string in which all uppercase characters have been replaced by their corresponding lowercase characters. More...

static Expr	LTrim (Expr expr)
	Removes all white spaces, tabs, and new lines from the beginning of a string. More...

static Expr	Repeat (Expr expr)
	Returns a string consisting of the value string repeated number times. More...

static Expr	Repeat (Expr expr, Expr number)
	Returns a string consisting of the value string repeated number times. More...

static Expr	ReplaceStr (Expr expr, Expr find, Expr replace)
	Replaces a string. More...

static Expr	ReplaceStrRegex (Expr expr, Expr pattern, Expr replace, Expr first=null)
	Replaces all the occurrences (or the first one) of find pattern substituted with replace string. More...

static Expr	RTrim (Expr expr)
	Replaces a string inside. More...

static Expr	Space (Expr count)
	Replaces a string inside. More...

static Expr	SubString (Expr expr, Expr start=null, Expr length=null)
	Returns a portion of the string. More...

static Expr	TitleCase (Expr expr)
	Returns a string which has the first letter of each word capitalized. More...

static Expr	Trim (Expr expr)
	Returns a string which has both the leading and trailing white spaces, tabs, and new lines removed. More...

static Expr	UpperCase (Expr expr)
	Returns a string which has all lowercase characters in the string replaced by their corresponding uppercase characters. More...

static Expr	StartsWith (Expr value, Expr search)
	See the FaunaDB StartsWith Function More...

static Expr	EndsWith (Expr value, Expr search)
	See the FaunaDB EndsWith Function More...

static Expr	ContainsStr (Expr value, Expr search)

static Expr	ContainsStrRegex (Expr value, Expr pattern)

static Expr	RegexEscape (Expr value)

static Expr	Documents (Expr collection)

static Expr	ToArray (Expr expr)
	Try to convert an object into an array of (field, value). More...

static Expr	ToObject (Expr fields)
	Try to convert an array of (field, value) into an object. More...

static Expr	ToDouble (Expr value)
	Casts an expression to a double value, if possible. More...

static Expr	ToInteger (Expr value)
	Casts an expression to an integer value, if possible. More...

static Expr	Get (Expr @ref, Expr ts=null)
	Creates a new Get expression. More...

static Expr	KeyFromSecret (Expr secret)
	Creates a new KeyFromSecret expression. More...

static Expr	Paginate (Expr set, Expr ts=null, Expr after=null, Expr before=null, Expr size=null, Expr events=null, Expr sources=null, Cursor cursor=null)
	Creates a new Paginate expression. More...

static Cursor	RawCursor (Expr expr)

static Cursor	After (Expr expr)

static Cursor	Before (Expr expr)

static Expr	Exists (Expr @ref, Expr ts=null)
	Creates a new Exists expression. More...

static Expr	Reduce (Expr lambda, Expr initial, Expr collection)
	Creates a new Exists expression. More...

static Expr	Reduce (Func< Expr, Expr, Expr > lambda, Expr initial, Expr collection)
	Creates a new Exists expression. More...

static Expr	Count (Expr expr)
	Returns the number of items that exist in the array or set More...

static Expr	Sum (Expr expr)
	Returns the sum of all items. More...

static Expr	Mean (Expr expr)
	Returns the average value of the items. More...

static Expr	Singleton (Expr @ref)
	Creates a new Singleton expression. More...

static Expr	Events (Expr refSet)
	Creates a new Events expression. More...

static Expr	Match (Expr index, params Expr[] terms)
	Creates a new Match expression. More...

static Expr	Union (params Expr[] values)
	Creates a new Union expression. More...

static Expr	Intersection (params Expr[] values)
	Creates a new Intersection expression. More...

static Expr	Difference (params Expr[] values)
	Creates a new Difference expression. More...

static Expr	Distinct (Expr set)
	Creates a new Distinct expression. More...

static Expr	Join (Expr source, Expr target)
	Creates a new Join expression. More...

static Expr	Range (Expr set, Expr from, Expr to)
	Filters the set based on the lower/upper bounds (inclusive). More...

static Expr	Join (Expr source, Func< Expr, Expr > target)
	Creates a new Join expression. More...

static Expr	Join (Expr source, Func< Expr, Expr, Expr > target)
	Creates a new Join expression. More...

static Expr	Join (Expr source, Func< Expr, Expr, Expr, Expr > target)
	Creates a new Join expression. More...

static Expr	Join (Expr source, Func< Expr, Expr, Expr, Expr, Expr > target)
	Creates a new Join expression. More...

static Expr	Join (Expr source, Func< Expr, Expr, Expr, Expr, Expr, Expr > target)
	Creates a new Join expression. More...

static Expr	Join (Expr source, Func< Expr, Expr, Expr, Expr, Expr, Expr, Expr > target)
	Creates a new Join expression. More...

static Expr	Concat (Expr strings, Expr separator=null)
	Creates a new Concat expression. More...

static Expr	Casefold (Expr @string, Normalizer normalizer)
	Creates a new Casefold expression. More...

static Expr	Casefold (Expr @string, Expr normalizer=null)
	Creates a new Casefold expression. More...

static Expr	NGram (Expr terms, Expr min=null, Expr max=null)
	Creates a new NGram expression. More...

static Expr	Format (Expr format, params Expr[] values)
	Format values into string. More...

static Expr	Time (Expr time)
	Creates a new Time expression. More...

static Expr	Epoch (Expr number, TimeUnit unit)
	Creates a new Epoch expression. More...

static Expr	Epoch (Expr number, Expr unit)
	Creates a new Epoch expression. More...

static Expr	Date (Expr date)
	Creates a new Date expression. More...

static Expr	Now ()
	Constructs a Timestamp representing the transaction’s start time. More...

static Expr	TimeAdd (Expr value, Expr offset, Expr unit)
	Returns a new time or date with the offset in terms of the unit added. More...

static Expr	TimeSubtract (Expr value, Expr offset, Expr unit)
	Returns a new time or date with the offset in terms of the unit subtracted. More...

static Expr	TimeDiff (Expr start, Expr finish, Expr unit)
	Returns the number of intervals in terms of the unit between two times or dates. Both start and finish must be of the same type. More...

static Expr	IsArray (Expr expr)
	Check if the expression is an array. More...

static Expr	IsBoolean (Expr expr)
	Check if the expression is a boolean. More...

static Expr	IsBytes (Expr expr)
	Check if the expression is a byte array. More...

static Expr	IsCollection (Expr expr)
	Check if the expression is a collection. More...

static Expr	IsCredentials (Expr expr)
	Check if the expression is a credentials. More...

static Expr	IsDatabase (Expr expr)
	Check if the expression is a database. More...

static Expr	IsDate (Expr expr)
	Check if the expression is a date. More...

static Expr	IsDoc (Expr expr)
	Check if the expression is a document (either a reference or an instance). More...

static Expr	IsDouble (Expr expr)
	Check if the expression is a double. More...

static Expr	IsFunction (Expr expr)
	Check if the expression is a function. More...

static Expr	IsIndex (Expr expr)
	Check if the expression is an index. More...

static Expr	IsInteger (Expr expr)
	Check if the expression is an integer. More...

static Expr	IsKey (Expr expr)
	Check if the expression is a key. More...

static Expr	IsLambda (Expr expr)
	Check if the expression is a lambda. More...

static Expr	IsNull (Expr expr)
	Check if the expression is null. More...

static Expr	IsNumber (Expr expr)
	Check if the expression is a number. More...

static Expr	IsObject (Expr expr)
	Check if the expression is an object. More...

static Expr	IsRef (Expr expr)
	Check if the expression is a reference. More...

static Expr	IsRole (Expr expr)
	Check if the expression is a role. More...

static Expr	IsSet (Expr expr)
	Check if the expression is a set. More...

static Expr	IsString (Expr expr)
	Check if the expression is a string. More...

static Expr	IsTimestamp (Expr expr)
	Check if the expression is a timestamp. More...

static Expr	IsToken (Expr expr)
	Check if the expression is a token. More...

static PathSelector	Path (params string[] segments)
	Helper for constructing a PathSelector with the given path terms. More...

static PathSelector	Path (params int[] segments)
	Helper for constructing a PathSelector with the given path terms. More...

static PathSelector	Path (params Expr[] expr)
	Helper for constructing a PathSelector with the given expression. More...

static Expr	Null ()
	Creates a null value. More...

static Expr	Ref (string @ref)
	Creates a ref value from a string. More...

static Expr	Ref (Expr classRef, Expr id)
	Calls ref function to create a ref value. More...

static Expr	Ts (DateTime dateTime)
	Creates a new Timestamp value. More...

static Expr	Ts (string iso8601Time)
	Creates a new Timestamp value. More...

static Expr	Dt (DateTime dateTime)
	Creates a new Date value. More...

static Expr	Dt (string iso8601Date)
	Creates a new Date value. More...

static Expr	Arr (params Expr[] values)
	Creates a new Array value containing the provided entries. More...

static Expr	Arr (IEnumerable< Expr > values)
	Creates a new Array value containing the provided enumerable of values. More...

static Expr	Obj (IReadOnlyDictionary< string, Expr > fields)
	Creates a new Object value wrapping the provided map. More...

static Expr	Bytes (params byte[] bytes)
	Creates a new Bytes value More...

static Expr	Obj ()
	Creates a new empty Object value. More...

static Expr	Obj (string key1, Expr value1)
	Creates a new Object value with the provided entries. More...

static Expr	Obj (string key1, Expr value1, string key2, Expr value2)
	Creates a new Object value with the provided entries. More...

static Expr	Obj (string key1, Expr value1, string key2, Expr value2, string key3, Expr value3)
	Creates a new Object value with the provided entries. More...

static Expr	Obj (string key1, Expr value1, string key2, Expr value2, string key3, Expr value3, string key4, Expr value4)
	Creates a new Object value with the provided entries. More...

static Expr	Obj (string key1, Expr value1, string key2, Expr value2, string key3, Expr value3, string key4, Expr value4, string key5, Expr value5)
	Creates a new Object value with the provided entries. More...

static Expr	Obj (string key1, Expr value1, string key2, Expr value2, string key3, Expr value3, string key4, Expr value4, string key5, Expr value5, string key6, Expr value6)
	Creates a new Object value with the provided entries. More...

static Expr	Create (Expr classRef, Expr @params)
	Creates a new Create expression. More...

static Expr	Update (Expr @ref, Expr @params)
	Creates a new Update expression. More...

static Expr	Replace (Expr @ref, Expr @params)
	Creates a new Replace expression. More...

static Expr	Delete (Expr @ref)
	Creates a new Delete expression. More...

static Expr	Insert (Expr @ref, Expr ts, ActionType action, Expr @params)
	Creates a new Insert expression. More...

static Expr	Insert (Expr @ref, Expr ts, Expr action, Expr @params)
	Creates a new Insert expression. More...

static Expr	Remove (Expr @ref, Expr ts, ActionType action)
	Creates a new Remove expression. More...

static Expr	Remove (Expr @ref, Expr ts, Expr action)
	Creates a new Remove expression. More...

static Expr	CreateClass (Expr class_params)
	Creates a new CreateClass expression. More...

static Expr	CreateCollection (Expr coll_params)
	Creates a new CreateCollection expression. More...

static Expr	CreateDatabase (Expr db_params)
	Creates a new CreateDatabase expression. More...

static Expr	CreateIndex (Expr index_params)
	Creates a new CreateIndex expression. More...

static Expr	CreateKey (Expr key_params)
	Creates a new CreateKey expression. More...

static Expr	CreateFunction (Expr function_params)
	Creates a new CreateFunction expression. More...

static Expr	CreateRole (Expr role_params)
	Creates a new CreateRole expression. More...

static Expr	MoveDatabase (Expr from, Expr to)
	Moves a database to a new hierarchy. More...

Detailed Description

Methods modeling the FaunaDB query language. This class is intended to be statically imported into your code:

using static FaunaDB.Query.Language;

Each of these methods constructs a Expr, which can then be composed with other methods to form complex expressions.

Expr existsValue = Exists(Ref("some/ref"));
 
Expr createValue = Create(
 Ref("classes/some_class"),
 Obj("data",
   Obj("some", "field"))
);

FaunaDB Query API

Definition at line 3 of file Language.Authentication.cs.

Member Enumeration Documentation

◆ ActionType

enum FaunaDB.Query.Language.ActionType

strong

Possible actions for functions Insert(Expr, Expr, ActionType, Expr) and Remove(Expr, Expr, ActionType).

Enumerator
Create
Delete

Definition at line 46 of file Language.Write.cs.

◆ Normalizer

enum FaunaDB.Query.Language.Normalizer

strong

Possible normalizer values accepted by Casefold(Expr, Normalizer).

See the FaunaDB Time and Date Functions

Enumerator
NFD
NFC
NFKD
NFKC
NFKCCaseFold

Definition at line 20 of file Language.String.cs.

◆ TimeUnit

enum FaunaDB.Query.Language.TimeUnit

strong

Possible time units accepted by Epoch(Expr, TimeUnit).

See the FaunaDB Time and Date Functions

Enumerator
Day
HalfDay
Hour
Minute
Second
Millisecond
Microsecond
Nanosecond

Definition at line 20 of file Language.TimeDate.cs.

Member Function Documentation

◆ Abort()

static Expr FaunaDB.Query.Language.Abort ( Expr msg )

static

Creates a new Abort expression.

See the FaunaDB Basic Forms

.

◆ Abs()

static Expr FaunaDB.Query.Language.Abs ( Expr value )

static

Creates a new Abs expression.

See the FaunaDB Abs Function

◆ AccessProvider()

static Expr FaunaDB.Query.Language.AccessProvider	(	Expr	name,
		Expr	scope = `null`
	)

static

Creates a new AccessProvider expression.

See the docs

.

◆ AccessProviders()

static Expr FaunaDB.Query.Language.AccessProviders ( Expr scope = null )

static

Creates a new AccessProviders expression.

See the docs

.

◆ Acos()

static Expr FaunaDB.Query.Language.Acos ( Expr value )

static

Creates a new Acos expression.

See the FaunaDB Acos Function

◆ Add()

static Expr FaunaDB.Query.Language.Add ( params Expr[] values )

static

Creates a new Add expression.

See the FaunaDB Miscellaneous Functions

◆ After()

static Cursor FaunaDB.Query.Language.After ( Expr expr )

static

◆ All()

static Expr FaunaDB.Query.Language.All ( Expr collection )

static

Evaluates to true if all elements of the collection is true.

All function

Parameters

collection A collection expression

var result = await client.Query(All(Arr(true, true, true)));
 
Assert.IsTrue(true, result.To<bool>().Value);

◆ And()

static Expr FaunaDB.Query.Language.And ( params Expr[] values )

static

Creates a new And expression.

See the FaunaDB Miscellaneous Functions

◆ Any()

static Expr FaunaDB.Query.Language.Any ( Expr collection )

static

Evaluates to true if any element of the collection is true.

Any function

Parameters

collection A collection expression

var result = await client.Query(Any(Arr(true, false, false)));
 
Assert.IsTrue(true, result.To<bool>().Value);

◆ Append()

static Expr FaunaDB.Query.Language.Append	(	Expr	elements,
		Expr	collection
	)

static

Creates a new Append expression.

FaunaDB Collection Functions

Parameters

elements	Elements to be appended into the collection
collection	A collection expression

var result = await client.Query(Append(Arr(4, 5, 6), Arr(1, 2, 3)));
 
Assert.AreEqual(Arr(1, 2, 3, 4, 5, 6), result);

◆ Arr() [1/2]

static Expr FaunaDB.Query.Language.Arr ( IEnumerable< Expr > values )

static

Creates a new Array value containing the provided enumerable of values.

See the FaunaDB Values

◆ Arr() [2/2]

static Expr FaunaDB.Query.Language.Arr ( params Expr[] values )

static

Creates a new Array value containing the provided entries.

See the FaunaDB Values

◆ Asin()

static Expr FaunaDB.Query.Language.Asin ( Expr expr )

static

Creates a new Asin expression.

See the FaunaDB Asin Function

◆ At()

static Expr FaunaDB.Query.Language.At	(	Expr	timestamp,
		Expr	expr
	)

static

Creates a new At expression.

See the FaunaDB Basic Forms

.

◆ Atan()

static Expr FaunaDB.Query.Language.Atan ( Expr expr )

static

Creates a new Atan expression.

See the FaunaDB Atan Function

◆ Before()

static Cursor FaunaDB.Query.Language.Before ( Expr expr )

static

◆ BitAnd()

static Expr FaunaDB.Query.Language.BitAnd ( params Expr[] terms )

static

Creates a new BitAnd expression.

See the FaunaDB BitAnd Function

◆ BitNot()

static Expr FaunaDB.Query.Language.BitNot ( Expr expr )

static

Creates a new BitNot expression.

See the FaunaDB BitNot Function

◆ BitOr()

static Expr FaunaDB.Query.Language.BitOr ( params Expr[] terms )

static

Creates a new BitOr expression.

See the FaunaDB BitOr Function

◆ BitXor()

static Expr FaunaDB.Query.Language.BitXor ( params Expr[] terms )

static

Creates a new BitXor expression.

See the FaunaDB BitXor Function

◆ Bytes()

static Expr FaunaDB.Query.Language.Bytes ( params byte[] bytes )

static

Creates a new Bytes value

◆ Call()

static Expr FaunaDB.Query.Language.Call	(	Expr @	ref,
		params Expr[]	arguments
	)

static

Creates a new Call expression.

See the FaunaDB Basic Forms

.

◆ Casefold() [1/2]

static Expr FaunaDB.Query.Language.Casefold	(	Expr @	string,
		Expr	normalizer = `null`
	)

static

Creates a new Casefold expression.

See the FaunaDB String Functions

◆ Casefold() [2/2]

static Expr FaunaDB.Query.Language.Casefold	(	Expr @	string,
		Normalizer	normalizer
	)

static

Creates a new Casefold expression.

See the FaunaDB String Functions

◆ Ceil()

static Expr FaunaDB.Query.Language.Ceil ( Expr expr )

static

Creates a new Ceil expression.

See the FaunaDB Ceil Function

◆ Class()

static Expr FaunaDB.Query.Language.Class	(	Expr	class_name,
		Expr	scope = `null`
	)

static

Creates a new Class expression.

See the FaunaDB Miscellaneous Functions

◆ Classes()

static Expr FaunaDB.Query.Language.Classes ( Expr scope = null )

static

Returns an internal reference to classes object. Useful to paginate over all classes of a given scope database.

See the FaunaDB Miscellaneous Functions

◆ Collection()

static Expr FaunaDB.Query.Language.Collection	(	Expr	coll_name,
		Expr	scope = `null`
	)

static

Creates a new Collection expression.

See the FaunaDB Miscellaneous Functions

◆ Collections()

static Expr FaunaDB.Query.Language.Collections ( Expr scope = null )

static

Returns an internal reference to collections object. Useful to paginate over all classes of a given scope database.

See the FaunaDB Collections

◆ Concat()

static Expr FaunaDB.Query.Language.Concat	(	Expr	strings,
		Expr	separator = `null`
	)

static

Creates a new Concat expression.

See the FaunaDB String Functions

◆ Contains() [1/2]

static Expr FaunaDB.Query.Language.Contains	(	Expr	path,
		Expr @	in
	)

static

Creates a new Contains expression.

See the FaunaDB Miscellaneous Functions

◆ Contains() [2/2]

static Expr FaunaDB.Query.Language.Contains	(	PathSelector	path,
		Expr @	in
	)

static

Creates a new Contains expression.

See the FaunaDB Miscellaneous Functions

◆ ContainsField()

static Expr FaunaDB.Query.Language.ContainsField	(	Expr	path,
		Expr @	in
	)

static

Creates a new ContainsField expression.

See the FaunaDB ConstainsField Function

◆ ContainsPath() [1/2]

static Expr FaunaDB.Query.Language.ContainsPath	(	Expr	expr,
		Expr @	in
	)

static

Creates a new ContainsPath expression.

See the FaunaDB ConstainsPath Function

◆ ContainsPath() [2/2]

static Expr FaunaDB.Query.Language.ContainsPath	(	PathSelector	path,
		Expr @	in
	)

static

Creates a new ContainsPath expression.

See the FaunaDB ConstainsPath Function

◆ ContainsStr()

static Expr FaunaDB.Query.Language.ContainsStr	(	Expr	value,
		Expr	search
	)

static

See the FaunaDB ContainsStr Function

◆ ContainsStrRegex()

static Expr FaunaDB.Query.Language.ContainsStrRegex	(	Expr	value,
		Expr	pattern
	)

static

See the FaunaDB ContainsStrRegex Function

◆ ContainsValue()

static Expr FaunaDB.Query.Language.ContainsValue	(	Expr	value,
		Expr @	in
	)

static

Creates a new ContainsValue expression.

See the FaunaDB ConstainsValue Function

◆ Cos()

static Expr FaunaDB.Query.Language.Cos ( Expr expr )

static

Creates a new Cos expression.

See the FaunaDB Cos Function

◆ Cosh()

static Expr FaunaDB.Query.Language.Cosh ( Expr expr )

static

Creates a new Cosh expression.

See the FaunaDB Cosh Function

◆ Count()

static Expr FaunaDB.Query.Language.Count ( Expr expr )

static

Returns the number of items that exist in the array or set

See the FaunaDB Count Function

◆ Create()

static Expr FaunaDB.Query.Language.Create	(	Expr	classRef,
		Expr @	params
	)

static

Creates a new Create expression.

See the FaunaDB Write Functions

.

◆ CreateAccessProvider()

static Expr FaunaDB.Query.Language.CreateAccessProvider ( Expr expr )

static

Creates a new CreateAccessProvider expression.

See the docs

.

◆ CreateClass()

static Expr FaunaDB.Query.Language.CreateClass ( Expr class_params )

static

Creates a new CreateClass expression.

See the FaunaDB Write Functions

.

◆ CreateCollection()

static Expr FaunaDB.Query.Language.CreateCollection ( Expr coll_params )

static

Creates a new CreateCollection expression.

See the FaunaDB Write Functions

.

◆ CreateDatabase()

static Expr FaunaDB.Query.Language.CreateDatabase ( Expr db_params )

static

Creates a new CreateDatabase expression.

See the FaunaDB Write Functions

.

◆ CreateFunction()

static Expr FaunaDB.Query.Language.CreateFunction ( Expr function_params )

static

Creates a new CreateFunction expression.

See the FaunaDB Write Functions

.

◆ CreateIndex()

static Expr FaunaDB.Query.Language.CreateIndex ( Expr index_params )

static

Creates a new CreateIndex expression.

See the FaunaDB Write Functions

.

◆ CreateKey()

static Expr FaunaDB.Query.Language.CreateKey ( Expr key_params )

static

Creates a new CreateKey expression.

See the FaunaDB Write Functions

.

◆ CreateRole()

static Expr FaunaDB.Query.Language.CreateRole ( Expr role_params )

static

Creates a new CreateRole expression.

See the FaunaDB Write Functions

.

◆ Credentials()

static Expr FaunaDB.Query.Language.Credentials ( Expr scope = null )

static

Returns an internal reference to credentials object. Useful to paginate over all credentials of a given scope database.

See the FaunaDB Miscellaneous Functions

◆ CurrentIdentity()

static Expr FaunaDB.Query.Language.CurrentIdentity ( )

static

Creates a new CurrentIdentity expression.

See the docs

.

◆ CurrentToken()

static Expr FaunaDB.Query.Language.CurrentToken ( )

static

Creates a new CurrentToken expression.

See the docs

.

◆ Database()

static Expr FaunaDB.Query.Language.Database	(	Expr	db_name,
		Expr	scope = `null`
	)

static

Creates a new Database expression.

See the FaunaDB Miscellaneous Functions

◆ Databases()

static Expr FaunaDB.Query.Language.Databases ( Expr scope = null )

static

Returns an internal reference to databases object. Useful to paginate over all databases of a given scope database.

See the FaunaDB Miscellaneous Functions

◆ Date()

static Expr FaunaDB.Query.Language.Date ( Expr date )

static

Creates a new Date expression.

See the FaunaDB Time and Date Functions

◆ DayOfMonth()

static Expr FaunaDB.Query.Language.DayOfMonth ( Expr expr )

static

Returns a time expression's day of the month, from 1 to 31.

◆ DayOfWeek()

static Expr FaunaDB.Query.Language.DayOfWeek ( Expr expr )

static

Returns a time expression's day of the week following ISO-8601 convention, from 1 (Monday) to 7 (Sunday).

◆ DayOfYear()

static Expr FaunaDB.Query.Language.DayOfYear ( Expr expr )

static

Returns a time expression's day of the year, from 1 to 365, or 366 in a leap year.

◆ Degrees()

static Expr FaunaDB.Query.Language.Degrees ( Expr expr )

static

Creates a new Degrees expression.

See the FaunaDB Degrees Function

◆ Delete()

static Expr FaunaDB.Query.Language.Delete ( Expr @ ref )

static

Creates a new Delete expression.

See the FaunaDB Write Functions

.

◆ Difference()

static Expr FaunaDB.Query.Language.Difference ( params Expr[] values )

static

Creates a new Difference expression.

See the FaunaDB Set Functions

◆ Distinct()

static Expr FaunaDB.Query.Language.Distinct ( Expr set )

static

Creates a new Distinct expression.

See the FaunaDB Set Functions

◆ Divide()

static Expr FaunaDB.Query.Language.Divide ( params Expr[] values )

static

Creates a new Divide expression.

See the FaunaDB Miscellaneous Functions

◆ Do()

static Expr FaunaDB.Query.Language.Do ( params Expr[] expressions )

static

Creates a new Do expression containing the provided expressions.

See the FaunaDB Basic Forms

.

◆ Documents()

static Expr FaunaDB.Query.Language.Documents ( Expr collection )

static

See the FaunaDB Documents Function

◆ Drop()

static Expr FaunaDB.Query.Language.Drop	(	Expr	number,
		Expr	collection
	)

static

Creates a new Drop expression.

FaunaDB Collection Functions

Parameters

number	Number of elements to drop from the head of collection
collection	A collection expression

var result = await client.Query(Drop(2, Arr(1, 2, 3)));
 
Assert.AreEqual(Arr(3), result);

◆ Dt() [1/2]

static Expr FaunaDB.Query.Language.Dt ( DateTime dateTime )

static

Creates a new Date value.

See the FaunaDB Values

◆ Dt() [2/2]

static Expr FaunaDB.Query.Language.Dt ( string iso8601Date )

static

Creates a new Date value.

See the FaunaDB Values

◆ EndsWith()

static Expr FaunaDB.Query.Language.EndsWith	(	Expr	value,
		Expr	search
	)

static

See the FaunaDB EndsWith Function

◆ Epoch() [1/2]

static Expr FaunaDB.Query.Language.Epoch	(	Expr	number,
		Expr	unit
	)

static

Creates a new Epoch expression.

See the FaunaDB Time and Date Functions

◆ Epoch() [2/2]

static Expr FaunaDB.Query.Language.Epoch	(	Expr	number,
		TimeUnit	unit
	)

static

Creates a new Epoch expression.

See the FaunaDB Time and Date Functions

◆ EqualsFn()

static Expr FaunaDB.Query.Language.EqualsFn ( params Expr[] values )

static

Creates a new Equals expression.

See the FaunaDB Miscellaneous Functions

◆ Events()

static Expr FaunaDB.Query.Language.Events ( Expr refSet )

static

Creates a new Events expression.

See the FaunaDB Set Functions

◆ Exists()

static Expr FaunaDB.Query.Language.Exists	(	Expr @	ref,
		Expr	ts = `null`
	)

static

Creates a new Exists expression.

See the FaunaDB Read Functions

◆ Exp()

static Expr FaunaDB.Query.Language.Exp ( Expr expr )

static

Creates a new Exp expression.

See the FaunaDB Exp Function

◆ Filter() [1/7]

static Expr FaunaDB.Query.Language.Filter	(	Expr	collection,
		Expr	lambda
	)

static

Creates a new Filter expression.

FaunaDB Collection Functions

This is the raw version. Usually it's easier to use the overload.

See Filter(Expr, System.Func<Expr, Expr>), Filter(Expr, System.Func<Expr, Expr, Expr>), Filter(Expr, System.Func<Expr, Expr, Expr, Expr>), Filter(Expr, System.Func<Expr, Expr, Expr, Expr, Expr>), Filter(Expr, System.Func<Expr, Expr, Expr, Expr, Expr, Expr>), Filter(Expr, System.Func<Expr, Expr, Expr, Expr, Expr, Expr, Expr>)

Parameters

collection	A collection expression
lambda	Lambda expression created by Lambda(Expr, Expr). It must return a boolean value.

var result = await client.Query(Filter(Arr(1, 2, 3, 4), Lambda("i", GT(Var("i"), 2))));
 
Assert.AreEqual(Arr(3, 4), result);

◆ Filter() [2/7]

static Expr FaunaDB.Query.Language.Filter	(	Expr	collection,
		Func< Expr, Expr >	lambda
	)

static

Creates a new Filter expression with a lambda function that receives one argument.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives one argument

◆ Filter() [3/7]

static Expr FaunaDB.Query.Language.Filter	(	Expr	collection,
		Func< Expr, Expr, Expr >	lambda
	)

static

Creates a new Filter expression with a lambda function that receives two arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives two arguments

◆ Filter() [4/7]

static Expr FaunaDB.Query.Language.Filter	(	Expr	collection,
		Func< Expr, Expr, Expr, Expr >	lambda
	)

static

Creates a new Filter expression with a lambda function that receives three arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives three arguments

◆ Filter() [5/7]

static Expr FaunaDB.Query.Language.Filter	(	Expr	collection,
		Func< Expr, Expr, Expr, Expr, Expr >	lambda
	)

static

Creates a new Filter expression with a lambda function that receives four arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives four arguments

◆ Filter() [6/7]

static Expr FaunaDB.Query.Language.Filter	(	Expr	collection,
		Func< Expr, Expr, Expr, Expr, Expr, Expr >	lambda
	)

static

Creates a new Filter expression with a lambda function that receives five arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives five arguments

◆ Filter() [7/7]

static Expr FaunaDB.Query.Language.Filter	(	Expr	collection,
		Func< Expr, Expr, Expr, Expr, Expr, Expr, Expr >	lambda
	)

static

Creates a new Filter expression with a lambda function that receives six arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives six arguments

◆ FindStr()

static Expr FaunaDB.Query.Language.FindStr	(	Expr	expr,
		Expr	find,
		Expr	start = `null`
	)

static

Returns the offset position of a string in another string.

See the FaunaDB FindStr Function

◆ FindStrRegex()

static Expr FaunaDB.Query.Language.FindStrRegex	(	Expr	expr,
		Expr	pattern,
		Expr	start = `null`,
		Expr	numResults = `null`
	)

static

Returns an array of up to 1024 objects describing where the pattern is found in the search string.

See the FaunaDB FindStrRegex Function

◆ Floor()

static Expr FaunaDB.Query.Language.Floor ( Expr expr )

static

Creates a new Floor expression.

See the FaunaDB Floor Function

◆ Foreach() [1/7]

static Expr FaunaDB.Query.Language.Foreach	(	Expr	collection,
		Expr	lambda
	)

static

Creates a new Foreach expression.

FaunaDB Collection Functions

See Foreach(Expr, System.Func<Expr, Expr>), Foreach(Expr, System.Func<Expr, Expr, Expr>), Foreach(Expr, System.Func<Expr, Expr, Expr, Expr>), Foreach(Expr, System.Func<Expr, Expr, Expr, Expr, Expr>), Foreach(Expr, System.Func<Expr, Expr, Expr, Expr, Expr, Expr>), Foreach(Expr, System.Func<Expr, Expr, Expr, Expr, Expr, Expr, Expr>)

This is the raw version. Usually it's easier to use the overload.

Parameters

collection	A collection expression
lambda	Lambda expression created by Lambda(Expr, Expr)

◆ Foreach() [2/7]

static Expr FaunaDB.Query.Language.Foreach	(	Expr	collection,
		Func< Expr, Expr >	lambda
	)

static

Creates a new Foreach expression with a lambda function that receives one argument.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives one argument

◆ Foreach() [3/7]

static Expr FaunaDB.Query.Language.Foreach	(	Expr	collection,
		Func< Expr, Expr, Expr >	lambda
	)

static

Creates a new Foreach expression with a lambda function that receives two arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives two arguments

◆ Foreach() [4/7]

static Expr FaunaDB.Query.Language.Foreach	(	Expr	collection,
		Func< Expr, Expr, Expr, Expr >	lambda
	)

static

Creates a new Foreach expression with a lambda function that receives three arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives three arguments

◆ Foreach() [5/7]

static Expr FaunaDB.Query.Language.Foreach	(	Expr	collection,
		Func< Expr, Expr, Expr, Expr, Expr >	lambda
	)

static

Creates a new Foreach expression with a lambda function that receives four arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives four arguments

◆ Foreach() [6/7]

static Expr FaunaDB.Query.Language.Foreach	(	Expr	collection,
		Func< Expr, Expr, Expr, Expr, Expr, Expr >	lambda
	)

static

Creates a new Foreach expression with a lambda function that receives five arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives five arguments

◆ Foreach() [7/7]

static Expr FaunaDB.Query.Language.Foreach	(	Expr	collection,
		Func< Expr, Expr, Expr, Expr, Expr, Expr, Expr >	lambda
	)

static

Creates a new Foreach expression with a lambda function that receives six arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives six arguments

◆ Format()

static Expr FaunaDB.Query.Language.Format	(	Expr	format,
		params Expr[]	values
	)

static

Format values into string.

See the FaunaDB Format Function

◆ Function()

static Expr FaunaDB.Query.Language.Function	(	Expr	function_name,
		Expr	scope = `null`
	)

static

Creates a new Function expression.

See the FaunaDB Miscellaneous Functions

◆ Functions()

static Expr FaunaDB.Query.Language.Functions ( Expr scope = null )

static

Returns an internal reference to functions object. Useful to paginate over all functions of a given scope database.

See the FaunaDB Miscellaneous Functions

◆ Get()

static Expr FaunaDB.Query.Language.Get	(	Expr @	ref,
		Expr	ts = `null`
	)

static

Creates a new Get expression.

See the FaunaDB Read Functions

◆ GT()

static Expr FaunaDB.Query.Language.GT ( params Expr[] values )

static

Creates a new GT expression.

See the FaunaDB Miscellaneous Functions

◆ GTE()

static Expr FaunaDB.Query.Language.GTE ( params Expr[] values )

static

Creates a new GTE expression.

See the FaunaDB Miscellaneous Functions

◆ HasCurrentIdentity()

static Expr FaunaDB.Query.Language.HasCurrentIdentity ( )

static

Creates a new HasCurrentIdentity expression.

See the docs

.

◆ HasCurrentToken()

static Expr FaunaDB.Query.Language.HasCurrentToken ( )

static

Creates a new HasCurrentToken expression.

See the docs

.

◆ HasIdentity()

static Expr FaunaDB.Query.Language.HasIdentity ( )

static

Creates a new HasIdentity expression.

See the docs

.

◆ Hour()

static Expr FaunaDB.Query.Language.Hour ( Expr expr )

static

Returns a time expression's hour of the day, from 0 to 23.

◆ Hypot()

static Expr FaunaDB.Query.Language.Hypot	(	Expr	value,
		Expr	exp = `null`
	)

static

Creates a new Hypot expression.

See the FaunaDB Hypot Function

◆ Identify()

static Expr FaunaDB.Query.Language.Identify	(	Expr @	ref,
		Expr	password
	)

static

Creates a new Identify expression.

See the docs

.

Parameters

ref	Reference to the object
password	Password to be validated

◆ Identity()

static Expr FaunaDB.Query.Language.Identity ( )

static

Creates a new Identity expression.

See the docs

.

◆ If()

static Expr FaunaDB.Query.Language.If	(	Expr @	if,
		Expr @	then,
		Expr @	else
	)

static

Creates a new If expression.

See the FaunaDB Basic Forms

.

◆ Index()

static Expr FaunaDB.Query.Language.Index	(	Expr	index_name,
		Expr	scope = `null`
	)

static

Creates a new Index expression.

See the FaunaDB Miscellaneous Functions

◆ Indexes()

static Expr FaunaDB.Query.Language.Indexes ( Expr scope = null )

static

Returns an internal reference to indexes object. Useful to paginate over all indexes of a given scope database.

See the FaunaDB Miscellaneous Functions

◆ Insert() [1/2]

static Expr FaunaDB.Query.Language.Insert	(	Expr @	ref,
		Expr	ts,
		ActionType	action,
		Expr @	params
	)

static

Creates a new Insert expression.

See the FaunaDB Write Functions

.

◆ Insert() [2/2]

static Expr FaunaDB.Query.Language.Insert	(	Expr @	ref,
		Expr	ts,
		Expr	action,
		Expr @	params
	)

static

Creates a new Insert expression.

See the FaunaDB Write Functions

.

◆ Intersection()

static Expr FaunaDB.Query.Language.Intersection ( params Expr[] values )

static

Creates a new Intersection expression.

See the FaunaDB Set Functions

◆ IsArray()

static Expr FaunaDB.Query.Language.IsArray ( Expr expr )

static

Check if the expression is an array.

See the IsArray

.

◆ IsBoolean()

static Expr FaunaDB.Query.Language.IsBoolean ( Expr expr )

static

Check if the expression is a boolean.

See the IsBoolean

.

◆ IsBytes()

static Expr FaunaDB.Query.Language.IsBytes ( Expr expr )

static

Check if the expression is a byte array.

See the IsBytes

.

◆ IsCollection()

static Expr FaunaDB.Query.Language.IsCollection ( Expr expr )

static

Check if the expression is a collection.

See the IsCollection

.

◆ IsCredentials()

static Expr FaunaDB.Query.Language.IsCredentials ( Expr expr )

static

Check if the expression is a credentials.

See the IsCredentials

.

◆ IsDatabase()

static Expr FaunaDB.Query.Language.IsDatabase ( Expr expr )

static

Check if the expression is a database.

See the IsDatabase

.

◆ IsDate()

static Expr FaunaDB.Query.Language.IsDate ( Expr expr )

static

Check if the expression is a date.

See the IsDate

.

◆ IsDoc()

static Expr FaunaDB.Query.Language.IsDoc ( Expr expr )

static

Check if the expression is a document (either a reference or an instance).

See the IsDoc

.

◆ IsDouble()

static Expr FaunaDB.Query.Language.IsDouble ( Expr expr )

static

Check if the expression is a double.

See the IsDouble

.

◆ IsEmpty()

static Expr FaunaDB.Query.Language.IsEmpty ( Expr collection )

static

Creates a new IsEmpty expression.

FaunaDB Collection Functions

Parameters

collection A collection expression

var result = await client.Query(IsEmpty(Arr(4, 5, 6)));
 
Assert.AreEqual(false, result.To<bool>().Value);

◆ IsFunction()

static Expr FaunaDB.Query.Language.IsFunction ( Expr expr )

static

Check if the expression is a function.

See the IsFunction

.

◆ IsIndex()

static Expr FaunaDB.Query.Language.IsIndex ( Expr expr )

static

Check if the expression is an index.

See the IsIndex

.

◆ IsInteger()

static Expr FaunaDB.Query.Language.IsInteger ( Expr expr )

static

Check if the expression is an integer.

See the IsInteger

.

◆ IsKey()

static Expr FaunaDB.Query.Language.IsKey ( Expr expr )

static

Check if the expression is a key.

See the IsKey

.

◆ IsLambda()

static Expr FaunaDB.Query.Language.IsLambda ( Expr expr )

static

Check if the expression is a lambda.

See the IsLambda

.

◆ IsNonEmpty()

static Expr FaunaDB.Query.Language.IsNonEmpty ( Expr collection )

static

Creates a new IsNonEmpty expression.

FaunaDB Collection Functions

Parameters

collection A collection expression

var result = await client.Query(IsNonEmpty(Arr(4, 5, 6)));
 
Assert.AreEqual(true, result.To<bool>().Value);

◆ IsNull()

static Expr FaunaDB.Query.Language.IsNull ( Expr expr )

static

Check if the expression is null.

See the IsNull

.

◆ IsNumber()

static Expr FaunaDB.Query.Language.IsNumber ( Expr expr )

static

Check if the expression is a number.

See the IsNumber

.

◆ IsObject()

static Expr FaunaDB.Query.Language.IsObject ( Expr expr )

static

Check if the expression is an object.

See the IsObject

.

◆ IsRef()

static Expr FaunaDB.Query.Language.IsRef ( Expr expr )

static

Check if the expression is a reference.

See the IsRef

.

◆ IsRole()

static Expr FaunaDB.Query.Language.IsRole ( Expr expr )

static

Check if the expression is a role.

See the IsRole

.

◆ IsSet()

static Expr FaunaDB.Query.Language.IsSet ( Expr expr )

static

Check if the expression is a set.

See the IsSet

.

◆ IsString()

static Expr FaunaDB.Query.Language.IsString ( Expr expr )

static

Check if the expression is a string.

See the IsString

.

◆ IsTimestamp()

static Expr FaunaDB.Query.Language.IsTimestamp ( Expr expr )

static

Check if the expression is a timestamp.

See the IsTimestamp

.

◆ IsToken()

static Expr FaunaDB.Query.Language.IsToken ( Expr expr )

static

Check if the expression is a token.

See the IsToken

.

◆ Join() [1/7]

static Expr FaunaDB.Query.Language.Join	(	Expr	source,
		Expr	target
	)

static

Creates a new Join expression.

See the FaunaDB Set Functions

This is the raw version. Usually it's easier to use the overload.

Parameters

source	A set resulting from one of the Set Functions
target	Can be either an index reference or a lambda function

◆ Join() [2/7]

static Expr FaunaDB.Query.Language.Join	(	Expr	source,
		Func< Expr, Expr >	target
	)

static

Creates a new Join expression.

See the FaunaDB Set Functions

◆ Join() [3/7]

static Expr FaunaDB.Query.Language.Join	(	Expr	source,
		Func< Expr, Expr, Expr >	target
	)

static

Creates a new Join expression.

See the FaunaDB Set Functions

◆ Join() [4/7]

static Expr FaunaDB.Query.Language.Join	(	Expr	source,
		Func< Expr, Expr, Expr, Expr >	target
	)

static

Creates a new Join expression.

See the FaunaDB Set Functions

◆ Join() [5/7]

static Expr FaunaDB.Query.Language.Join	(	Expr	source,
		Func< Expr, Expr, Expr, Expr, Expr >	target
	)

static

Creates a new Join expression.

See the FaunaDB Set Functions

◆ Join() [6/7]

static Expr FaunaDB.Query.Language.Join	(	Expr	source,
		Func< Expr, Expr, Expr, Expr, Expr, Expr >	target
	)

static

Creates a new Join expression.

See the FaunaDB Set Functions

◆ Join() [7/7]

static Expr FaunaDB.Query.Language.Join	(	Expr	source,
		Func< Expr, Expr, Expr, Expr, Expr, Expr, Expr >	target
	)

static

Creates a new Join expression.

See the FaunaDB Set Functions

◆ KeyFromSecret()

static Expr FaunaDB.Query.Language.KeyFromSecret ( Expr secret )

static

Creates a new KeyFromSecret expression.

See the FaunaDB Read Functions

◆ Keys()

static Expr FaunaDB.Query.Language.Keys ( Expr scope = null )

static

Returns an internal reference to keys object. Useful to paginate over all keys of a given scope database.

See the FaunaDB Miscellaneous Functions

◆ Lambda() [1/7]

static Expr FaunaDB.Query.Language.Lambda	(	Expr	vars,
		Expr	expr
	)

static

Creates a new Lambda expression.

This is the raw version. Usually it's easier to use the overload.

See Lambda(System.Func<Expr, Expr>), Lambda(System.Func<Expr, Expr, Expr>), Lambda(System.Func<Expr, Expr, Expr, Expr>), Lambda(System.Func<Expr, Expr, Expr, Expr, Expr>), Lambda(System.Func<Expr, Expr, Expr, Expr, Expr, Expr>), Lambda(System.Func<Expr, Expr, Expr, Expr, Expr, Expr, Expr>)

See the FaunaDB Basic Forms

.

Parameters

vars	Variable names. Can be a single string or an array of strings
expr	Any composed expression created by Language

var lambda1 = Lambda("a", Add(Var("a"), 1);

var lambda2 = Lambda(Arr("a", "b"), Add(Var("a"), Var("b"));

FaunaDB.Query.Language.Add

static Expr Add(params Expr[] values)

Creates a new Add expression.

◆ Lambda() [2/7]

static Expr FaunaDB.Query.Language.Lambda ( Func< Expr, Expr > lambda )

static

Creates a lambda expression that receives one argument.

See the FaunaDB Basic Forms

.

var lambda = Lambda(a => a);

is equivalent to

var lambda = Lambda("a", Var("a"));

Definition at line 23 of file Language.Basic.Lambda.cs.

◆ Lambda() [3/7]

static Expr FaunaDB.Query.Language.Lambda ( Func< Expr, Expr, Expr > lambda )

static

Creates a lambda expression that receives two arguments.

See the FaunaDB Basic Forms

.

var lambda = Lambda((a, b) => Add(a, b));

is equivalent to

var lambda = Lambda(Arr("a", "b"), Add(Var("a"), Var("b")));

Definition at line 46 of file Language.Basic.Lambda.cs.

◆ Lambda() [4/7]

static Expr FaunaDB.Query.Language.Lambda ( Func< Expr, Expr, Expr, Expr > lambda )

static

Creates a lambda expression that receives three arguments.

See the FaunaDB Basic Forms

.

var lambda = Lambda((a, b, c) => Add(a, b, c));

is equivalent to

var lambda = Lambda(Arr("a", "b", "c"), Add(Var("a"), Var("b"), Var("c")));

Definition at line 72 of file Language.Basic.Lambda.cs.

◆ Lambda() [5/7]

static Expr FaunaDB.Query.Language.Lambda ( Func< Expr, Expr, Expr, Expr, Expr > lambda )

static

Creates a lambda expression that receives four arguments.

See the FaunaDB Basic Forms

.

var lambda = Lambda((a, b, c, d) => Add(a, b, c, d));

is equivalent to

var lambda = Lambda(Arr("a", "b", "c", "d"), Add(Var("a"), Var("b"), Var("c"), Var("d")));

Definition at line 99 of file Language.Basic.Lambda.cs.

◆ Lambda() [6/7]

static Expr FaunaDB.Query.Language.Lambda ( Func< Expr, Expr, Expr, Expr, Expr, Expr > lambda )

static

Creates a lambda expression that receives five arguments.

See the FaunaDB Basic Forms

.

var lambda = Lambda((a, b, c, d, e) => Add(a, b, c, d, e));

is equivalent to

var lambda = Lambda(Arr("a", "b", "c", "d", "e"), Add(Var("a"), Var("b"), Var("c"), Var("d"), Var("e")));

Definition at line 127 of file Language.Basic.Lambda.cs.

◆ Lambda() [7/7]

static Expr FaunaDB.Query.Language.Lambda ( Func< Expr, Expr, Expr, Expr, Expr, Expr, Expr > lambda )

static

Creates a lambda expression that receives six arguments.

See the FaunaDB Basic Forms

.

var lambda = Lambda((a, b, c, d, e, f) => Add(a, b, c, d, e, f));

is equivalent to

var lambda = Lambda(Arr("a", "b", "c", "d", "f"), Add(Var("a"), Var("b"), Var("c"), Var("d"), Var("f")));

Definition at line 156 of file Language.Basic.Lambda.cs.

◆ Length()

static Expr FaunaDB.Query.Language.Length ( Expr expr )

static

Returns the number of code points in the string.

See the FaunaDB Length Function

◆ Let() [1/7]

static Expr FaunaDB.Query.Language.Let	(	IReadOnlyDictionary< string, Expr >	vars,
		Expr @	in
	)

static

Creates a new Let expression wrapping the provided map of bindings.

See the FaunaDB Let Function

.

◆ Let() [2/7]

static LetBinding FaunaDB.Query.Language.Let	(	string	k0,
		Expr	v0
	)

static

Creates a new Let expression with the provided bindings.

See the FaunaDB Basic Forms

.

Parameters

k0	First variable name
v0	First variable value

◆ Let() [3/7]

static LetBinding FaunaDB.Query.Language.Let	(	string	k0,
		Expr	v0,
		string	k1,
		Expr	v1
	)

static

Creates a new Let expression with the provided bindings.

See the FaunaDB Basic Forms

.

Parameters

k0	First variable name
v0	First variable value
k1	Second variable name
v1	Second variable value

◆ Let() [4/7]

static LetBinding FaunaDB.Query.Language.Let	(	string	k0,
		Expr	v0,
		string	k1,
		Expr	v1,
		string	k2,
		Expr	v2
	)

static

Creates a new Let expression with the provided bindings.

See the FaunaDB Basic Forms

.

Parameters

k0	First variable name
v0	First variable value
k1	Second variable name
v1	Second variable value
k2	Third variable name
v2	Third variable value

◆ Let() [5/7]

static LetBinding FaunaDB.Query.Language.Let	(	string	k0,
		Expr	v0,
		string	k1,
		Expr	v1,
		string	k2,
		Expr	v2,
		string	k3,
		Expr	v3
	)

static

Creates a new Let expression with the provided bindings.

See the FaunaDB Basic Forms

.

Parameters

k0	First variable name
v0	First variable value
k1	Second variable name
v1	Second variable value
k2	Third variable name
v2	Third variable value
k3	Fourth variable name
v3	Fourth variable value

◆ Let() [6/7]

static LetBinding FaunaDB.Query.Language.Let	(	string	k0,
		Expr	v0,
		string	k1,
		Expr	v1,
		string	k2,
		Expr	v2,
		string	k3,
		Expr	v3,
		string	k4,
		Expr	v4
	)

static

Creates a new Let expression with the provided bindings.

See the FaunaDB Basic Forms

.

Parameters

k0	First variable name
v0	First variable value
k1	Second variable name
v1	Second variable value
k2	Third variable name
v2	Third variable value
k3	Fourth variable name
v3	Fourth variable value
k4	Fifth variable name
v4	Fifth variable value

◆ Let() [7/7]

static LetBinding FaunaDB.Query.Language.Let	(	string	k0,
		Expr	v0,
		string	k1,
		Expr	v1,
		string	k2,
		Expr	v2,
		string	k3,
		Expr	v3,
		string	k4,
		Expr	v4,
		string	k5,
		Expr	v5
	)

static

Creates a new Let expression with the provided bindings.

See the FaunaDB Basic Forms

.

Parameters

k0	First variable name
v0	First variable value
k1	Second variable name
v1	Second variable value
k2	Third variable name
v2	Third variable value
k3	Fourth variable name
v3	Fourth variable value
k4	Fifth variable name
v4	Fifth variable value
k5	Sixth variable name
v5	Sixth variable value

◆ Ln()

static Expr FaunaDB.Query.Language.Ln ( Expr expr )

static

Creates a new Ln expression.

See the FaunaDB Ln Function

◆ Log()

static Expr FaunaDB.Query.Language.Log ( Expr expr )

static

Creates a new Log expression.

See the FaunaDB Log Function

◆ Login()

static Expr FaunaDB.Query.Language.Login	(	Expr @	ref,
		Expr @	params
	)

static

Creates a new Login expression.

See the docs

.

◆ Logout() [1/2]

static Expr FaunaDB.Query.Language.Logout ( bool deleteTokens )

static

Creates a new Logout expression.

See the docs

.

Parameters

deleteTokens True will delete all tokens associated with the current session. False will delete only the token used in this request

◆ Logout() [2/2]

static Expr FaunaDB.Query.Language.Logout ( Expr deleteTokens )

static

Creates a new Logout expression.

See the docs

.

Parameters

deleteTokens Expr object where, True will delete all tokens associated with the current session. False will delete only the token used in this request

◆ LowerCase()

static Expr FaunaDB.Query.Language.LowerCase ( Expr expr )

static

Returns a string in which all uppercase characters have been replaced by their corresponding lowercase characters.

See the FaunaDB LowerCase Function

◆ LT()

static Expr FaunaDB.Query.Language.LT ( params Expr[] values )

static

Creates a new LT expression.

See the FaunaDB Miscellaneous Functions

◆ LTE()

static Expr FaunaDB.Query.Language.LTE ( params Expr[] values )

static

Creates a new LTE expression.

See the FaunaDB Miscellaneous Functions

◆ LTrim()

static Expr FaunaDB.Query.Language.LTrim ( Expr expr )

static

Removes all white spaces, tabs, and new lines from the beginning of a string.

See the FaunaDB Ltrim Function

◆ Map() [1/7]

static Expr FaunaDB.Query.Language.Map	(	Expr	collection,
		Expr	lambda
	)

static

Creates a new Map expression.

FaunaDB Collection Functions

This is the raw version. Usually it's easier to use the overload.

See Map(Expr, System.Func<Expr, Expr>), Map(Expr, System.Func<Expr, Expr, Expr>), Map(Expr, System.Func<Expr, Expr, Expr, Expr>), Map(Expr, System.Func<Expr, Expr, Expr, Expr, Expr>), Map(Expr, System.Func<Expr, Expr, Expr, Expr, Expr, Expr>), Map(Expr, System.Func<Expr, Expr, Expr, Expr, Expr, Expr, Expr>)

Parameters

collection	A collection expression
lambda	Lambda expression created by Lambda(Expr, Expr)

var result = await client.Query(Arr(1, 2, 3), Lambda("i", Multiply(Var("i"), 2)));
 
Assert.AreEqual(Arr(2, 4, 6), result);

◆ Map() [2/7]

static Expr FaunaDB.Query.Language.Map	(	Expr	collection,
		Func< Expr, Expr >	lambda
	)

static

Creates a new Map expression with a lambda function that receives one argument.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives one argument

◆ Map() [3/7]

static Expr FaunaDB.Query.Language.Map	(	Expr	collection,
		Func< Expr, Expr, Expr >	lambda
	)

static

Creates a new Map expression with a lambda function that receives two arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives two arguments

◆ Map() [4/7]

static Expr FaunaDB.Query.Language.Map	(	Expr	collection,
		Func< Expr, Expr, Expr, Expr >	lambda
	)

static

Creates a new Map expression with a lambda function that receives three arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives three arguments

◆ Map() [5/7]

static Expr FaunaDB.Query.Language.Map	(	Expr	collection,
		Func< Expr, Expr, Expr, Expr, Expr >	lambda
	)

static

Creates a new Map expression with a lambda function that receives four arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives four arguments

◆ Map() [6/7]

static Expr FaunaDB.Query.Language.Map	(	Expr	collection,
		Func< Expr, Expr, Expr, Expr, Expr, Expr >	lambda
	)

static

Creates a new Map expression with a lambda function that receives five arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives five arguments

◆ Map() [7/7]

static Expr FaunaDB.Query.Language.Map	(	Expr	collection,
		Func< Expr, Expr, Expr, Expr, Expr, Expr, Expr >	lambda
	)

static

Creates a new Map expression with a lambda function that receives six arguments.

FaunaDB Collection Functions

Parameters

collection	A collection expression
lambda	A lambda function that receives six arguments

◆ Match()

static Expr FaunaDB.Query.Language.Match	(	Expr	index,
		params Expr[]	terms
	)

static

Creates a new Match expression.

See the FaunaDB Set Functions

◆ Max()

static Expr FaunaDB.Query.Language.Max ( params Expr[] terms )

static

Creates a new Max expression.

See the FaunaDB Max Function

◆ Mean()

static Expr FaunaDB.Query.Language.Mean ( Expr expr )

static

Returns the average value of the items.

See the FaunaDB Mean Function

◆ Merge() [1/3]

static Expr FaunaDB.Query.Language.Merge	(	Expr	merge,
		Expr	with
	)

static

Merges two or more objects

◆ Merge() [2/3]

static Expr FaunaDB.Query.Language.Merge	(	Expr	merge,
		Expr	with,
		Expr	lambda
	)

static

Merges two or more objects

◆ Merge() [3/3]

static Expr FaunaDB.Query.Language.Merge	(	Expr	merge,
		Expr	with,
		Func< Expr, Expr, Expr, Expr >	lambda
	)

static

Merges two or more objects

◆ Min()

static Expr FaunaDB.Query.Language.Min ( params Expr[] terms )

static

Creates a new Min expression.

See the FaunaDB Min Function

◆ Minute()

static Expr FaunaDB.Query.Language.Minute ( Expr expr )

static

Returns a time expression's minute of the hour, from 0 to 59.

◆ Modulo()

static Expr FaunaDB.Query.Language.Modulo ( params Expr[] values )

static

Creates a new Modulo expression.

See the FaunaDB Miscellaneous Functions

◆ Month()

static Expr FaunaDB.Query.Language.Month ( Expr expr )

static

Returns a time expression's month of the year, from 1 to 12.

◆ MoveDatabase()

static Expr FaunaDB.Query.Language.MoveDatabase	(	Expr	from,
		Expr	to
	)

static

Moves a database to a new hierarchy.

See the FaunaDB MoveDatabase Function

.

◆ Multiply()

static Expr FaunaDB.Query.Language.Multiply ( params Expr[] values )

static

Creates a new Multiply expression.

See the FaunaDB Miscellaneous Functions

◆ NewId()

static Expr FaunaDB.Query.Language.NewId ( )

static

Creates a new NewId expression.

See the FaunaDB Miscellaneous Functions

◆ NextId()

static Expr FaunaDB.Query.Language.NextId ( )

static

Creates a new NextId expression.

See the FaunaDB Miscellaneous Functions

◆ NGram()

static Expr FaunaDB.Query.Language.NGram	(	Expr	terms,
		Expr	min = `null`,
		Expr	max = `null`
	)

static

Creates a new NGram expression.

See the FaunaDB String Functions

◆ Not()

static Expr FaunaDB.Query.Language.Not ( Expr boolean )

static

Creates a new Not expression.

See the FaunaDB Miscellaneous Functions

◆ Now()

static Expr FaunaDB.Query.Language.Now ( )

static

Constructs a Timestamp representing the transaction’s start time.

See the FaunaDB Now Functions

◆ Null()

static Expr FaunaDB.Query.Language.Null ( )

static

Creates a null value.

See the FaunaDB Values

◆ Obj() [1/8]

static Expr FaunaDB.Query.Language.Obj ( )

static

Creates a new empty Object value.

See the FaunaDB Values

◆ Obj() [2/8]

static Expr FaunaDB.Query.Language.Obj ( IReadOnlyDictionary< string, Expr > fields )

static

Creates a new Object value wrapping the provided map.

See the FaunaDB Values

◆ Obj() [3/8]

static Expr FaunaDB.Query.Language.Obj	(	string	key1,
		Expr	value1
	)

static

Creates a new Object value with the provided entries.

See the FaunaDB Values

◆ Obj() [4/8]

static Expr FaunaDB.Query.Language.Obj	(	string	key1,
		Expr	value1,
		string	key2,
		Expr	value2
	)

static

Creates a new Object value with the provided entries.

See the FaunaDB Values

◆ Obj() [5/8]

static Expr FaunaDB.Query.Language.Obj	(	string	key1,
		Expr	value1,
		string	key2,
		Expr	value2,
		string	key3,
		Expr	value3
	)

static

Creates a new Object value with the provided entries.

See the FaunaDB Values

◆ Obj() [6/8]

static Expr FaunaDB.Query.Language.Obj	(	string	key1,
		Expr	value1,
		string	key2,
		Expr	value2,
		string	key3,
		Expr	value3,
		string	key4,
		Expr	value4
	)

static

Creates a new Object value with the provided entries.

See the FaunaDB Values

◆ Obj() [7/8]

static Expr FaunaDB.Query.Language.Obj	(	string	key1,
		Expr	value1,
		string	key2,
		Expr	value2,
		string	key3,
		Expr	value3,
		string	key4,
		Expr	value4,
		string	key5,
		Expr	value5
	)

static

Creates a new Object value with the provided entries.

See the FaunaDB Values

◆ Obj() [8/8]

static Expr FaunaDB.Query.Language.Obj	(	string	key1,
		Expr	value1,
		string	key2,
		Expr	value2,
		string	key3,
		Expr	value3,
		string	key4,
		Expr	value4,
		string	key5,
		Expr	value5,
		string	key6,
		Expr	value6
	)

static

Creates a new Object value with the provided entries.

See the FaunaDB Values

◆ Or()

static Expr FaunaDB.Query.Language.Or ( params Expr[] values )

static

Creates a new Or expression.

See the FaunaDB Miscellaneous Functions

◆ Paginate()

static Expr FaunaDB.Query.Language.Paginate	(	Expr	set,
		Expr	ts = `null`,
		Expr	after = `null`,
		Expr	before = `null`,
		Expr	size = `null`,
		Expr	events = `null`,
		Expr	sources = `null`,
		Cursor	cursor = `null`
	)

static

Creates a new Paginate expression.

See the FaunaDB Paginate Function

◆ Path() [1/3]

static PathSelector FaunaDB.Query.Language.Path ( params Expr[] expr )

static

Helper for constructing a PathSelector with the given expression.

See PathSelector

◆ Path() [2/3]

static PathSelector FaunaDB.Query.Language.Path ( params int[] segments )

static

Helper for constructing a PathSelector with the given path terms.

See PathSelector

◆ Path() [3/3]

static PathSelector FaunaDB.Query.Language.Path ( params string[] segments )

static

Helper for constructing a PathSelector with the given path terms.

See PathSelector

◆ Pow()

static Expr FaunaDB.Query.Language.Pow	(	Expr	value,
		Expr	exp = `null`
	)

static

Creates a new Pow expression.

See the FaunaDB Pow Function

◆ Prepend()

static Expr FaunaDB.Query.Language.Prepend	(	Expr	elements,
		Expr	collection
	)

static

Creates a new Prepend expression.

FaunaDB Collection Functions

Parameters

elements	Elements to be prepended into the collection
collection	A collection expression

var result = await client.Query(Prepend(Arr(1, 2, 3), Arr(4, 5, 6)));
 
Assert.AreEqual(Arr(1, 2, 3, 4, 5, 6), result);

◆ Query()

static Expr FaunaDB.Query.Language.Query ( Expr lambda )

static

Creates a new Query expression.

See the FaunaDB Basic Forms

.

◆ Radians()

static Expr FaunaDB.Query.Language.Radians ( Expr expr )

static

Creates a new Radians expression.

See the FaunaDB Radians Function

◆ Range()

static Expr FaunaDB.Query.Language.Range	(	Expr	set,
		Expr	from,
		Expr	to
	)

static

Filters the set based on the lower/upper bounds (inclusive).

See the FaunaDB Range Function

Parameters

set	set to be filtered
from	lower bound
to	upper bound

◆ RawCursor()

static Cursor FaunaDB.Query.Language.RawCursor ( Expr expr )

static

◆ Reduce() [1/2]

static Expr FaunaDB.Query.Language.Reduce	(	Expr	lambda,
		Expr	initial,
		Expr	collection
	)

static

Creates a new Exists expression.

See the FaunaDB Reduce Function

◆ Reduce() [2/2]

static Expr FaunaDB.Query.Language.Reduce	(	Func< Expr, Expr, Expr >	lambda,
		Expr	initial,
		Expr	collection
	)

static

Creates a new Exists expression.

See the FaunaDB Reduce Function

◆ Ref() [1/2]

static Expr FaunaDB.Query.Language.Ref	(	Expr	classRef,
		Expr	id
	)

static

Calls ref function to create a ref value.

See the FaunaDB Values

◆ Ref() [2/2]

static Expr FaunaDB.Query.Language.Ref ( string @ ref )

static

Creates a ref value from a string.

See the FaunaDB Values

◆ RegexEscape()

static Expr FaunaDB.Query.Language.RegexEscape ( Expr value )

static

See the FaunaDB RegexEscape Function

◆ Remove() [1/2]

static Expr FaunaDB.Query.Language.Remove	(	Expr @	ref,
		Expr	ts,
		ActionType	action
	)

static

Creates a new Remove expression.

See the FaunaDB Write Functions

.

◆ Remove() [2/2]

static Expr FaunaDB.Query.Language.Remove	(	Expr @	ref,
		Expr	ts,
		Expr	action
	)

static

Creates a new Remove expression.

See the FaunaDB Write Functions

.

◆ Repeat() [1/2]

static Expr FaunaDB.Query.Language.Repeat ( Expr expr )

static

Returns a string consisting of the value string repeated number times.

See the FaunaDB Repeat Function

◆ Repeat() [2/2]

static Expr FaunaDB.Query.Language.Repeat	(	Expr	expr,
		Expr	number
	)

static

Returns a string consisting of the value string repeated number times.

See the FaunaDB Repeat Function

◆ Replace()

static Expr FaunaDB.Query.Language.Replace	(	Expr @	ref,
		Expr @	params
	)

static

Creates a new Replace expression.

See the FaunaDB Write Functions

.

◆ ReplaceStr()

static Expr FaunaDB.Query.Language.ReplaceStr	(	Expr	expr,
		Expr	find,
		Expr	replace
	)

static

Replaces a string.

See the FaunaDB ReplaceStr Function

◆ ReplaceStrRegex()

static Expr FaunaDB.Query.Language.ReplaceStrRegex	(	Expr	expr,
		Expr	pattern,
		Expr	replace,
		Expr	first = `null`
	)

static

Replaces all the occurrences (or the first one) of find pattern substituted with replace string.

See the FaunaDB Length Function

◆ Reverse()

static Expr FaunaDB.Query.Language.Reverse ( Expr expr )

static

Creates a new Reverse expression.

FaunaDB Reverse Function

Parameters

expr	An expression

var result = await client.Query(Reverse(Arr(0, 1, 2, 3)));
 
Assert.AreEqual(new int[] { 3, 2, 1, 0 }, result.To<int[]>().Value);

◆ Role()

static Expr FaunaDB.Query.Language.Role	(	Expr	role_name,
		Expr	scope = `null`
	)

static

Creates a new Role expression.

See the FaunaDB Miscellaneous Functions

◆ Roles()

static Expr FaunaDB.Query.Language.Roles ( Expr scope = null )

static

Returns an internal reference to roles object. Useful to paginate over all roles of a given scope database.

See the FaunaDB Miscellaneous Functions

◆ Round()

static Expr FaunaDB.Query.Language.Round	(	Expr	expr,
		Expr	precision = `null`
	)

static

Creates a new Round expression.

See the FaunaDB Round Function

◆ RTrim()

static Expr FaunaDB.Query.Language.RTrim ( Expr expr )

static

Replaces a string inside.

See the FaunaDB RTrim Function

◆ Second()

static Expr FaunaDB.Query.Language.Second ( Expr expr )

static

Returns a time expression's second of the minute, from 0 to 59.

◆ Select() [1/2]

static Expr FaunaDB.Query.Language.Select	(	Expr	path,
		Expr @	from,
		Expr @	default = `null`
	)

static

Creates a new Select expression.

See the FaunaDB Miscellaneous Functions

◆ Select() [2/2]

static Expr FaunaDB.Query.Language.Select	(	PathSelector	path,
		Expr @	from,
		Expr @	default = `null`
	)

static

Creates a new Select expression.

See the FaunaDB Miscellaneous Functions

◆ SelectAll() [1/2]

static Expr FaunaDB.Query.Language.SelectAll	(	Expr	path,
		Expr @	from
	)

static

Creates a new SelectAll expression.

See the FaunaDB Miscellaneous Functions

◆ SelectAll() [2/2]

static Expr FaunaDB.Query.Language.SelectAll	(	PathSelector	path,
		Expr @	from
	)

static

Creates a new SelectAll expression.

See the FaunaDB Miscellaneous Functions

◆ Sign()

static Expr FaunaDB.Query.Language.Sign ( Expr expr )

static

Creates a new Sign expression.

See the FaunaDB Sign Function

◆ Sin()

static Expr FaunaDB.Query.Language.Sin ( Expr expr )

static

Creates a new Sin expression.

See the FaunaDB Sin Function

◆ Singleton()

static Expr FaunaDB.Query.Language.Singleton ( Expr @ ref )

static

Creates a new Singleton expression.

See the FaunaDB Set Functions

◆ Sinh()

static Expr FaunaDB.Query.Language.Sinh ( Expr expr )

static

Creates a new Sinh expression.

See the FaunaDB Sinh Function

◆ Space()

static Expr FaunaDB.Query.Language.Space ( Expr count )

static

Replaces a string inside.

See the FaunaDB Space Function

◆ Sqrt()

static Expr FaunaDB.Query.Language.Sqrt ( Expr expr )

static

Creates a new Sqrt expression.

See the FaunaDB Sqrt Function

◆ StartsWith()

static Expr FaunaDB.Query.Language.StartsWith	(	Expr	value,
		Expr	search
	)

static

See the FaunaDB StartsWith Function

◆ SubString()

static Expr FaunaDB.Query.Language.SubString	(	Expr	expr,
		Expr	start = `null`,
		Expr	length = `null`
	)

static

Returns a portion of the string.

See the FaunaDB SubString Function

◆ Subtract()

static Expr FaunaDB.Query.Language.Subtract ( params Expr[] values )

static

Creates a new Subtract expression.

See the FaunaDB Miscellaneous Functions

◆ Sum()

static Expr FaunaDB.Query.Language.Sum ( Expr expr )

static

Returns the sum of all items.

See the FaunaDB Sum Function

◆ Take()

static Expr FaunaDB.Query.Language.Take	(	Expr	number,
		Expr	collection
	)

static

Creates a new Take expression.

FaunaDB Collection Functions

Parameters

number	Number of elements to take from the head of collection
collection	A collection expression

var result = await client.Query(Take(2, Arr(1, 2, 3)));
 
Assert.AreEqual(Arr(1, 2), result);

◆ Tan()

static Expr FaunaDB.Query.Language.Tan ( Expr expr )

static

Creates a new Tan expression.

See the FaunaDB Tan Function

◆ Tanh()

static Expr FaunaDB.Query.Language.Tanh ( Expr expr )

static

Creates a new Tanh expression.

See the FaunaDB Tanh Function

◆ Time()

static Expr FaunaDB.Query.Language.Time ( Expr time )

static

Creates a new Time expression.

See the FaunaDB Time and Date Functions

◆ TimeAdd()

static Expr FaunaDB.Query.Language.TimeAdd	(	Expr	value,
		Expr	offset,
		Expr	unit
	)

static

Returns a new time or date with the offset in terms of the unit added.

See the TimeAdd

◆ TimeDiff()

static Expr FaunaDB.Query.Language.TimeDiff	(	Expr	start,
		Expr	finish,
		Expr	unit
	)

static

Returns the number of intervals in terms of the unit between two times or dates. Both start and finish must be of the same type.

See the TimeDiff

◆ TimeSubtract()

static Expr FaunaDB.Query.Language.TimeSubtract	(	Expr	value,
		Expr	offset,
		Expr	unit
	)

static

Returns a new time or date with the offset in terms of the unit subtracted.

See the TimeSubtract

◆ TitleCase()

static Expr FaunaDB.Query.Language.TitleCase ( Expr expr )

static

Returns a string which has the first letter of each word capitalized.

See the FaunaDB TitleCase Function

◆ ToArray()

static Expr FaunaDB.Query.Language.ToArray ( Expr expr )

static

Try to convert an object into an array of (field, value).

See the ToArray

◆ ToDate()

static Expr FaunaDB.Query.Language.ToDate ( Expr expr )

static

Converts an expression to a date literal.

◆ ToDouble()

static Expr FaunaDB.Query.Language.ToDouble ( Expr value )

static

Casts an expression to a double value, if possible.

See the ToDouble

◆ ToInteger()

static Expr FaunaDB.Query.Language.ToInteger ( Expr value )

static

Casts an expression to an integer value, if possible.

See the ToInteger

◆ Tokens()

static Expr FaunaDB.Query.Language.Tokens ( Expr scope = null )

static

Returns an internal reference to tokens object. Useful to paginate over all tokens of a given scope database.

See the FaunaDB Miscellaneous Functions

◆ ToMicros()

static Expr FaunaDB.Query.Language.ToMicros ( Expr expr )

static

Converts a time expression to microseconds since the UNIX epoch.

◆ ToMillis()

static Expr FaunaDB.Query.Language.ToMillis ( Expr expr )

static

Converts a time expression to milliseconds since the UNIX epoch.

◆ ToNumber()

static Expr FaunaDB.Query.Language.ToNumber ( Expr expr )

static

Converts an expression to a number literal.

◆ ToObject()

static Expr FaunaDB.Query.Language.ToObject ( Expr fields )

static

Try to convert an array of (field, value) into an object.

See the ToObject

◆ ToSeconds()

static Expr FaunaDB.Query.Language.ToSeconds ( Expr expr )

static

Converts a time expression to seconds since the UNIX epoch.

◆ ToStringExpr()

static Expr FaunaDB.Query.Language.ToStringExpr ( Expr expr )

static

Converts an expression to a string literal.

◆ ToTime()

static Expr FaunaDB.Query.Language.ToTime ( Expr expr )

static

Converts an expresion to a time literal.

◆ Trim()

static Expr FaunaDB.Query.Language.Trim ( Expr expr )

static

Returns a string which has both the leading and trailing white spaces, tabs, and new lines removed.

See the FaunaDB Trim Function

◆ Trunc()

static Expr FaunaDB.Query.Language.Trunc	(	Expr	expr,
		Expr	precision = `null`
	)

static

Creates a new Trunc expression.

See the FaunaDB Trunc Function

◆ Ts() [1/2]

static Expr FaunaDB.Query.Language.Ts ( DateTime dateTime )

static

Creates a new Timestamp value.

See the FaunaDB Values

◆ Ts() [2/2]

static Expr FaunaDB.Query.Language.Ts ( string iso8601Time )

static

Creates a new Timestamp value.

See the FaunaDB Values

◆ Union()

static Expr FaunaDB.Query.Language.Union ( params Expr[] values )

static

Creates a new Union expression.

See the FaunaDB Set Functions

◆ Update()

static Expr FaunaDB.Query.Language.Update	(	Expr @	ref,
		Expr @	params
	)

static

Creates a new Update expression.

See the FaunaDB Write Functions

.

◆ UpperCase()

static Expr FaunaDB.Query.Language.UpperCase ( Expr expr )

static

Returns a string which has all lowercase characters in the string replaced by their corresponding uppercase characters.

See the FaunaDB UpperCase Function

◆ Var()

static Expr FaunaDB.Query.Language.Var ( string varName )

static

Creates a new Var expression.

See the FaunaDB Basic Forms

.

◆ Year()

static Expr FaunaDB.Query.Language.Year ( Expr expr )

static

Returns the time expression's year, following the ISO-8601 standard.

The documentation for this struct was generated from the following files:

/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Authentication.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Basic.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Basic.Lambda.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Basic.Let.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Collection.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Collection.Filter.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Collection.Foreach.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Collection.Map.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Miscellaneous.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Read.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Sets.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Sets.Join.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.String.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.TimeDate.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.TypeCheckers.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Values.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Values.Obj.cs
/tmp/build/1a4543b4/fauna-csharp-repository/FaunaDB.Client/Query/Language.Write.cs

Classes

Public Types

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ActionType

◆ Normalizer

◆ TimeUnit

Member Function Documentation

◆ Abort()

◆ Abs()

◆ AccessProvider()

◆ AccessProviders()

◆ Acos()

◆ Add()

◆ After()

◆ All()

◆ And()

◆ Any()

◆ Append()

◆ Arr() [1/2]

◆ Arr() [2/2]

◆ Asin()

◆ At()

◆ Atan()

◆ Before()

◆ BitAnd()

◆ BitNot()

◆ BitOr()

◆ BitXor()

◆ Bytes()

◆ Call()

◆ Casefold() [1/2]

◆ Casefold() [2/2]

◆ Ceil()

◆ Class()

◆ Classes()

◆ Collection()

◆ Collections()

◆ Concat()

◆ Contains() [1/2]

◆ Contains() [2/2]

◆ ContainsField()

◆ ContainsPath() [1/2]

◆ ContainsPath() [2/2]

◆ ContainsStr()

◆ ContainsStrRegex()

◆ ContainsValue()

◆ Cos()

◆ Cosh()

◆ Count()

◆ Create()

◆ CreateAccessProvider()

◆ CreateClass()

◆ CreateCollection()

◆ CreateDatabase()

◆ CreateFunction()

◆ CreateIndex()

◆ CreateKey()

◆ CreateRole()

◆ Credentials()

◆ CurrentIdentity()

◆ CurrentToken()

◆ Database()

◆ Databases()

◆ Date()

◆ DayOfMonth()

◆ DayOfWeek()

◆ DayOfYear()

◆ Degrees()

◆ Delete()

◆ Difference()

◆ Distinct()

◆ Divide()

◆ Do()

◆ Documents()

◆ Drop()

◆ Dt() [1/2]

◆ Dt() [2/2]

◆ EndsWith()