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.

Packages

p

faunadb

query

package query

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. query
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed abstract class Action extends AnyRef

    Enumeration for event action types.

  2. case class After(expr: Expr) extends Cursor with Product with Serializable
  3. case class Before(expr: Expr) extends Cursor with Product with Serializable
  4. sealed trait Cursor extends AnyRef

    Helper for pagination cursors

  5. final case class Expr extends AnyVal with Product with Serializable

    A query language expression.

  6. sealed abstract class Normalizer extends AnyRef

    Enumeration for casefold operation.

  7. final case class Path extends AnyVal with Product with Serializable

    Helper for path syntax

  8. class QueryMacros extends AnyRef
  9. case class RawCursor(expr: Expr) extends Cursor with Product with Serializable
  10. sealed abstract class TimeUnit extends AnyRef

    Enumeration for time units.

    Enumeration for time units. Used by https://app.fauna.com/documentation/reference/queryapi#time-and-date.

Value Members

  1. def Abort(msg: Expr): Expr

    A Abort expression.

    A Abort expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#basic-forms

  2. def Abs(num: Expr): Expr

    An Abs expression.

    An Abs expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  3. def Acos(num: Expr): Expr

    An Acos expression.

    An Acos expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  4. def Add(terms: Expr*): Expr

    An Add expression.

    An Add expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  5. def All(collection: Expr): Expr

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

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

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/all

  6. def And(terms: Expr*): Expr

    An And expression.

    An And expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#logical-functions

  7. def Any(collection: Expr): Expr

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

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

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/any

  8. def Append(elems: Expr, collection: Expr): Expr

    An Append expression.

    An Append expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#collections

  9. def Arr(elems: Expr*): Expr

    An Array value.

    An Array value.

    Reference: https://app.fauna.com/documentation/reference/queryapi#simple-type

  10. def Asin(num: Expr): Expr

    An Asin expression.

    An Asin expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  11. def At(timestamp: Expr, expr: Expr): Expr

    A At expression.

    A At expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#basic-forms

  12. def Atan(num: Expr): Expr

    An Atan expression.

    An Atan expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  13. def BitAnd(terms: Expr*): Expr

    An BitAnd expression.

    An BitAnd expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  14. def BitNot(num: Expr): Expr

    A BitNot expression.

    A BitNot expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  15. def BitOr(terms: Expr*): Expr

    An BitOr expression.

    An BitOr expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  16. def BitXor(terms: Expr*): Expr

    An BitXor expression.

    An BitXor expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  17. def Call(ref: Expr, arguments: Expr*): Expr

    A Call expression.

    A Call expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#basic-forms

  18. def Casefold(term: Expr, normalizer: Expr): Expr
  19. def Casefold(term: Expr, normalizer: Normalizer): Expr
  20. def Casefold(term: Expr): Expr

    A Casefold expression.

    A Casefold expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#string-functions

  21. def Ceil(num: Expr): Expr

    A Ceil expression.

    A Ceil expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  22. def Collection(name: Expr, scope: Expr): Expr

    A Collection expression.

    A Collection expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

  23. def Collection(name: Expr): Expr

    A Collection expression.

    A Collection expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

  24. def Collections(scope: Expr = NullV): Expr

    Native reference to all classes

  25. def Concat(term: Expr, separator: Expr): Expr
  26. def Concat(term: Expr): Expr

    A Concat expression.

    A Concat expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#string-functions

  27. def Contains(path: Expr, in: Expr): Expr

    A Contains expression.

    A Contains expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

  28. def ContainsStr(value: Expr, search: Expr): Expr

    A ContainsStr expression

    A ContainsStr expression

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/containsstr

  29. def ContainsStrRegex(value: Expr, pattern: Expr): Expr

    A ContainsStrRegex expression

    A ContainsStrRegex expression

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/containsstrregex

  30. def Cos(num: Expr): Expr

    A Cos expression.

    A Cos expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  31. def Cosh(num: Expr): Expr

    A Cosh expression.

    A Cosh expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  32. def Count(collection: Expr): Expr

    Count the number of elements in the collection.

    Count the number of elements in the collection.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/count

  33. def Create(ref: Expr, params: Expr): Expr

    A Create expression.

    A Create expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

  34. def CreateCollection(params: Expr): Expr

    A Create Collection expression.

    A Create Collection expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

  35. def CreateDatabase(params: Expr): Expr

    A Create Database expression.

    A Create Database expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

  36. def CreateFunction(params: Expr): Expr

    A Create Function expression.

    A Create Function expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

  37. def CreateIndex(params: Expr): Expr

    A Create Index expression.

    A Create Index expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

  38. def CreateKey(params: Expr): Expr

    A Create Key expression.

    A Create Key expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

  39. def CreateRole(params: Expr): Expr

    A Create Role expression.

    A Create Role expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

  40. def Credentials(scope: Expr = NullV): Expr

    Native reference to all credentials

  41. def Database(name: Expr, scope: Expr): Expr

    A Database expression.

    A Database expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

  42. def Database(name: Expr): Expr

    A Database expression.

    A Database expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

  43. def Databases(scope: Expr = NullV): Expr

    Native reference to all databases

  44. def Date(str: Expr): Expr

    A Date expression.

    A Date expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-and-date

  45. def DayOfMonth(term: Expr): Expr

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

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

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-functions

  46. def DayOfWeek(term: Expr): Expr

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

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

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-functions

  47. def DayOfYear(term: Expr): Expr

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

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

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-functions

  48. def Degrees(num: Expr): Expr

    A Degrees expression.

    A Degrees expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  49. def Delete(ref: Expr): Expr

    A Delete expression.

    A Delete expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

  50. def Difference(sets: Expr*): Expr

    A Difference set.

    A Difference set.

    Reference: https://app.fauna.com/documentation/reference/queryapi#sets

  51. def Distinct(set: Expr): Expr

    A Distinct set.

    A Distinct set.

    Reference: https://app.fauna.com/documentation/reference/queryapi#sets

  52. def Divide(terms: Expr*): Expr

    A Divide expression.

    A Divide expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  53. def Do(exprs: Expr*): Expr

    A Do expression.

    A Do expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#basic-forms

  54. def Documents(collection: Expr): Expr

    Returns a set of all documents in the given collection

  55. def Drop(num: Expr, collection: Expr): Expr

    A Drop expression.

    A Drop expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#collections

  56. def EndsWith(value: Expr, search: Expr): Expr

    An EndsWith expression

    An EndsWith expression

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/endswith

  57. def Epoch(num: Expr, unit: Expr): Expr
  58. def Epoch(num: Expr, unit: TimeUnit): Expr

    An Epoch expression.

    An Epoch expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-and-date

  59. def Equals(terms: Expr*): Expr

    An Equals expression.

    An Equals expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

  60. def Events(refSet: Expr): Expr

    A Events set.

    A Events set.

    Reference: https://app.fauna.com/documentation/reference/queryapi#sets

  61. def Exists(ref: Expr, ts: Expr): Expr
  62. def Exists(ref: Expr): Expr

    An Exists expression.

    An Exists expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#read-functions

  63. def Exp(num: Expr): Expr

    An Exp expression.

    An Exp expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  64. def Filter(collection: Expr, lambda: Expr): Expr

    A Filter expression.

    A Filter expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#collections

  65. def FindStr(value: Expr, find: Expr, start: Expr): Expr
  66. def FindStr(value: Expr, find: Expr): Expr

    A FindStr expression

    A FindStr expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  67. def FindStrRegex(value: Expr, pattern: Expr, start: Expr, num_results: Expr): Expr

    A FindStrRegex expression

    A FindStrRegex expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  68. def FindStrRegex(value: Expr, pattern: Expr, start: Expr): Expr

    A FindStrRegex expression

    A FindStrRegex expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  69. def Floor(num: Expr): Expr

    A Floor expression.

    A Floor expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  70. def Foreach(collection: Expr, lambda: Expr): Expr

    A Foreach expression.

    A Foreach expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#collections

  71. def Format(format: Expr, values: Expr*): Expr

    A Format expression

    A Format expression

    Reference: https://app.fauna.com/documentation/reference/queryapi#string-functions

  72. def Function(name: Expr, scope: Expr): Expr

    A Function expression.

    A Function expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

  73. def Function(name: Expr): Expr

    A Function expression.

    A Function expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

  74. def Functions(scope: Expr = NullV): Expr

    Native reference to all functions

  75. def GT(terms: Expr*): Expr

    A GT expression.

    A GT expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#logical-functions

  76. def GTE(terms: Expr*): Expr

    A GTE expression.

    A GTE expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#logical-functions

  77. def Get(resource: Expr, ts: Expr): Expr
  78. def Get(resource: Expr): Expr

    A Get expression.

    A Get expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#read-functions

  79. def HasIdentity(): Expr

    An HasIdentity expression.

    An HasIdentity expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#authentication

  80. def Hour(term: Expr): Expr

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

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

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-functions

  81. def Hypot(num: Expr, exp: Expr): Expr

    A Hypot expression.

    A Hypot expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  82. def Hypot(num: Expr): Expr

    A Hypot expression.

    A Hypot expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  83. def Identify(ref: Expr, password: Expr): Expr

    An Identify expression.

    An Identify expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#authentication

  84. def Identity(): Expr

    An Identity expression.

    An Identity expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#authentication

  85. def If(pred: Expr, then: Expr, else: Expr): Expr

    An If expression.

    An If expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#basic-forms

  86. def Index(name: Expr, scope: Expr): Expr

    An Index expression.

    An Index expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

  87. def Index(name: Expr): Expr

    An Index expression.

    An Index expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

  88. def Indexes(scope: Expr = NullV): Expr

    Native reference to all indexes

  89. def Insert(ref: Expr, ts: Expr, action: Expr, params: Expr): Expr
  90. def Insert(ref: Expr, ts: Expr, action: Action, params: Expr): Expr

    An Insert expression.

    An Insert expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

  91. def Intersection(sets: Expr*): Expr

    An Intersection set.

    An Intersection set.

    Reference: https://app.fauna.com/documentation/reference/queryapi#sets

  92. def IsArray(expr: Expr): Expr

    Check if the expression is an array.

    Check if the expression is an array.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isarray

  93. def IsBoolean(expr: Expr): Expr

    Check if the expression is a boolean.

    Check if the expression is a boolean.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isboolean

  94. def IsBytes(expr: Expr): Expr

    Check if the expression is a byte array.

    Check if the expression is a byte array.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isbytes

  95. def IsCollection(expr: Expr): Expr

    Check if the expression is a collection.

    Check if the expression is a collection.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/iscollection

  96. def IsCredentials(expr: Expr): Expr

    Check if the expression is a credentials.

    Check if the expression is a credentials.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/iscredentials

  97. def IsDatabase(expr: Expr): Expr

    Check if the expression is a database.

    Check if the expression is a database.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isdatabase

  98. def IsDate(expr: Expr): Expr

    Check if the expression is a date.

    Check if the expression is a date.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isdate

  99. def IsDoc(expr: Expr): Expr

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

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

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isdoc

  100. def IsDouble(expr: Expr): Expr

    Check if the expression is a double.

    Check if the expression is a double.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isdouble

  101. def IsEmpty(collection: Expr): Expr

    A IsEmpty expression.

    A IsEmpty expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#collections

  102. def IsFunction(expr: Expr): Expr

    Check if the expression is a function.

    Check if the expression is a function.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isfunction

  103. def IsIndex(expr: Expr): Expr

    Check if the expression is an index.

    Check if the expression is an index.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isindex

  104. def IsInteger(expr: Expr): Expr

    Check if the expression is an integer.

    Check if the expression is an integer.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isinteger

  105. def IsKey(expr: Expr): Expr

    Check if the expression is a key.

    Check if the expression is a key.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/iskey

  106. def IsLambda(expr: Expr): Expr

    Check if the expression is a lambda.

    Check if the expression is a lambda.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/islambda

  107. def IsNonEmpty(collection: Expr): Expr

    A IsNonEmpty expression.

    A IsNonEmpty expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#collections

  108. def IsNull(expr: Expr): Expr

    Check if the expression is null.

    Check if the expression is null.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isnull

  109. def IsNumber(expr: Expr): Expr

    Check if the expression is a number.

    Check if the expression is a number.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isnumber

  110. def IsObject(expr: Expr): Expr

    Check if the expression is an object.

    Check if the expression is an object.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isobject

  111. def IsRef(expr: Expr): Expr

    Check if the expression is a reference.

    Check if the expression is a reference.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isref

  112. def IsRole(expr: Expr): Expr

    Check if the expression is a role.

    Check if the expression is a role.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isrole

  113. def IsSet(expr: Expr): Expr

    Check if the expression is a set.

    Check if the expression is a set.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isset

  114. def IsString(expr: Expr): Expr

    Check if the expression is a string.

    Check if the expression is a string.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/isstring

  115. def IsTimestamp(expr: Expr): Expr

    Check if the expression is a timestamp.

    Check if the expression is a timestamp.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/istimestamp

  116. def IsToken(expr: Expr): Expr

    Check if the expression is a token.

    Check if the expression is a token.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/istoken

  117. def Join(source: Expr, with: Expr): Expr

    A Join set.

    A Join set.

    Reference: https://app.fauna.com/documentation/reference/queryapi#sets

  118. def KeyFromSecret(secret: Expr): Expr

    A KeyFromSecret expression.

    A KeyFromSecret expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#read-functions

  119. def Keys(scope: Expr = NullV): Expr

    Native reference to all keys

  120. def LT(terms: Expr*): Expr

    A LT expression.

    A LT expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#logical-functions

  121. def LTE(terms: Expr*): Expr

    A LTE expression.

    A LTE expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#logical-functions

  122. def LTrim(value: Expr): Expr

    A LTrim expression

    A LTrim expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  123. def Lambda(lambda: Expr, expr: Expr): Expr
  124. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  125. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  126. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  127. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  128. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  129. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  130. macro def Lambda(fn: (Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  131. macro def Lambda(fn: (Expr, Expr, Expr) ⇒ Expr): Expr
  132. macro def Lambda(fn: (Expr, Expr) ⇒ Expr): Expr
  133. macro def Lambda(fn: (Expr) ⇒ Expr): Expr

    A Lambda expression.

    A Lambda expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#basic-forms

  134. def Length(value: Expr): Expr

    A Length expression

    A Length expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  135. def Let(bindings: Seq[(String, Expr)], in: Expr): Expr
  136. macro def Let(block: ⇒ Any): Expr

    A Let expression.

    A Let expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#basic-forms

  137. def Ln(num: Expr): Expr

    A ln expression.

    A ln expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  138. def Log(num: Expr): Expr

    A Log expression.

    A Log expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  139. def Login(ref: Expr, params: Expr): Expr

    A Login expression.

    A Login expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#authentication

  140. def Logout(invalidateAll: Expr): Expr

    A Logout expression.

    A Logout expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#authentication

  141. def LowerCase(value: Expr): Expr

    A LowerCase expression

    A LowerCase expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  142. def Map(collection: Expr, lambda: Expr): Expr

    A Map expression.

    A Map expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#collections

  143. def Match(index: Expr, terms: Expr*): Expr

    A Match set.

    A Match set.

    Reference: https://app.fauna.com/documentation/reference/queryapi#sets

  144. def Max(terms: Expr*): Expr

    A Max expression.

    A Max expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  145. def Mean(collection: Expr): Expr

    Returns the mean of all elements in the collection.

    Returns the mean of all elements in the collection.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/mean

  146. def Merge(merge: Expr, with: Expr, lambda: Expr): Expr

    Merge two or more objects into a single one.

    Merge two or more objects into a single one. A lambda can be specified to resolve conflicts.

    Reference: https://app.fauna.com/documentation/reference/queryapi#object-functions

  147. def Merge(merge: Expr, with: Expr): Expr

    Merge two or more objects into a single one.

    Merge two or more objects into a single one.

    Reference: https://app.fauna.com/documentation/reference/queryapi#object-functions

  148. def Min(terms: Expr*): Expr

    A Min expression.

    A Min expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  149. def Minute(term: Expr): Expr

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

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

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-functions

  150. def Modulo(terms: Expr*): Expr

    A Modulo expression.

    A Modulo expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  151. def Month(term: Expr): Expr

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

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

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-functions

  152. def MoveDatabase(from: Expr, to: Expr): Expr

    A Move Database expression.

    A Move Database expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

  153. def Multiply(terms: Expr*): Expr

    A Multiply expression.

    A Multiply expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  154. def NGram(terms: Expr, min: Expr = NullV, max: Expr = NullV): Expr

    A NGram expression.

    A NGram expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#string-functions

  155. def NewId(): Expr

    A New Id expression.

    A New Id expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

  156. def Not(term: Expr): Expr

    A Not expression.

    A Not expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#logical-functions

  157. def Now(): Expr

    Returns the current snapshot time.

    Returns the current snapshot time.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/now

  158. def Null(): Expr

    A Null value.

    A Null value.

    Reference: https://app.fauna.com/documentation/reference/queryapi#simple-type

  159. def Obj(pairs: (String, Expr)*): Expr

    An Object value.

    An Object value.

    Reference: https://app.fauna.com/documentation/reference/queryapi#simple-type

  160. def Or(terms: Expr*): Expr

    An Or expression.

    An Or expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#logical-functions

  161. def Paginate(resource: Expr, cursor: Cursor = NoCursor, ts: Expr = Expr(NullV), size: Expr = Expr(NullV), sources: Expr = Expr(NullV), events: Expr = Expr(NullV)): Expr

    A Paginate expression.

    A Paginate expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#read-functions

  162. def Pow(num: Expr, exp: Expr): Expr

    A Pow expression.

    A Pow expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  163. def Pow(num: Expr): Expr

    A Pow expression.

    A Pow expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  164. def Prepend(elems: Expr, collection: Expr): Expr

    A Prepend expression.

    A Prepend expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#collections

  165. def Query(lambda: Expr): Expr
  166. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  167. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  168. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  169. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  170. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  171. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  172. macro def Query(fn: (Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  173. macro def Query(fn: (Expr, Expr, Expr) ⇒ Expr): Expr
  174. macro def Query(fn: (Expr, Expr) ⇒ Expr): Expr
  175. macro def Query(fn: (Expr) ⇒ Expr): Expr

    A Query expression.

    A Query expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#basic-forms

  176. def RTrim(value: Expr): Expr

    A RTrim expression

    A RTrim expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  177. def Radians(num: Expr): Expr

    A Radians expression.

    A Radians expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  178. def Range(set: Expr, from: Expr, to: Expr): Expr

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

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

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/range

    set

    set to be filtered

    from

    lower bound

    to

    upper bound

  179. def Reduce(lambda: Expr, initial: Expr, collection: Expr): Expr

    A Reduce expression.

    A Reduce expression.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/reduce

  180. def Ref(collectionRef: Expr, id: Expr): Expr
  181. def Ref(value: String): Expr

    Creates a RefV value.

    Creates a RefV value. The string "collections/widget/123" will be equivalent to:

    RefV("123", RefV("widget", Native.Collections))

    Reference: https://app.fauna.com/documentation/reference/queryapi#simple-type

  182. def RegexEscape(value: Expr): Expr

    A RegexEscape expression

    A RegexEscape expression

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/regexescape

  183. def Remove(ref: Expr, ts: Expr, action: Expr): Expr
  184. def Remove(ref: Expr, ts: Expr, action: Action): Expr

    A Remove expression.

    A Remove expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

  185. def Repeat(value: Expr, number: Expr): Expr

    A Repeat expression

    A Repeat expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  186. def Repeat(value: Expr): Expr

    A Repeat expression

    A Repeat expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  187. def Replace(ref: Expr, params: Expr): Expr

    A Replace expression.

    A Replace expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

  188. def ReplaceStr(value: Expr, find: Expr, replace: Expr): Expr

    A ReplaceStr expression

    A ReplaceStr expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  189. def ReplaceStrRegex(value: Expr, pattern: Expr, replace: Expr, first: Expr): Expr

    A ReplaceStrRegex expression

    A ReplaceStrRegex expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  190. def ReplaceStrRegex(value: Expr, pattern: Expr, replace: Expr): Expr

    A ReplaceStrRegex expression

    A ReplaceStrRegex expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  191. def Role(name: Expr, scope: Expr): Expr

    A Role expression.

    A Role expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

  192. def Role(name: Expr): Expr

    A Role expression.

    A Role expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

  193. def Roles(scope: Expr = NullV): Expr

    Native reference to all roles

  194. def Round(num: Expr, precision: Expr): Expr

    A Round expression.

    A Round expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  195. def Round(num: Expr): Expr

    A Round expression.

    A Round expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  196. def Second(term: Expr): Expr

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

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

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-functions

  197. def Select(path: Expr, from: Expr, default: Expr): Expr
  198. def Select(path: Expr, from: Expr): Expr

    A Select expression.

    A Select expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#read-functions

  199. def SelectAsIndex(path: Expr, from: Expr): Expr

    A SelectAsIndex expression.

    A SelectAsIndex expression.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/selectasindex

  200. def Sign(num: Expr): Expr

    A sign expression.

    A sign expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  201. def Sin(num: Expr): Expr

    A sin expression.

    A sin expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  202. def Singleton(ref: Expr): Expr

    A Singleton set.

    A Singleton set.

    Reference: https://app.fauna.com/documentation/reference/queryapi#sets

  203. def Sinh(num: Expr): Expr

    A sinh expression.

    A sinh expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  204. def Space(value: Expr): Expr

    A Space expression

    A Space expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  205. def Sqrt(num: Expr): Expr

    A sqrt expression.

    A sqrt expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  206. def StartsWith(value: Expr, search: Expr): Expr

    A StartsWith expression

    A StartsWith expression

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/startswith

  207. def SubString(value: Expr, start: Expr, length: Expr): Expr

    A SubString expression

    A SubString expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  208. def SubString(value: Expr, start: Expr): Expr

    A SubString expression

    A SubString expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  209. def SubString(value: Expr): Expr

    A SubString expression

    A SubString expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  210. def Subtract(terms: Expr*): Expr

    A Subtract expression.

    A Subtract expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  211. def Sum(collection: Expr): Expr

    Sum the elements in the collection.

    Sum the elements in the collection.

    Reference: https://docs.fauna.com/fauna/current/api/fql/functions/sum

  212. def Take(num: Expr, collection: Expr): Expr

    A Take expression.

    A Take expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#collections

  213. def Tan(num: Expr): Expr

    A Tan expression.

    A Tan expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  214. def Tanh(num: Expr): Expr

    A Tanh expression.

    A Tanh expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  215. def Time(str: Expr): Expr

    A Time expression.

    A Time expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-and-date

  216. def TimeAdd(base: Expr, offset: Expr, unit: TimeUnit): Expr
  217. def TimeAdd(base: Expr, offset: Expr, unit: Expr): Expr

    A TimeAdd expression.

    A TimeAdd expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-and-date

  218. def TimeDiff(start: Expr, finish: Expr, unit: TimeUnit): Expr
  219. def TimeDiff(start: Expr, finish: Expr, unit: Expr): Expr

    A TimeDiff expression.

    A TimeDiff expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-and-date

  220. def TimeSubtract(base: Expr, offset: Expr, unit: TimeUnit): Expr
  221. def TimeSubtract(base: Expr, offset: Expr, unit: Expr): Expr

    A TimeSubtract expression.

    A TimeSubtract expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-and-date

  222. def TitleCase(value: Expr): Expr

    A TitleCase expression

    A TitleCase expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  223. def ToArray(obj: Expr): Expr

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

  224. def ToDate(term: Expr): Expr

    Casts an expression to a data value, if possible.

    Casts an expression to a data value, if possible.

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-functions

  225. def ToDouble(term: Expr): Expr

    Casts an expression to a double value, if possible.

  226. def ToInteger(term: Expr): Expr

    Casts an expression to an integer value, if possible.

  227. def ToMicros(term: Expr): Expr

    Converts a time expression to microseconds since the UNIX epoch.

    Converts a time expression to microseconds since the UNIX epoch.

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-functions

  228. def ToMillis(term: Expr): Expr

    Converts a time expression to milliseconds since the UNIX epoch.

    Converts a time expression to milliseconds since the UNIX epoch.

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-functions

  229. def ToNumber(term: Expr): Expr

    Casts an expression to a numeric value, if possible.

  230. def ToObject(fields: Expr): Expr

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

  231. def ToSeconds(term: Expr): Expr

    Converts a time expression to seconds since the UNIX epoch.

    Converts a time expression to seconds since the UNIX epoch.

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-functions

  232. def ToString(term: Expr): Expr

    Casts an expression to a string value, if possible.

  233. def ToTime(term: Expr): Expr

    Casts an expression to a time value, if possible.

    Casts an expression to a time value, if possible.

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-functions

  234. def Tokens(scope: Expr = NullV): Expr

    Native reference to all tokens

  235. def Trim(term: Expr): Expr

    A Trim expression

    A Trim expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  236. def Trunc(num: Expr, precision: Expr): Expr

    A Trunc expression.

    A Trunc expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  237. def Trunc(num: Expr): Expr

    A Trunc expression.

    A Trunc expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#mathematical-functions

  238. def Union(sets: Expr*): Expr

    A Union set.

    A Union set.

    Reference: https://app.fauna.com/documentation/reference/queryapi#sets

  239. def Update(ref: Expr, params: Expr): Expr

    An Update expression.

    An Update expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

  240. def UpperCase(term: Expr): Expr

    A UpperCase expression

    A UpperCase expression

    Reference': https://app.fauna.com/documentation/reference/queryapi#string-functions

  241. def Var(name: String): Expr

    A Var expression.

    A Var expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#basic-forms

  242. def Year(term: Expr): Expr

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

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

    Reference: https://app.fauna.com/documentation/reference/queryapi#time-functions

  243. implicit def intToPath(int: Int): Path
  244. implicit def pathToExpr(path: Path): Expr
  245. implicit def strToPath(str: String): Path
  246. object Action
  247. object Cursor
  248. object Expr extends Serializable
  249. object NoCursor extends Cursor with Product with Serializable
  250. object Normalizer
  251. object TimeUnit

Deprecated Value Members

  1. def Class(name: Expr, scope: Expr): Expr

    A Class expression.

    A Class expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) use Collection instead

  2. def Class(name: Expr): Expr

    A Class expression.

    A Class expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) use Collection instead

  3. def Classes(scope: Expr = NullV): Expr

    Native reference to all classes

    Native reference to all classes

    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) use Collections instead

  4. def CreateClass(params: Expr): Expr

    A Create Class expression.

    A Create Class expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#write-functions

    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) use CreateCollection instead

  5. def NextId(): Expr

    A Next Id expression.

    A Next Id expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#miscellaneous-functions

    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) use NewId instead

  6. def SelectAll(path: Expr, from: Expr): Expr

    A SelectAll expression.

    A SelectAll expression.

    Reference: https://app.fauna.com/documentation/reference/queryapi#read-functions

    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) use SelectAsIndex instead

Inherited from AnyRef

Inherited from Any

Ungrouped