Class MetadataSyncOptions

See the api reference for WithMetadataSyncOptions(MetadataSyncOptions) for an explanation of the Metadata synchronization feature. See the api reference for the properties of this class in order to know what the default values are.

Inheritance

System.Object

MetadataSyncOptions

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Dse

Assembly: Dse.dll

Syntax

public class MetadataSyncOptions

Properties

MaxTotalRefreshSchemaDelay

Use SetMaxTotalRefreshSchemaDelay(Int64) to set this value. The default value is

10000

. Also check the api reference for SetMaxTotalRefreshSchemaDelay(Int64) for a more thorough explanation.

Declaration

public long MaxTotalRefreshSchemaDelay { get; }

Property Value

Type	Description
System.Int64

MetadataSyncEnabled

Use SetMetadataSyncEnabled(Boolean) to set this value. The default value is

true

. Also check the api reference for WithMetadataSyncOptions(MetadataSyncOptions) for a more thorough explanation.

Declaration

public bool MetadataSyncEnabled { get; }

Property Value

Type	Description
System.Boolean

RefreshSchemaDelayIncrement

Use SetRefreshSchemaDelayIncrement(Int64) to set this value. The default value is

1000

. Also check the api reference for SetRefreshSchemaDelayIncrement(Int64) for a more thorough explanation.

Declaration

public long RefreshSchemaDelayIncrement { get; }

Property Value

Type	Description
System.Int64

Methods

SetMaxTotalRefreshSchemaDelay(Int64)

The default value is

10000

.

The driver will never wait more than maxTotalRefreshSchemaDelay milliseconds until a schema or topology refresh event is processed even if events keep being scheduled for processing.

Declaration

public MetadataSyncOptions SetMaxTotalRefreshSchemaDelay(long maxTotalRefreshSchemaDelay)

Parameters

Type	Name	Description
System.Int64	maxTotalRefreshSchemaDelay

Returns

Type	Description
MetadataSyncOptions

SetMetadataSyncEnabled(Boolean)

The default value is

true

.

Enables or disables the Metadata synchronization feature of the driver. See the api reference for WithMetadataSyncOptions(MetadataSyncOptions) for a more thorough explanation.

Declaration

public MetadataSyncOptions SetMetadataSyncEnabled(bool metadataSyncEnabled)

Parameters

Type	Name	Description
System.Boolean	metadataSyncEnabled

Returns

Type	Description
MetadataSyncOptions

SetRefreshSchemaDelayIncrement(Int64)

The default value is

1000

.

The driver will wait refreshSchemaDelayIncrement milliseconds until it processes a schema or topology refresh event. If another event gets scheduled to be processed within this interval, then the driver will cancel the first execution and will wait another refreshSchemaDelayIncrement milliseconds until it processes both events. As long as events keep coming in, then the driver will keep postponing the execution up until MaxTotalRefreshSchemaDelay milliseconds have passed since the first unprocessed event was scheduled.

Declaration

public MetadataSyncOptions SetRefreshSchemaDelayIncrement(long refreshSchemaDelayIncrement)

Parameters

Type	Name	Description
System.Int64	refreshSchemaDelayIncrement

Returns

Type	Description
MetadataSyncOptions