DseClusterBuilder Class

An optional configuration identifying the name of the application using this cluster instance.

An optional configuration identifying the version of the application using this cluster instance.

Use this method when a custom authentication scheme is in place. You shouldn't call both this method and {@code withCredentials}' on the same Builder instance as one will supersede the other

Configures a DseCluster using the Cloud Secure Connection Bundle. Using this method will configure this builder with specific contact points, SSL options, credentials and load balancing policy. When needed, you can specify custom settings by calling other builder methods.

In case you need to specify a different set of credentials from the one in the bundle, here is an example:

DseCluster.Builder()
          .WithCloudSecureConnectionBundle("/path/to/bundle.zip")
          .WithCredentials("username", "password")
          .Build();

Build will throw InvalidOperationException when an error occurs that is not related to connectivity and NoHostAvailableException when an error occurs while trying to obtain the cluster metadata from the remote endpoint.

An optional configuration for providing a unique identifier for the created cluster instance.

This value is passed to DSE and is useful as metadata for describing a client connection.

This should be used if the Cassandra cluster has been configured to use the PasswordAuthenticator. If the the default * AllowAllAuthenticator is used instead, using this method has no effect.

Adds Execution Profiles to the DseCluster instance.

Execution profiles are like configuration presets, multiple methods of the driver accept an execution profile name which is like telling the driver which settings to use for that particular request. This makes it easier to change settings like ConsistencyLevel and ReadTimeoutMillis on a per request basis.

Note that subsequent calls to this method will override the previously provided profiles.

To add execution profiles you can use WithProfile(String, ActionIExecutionProfileBuilder):

DseCluster.Builder()
        .WithExecutionProfiles(options => options
            .WithProfile("profile1", profileBuilder => profileBuilder
                .WithReadTimeoutMillis(10000)
                .WithConsistencyLevel(ConsistencyLevel.LocalQuorum))
            .WithProfile("profile-graph", profileBuilder => profileBuilder
                .WithReadTimeoutMillis(10000)
                .WithGraphOptions(new GraphOptions().SetName("name"))))
        .Build();

If no load balancing policy is set through this method, DseLoadBalancingPolicy will be used instead.

To specify the local datacenter, use the following method CreateDefault(String) to create an instance of the default policy with a specific local datacenter.

Limits the maximum protocol version used to connect to the nodes, when it is not set protocol version used between the driver and the Cassandra cluster is negotiated upon establishing the first connection.

Useful for using the driver against a cluster that contains nodes with different major/minor versions of Cassandra. For example, preparing for a rolling upgrade of the Cluster.

DDL queries introduce schema changes that need to be propagated to all nodes in the cluster. Once they have settled on a common version, we say that they are in agreement.

If not set through this method, the default value (10 seconds) will be used.

If not set through this method, the default value options will be used (metadata synchronization is enabled by default). The api reference of MetadataSyncOptions specifies what is the default for each option.

In case you disable Metadata synchronization, please ensure you invoke RefreshSchemaAsync(String, String) in order to keep the token metadata up to date otherwise you will not be getting everything you can out of token aware routing, i.e. TokenAwarePolicy, which is used by DseLoadBalancingPolicy and is the default.

Disabling this feature has the following impact:

• Token metadata will not be computed and stored. This means that token aware routing (TokenAwarePolicy, which is used by DseLoadBalancingPolicy and is the default) will only work correctly if you keep the token metadata up to date using the RefreshSchemaAsync(String, String) method. If you wish to go this route of manually refreshing the metadata then it's recommended to refresh only the keyspaces that this application will use, by passing the
  Copy

  keyspace

  parameter.
• Keyspace metadata will not be cached by the driver. Every time you call methods like GetTable(String, String), GetKeyspace(String) and other similar methods of the Metadata class, the driver will query that data on demand and will not cache it.
• The driver will not handle
  Copy

  SCHEMA_CHANGED

  responses. This means that when you execute schema changing statements through the driver, it will not update the schema or topology metadata automatically before returning.

Enables metrics. DataStax provides an implementation based on a third party library (App.Metrics) on a separate NuGet package: Dse.AppMetrics Alternatively, you can implement your own provider that implements IDriverMetricsProvider.

This method enables all individual metrics without a bucket prefix. To customize these options, use WithMetrics(IDriverMetricsProvider, DriverMetricsOptions).

Enables metrics. DataStax provides an implementation based on a third party library (App.Metrics) on a separate NuGet package: Dse.AppMetrics Alternatively, you can implement your own provider that implements IDriverMetricsProvider.

This method enables all individual metrics without a bucket prefix. To customize these settings, use WithMetrics(IDriverMetricsProvider, DriverMetricsOptions). For explanations on these settings, see the API docs of the DriverMetricsOptions class.

The AppMetrics provider also has some settings that can be customized, check out the API docs of Dse.AppMetrics.DriverAppMetricsOptions.

Here is an example:

var cluster = 
    DseCluster.Builder()
           .WithMetrics(
               metrics.CreateDriverMetricsProvider(new DriverAppMetricsOptions()),
               new DriverMetricsOptions()
                   .SetEnabledNodeMetrics(NodeMetric.DefaultNodeMetrics.Except(new [] { NodeMetric.Meters.BytesSent }))
                   .SetEnabledSessionMetrics(
                       SessionMetric.DefaultSessionMetrics.Except(new[] { SessionMetric.Meters.BytesReceived }))
                   .SetBucketPrefix("web.app"))
           .Build();

When this option is set, SELECT, UPDATE, DELETE, and BATCH statements on COMPACT STORAGE tables function in "compatibility" mode which allows seeing these tables as if they were "regular" CQL tables.

This option only affects interactions with tables using COMPACT STORAGE and it is only supported by DSE 5.1 and 6.0+.

This will cause that synchronous operations like Execute(String) to throw a TimeoutException after the specified number of milliseconds.

20,000

If no reconnection policy is set through this method, Policies.DefaultReconnectionPolicy will be used instead.

If no retry policy is set through this method, IdempotenceAwareRetryPolicy will be used instead.

If no speculative execution policy is set through this method, DefaultSpeculativeExecutionPolicy will be used instead.

This feature is only available with protocol version 3 or above of the native protocol. With earlier versions, timestamps are always generated server-side, and setting a generator through this method will have no effect.

If no generator is set through this method, the driver will default to client-side timestamps by using AtomicMonotonicTimestampGenerator.