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 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 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 CreateCollection(params: Expr): Expr

    A Create Collection 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 CreateRole(params: Expr): Expr

    A Create Role expression.

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

    Native reference to all credentials

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

    A Database expression.

  37. def Database(name: Expr): Expr

    A Database expression.

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

    Native reference to all databases

  39. def Date(str: Expr): Expr

    A Date expression.

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

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

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

  43. def Degrees(num: Expr): Expr

    A Degrees expression.

  44. def Delete(ref: Expr): Expr

    A Delete expression.

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

    A Difference set.

  46. def Distinct(set: Expr): Expr

    A Distinct set.

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

    A Divide expression.

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

    A Do expression.

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

    A Drop expression.

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

    An Epoch expression.

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

    An Equals expression.

  53. def Events(refSet: Expr): Expr

    A Events set.

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

    An Exists expression.

  56. def Exp(num: Expr): Expr

    An Exp expression.

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

    A Filter expression.

  58. def FindStr(value: Expr, find: Expr, start: Expr): Expr
  59. def FindStr(value: Expr, find: Expr): Expr

    A FindStr expression

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

    A FindStrRegex expression

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

    A FindStrRegex expression

  62. def Floor(num: Expr): Expr

    A Floor expression.

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

    A Foreach expression.

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

    A Format expression

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

    A Function expression.

  66. def Function(name: Expr): Expr

    A Function expression.

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

    Native reference to all functions

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

    A GT expression.

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

    A GTE expression.

  70. def Get(resource: Expr, ts: Expr): Expr
  71. def Get(resource: Expr): Expr

    A Get expression.

  72. def HasIdentity(): Expr

    An HasIdentity expression.

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

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

    A Hypot expression.

  75. def Hypot(num: Expr): Expr

    A Hypot expression.

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

    An Identify expression.

  77. def Identity(): Expr

    An Identity expression.

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

    An If expression.

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

    An Index expression.

  80. def Index(name: Expr): Expr

    An Index expression.

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

    Native reference to all indexes

  82. def Insert(ref: Expr, ts: Expr, action: Expr, params: Expr): Expr
  83. def Insert(ref: Expr, ts: Expr, action: Action, params: Expr): Expr

    An Insert expression.

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

    An Intersection set.

  85. def IsEmpty(collection: Expr): Expr

    A IsEmpty expression.

  86. def IsNonEmpty(collection: Expr): Expr

    A IsNonEmpty expression.

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

    A Join set.

  88. def KeyFromSecret(secret: Expr): Expr

    A KeyFromSecret expression.

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

    Native reference to all keys

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

    A LT expression.

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

    A LTE expression.

  92. def LTrim(value: Expr): Expr

    A LTrim expression

  93. def Lambda(lambda: Expr, expr: Expr): Expr
  94. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  95. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  96. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  97. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  98. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  99. macro def Lambda(fn: (Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  100. macro def Lambda(fn: (Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  101. macro def Lambda(fn: (Expr, Expr, Expr) ⇒ Expr): Expr
  102. macro def Lambda(fn: (Expr, Expr) ⇒ Expr): Expr
  103. macro def Lambda(fn: (Expr) ⇒ Expr): Expr

    A Lambda expression.

  104. def Length(value: Expr): Expr

    A Length expression

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

    A Let expression.

  107. def Ln(num: Expr): Expr

    A ln expression.

  108. def Log(num: Expr): Expr

    A Log expression.

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

    A Login expression.

  110. def Logout(invalidateAll: Expr): Expr

    A Logout expression.

  111. def LowerCase(value: Expr): Expr

    A LowerCase expression

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

    A Map expression.

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

    A Match set.

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

    A Max expression.

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

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

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

    A Min expression.

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

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

    A Modulo expression.

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

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

    A Multiply expression.

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

    A NGram expression.

  123. def NewId(): Expr

    A New Id expression.

  124. def Not(term: Expr): Expr

    A Not expression.

  125. def Null(): Expr

    A Null value.

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

    An Object value.

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

    An Or expression.

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

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

    A Pow expression.

  130. def Pow(num: Expr): Expr

    A Pow expression.

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

    A Prepend expression.

  132. def Query(lambda: Expr): Expr
  133. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  134. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  135. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  136. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  137. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  138. macro def Query(fn: (Expr, Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  139. macro def Query(fn: (Expr, Expr, Expr, Expr) ⇒ Expr): Expr
  140. macro def Query(fn: (Expr, Expr, Expr) ⇒ Expr): Expr
  141. macro def Query(fn: (Expr, Expr) ⇒ Expr): Expr
  142. macro def Query(fn: (Expr) ⇒ Expr): Expr

    A Query expression.

  143. def RTrim(value: Expr): Expr

    A RTrim expression

  144. def Radians(num: Expr): Expr

    A Radians expression.

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

  147. def Remove(ref: Expr, ts: Expr, action: Expr): Expr
  148. def Remove(ref: Expr, ts: Expr, action: Action): Expr

    A Remove expression.

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

    A Repeat expression

  150. def Repeat(value: Expr): Expr

    A Repeat expression

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

    A Replace expression.

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

    A ReplaceStr expression

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

    A ReplaceStrRegex expression

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

    A ReplaceStrRegex expression

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

    A Role expression.

  156. def Role(name: Expr): Expr

    A Role expression.

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

    Native reference to all roles

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

    A Round expression.

  159. def Round(num: Expr): Expr

    A Round expression.

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

  161. def Select(path: Expr, from: Expr, default: Expr): Expr
  162. def Select(path: Expr, from: Expr): Expr

    A Select expression.

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

    A SelectAll expression.

  164. def Sign(num: Expr): Expr

    A sign expression.

  165. def Sin(num: Expr): Expr

    A sin expression.

  166. def Singleton(ref: Expr): Expr

    A Singleton set.

  167. def Sinh(num: Expr): Expr

    A sinh expression.

  168. def Space(value: Expr): Expr

    A Space expression

  169. def Sqrt(num: Expr): Expr

    A sqrt expression.

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

    A SubString expression

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

    A SubString expression

  172. def SubString(value: Expr): Expr

    A SubString expression

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

    A Subtract expression.

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

    A Take expression.

  175. def Tan(num: Expr): Expr

    A Tan expression.

  176. def Tanh(num: Expr): Expr

    A Tanh expression.

  177. def Time(str: Expr): Expr

    A Time expression.

  178. def TitleCase(value: Expr): Expr

    A TitleCase expression

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

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

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

  182. def ToNumber(term: Expr): Expr

    Casts an expression to a numeric value, if possible.

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

  184. def ToString(term: Expr): Expr

    Casts an expression to a string value, if possible.

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

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

    Native reference to all tokens

  187. def Trim(term: Expr): Expr

    A Trim expression

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

    A Trunc expression.

  189. def Trunc(num: Expr): Expr

    A Trunc expression.

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

    A Union set.

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

    An Update expression.

  192. def UpperCase(term: Expr): Expr

    A UpperCase expression

  193. def Var(name: String): Expr

    A Var expression.

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

  195. implicit def intToPath(int: Int): Path
  196. implicit def pathToExpr(path: Path): Expr
  197. implicit def strToPath(str: String): Path
  198. object Action
  199. object Expr extends Serializable
  200. object NoCursor extends Cursor with Product with Serializable
  201. object Normalizer
  202. 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

Inherited from AnyRef

Inherited from Any

Ungrouped