kotlin-client/com.couchbase.client.kotlin.query/QueryProfile

QueryProfile

@VolatileCouchbaseApi

enum QueryProfile : Enum<QueryProfile>

Controls how much query profiling information is included in the response metadata.

Access the returned info via QueryMetadata.profile.

Entries

OFF

No profiling information is added to the query response.

PHASES

The query response includes a profile section with stats and details about various phases of the query plan and execution.

TIMINGS

Besides the phase times, the profile section of the query response document will include a full query plan with timing and information about the number of processed documents at each phase.

Properties

entries

val entries: EnumEntries<QueryProfile>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

toString

open override fun toString(): String

valueOf

fun valueOf(value: String): QueryProfile

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<QueryProfile>

Returns an array containing the constants of this enum type, in the order they're declared.