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
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. sealed abstract class TimeUnit extends AnyRef

    Enumeration for time units.

Value Members

  1. def Abort(msg: Expr): Expr

    A Abort expression.

  2. def Abs(num: Expr): Expr

    An Abs expression.

  3. def Acos(num: Expr): Expr

    An Acos expression.

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

    An Add expression.

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

    An And expression.

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

    An Append expression.

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

    An Array value.

  8. def Asin(num: Expr): Expr

    An Asin expression.

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

    A At expression.

  10. def Atan(num: Expr): Expr

    An Atan expression.

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

    An BitAnd expression.

  12. def BitNot(num: Expr): Expr

    A BitNot expression.

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

    An BitOr expression.

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

    An BitXor expression.

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

    A Call expression.

  16. def Casefold(term: Expr, normalizer: Expr): Expr
  17. def Casefold(term: Expr, normalizer: Normalizer): Expr
  18. def Casefold(term: Expr): Expr

    A Casefold expression.

  19. def Ceil(num: Expr): Expr

    A Ceil expression.

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

    A Class expression.

  21. def Class(name: Expr): Expr

    A Class expression.

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

    Native reference to all classes

  23. def Concat(term: Expr, separator: Expr): Expr
  24. def Concat(term: Expr): Expr

    A Concat expression.

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

    A Contains expression.

  26. def Cos(num: Expr): Expr

    A Cos expression.

  27. def Cosh(num: Expr): Expr

    A Cosh expression.

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

    A Create expression.

  29. def CreateClass(params: Expr): Expr

    A Create Class expression.

  30. def CreateDatabase(params: Expr): Expr

    A Create Database expression.

  31. def CreateFunction(params: Expr): Expr

    A Create Function expression.

  32. def CreateIndex(params: Expr): Expr

    A Create Index expression.

  33. def CreateKey(params: Expr): Expr

    A Create Key expression.

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

    Native reference to all credentials

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

    A Database expression.

  36. def Database(name: Expr): Expr

    A Database expression.

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

    Native reference to all databases

  38. def Date(str: Expr): Expr

    A Date expression.

  39. def Degrees(num: Expr): Expr

    A Degrees expression.

  40. def Delete(ref: Expr): Expr

    A Delete expression.

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

    A Difference set.

  42. def Distinct(set: Expr): Expr

    A Distinct set.

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

    A Divide expression.

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

    A Do expression.

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

    A Drop expression.

  46. def Epoch(num: Expr, unit: Expr): Expr
  47. def Epoch(num: Expr, unit: TimeUnit): Expr

    An Epoch expression.

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

    An Equals expression.

  49. def Events(refSet: Expr): Expr

    A Events set.

  50. def Exists(ref: Expr, ts: Expr): Expr
  51. def Exists(ref: Expr): Expr

    An Exists expression.

  52. def Exp(num: Expr): Expr

    An Exp expression.

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

    A Filter expression.

  54. def FindStr(value: Expr, find: Expr, start: Expr): Expr
  55. def FindStr(value: Expr, find: Expr): Expr

    A FindStr expression

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

    A FindStrRegex expression

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

    A FindStrRegex expression

  58. def Floor(num: Expr): Expr

    A Floor expression.

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

    A Foreach expression.

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

    A Function expression.

  61. def Function(name: Expr): Expr

    A Function expression.

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

    Native reference to all functions

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

    A GT expression.

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

    A GTE expression.

  65. def Get(resource: Expr, ts: Expr): Expr
  66. def Get(resource: Expr): Expr

    A Get expression.

  67. def HasIdentity(): Expr

    An HasIdentity expression.

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

    A Hypot expression.

  69. def Hypot(num: Expr): Expr

    A Hypot expression.

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

    An Identify expression.

  71. def Identity(): Expr

    An Identity expression.

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

    An If expression.

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

    An Index expression.

  74. def Index(name: Expr): Expr

    An Index expression.

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

    Native reference to all indexes

  76. def Insert(ref: Expr, ts: Expr, action: Expr, params: Expr): Expr
  77. def Insert(ref: Expr, ts: Expr, action: Action, params: Expr): Expr

    An Insert expression.

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

    An Intersection set.

  79. def IsEmpty(collection: Expr): Expr

    A IsEmpty expression.

  80. def IsNonEmpty(collection: Expr): Expr

    A IsNonEmpty expression.

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

    A Join set.

  82. def KeyFromSecret(secret: Expr): Expr

    A KeyFromSecret expression.

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

    Native reference to all keys

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

    A LT expression.

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

    A LTE expression.

  86. def LTrim(value: Expr): Expr

    A LTrim expression

  87. def Lambda(lambda: Expr, expr: Expr): Expr
  88. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  89. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  90. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  91. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  92. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  93. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  94. macro def Lambda(fn: (Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  95. macro def Lambda(fn: (Expr, Expr, Expr) ⇒ Expr): Expr
  96. macro def Lambda(fn: (Expr, Expr) ⇒ Expr): Expr
  97. macro def Lambda(fn: (Expr) ⇒ Expr): Expr

    A Lambda expression.

  98. def Length(value: Expr): Expr

    A Length expression

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

    A Let expression.

  101. def Ln(num: Expr): Expr

    A ln expression.

  102. def Log(num: Expr): Expr

    A Log expression.

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

    A Login expression.

  104. def Logout(invalidateAll: Expr): Expr

    A Logout expression.

  105. def LowerCase(value: Expr): Expr

    A LowerCase expression

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

    A Map expression.

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

    A Match set.

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

    A Max expression.

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

    A Min expression.

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

    A Modulo expression.

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

    A Multiply expression.

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

    A NGram expression.

  113. def NewId(): Expr

    A New Id expression.

  114. def Not(term: Expr): Expr

    A Not expression.

  115. def Null(): Expr

    A Null value.

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

    An Object value.

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

    An Or expression.

  118. 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.

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

    A Pow expression.

  120. def Pow(num: Expr): Expr

    A Pow expression.

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

    A Prepend expression.

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

    A Query expression.

  133. def RTrim(value: Expr): Expr

    A RTrim expression

  134. def Radians(num: Expr): Expr

    A Radians expression.

  135. def Ref(classRef: Expr, id: Expr): Expr
  136. def Ref(value: String): Expr

    Creates a RefV value.

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

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

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

  137. def Remove(ref: Expr, ts: Expr, action: Expr): Expr
  138. def Remove(ref: Expr, ts: Expr, action: Action): Expr

    A Remove expression.

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

    A Repeat expression

  140. def Repeat(value: Expr): Expr

    A Repeat expression

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

    A Replace expression.

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

    A ReplaceStr expression

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

    A ReplaceStrRegex expression

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

    A ReplaceStrRegex expression

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

    A Round expression.

  146. def Round(num: Expr): Expr

    A Round expression.

  147. def Select(path: Expr, from: Expr, default: Expr): Expr
  148. def Select(path: Expr, from: Expr): Expr

    A Select expression.

  149. def SelectAll(path: Expr, from: Expr, default: Expr): Expr
  150. def SelectAll(path: Expr, from: Expr): Expr

    A SelectAll expression.

  151. def Sign(num: Expr): Expr

    A sign expression.

  152. def Sin(num: Expr): Expr

    A sin expression.

  153. def Singleton(ref: Expr): Expr

    A Singleton set.

  154. def Sinh(num: Expr): Expr

    A sinh expression.

  155. def Space(value: Expr): Expr

    A Space expression

  156. def Sqrt(num: Expr): Expr

    A sqrt expression.

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

    A SubString expression

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

    A SubString expression

  159. def SubString(value: Expr): Expr

    A SubString expression

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

    A Subtract expression.

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

    A Take expression.

  162. def Tan(num: Expr): Expr

    A Tan expression.

  163. def Tanh(num: Expr): Expr

    A Tanh expression.

  164. def Time(str: Expr): Expr

    A Time expression.

  165. def TitleCase(value: Expr): Expr

    A TitleCase expression

  166. def ToDate(term: Expr): Expr

    Casts an expression to a data value, if possible.

  167. def ToNumber(term: Expr): Expr

    Casts an expression to a numeric value, if possible.

  168. def ToString(term: Expr): Expr

    Casts an expression to a string value, if possible.

  169. def ToTime(term: Expr): Expr

    Casts an expression to a time value, if possible.

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

    Native reference to all tokens

  171. def Trim(term: Expr): Expr

    A Trim expression

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

    A Trunc expression.

  173. def Trunc(num: Expr): Expr

    A Trunc expression.

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

    A Union set.

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

    An Update expression.

  176. def UpperCase(term: Expr): Expr

    A UpperCase expression

  177. def Var(name: String): Expr

    A Var expression.

  178. implicit def intToPath(int: Int): Path
  179. implicit def pathToExpr(path: Path): Expr
  180. implicit def strToPath(str: String): Path
  181. object Action
  182. object Expr extends Serializable
  183. object NoCursor extends Cursor with Product with Serializable
  184. object Normalizer
  185. object TimeUnit

Deprecated Value Members

  1. def NextId(): Expr

    A Next Id expression.

    Annotations
    @deprecated
    Deprecated

    use NewId instead

Inherited from AnyRef

Inherited from Any

Ungrouped