Package

faunadb

query

Permalink

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

    Permalink

    Enumeration for event action types.

  2. case class After(expr: Expr) extends Cursor with Product with Serializable

    Permalink
  3. case class Before(expr: Expr) extends Cursor with Product with Serializable

    Permalink
  4. sealed trait Cursor extends AnyRef

    Permalink

    Helper for pagination cursors

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

    Permalink

    A query language expression.

  6. sealed abstract class Normalizer extends AnyRef

    Permalink

    Enumeration for casefold operation.

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

    Permalink

    Helper for path syntax

  8. class QueryMacros extends AnyRef

    Permalink
  9. sealed abstract class TimeUnit extends AnyRef

    Permalink

    Enumeration for time units.

Value Members

  1. def Abort(msg: Expr): Expr

    Permalink

    A Abort expression.

  2. def Abs(num: Expr): Expr

    Permalink

    An Abs expression.

  3. def Acos(num: Expr): Expr

    Permalink

    An Acos expression.

  4. object Action

    Permalink
  5. def Add(terms: Expr*): Expr

    Permalink

    An Add expression.

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

    Permalink

    An And expression.

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

    Permalink

    An Append expression.

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

    Permalink

    An Array value.

  9. def Asin(num: Expr): Expr

    Permalink

    An Asin expression.

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

    Permalink

    A At expression.

  11. def Atan(num: Expr): Expr

    Permalink

    An Atan expression.

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

    Permalink

    An BitAnd expression.

  13. def BitNot(num: Expr): Expr

    Permalink

    A BitNot expression.

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

    Permalink

    An BitOr expression.

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

    Permalink

    An BitXor expression.

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

    Permalink

    A Call expression.

  17. def Casefold(term: Expr, normalizer: Expr): Expr

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

    Permalink
  19. def Casefold(term: Expr): Expr

    Permalink

    A Casefold expression.

  20. def Ceil(num: Expr): Expr

    Permalink

    A Ceil expression.

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

    Permalink

    A Collection expression.

  22. def Collection(name: Expr): Expr

    Permalink

    A Collection expression.

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

    Permalink

    Native reference to all classes

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

    Permalink
  25. def Concat(term: Expr): Expr

    Permalink

    A Concat expression.

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

    Permalink

    A Contains expression.

  27. def Cos(num: Expr): Expr

    Permalink

    A Cos expression.

  28. def Cosh(num: Expr): Expr

    Permalink

    A Cosh expression.

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

    Permalink

    A Create expression.

  30. def CreateCollection(params: Expr): Expr

    Permalink

    A Create Collection expression.

  31. def CreateDatabase(params: Expr): Expr

    Permalink

    A Create Database expression.

  32. def CreateFunction(params: Expr): Expr

    Permalink

    A Create Function expression.

  33. def CreateIndex(params: Expr): Expr

    Permalink

    A Create Index expression.

  34. def CreateKey(params: Expr): Expr

    Permalink

    A Create Key expression.

  35. def CreateRole(params: Expr): Expr

    Permalink

    A Create Role expression.

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

    Permalink

    Native reference to all credentials

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

    Permalink

    A Database expression.

  38. def Database(name: Expr): Expr

    Permalink

    A Database expression.

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

    Permalink

    Native reference to all databases

  40. def Date(str: Expr): Expr

    Permalink

    A Date expression.

  41. def DayOfMonth(term: Expr): Expr

    Permalink

    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

  42. def DayOfWeek(term: Expr): Expr

    Permalink

    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

  43. def DayOfYear(term: Expr): Expr

    Permalink

    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

  44. def Degrees(num: Expr): Expr

    Permalink

    A Degrees expression.

  45. def Delete(ref: Expr): Expr

    Permalink

    A Delete expression.

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

    Permalink

    A Difference set.

  47. def Distinct(set: Expr): Expr

    Permalink

    A Distinct set.

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

    Permalink

    A Divide expression.

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

    Permalink

    A Do expression.

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

    Permalink

    A Drop expression.

  51. def Epoch(num: Expr, unit: Expr): Expr

    Permalink
  52. def Epoch(num: Expr, unit: TimeUnit): Expr

    Permalink

    An Epoch expression.

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

    Permalink

    An Equals expression.

  54. def Events(refSet: Expr): Expr

    Permalink

    A Events set.

  55. def Exists(ref: Expr, ts: Expr): Expr

    Permalink
  56. def Exists(ref: Expr): Expr

    Permalink

    An Exists expression.

  57. def Exp(num: Expr): Expr

    Permalink

    An Exp expression.

  58. object Expr extends Serializable

    Permalink
  59. def Filter(collection: Expr, lambda: Expr): Expr

    Permalink

    A Filter expression.

  60. def FindStr(value: Expr, find: Expr, start: Expr): Expr

    Permalink
  61. def FindStr(value: Expr, find: Expr): Expr

    Permalink

    A FindStr expression

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

    Permalink

    A FindStrRegex expression

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

    Permalink

    A FindStrRegex expression

  64. def Floor(num: Expr): Expr

    Permalink

    A Floor expression.

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

    Permalink

    A Foreach expression.

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

    Permalink

    A Format expression

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

    Permalink

    A Function expression.

  68. def Function(name: Expr): Expr

    Permalink

    A Function expression.

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

    Permalink

    Native reference to all functions

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

    Permalink

    A GT expression.

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

    Permalink

    A GTE expression.

  72. def Get(resource: Expr, ts: Expr): Expr

    Permalink
  73. def Get(resource: Expr): Expr

    Permalink

    A Get expression.

  74. def HasIdentity(): Expr

    Permalink

    An HasIdentity expression.

  75. def Hour(term: Expr): Expr

    Permalink

    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

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

    Permalink

    A Hypot expression.

  77. def Hypot(num: Expr): Expr

    Permalink

    A Hypot expression.

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

    Permalink

    An Identify expression.

  79. def Identity(): Expr

    Permalink

    An Identity expression.

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

    Permalink

    An If expression.

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

    Permalink

    An Index expression.

  82. def Index(name: Expr): Expr

    Permalink

    An Index expression.

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

    Permalink

    Native reference to all indexes

  84. def Insert(ref: Expr, ts: Expr, action: Expr, params: Expr): Expr

    Permalink
  85. def Insert(ref: Expr, ts: Expr, action: Action, params: Expr): Expr

    Permalink

    An Insert expression.

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

    Permalink

    An Intersection set.

  87. def IsEmpty(collection: Expr): Expr

    Permalink

    A IsEmpty expression.

  88. def IsNonEmpty(collection: Expr): Expr

    Permalink

    A IsNonEmpty expression.

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

    Permalink

    A Join set.

  90. def KeyFromSecret(secret: Expr): Expr

    Permalink

    A KeyFromSecret expression.

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

    Permalink

    Native reference to all keys

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

    Permalink

    A LT expression.

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

    Permalink

    A LTE expression.

  94. def LTrim(value: Expr): Expr

    Permalink

    A LTrim expression

  95. def Lambda(lambda: Expr, expr: Expr): Expr

    Permalink
  96. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  97. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  98. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  99. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  100. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  101. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  102. macro def Lambda(fn: (Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  103. macro def Lambda(fn: (Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  104. macro def Lambda(fn: (Expr, Expr) ⇒ Expr): Expr

    Permalink
  105. macro def Lambda(fn: (Expr) ⇒ Expr): Expr

    Permalink

    A Lambda expression.

  106. def Length(value: Expr): Expr

    Permalink

    A Length expression

  107. def Let(bindings: Seq[(String, Expr)], in: Expr): Expr

    Permalink
  108. macro def Let(block: ⇒ Any): Expr

    Permalink

    A Let expression.

  109. def Ln(num: Expr): Expr

    Permalink

    A ln expression.

  110. def Log(num: Expr): Expr

    Permalink

    A Log expression.

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

    Permalink

    A Login expression.

  112. def Logout(invalidateAll: Expr): Expr

    Permalink

    A Logout expression.

  113. def LowerCase(value: Expr): Expr

    Permalink

    A LowerCase expression

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

    Permalink

    A Map expression.

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

    Permalink

    A Match set.

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

    Permalink

    A Max expression.

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

    Permalink

    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

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

    Permalink

    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

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

    Permalink

    A Min expression.

  120. def Minute(term: Expr): Expr

    Permalink

    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

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

    Permalink

    A Modulo expression.

  122. def Month(term: Expr): Expr

    Permalink

    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

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

    Permalink

    A Multiply expression.

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

    Permalink

    A NGram expression.

  125. def NewId(): Expr

    Permalink

    A New Id expression.

  126. object NoCursor extends Cursor with Product with Serializable

    Permalink
  127. object Normalizer

    Permalink
  128. def Not(term: Expr): Expr

    Permalink

    A Not expression.

  129. def Null(): Expr

    Permalink

    A Null value.

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

    Permalink

    An Object value.

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

    Permalink

    An Or expression.

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

    Permalink

    A Paginate expression.

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

    Permalink

    A Pow expression.

  134. def Pow(num: Expr): Expr

    Permalink

    A Pow expression.

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

    Permalink

    A Prepend expression.

  136. def Query(lambda: Expr): Expr

    Permalink
  137. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  138. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  139. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  140. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  141. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  142. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  143. macro def Query(fn: (Expr, Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  144. macro def Query(fn: (Expr, Expr, Expr) ⇒ Expr): Expr

    Permalink
  145. macro def Query(fn: (Expr, Expr) ⇒ Expr): Expr

    Permalink
  146. macro def Query(fn: (Expr) ⇒ Expr): Expr

    Permalink

    A Query expression.

  147. def RTrim(value: Expr): Expr

    Permalink

    A RTrim expression

  148. def Radians(num: Expr): Expr

    Permalink

    A Radians expression.

  149. def Ref(collectionRef: Expr, id: Expr): Expr

    Permalink
  150. def Ref(value: String): Expr

    Permalink

    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

  151. def Remove(ref: Expr, ts: Expr, action: Expr): Expr

    Permalink
  152. def Remove(ref: Expr, ts: Expr, action: Action): Expr

    Permalink

    A Remove expression.

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

    Permalink

    A Repeat expression

  154. def Repeat(value: Expr): Expr

    Permalink

    A Repeat expression

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

    Permalink

    A Replace expression.

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

    Permalink

    A ReplaceStr expression

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

    Permalink

    A ReplaceStrRegex expression

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

    Permalink

    A ReplaceStrRegex expression

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

    Permalink

    A Role expression.

  160. def Role(name: Expr): Expr

    Permalink

    A Role expression.

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

    Permalink

    Native reference to all roles

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

    Permalink

    A Round expression.

  163. def Round(num: Expr): Expr

    Permalink

    A Round expression.

  164. def Second(term: Expr): Expr

    Permalink

    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

  165. def Select(path: Expr, from: Expr, default: Expr): Expr

    Permalink
  166. def Select(path: Expr, from: Expr): Expr

    Permalink

    A Select expression.

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

    Permalink

    A SelectAll expression.

  168. def Sign(num: Expr): Expr

    Permalink

    A sign expression.

  169. def Sin(num: Expr): Expr

    Permalink

    A sin expression.

  170. def Singleton(ref: Expr): Expr

    Permalink

    A Singleton set.

  171. def Sinh(num: Expr): Expr

    Permalink

    A sinh expression.

  172. def Space(value: Expr): Expr

    Permalink

    A Space expression

  173. def Sqrt(num: Expr): Expr

    Permalink

    A sqrt expression.

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

    Permalink

    A SubString expression

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

    Permalink

    A SubString expression

  176. def SubString(value: Expr): Expr

    Permalink

    A SubString expression

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

    Permalink

    A Subtract expression.

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

    Permalink

    A Take expression.

  179. def Tan(num: Expr): Expr

    Permalink

    A Tan expression.

  180. def Tanh(num: Expr): Expr

    Permalink

    A Tanh expression.

  181. def Time(str: Expr): Expr

    Permalink

    A Time expression.

  182. object TimeUnit

    Permalink
  183. def TitleCase(value: Expr): Expr

    Permalink

    A TitleCase expression

  184. def ToDate(term: Expr): Expr

    Permalink

    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

  185. def ToMicros(term: Expr): Expr

    Permalink

    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

  186. def ToMillis(term: Expr): Expr

    Permalink

    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

  187. def ToNumber(term: Expr): Expr

    Permalink

    Casts an expression to a numeric value, if possible.

  188. def ToSeconds(term: Expr): Expr

    Permalink

    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

  189. def ToString(term: Expr): Expr

    Permalink

    Casts an expression to a string value, if possible.

  190. def ToTime(term: Expr): Expr

    Permalink

    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

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

    Permalink

    Native reference to all tokens

  192. def Trim(term: Expr): Expr

    Permalink

    A Trim expression

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

    Permalink

    A Trunc expression.

  194. def Trunc(num: Expr): Expr

    Permalink

    A Trunc expression.

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

    Permalink

    A Union set.

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

    Permalink

    An Update expression.

  197. def UpperCase(term: Expr): Expr

    Permalink

    A UpperCase expression

  198. def Var(name: String): Expr

    Permalink

    A Var expression.

  199. def Year(term: Expr): Expr

    Permalink

    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

  200. implicit def intToPath(int: Int): Path

    Permalink
  201. implicit def pathToExpr(path: Path): Expr

    Permalink
  202. implicit def strToPath(str: String): Path

    Permalink

Deprecated Value Members

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

    Permalink

    A Class expression.

    Annotations
    @deprecated
    Deprecated

    use Collection instead

  2. def Class(name: Expr): Expr

    Permalink

    A Class expression.

    Annotations
    @deprecated
    Deprecated

    use Collection instead

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

    Permalink

    Native reference to all classes

    Native reference to all classes

    Annotations
    @deprecated
    Deprecated

    use Collections instead

  4. def CreateClass(params: Expr): Expr

    Permalink

    A Create Class expression.

    Annotations
    @deprecated
    Deprecated

    use CreateCollection instead

  5. def NextId(): Expr

    Permalink

    A Next Id expression.

    Annotations
    @deprecated
    Deprecated

    use NewId instead

Inherited from AnyRef

Inherited from Any

Ungrouped