Struct ColumnEncryptionMetadata

Utility type used in IColumnEncryptionPolicy to provide the driver with the encryption key and "real" cql type of the column (the server side type should always be 'blob' for encrypted columns but the type at the application level can be any cql type)

Implements
Inherited Members
ValueType.ToString()
object.Equals(object, object)
object.GetType()
object.ReferenceEquals(object, object)
Namespace: Cassandra
Assembly: Cassandra.dll
Syntax
public struct ColumnEncryptionMetadata : IEquatable<ColumnEncryptionMetadata>

Constructors

ColumnEncryptionMetadata(ColumnTypeCode, IColumnInfo, object)

Declaration
public ColumnEncryptionMetadata(ColumnTypeCode typeCode, IColumnInfo typeInfo, object key)
Parameters
Type Name Description
ColumnTypeCode typeCode
IColumnInfo typeInfo
object key

ColumnEncryptionMetadata(ColumnTypeCode, object)

Declaration
public ColumnEncryptionMetadata(ColumnTypeCode typeCode, object key)
Parameters
Type Name Description
ColumnTypeCode typeCode
object key

Properties

Key

Key object that will provided to the Encrypt(object, byte[]) and Decrypt(object, byte[]) methods. The type that is used for this key has to be a type that is "understood" by the particular implementation of IColumnEncryptionPolicy that is used.

E.g. For AesColumnEncryptionPolicy this key should be an instance of AesColumnEncryptionPolicy.AesKeyAndIV (which is forced by the AddColumn(string, string, string, AesKeyAndIV, ColumnTypeCode) method.

Declaration
public object Key { get; }
Property Value
Type Description
object

TypeCode

CQL Type code of the encrypted column at the application level. The driver will decrypt the encrypted column data and then deserialize it to the type provided here. You must ensure that you are providing a .NET value that matches this CQL type code when using encrypted parameter values.

Declaration
public ColumnTypeCode TypeCode { get; }
Property Value
Type Description
ColumnTypeCode

TypeInfo

This must be provided in addition to TypeCode if the type code refers to 'list','set','map','udt','tuple' or 'custom'. Each of these cql types has a ColumnInfo class associated with it (e.g. ListColumnInfo for 'list').

Declaration
public IColumnInfo TypeInfo { get; }
Property Value
Type Description
IColumnInfo

Methods

Equals(ColumnEncryptionMetadata)

Declaration
public bool Equals(ColumnEncryptionMetadata other)
Parameters
Type Name Description
ColumnEncryptionMetadata other
Returns
Type Description
bool

Equals(object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
System.ValueType.Equals(object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
System.ValueType.GetHashCode()

Operators

operator ==(ColumnEncryptionMetadata, ColumnEncryptionMetadata)

Declaration
public static bool operator ==(ColumnEncryptionMetadata left, ColumnEncryptionMetadata right)
Parameters
Type Name Description
ColumnEncryptionMetadata left
ColumnEncryptionMetadata right
Returns
Type Description
bool

operator !=(ColumnEncryptionMetadata, ColumnEncryptionMetadata)

Declaration
public static bool operator !=(ColumnEncryptionMetadata left, ColumnEncryptionMetadata right)
Parameters
Type Name Description
ColumnEncryptionMetadata left
ColumnEncryptionMetadata right
Returns
Type Description
bool

Implements

System.IEquatable<T>