Class QueryOptions

Represents the options for configuring query behavior in the client.

Inheritance

object

QueryOptions

Implements

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: InfluxDB3.Client.Config

Assembly: InfluxDB3.Client.dll

Syntax

public class QueryOptions : ICloneable

Properties

CompressionProviders

Gets or sets the collection of compression providers used for gRPC message compression.

Declaration

public IList<ICompressionProvider>? CompressionProviders { get; set; }

Property Value

Type	Description
IList<ICompressionProvider>

Remarks

This property specifies the list of compression algorithms available for compressing gRPC messages. The value is represented as a nullable list of ICompressionProvider. If set to null, Gzip will be used

Deadline

Gets or sets the optional deadline for query execution.

Declaration

public DateTime? Deadline { get; set; }

Property Value

Type	Description
DateTime?

Remarks

This property specifies the maximum time allowed for query execution before a timeout. If set to null, no deadline is applied. The value is represented as a nullable DateTime.

MaxReceiveMessageSize

Gets or sets the maximum size, in bytes, of a single message that can be received.

Declaration

public int? MaxReceiveMessageSize { get; set; }

Property Value

Type	Description
int?

Remarks

This property defines an optional limit for the size of incoming messages to avoid excessive memory allocation. A value of null specifies that no maximum size is enforced. The default value is 4,194,304 bytes (4 MB).

MaxSendMessageSize

Gets or sets the maximum size of a message that can be sent.

Declaration

public int? MaxSendMessageSize { get; set; }

Property Value

Type	Description
int?

Remarks

This property defines the maximum allowable size, in bytes, for messages sent by the client. If set to null, there is no limit on the size of the sent messages.

Methods

Clone()

Creates a shallow copy of the current QueryOptions instance.

Declaration

public object Clone()

Returns

Type	Description
object	A new object that is a shallow copy of the current QueryOptions instance.

Implements

ICloneable