Class ContinuousQueryOptions

Namespace

Apache.Ignite.Table

Assembly

Apache.Ignite.dll

Continuous query options.

public sealed record ContinuousQueryOptions : IEquatable<ContinuousQueryOptions>

Inheritance

object

ContinuousQueryOptions

Implements

IEquatable<ContinuousQueryOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ContinuousQueryOptions()

Initializes a new instance of the ContinuousQueryOptions class.

public ContinuousQueryOptions()

ContinuousQueryOptions(IContinuousQueryWatermark?, ICollection<string>?, ICollection<TableRowEventType>?, int, TimeSpan, bool)

Continuous query options.

public ContinuousQueryOptions(IContinuousQueryWatermark? Watermark, ICollection<string>? ColumnNames, ICollection<TableRowEventType>? EventTypes, int PageSize, TimeSpan PollInterval, bool EnableEmptyBatches = false)

Parameters

Watermark IContinuousQueryWatermark

Starting watermark. When null, the query will start from the current time. Watermark can be obtained from physical time (FromInstant(Instant)) or from a previous event (GetWatermark()).

The default value is null, meaning the query will start from the current time.

ColumnNames ICollection<string>

Column names to include. When null, all columns are included.

By default, all columns are included.

EventTypes ICollection<TableRowEventType>

Event types to include. When null, all event types are included.

By default, all event types are included.

PageSize int

Per-partition page size.

Continuous Query polls every partition in a loop. This parameter controls the number of entries that will be requested from a single partition in one network call. Therefore, the maximum number of entries that the query may hold in memory at any given time is pageSize * partitions.

The default value is 1000.

PollInterval TimeSpan

Poll interval.

The default value is 1 second.

EnableEmptyBatches bool

When true, empty batches are returned when there are no new events to track watermark updates.

The default value is false, meaning that empty batches are not returned.

Fields

Default

Default continuous query options.

public static readonly ContinuousQueryOptions Default

Field Value

ContinuousQueryOptions

Properties

ColumnNames

Column names to include. When null, all columns are included.

By default, all columns are included.

public ICollection<string>? ColumnNames { get; init; }

Property Value

ICollection<string>

EnableEmptyBatches

When true, empty batches are returned when there are no new events to track watermark updates.

The default value is false, meaning that empty batches are not returned.

public bool EnableEmptyBatches { get; init; }

Property Value

bool

EventTypes

Event types to include. When null, all event types are included.

By default, all event types are included.

public ICollection<TableRowEventType>? EventTypes { get; init; }

Property Value

ICollection<TableRowEventType>

PageSize

Per-partition page size.

Continuous Query polls every partition in a loop. This parameter controls the number of entries that will be requested from a single partition in one network call. Therefore, the maximum number of entries that the query may hold in memory at any given time is pageSize * partitions.

The default value is 1000.

public int PageSize { get; init; }

Property Value

int

PollInterval

Poll interval.

The default value is 1 second.

public TimeSpan PollInterval { get; init; }

Property Value

TimeSpan

Watermark

Starting watermark. When null, the query will start from the current time. Watermark can be obtained from physical time (FromInstant(Instant)) or from a previous event (GetWatermark()).

The default value is null, meaning the query will start from the current time.

public IContinuousQueryWatermark? Watermark { get; init; }

Property Value

IContinuousQueryWatermark