scarango-core
API
Generated with
scarango-core/com.outr.arango/com.outr.arango.query/Query

Query

com.outr.arango.query.Query
See theQuery companion class
object Query extends Query

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Query
trait Serializable
trait Product
trait Equals
trait Support
trait QueryPart
class Object
trait Matchable
class Any
Show all
Self type
Query.type

Members list

Type members

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def apply(query: String): Query
def apply(parts: List[QueryPart]): Query
def merge(queries: List[Query], separator: String): Query

Merges queries and renames overlapping argument names

Merges queries and renames overlapping argument names

Value parameters

queries

the list of queries to merge

separator

the separator string between each query

Attributes

Returns

merge quest

Inherited methods

def +(that: Query): Query

Attributes

Inherited from:
Query
def byName(key: String): Json

Attributes

Inherited from:
Query
def byValue(value: Json): String

Attributes

Inherited from:
Query
override def equals(obj: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Query -> Equals -> Any
Inherited from:
Query
def namedVariable(name: String, value: Json): Query

Attributes

Inherited from:
Query
def normalize: Query

Attributes

Inherited from:
Query
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def reverseLookup: Map[String, String]

Attributes

Inherited from:
Query
def static(value: String): Query

Attributes

Inherited from:
Query
override def toQueryPart: QueryPart

Attributes

Definition Classes
Inherited from:
Query
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Query -> Any
Inherited from:
Query
def variable(value: Json): Query

Attributes

Inherited from:
Query
def variables: Map[String, Json]

Attributes

Inherited from:
Query
def withAllowRetry(retry: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withBatchSize(batchSize: Int): T

Attributes

Inherited from:
QueryOptionsSupport
def withCache(cache: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withCount(count: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withFailOnWarning(fail: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withFillBlockCache(fill: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withFullCount(fullCount: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withIntermediateCommitCount(count: Long): T

Attributes

Inherited from:
QueryOptionsSupport
def withIntermediateCommitSize(size: Long): T

Attributes

Inherited from:
QueryOptionsSupport
def withMaxNumberOfPlans(plans: Int): T

Attributes

Inherited from:
QueryOptionsSupport
def withMaxRuntime(max: FiniteDuration): T

Attributes

Inherited from:
QueryOptionsSupport
def withMaxTransactionSize(max: Long): T

Attributes

Inherited from:
QueryOptionsSupport
def withMaxWarningCount(max: Int): T

Attributes

Inherited from:
QueryOptionsSupport
def withMemoryLimit(limit: Long): T

Attributes

Inherited from:
QueryOptionsSupport
override def withOptions(f: QueryOptions => QueryOptions): Query

Attributes

Definition Classes
Inherited from:
Query
def withPart(that: QueryPart): QueryPart

Attributes

Inherited from:
QueryPart
def withParts(parts: QueryPart*): Query

Attributes

Inherited from:
Query
def withPrefixParts(parts: QueryPart*): Query

Attributes

Inherited from:
Query
def withProfile(profile: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withQuery(that: Query): Query

Attributes

Inherited from:
Query
def withSatelliteSyncWait(wait: FiniteDuration): T

Attributes

Inherited from:
QueryOptionsSupport
def withSkipInaccessibleCollections(skip: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withStream(stream: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withTTL(ttl: FiniteDuration): T

Attributes

Inherited from:
QueryOptionsSupport

Inherited fields

lazy val compressed: String

Attributes

Inherited from:
Query
lazy val string: String

Attributes

Inherited from:
Query
Generated with