package query
- Alphabetic
- Public
- Protected
Type Members
- case class QueryMetaData(requestId: String, clientContextId: String, _signatureContent: Option[Array[Byte]], metrics: Option[QueryMetrics], warnings: Seq[QueryWarning], status: QueryStatus, _profileContent: Option[Array[Byte]]) extends Product with Serializable
Additional information returned by the query service aside from any rows and errors.
Additional information returned by the query service aside from any rows and errors.
- requestId
the request identifier string of the query request
- clientContextId
the client context id passed into com.couchbase.client.scala.query.QueryOptions
- metrics
metrics related to the query request, if they were enabled in com.couchbase.client.scala.query.QueryOptions
- warnings
any warnings returned from the query service
- status
the status returned from the query service
- case class QueryMetrics(elapsedTime: Duration, executionTime: Duration, resultCount: Long, resultSize: Long, mutationCount: Long, sortCount: Long, errorCount: Long, warningCount: Long) extends Product with Serializable
Metrics of a given query request.
Metrics of a given query request.
- elapsedTime
the total time taken for the request, that is the time from when the request was received until the results were returned.
- executionTime
the time taken for the execution of the request, that is the time from when query execution started until the results were returned.
- resultCount
the total number of results selected by the engine before restriction through LIMIT clause.
- resultSize
the total number of returned rows.
- mutationCount
the number of mutations that were made during the request.
- sortCount
the total number of results selected by the engine before restriction through LIMIT clause.
- errorCount
the number of errors that occurred during the request.
- warningCount
the number of warnings that occurred during the request.
- case class QueryOptions(parameters: Option[QueryParameters] = None, clientContextId: Option[String] = None, maxParallelism: Option[Int] = None, metrics: Boolean = false, pipelineBatch: Option[Int] = None, pipelineCap: Option[Int] = None, profile: Option[QueryProfile] = None, readonly: Option[Boolean] = None, retryStrategy: Option[RetryStrategy] = None, scanCap: Option[Int] = None, scanConsistency: Option[QueryScanConsistency] = None, consistentWith: Option[Seq[MutationToken]] = None, timeout: Option[Duration] = None, adhoc: Boolean = true, deferredException: Option[RuntimeException] = None, parentSpan: Option[RequestSpan] = None, raw: Option[Map[String, Any]] = None, flexIndex: Boolean = false, preserveExpiry: Option[Boolean] = None, useReplica: Option[Boolean] = None) extends Product with Serializable
Customize the execution of a N1QL query.
Customize the execution of a N1QL query.
- Since
1.0.0
- sealed trait QueryParameters extends AnyRef
- sealed trait QueryProfile extends AnyRef
- case class QueryResult(rows: Seq[QueryChunkRow], metaData: QueryMetaData) extends Product with Serializable
The results of a N1QL query.
The results of a N1QL query.
- rows
all rows returned from the query
- metaData
any additional information related to the query
- sealed trait QueryScanConsistency extends AnyRef
Provides some control over what consistency is required for a given query.
- sealed trait QueryStatus extends AnyRef
- case class QueryWarning(code: Int, message: String) extends Product with Serializable
A warning returned from the query service.
- case class ReactiveQueryResult(rows: SFlux[QueryChunkRow], metaData: SMono[QueryMetaData]) extends Product with Serializable
The results of a N1QL query, as returned by the reactive API.
The results of a N1QL query, as returned by the reactive API.
- metaData
any additional information related to the query
Value Members
- object QueryOptions extends Serializable
- object QueryParameters
- object QueryProfile
- object QueryScanConsistency
- object QueryStatus