Click or drag to resize
ProtocolOptions Class
Options of the Cassandra native binary protocol.
Inheritance Hierarchy
SystemObject
  CassandraProtocolOptions

Namespace: Cassandra
Assembly: Cassandra (in Cassandra.dll) Version: 3.7.0
Syntax
C#
Copy
public class ProtocolOptions

The ProtocolOptions type exposes the following members.

Constructors
  NameDescription
Public methodProtocolOptions
Creates a new ProtocolOptions instance using the DEFAULT_PORT.
Public methodProtocolOptions(Int32)
Creates a new ProtocolOptions instance using the provided port.
Public methodProtocolOptions(Int32, SSLOptions)
Creates a new ProtocolOptions instance using the provided port and SSL context.
Top
Methods
  NameDescription
Public methodSetCompression
Sets the compression to use.

Note that while this setting can be changed at any time, it will only apply to newly created connections.

Public methodSetCustomCompressor
Sets a custom compressor to be used for the compression type. If specified, the compression type is mandatory. If not specified the driver default compressor will be use for the compression type.
Public methodSetMaxProtocolVersion(Byte)
Sets the maximum protocol version to be used. When set, it limits the maximum protocol version used to connect to the nodes. Useful for using the driver against a cluster that contains nodes with different major/minor versions of Cassandra.
Public methodSetMaxProtocolVersion(ProtocolVersion)
Sets the maximum protocol version to be used. When set, it limits the maximum protocol version used to connect to the nodes. Useful for using the driver against a cluster that contains nodes with different major/minor versions of Cassandra.
Public methodSetMaxSchemaAgreementWaitSeconds
Sets the maximum time to wait for schema agreement before returning from a DDL query.
Public methodSetNoCompact
When set to true, it enables the NO_COMPACT startup option.

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 C* 3.0.16+, 3.11.2+, 4.0+ and DSE 6.0+.

Top
Fields
  NameDescription
Public fieldStatic memberDefaultPort
The default port for Cassandra native binary protocol: 9042.
Top
Properties
  NameDescription
Public propertyCompression
Returns the compression used by the protocol.

The default compression is Compression.SNAPPY.

Public propertyCustomCompressor
Gets the custom compressor specified to be used for the compression type.
Public propertyMaxProtocolVersion
Gets the maximum protocol version to be used. When set, it limits the maximum protocol version used to connect to the nodes. Useful for using the driver against a cluster that contains nodes with different major/minor versions of Cassandra.
Public propertyMaxSchemaAgreementWaitSeconds
Gets the maximum time to wait for schema agreement before returning from a DDL query.
Public propertyNoCompact
Determines whether NO_COMPACT is enabled as startup option.

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 C* 3.0.16+, 3.11.2+, 4.0+ and DSE 6.0+.

Public propertyPort
The port used to connect to the Cassandra hosts.
Public propertySslOptions
Specified SSL options used to connect to the Cassandra hosts.
Top
See Also