Value Class

Polymorphic value classes used to efficiently serialize objects into the wire protocol.

Definition

Properties

AsNull Get null value instance.
IsNull Get null value instance.
Object Return original value as an Object.
Type Get wire protocol value type.

Methods

EstimateSize Calculate number of bytes necessary to serialize the fixed value in the wire protocol.
Get(Value.BlobValue) Get blob value instance.
Get(Boolean) Get boolean value instance.
Get(Byte) Get boolean value instance.
Get(Byte[]) Get byte array value instance.
Get(Double) Get double value instance.
Get(IDictionary) Get map value instance.
Get(IList) Get list value instance.
Get(Int16) Get short value instance.
Get(Int32) Get integer value instance.
Get(Int64) Get long value instance.
Get(SByte) Get signed boolean value instance.
Get(Single) Get float value instance.
Get(String) Get string or null value instance.
Get(UInt16) Get unsigned short value instance.
Get(UInt32) Get unsigned integer value instance.
Get(UInt64) Get unsigned long value instance.
Get(Value[]) Get ValueArray value instance.
Get(IDictionary, MapOrder) Get map value instance.
Get(Byte[], Int32, Int32) Get byte array segment value instance.
Get<T>(T) Determine value given generic object. This is the slowest of the Value get() methods. Useful when copying records from one cluster to another.
GetAsGeoJSON Get GeoJSON value instance.
GetAsHLL Get HyperLogLog value instance.
Pack Serialize the value using MessagePack.
ToInteger Return value as an integer.
ToLong Return value as a long.
ToUnsignedInteger Return value as an unsigned integer.
ToUnsignedLong Return value as an unsigned long.
ValidateKeyType Validate if value type can be used as a key.
Write Serialize the fixed value in the wire protocol.

Fields

DisableDeserializer Should default object deserializer be disabled. If true, an exception will be thrown when a default object deserialization is attempted. Default object serialization is triggered when serialized data is read/parsed from the server. DisableDeserializer is separate from DisableSerializer because there may be cases when no new serialization is allowed, but existing serialized objects need to be supported. BinaryFormatter has been removed from the client by default, so this field is no longer relevant.
DisableSerializer Should BinaryFormatter be disabled. If true, an exception will be thrown when BinaryFormatter is used. BinaryFormatter has been removed from the client by default, so this field is no longer relevant.
INFINITY Infinity value to be used in CDT range comparisons only.
UseBoolBin Should client send boolean particle type for a boolean bin. If false an integer particle type (1 or 0) is sent instead. Must be false for server versions less than 5.6 which do not support boolean bins. Can set to true for server 5.6+.
WILDCARD Wildcard value to be used in CDT range comparisons only.

See Also