Class QueryOptions.ReadOnlyRecord

Inheritance
object
QueryOptions.ReadOnlyRecord
Implements
Inherited Members
Namespace: Couchbase.Query
Assembly: Couchbase.NetClient.dll
Syntax
public record QueryOptions.ReadOnlyRecord : IEquatable<QueryOptions.ReadOnlyRecord>

Constructors

View Source

ReadOnlyRecord(ReadOnlyRecord)

Declaration
protected ReadOnlyRecord(QueryOptions.ReadOnlyRecord original)
Parameters
Type Name Description
QueryOptions.ReadOnlyRecord original
View Source

ReadOnlyRecord(IReadOnlyList<object?>, IReadOnlyDictionary<string, object>, IReadOnlyDictionary<string, object>, bool, bool?, int?, int?, int?, QueryPlan?, QueryProfile, bool?, int?, QueryScanConsistency, TimeSpan?, string?, TimeSpan?, bool, bool, bool, string?, string?, IRequestSpan?, IRetryStrategy?, CancellationToken, Uri?, bool, bool, string?, ITypeSerializer?, string?, bool?)

Declaration
public ReadOnlyRecord(IReadOnlyList<object?> Arguments, IReadOnlyDictionary<string, object> Parameters, IReadOnlyDictionary<string, object> RawParameters, bool AutoExecute, bool? IncludeMetrics, int? MaxServerParallelism, int? PipelineBatch, int? PipelineCapacity, QueryPlan? PreparedPayload, QueryProfile Profile, bool? ReadOnly, int? ScanCapacity, QueryScanConsistency ScanConsistency, TimeSpan? ScanWait, string? Statement, TimeSpan? TimeOut, bool FlexIndex, bool IsUsed, bool PreserveExpiry, string? BucketName, string? ScopeName, IRequestSpan? RequestSpan, IRetryStrategy? RetryStrategy, CancellationToken Token, Uri? LastDispatchedNode, bool IsPrepared, bool IsAdHoc, string? CurrentContextId, ITypeSerializer? Serializer, string? QueryContext, bool? UseReplica)
Parameters
Type Name Description
IReadOnlyList<object> Arguments
IReadOnlyDictionary<string, object> Parameters
IReadOnlyDictionary<string, object> RawParameters
bool AutoExecute
bool? IncludeMetrics
int? MaxServerParallelism
int? PipelineBatch
int? PipelineCapacity
QueryPlan PreparedPayload
QueryProfile Profile
bool? ReadOnly
int? ScanCapacity
QueryScanConsistency ScanConsistency
TimeSpan? ScanWait
string Statement
TimeSpan? TimeOut
bool FlexIndex
bool IsUsed
bool PreserveExpiry
string BucketName
string ScopeName
IRequestSpan RequestSpan
IRetryStrategy RetryStrategy
CancellationToken Token
Uri LastDispatchedNode
bool IsPrepared
bool IsAdHoc
string CurrentContextId
ITypeSerializer Serializer
string QueryContext
bool? UseReplica

Properties

View Source

Arguments

Declaration
public IReadOnlyList<object?> Arguments { get; init; }
Property Value
Type Description
IReadOnlyList<object>
View Source

AutoExecute

Declaration
public bool AutoExecute { get; init; }
Property Value
Type Description
bool
View Source

BucketName

Declaration
public string? BucketName { get; init; }
Property Value
Type Description
string
View Source

CurrentContextId

Declaration
public string? CurrentContextId { get; init; }
Property Value
Type Description
string
View Source

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type
View Source

FlexIndex

Declaration
public bool FlexIndex { get; init; }
Property Value
Type Description
bool
View Source

IncludeMetrics

Declaration
public bool? IncludeMetrics { get; init; }
Property Value
Type Description
bool?
View Source

IsAdHoc

Declaration
public bool IsAdHoc { get; init; }
Property Value
Type Description
bool
View Source

IsPrepared

Declaration
public bool IsPrepared { get; init; }
Property Value
Type Description
bool
View Source

IsUsed

Declaration
public bool IsUsed { get; init; }
Property Value
Type Description
bool
View Source

LastDispatchedNode

Declaration
public Uri? LastDispatchedNode { get; init; }
Property Value
Type Description
Uri
View Source

MaxServerParallelism

Declaration
public int? MaxServerParallelism { get; init; }
Property Value
Type Description
int?
View Source

Parameters

Declaration
public IReadOnlyDictionary<string, object> Parameters { get; init; }
Property Value
Type Description
IReadOnlyDictionary<string, object>
View Source

PipelineBatch

Declaration
public int? PipelineBatch { get; init; }
Property Value
Type Description
int?
View Source

PipelineCapacity

Declaration
public int? PipelineCapacity { get; init; }
Property Value
Type Description
int?
View Source

PreparedPayload

Declaration
public QueryPlan? PreparedPayload { get; init; }
Property Value
Type Description
QueryPlan
View Source

PreserveExpiry

Declaration
public bool PreserveExpiry { get; init; }
Property Value
Type Description
bool
View Source

Profile

Declaration
public QueryProfile Profile { get; init; }
Property Value
Type Description
QueryProfile
View Source

QueryContext

Declaration
public string? QueryContext { get; init; }
Property Value
Type Description
string
View Source

RawParameters

Declaration
public IReadOnlyDictionary<string, object> RawParameters { get; init; }
Property Value
Type Description
IReadOnlyDictionary<string, object>
View Source

ReadOnly

Declaration
public bool? ReadOnly { get; init; }
Property Value
Type Description
bool?
View Source

RequestSpan

Declaration
public IRequestSpan? RequestSpan { get; init; }
Property Value
Type Description
IRequestSpan
View Source

RetryStrategy

Declaration
public IRetryStrategy? RetryStrategy { get; init; }
Property Value
Type Description
IRetryStrategy
View Source

ScanCapacity

Declaration
public int? ScanCapacity { get; init; }
Property Value
Type Description
int?
View Source

ScanConsistency

Declaration
public QueryScanConsistency ScanConsistency { get; init; }
Property Value
Type Description
QueryScanConsistency
View Source

ScanWait

Declaration
public TimeSpan? ScanWait { get; init; }
Property Value
Type Description
TimeSpan?
View Source

ScopeName

Declaration
public string? ScopeName { get; init; }
Property Value
Type Description
string
View Source

Serializer

Declaration
public ITypeSerializer? Serializer { get; init; }
Property Value
Type Description
ITypeSerializer
View Source

Statement

Declaration
public string? Statement { get; init; }
Property Value
Type Description
string
View Source

TimeOut

Declaration
public TimeSpan? TimeOut { get; init; }
Property Value
Type Description
TimeSpan?
View Source

Token

Declaration
public CancellationToken Token { get; init; }
Property Value
Type Description
CancellationToken
View Source

UseReplica

Declaration
public bool? UseReplica { get; init; }
Property Value
Type Description
bool?

Methods

View Source

Deconstruct(out IReadOnlyList<object?>, out IReadOnlyDictionary<string, object>, out IReadOnlyDictionary<string, object>, out bool, out bool?, out int?, out int?, out int?, out QueryPlan?, out QueryProfile, out bool?, out int?, out QueryScanConsistency, out TimeSpan?, out string?, out TimeSpan?, out bool, out bool, out bool, out string?, out string?, out IRequestSpan?, out IRetryStrategy?, out CancellationToken, out Uri?, out bool, out bool, out string?, out ITypeSerializer?, out string?, out bool?)

Declaration
public void Deconstruct(out IReadOnlyList<object?> Arguments, out IReadOnlyDictionary<string, object> Parameters, out IReadOnlyDictionary<string, object> RawParameters, out bool AutoExecute, out bool? IncludeMetrics, out int? MaxServerParallelism, out int? PipelineBatch, out int? PipelineCapacity, out QueryPlan? PreparedPayload, out QueryProfile Profile, out bool? ReadOnly, out int? ScanCapacity, out QueryScanConsistency ScanConsistency, out TimeSpan? ScanWait, out string? Statement, out TimeSpan? TimeOut, out bool FlexIndex, out bool IsUsed, out bool PreserveExpiry, out string? BucketName, out string? ScopeName, out IRequestSpan? RequestSpan, out IRetryStrategy? RetryStrategy, out CancellationToken Token, out Uri? LastDispatchedNode, out bool IsPrepared, out bool IsAdHoc, out string? CurrentContextId, out ITypeSerializer? Serializer, out string? QueryContext, out bool? UseReplica)
Parameters
Type Name Description
IReadOnlyList<object> Arguments
IReadOnlyDictionary<string, object> Parameters
IReadOnlyDictionary<string, object> RawParameters
bool AutoExecute
bool? IncludeMetrics
int? MaxServerParallelism
int? PipelineBatch
int? PipelineCapacity
QueryPlan PreparedPayload
QueryProfile Profile
bool? ReadOnly
int? ScanCapacity
QueryScanConsistency ScanConsistency
TimeSpan? ScanWait
string Statement
TimeSpan? TimeOut
bool FlexIndex
bool IsUsed
bool PreserveExpiry
string BucketName
string ScopeName
IRequestSpan RequestSpan
IRetryStrategy RetryStrategy
CancellationToken Token
Uri LastDispatchedNode
bool IsPrepared
bool IsAdHoc
string CurrentContextId
ITypeSerializer Serializer
string QueryContext
bool? UseReplica
View Source

Equals(ReadOnlyRecord?)

Declaration
public virtual bool Equals(QueryOptions.ReadOnlyRecord? other)
Parameters
Type Name Description
QueryOptions.ReadOnlyRecord other
Returns
Type Description
bool
View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
View Source

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Operators

View Source

operator ==(ReadOnlyRecord?, ReadOnlyRecord?)

Declaration
public static bool operator ==(QueryOptions.ReadOnlyRecord? left, QueryOptions.ReadOnlyRecord? right)
Parameters
Type Name Description
QueryOptions.ReadOnlyRecord left
QueryOptions.ReadOnlyRecord right
Returns
Type Description
bool
View Source

operator !=(ReadOnlyRecord?, ReadOnlyRecord?)

Declaration
public static bool operator !=(QueryOptions.ReadOnlyRecord? left, QueryOptions.ReadOnlyRecord? right)
Parameters
Type Name Description
QueryOptions.ReadOnlyRecord left
QueryOptions.ReadOnlyRecord right
Returns
Type Description
bool

Implements