kinetica.Utils.RecordKeyBuilder< T > Class Template Reference

Builds or creates RecordKey objects based on a given record. More...

Public Member Functions
	RecordKeyBuilder (bool is_primary_key, KineticaType ktype)
RecordKey	build (T record)
	Build a RecordKey object based on a record. More...
string	buildExpression (T record)
	Build an expression to be passed to getRecords in the option. More...
bool	hasKey ()
	Returns whether this builder builds any routing keys. More...
bool	hasSameKey (RecordKeyBuilder< T > other)
	Returns if other is equivalent to this builder. More...

Detailed Description

Builds or creates RecordKey objects based on a given record.

Template Parameters

T	The type of record to build keys off of.

Definition at line 11 of file RecordKeyBuilder.cs.

Constructor & Destructor Documentation

RecordKeyBuilder()

kinetica.Utils.RecordKeyBuilder< T >.RecordKeyBuilder ( bool  is_primary_key, KineticaType  ktype  )

inline

Definition at line 49 of file RecordKeyBuilder.cs.

Member Function Documentation

build()

RecordKey kinetica.Utils.RecordKeyBuilder< T >.build ( T  record )

inline

Build a RecordKey object based on a record.

Parameters

record

The object based on which the key is to be built.

Returns

The record key that helps is routing this record correctly.

Definition at line 277 of file RecordKeyBuilder.cs.

buildExpression()

string kinetica.Utils.RecordKeyBuilder< T >.buildExpression ( T  record )

inline

Build an expression to be passed to getRecords in the option.

The expression is based on the record provided, but only values of shard columns will be used, the rest will be ignored.

Parameters

record

The object based on which the expression is to be built.

Returns

The record key that helps is routing this record correctly.

Definition at line 403 of file RecordKeyBuilder.cs.

hasKey()

bool kinetica.Utils.RecordKeyBuilder< T >.hasKey ( )

inline

Returns whether this builder builds any routing keys.

That is, if there are any routing columns in the relevant record type.

Returns

Bool value indicating if this builder builds keys.

Definition at line 490 of file RecordKeyBuilder.cs.

hasSameKey()

bool kinetica.Utils.RecordKeyBuilder< T >.hasSameKey ( RecordKeyBuilder< T >  other )

inline

Returns if other is equivalent to this builder.

Parameters

other

The other key builder.

Returns

Whether the other builder is the same as this one.

Definition at line 502 of file RecordKeyBuilder.cs.

---

The documentation for this class was generated from the following file:

• Kinetica/Utils/RecordKeyBuilder.cs