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. case class RawCursor(expr: Expr) extends Cursor with Product with Serializable
  10. 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 Collection(name: Expr, scope: Expr): Expr

    A Collection expression.

  21. def Collection(name: Expr): Expr

    A Collection expression.

  22. def Collections(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 ContainsStr(value: Expr, search: Expr): Expr

    A ContainsStr expression

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

    A ContainsStrRegex expression

  28. def Cos(num: Expr): Expr

    A Cos expression.

  29. def Cosh(num: Expr): Expr

    A Cosh expression.

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

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

    A Create expression.

  32. def CreateCollection(params: Expr): Expr

    A Create Collection expression.

  33. def CreateDatabase(params: Expr): Expr

    A Create Database expression.

  34. def CreateFunction(params: Expr): Expr

    A Create Function expression.

  35. def CreateIndex(params: Expr): Expr

    A Create Index expression.

  36. def CreateKey(params: Expr): Expr

    A Create Key expression.

  37. def CreateRole(params: Expr): Expr

    A Create Role expression.

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

    Native reference to all credentials

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

    A Database expression.

  40. def Database(name: Expr): Expr

    A Database expression.

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

    Native reference to all databases

  42. def Date(str: Expr): Expr

    A Date expression.

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

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

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

  46. def Degrees(num: Expr): Expr

    A Degrees expression.

  47. def Delete(ref: Expr): Expr

    A Delete expression.

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

    A Difference set.

  49. def Distinct(set: Expr): Expr

    A Distinct set.

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

    A Divide expression.

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

    A Do expression.

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

    A Drop expression.

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

    An EndsWith expression

  54. def Epoch(num: Expr, unit: Expr): Expr
  55. def Epoch(num: Expr, unit: TimeUnit): Expr

    An Epoch expression.

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

    An Equals expression.

  57. def Events(refSet: Expr): Expr

    A Events set.

  58. def Exists(ref: Expr, ts: Expr): Expr
  59. def Exists(ref: Expr): Expr

    An Exists expression.

  60. def Exp(num: Expr): Expr

    An Exp expression.

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

    A Filter expression.

  62. def FindStr(value: Expr, find: Expr, start: Expr): Expr
  63. def FindStr(value: Expr, find: Expr): Expr

    A FindStr expression

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

    A FindStrRegex expression

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

    A FindStrRegex expression

  66. def Floor(num: Expr): Expr

    A Floor expression.

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

    A Foreach expression.

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

    A Format expression

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

    A Function expression.

  70. def Function(name: Expr): Expr

    A Function expression.

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

    Native reference to all functions

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

    A GT expression.

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

    A GTE expression.

  74. def Get(resource: Expr, ts: Expr): Expr
  75. def Get(resource: Expr): Expr

    A Get expression.

  76. def HasIdentity(): Expr

    An HasIdentity expression.

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

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

    A Hypot expression.

  79. def Hypot(num: Expr): Expr

    A Hypot expression.

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

    An Identify expression.

  81. def Identity(): Expr

    An Identity expression.

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

    An If expression.

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

    An Index expression.

  84. def Index(name: Expr): Expr

    An Index expression.

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

    Native reference to all indexes

  86. def Insert(ref: Expr, ts: Expr, action: Expr, params: Expr): Expr
  87. def Insert(ref: Expr, ts: Expr, action: Action, params: Expr): Expr

    An Insert expression.

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

    An Intersection set.

  89. def IsEmpty(collection: Expr): Expr

    A IsEmpty expression.

  90. def IsNonEmpty(collection: Expr): Expr

    A IsNonEmpty expression.

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

    A Join set.

  92. def KeyFromSecret(secret: Expr): Expr

    A KeyFromSecret expression.

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

    Native reference to all keys

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

    A LT expression.

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

    A LTE expression.

  96. def LTrim(value: Expr): Expr

    A LTrim expression

  97. def Lambda(lambda: Expr, expr: Expr): Expr
  98. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  99. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  100. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  101. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  102. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  103. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  104. macro def Lambda(fn: (Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  105. macro def Lambda(fn: (Expr, Expr, Expr) ⇒ Expr): Expr
  106. macro def Lambda(fn: (Expr, Expr) ⇒ Expr): Expr
  107. macro def Lambda(fn: (Expr) ⇒ Expr): Expr

    A Lambda expression.

  108. def Length(value: Expr): Expr

    A Length expression

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

    A Let expression.

  111. def Ln(num: Expr): Expr

    A ln expression.

  112. def Log(num: Expr): Expr

    A Log expression.

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

    A Login expression.

  114. def Logout(invalidateAll: Expr): Expr

    A Logout expression.

  115. def LowerCase(value: Expr): Expr

    A LowerCase expression

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

    A Map expression.

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

    A Match set.

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

    A Max expression.

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

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

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

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

    A Min expression.

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

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

    A Modulo expression.

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

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

    A Move Database expression.

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

    A Multiply expression.

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

    A NGram expression.

  129. def NewId(): Expr

    A New Id expression.

  130. def Not(term: Expr): Expr

    A Not expression.

  131. def Now(): Expr

    Returns the current snapshot time.

    Returns the current snapshot time.

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

  132. def Null(): Expr

    A Null value.

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

    An Object value.

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

    An Or expression.

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

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

    A Pow expression.

  137. def Pow(num: Expr): Expr

    A Pow expression.

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

    A Prepend expression.

  139. def Query(lambda: Expr): Expr
  140. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  141. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  142. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  143. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  144. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  145. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  146. macro def Query(fn: (Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  147. macro def Query(fn: (Expr, Expr, Expr) ⇒ Expr): Expr
  148. macro def Query(fn: (Expr, Expr) ⇒ Expr): Expr
  149. macro def Query(fn: (Expr) ⇒ Expr): Expr

    A Query expression.

  150. def RTrim(value: Expr): Expr

    A RTrim expression

  151. def Radians(num: Expr): Expr

    A Radians expression.

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

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

    A Reduce expression.

  154. def Ref(collectionRef: Expr, id: Expr): Expr
  155. 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

  156. def RegexEscape(value: Expr): Expr

    A RegexEscape expression

  157. def Remove(ref: Expr, ts: Expr, action: Expr): Expr
  158. def Remove(ref: Expr, ts: Expr, action: Action): Expr

    A Remove expression.

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

    A Repeat expression

  160. def Repeat(value: Expr): Expr

    A Repeat expression

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

    A Replace expression.

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

    A ReplaceStr expression

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

    A ReplaceStrRegex expression

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

    A ReplaceStrRegex expression

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

    A Role expression.

  166. def Role(name: Expr): Expr

    A Role expression.

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

    Native reference to all roles

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

    A Round expression.

  169. def Round(num: Expr): Expr

    A Round expression.

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

  171. def Select(path: Expr, from: Expr, default: Expr): Expr
  172. def Select(path: Expr, from: Expr): Expr

    A Select expression.

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

    A SelectAsIndex expression.

  174. def Sign(num: Expr): Expr

    A sign expression.

  175. def Sin(num: Expr): Expr

    A sin expression.

  176. def Singleton(ref: Expr): Expr

    A Singleton set.

  177. def Sinh(num: Expr): Expr

    A sinh expression.

  178. def Space(value: Expr): Expr

    A Space expression

  179. def Sqrt(num: Expr): Expr

    A sqrt expression.

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

    A StartsWith expression

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

    A SubString expression

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

    A SubString expression

  183. def SubString(value: Expr): Expr

    A SubString expression

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

    A Subtract expression.

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

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

    A Take expression.

  187. def Tan(num: Expr): Expr

    A Tan expression.

  188. def Tanh(num: Expr): Expr

    A Tanh expression.

  189. def Time(str: Expr): Expr

    A Time expression.

  190. def TimeAdd(base: Expr, offset: Expr, unit: TimeUnit): Expr
  191. def TimeAdd(base: Expr, offset: Expr, unit: Expr): Expr

    A TimeAdd expression.

  192. def TimeDiff(start: Expr, finish: Expr, unit: TimeUnit): Expr
  193. def TimeDiff(start: Expr, finish: Expr, unit: Expr): Expr

    A TimeDiff expression.

  194. def TimeSubtract(base: Expr, offset: Expr, unit: TimeUnit): Expr
  195. def TimeSubtract(base: Expr, offset: Expr, unit: Expr): Expr

    A TimeSubtract expression.

  196. def TitleCase(value: Expr): Expr

    A TitleCase expression

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

  198. def ToDouble(term: Expr): Expr

    Casts an expression to a double value, if possible.

  199. def ToInteger(term: Expr): Expr

    Casts an expression to an integer value, if possible.

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

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

  202. def ToNumber(term: Expr): Expr

    Casts an expression to a numeric value, if possible.

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

  204. def ToString(term: Expr): Expr

    Casts an expression to a string value, if possible.

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

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

    Native reference to all tokens

  207. def Trim(term: Expr): Expr

    A Trim expression

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

    A Trunc expression.

  209. def Trunc(num: Expr): Expr

    A Trunc expression.

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

    A Union set.

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

    An Update expression.

  212. def UpperCase(term: Expr): Expr

    A UpperCase expression

  213. def Var(name: String): Expr

    A Var expression.

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

  215. implicit def intToPath(int: Int): Path
  216. implicit def pathToExpr(path: Path): Expr
  217. implicit def strToPath(str: String): Path
  218. object Action
  219. object Cursor
  220. object Expr extends Serializable
  221. object NoCursor extends Cursor with Product with Serializable
  222. object Normalizer
  223. object TimeUnit

Deprecated Value Members

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

    A Class expression.

    Annotations
    @deprecated
    Deprecated

    use Collection instead

  2. def Class(name: Expr): Expr

    A Class expression.

    Annotations
    @deprecated
    Deprecated

    use Collection instead

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

    Native reference to all classes

    Native reference to all classes

    Annotations
    @deprecated
    Deprecated

    use Collections instead

  4. def CreateClass(params: Expr): Expr

    A Create Class expression.

    Annotations
    @deprecated
    Deprecated

    use CreateCollection instead

  5. def NextId(): Expr

    A Next Id expression.

    Annotations
    @deprecated
    Deprecated

    use NewId instead

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

    A SelectAll expression.

    Annotations
    @deprecated
    Deprecated

    use SelectAsIndex instead

Inherited from AnyRef

Inherited from Any

Ungrouped