ProtocolOptions Class |
Inheritance HierarchyDseProtocolOptions
Namespace: Dse
Assembly: Dse (in Dse.dll) Version: 2.9.0
Syntaxpublic class ProtocolOptions
The ProtocolOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ProtocolOptions |
Creates a new ProtocolOptions instance using the
DEFAULT_PORT.
|
| ProtocolOptions(Int32) |
Creates a new ProtocolOptions instance using the provided port.
|
| ProtocolOptions(Int32, SSLOptions) |
Creates a new ProtocolOptions instance using the provided port and SSL context.
|
Properties| Name | Description | |
|---|---|---|
 | Compression |
Returns the compression used by the protocol. The default compression is Compression.SNAPPY. |
| CustomCompressor |
Gets the custom compressor specified to be used for the compression type.
|
| MaxProtocolVersion |
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.
|
| MaxSchemaAgreementWaitSeconds |
Gets the maximum time to wait for schema agreement before returning from a DDL query.
|
| NoCompact |
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+. |
| Port |
The port used to connect to the Cassandra hosts.
|
| SslOptions |
Specified SSL options used to connect to the Cassandra hosts.
|
Methods| Name | Description | |
|---|---|---|
| SetCompression |
Sets the compression to use. Note that while this setting can be changed at any time, it will only apply to newly created connections. |
| SetCustomCompressor |
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.
|
| SetMaxProtocolVersion(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.
|
| SetMaxProtocolVersion(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.
|
| SetMaxSchemaAgreementWaitSeconds |
Sets the maximum time to wait for schema agreement before returning from a DDL query.
|
| SetNoCompact |
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+. |
Fields| Name | Description | |
|---|---|---|
  | DefaultMaxSchemaAgreementWaitSeconds |
The default value for get_MaxSchemaAgreementWaitSeconds: 10.
|
| DefaultPort |
The default port for Cassandra native binary protocol: 9042.
|
See Also