Collection of shard key column names and values. More…
Inherits IReadOnlyList, and IReadOnlyList.
Public Member Functions | |
| ShardKeyValues (params(string Name, ShardKeyValue Value)[] values) | |
| Creates a ShardKeyValues collection from the specified values. | |
| IEnumerator<(string Name, ShardKeyValue Value)> | GetEnumerator () |
| Gets an enumerator for the shard key values. | |
| IEnumerator IEnumerable. | GetEnumerator () |
| ShardKeyValues (params(string Name, ShardKeyValue Value)[] values) | |
| Creates a ShardKeyValues collection from the specified values. | |
| IEnumerator<(string Name, ShardKeyValue Value)> | GetEnumerator () |
| Gets an enumerator for the shard key values. | |
| IEnumerator IEnumerable. | GetEnumerator () |
Static Public Member Functions | |
| static ShardKeyValues | Single (string name, ShardKeyValue value) |
| Creates a ShardKeyValues collection with a single value. | |
| static ShardKeyValues | Two (string name1, ShardKeyValue value1, string name2, ShardKeyValue value2) |
| Creates a ShardKeyValues collection with two values. | |
| static ShardKeyValues | Three (string name1, ShardKeyValue value1, string name2, ShardKeyValue value2, string name3, ShardKeyValue value3) |
| Creates a ShardKeyValues collection with three values. | |
| static ShardKeyValues | Four (string name1, ShardKeyValue value1, string name2, ShardKeyValue value2, string name3, ShardKeyValue value3, string name4, ShardKeyValue value4) |
| Creates a ShardKeyValues collection with four values. | |
| static ShardKeyValues | Single (string name, ShardKeyValue value) |
| Creates a ShardKeyValues collection with a single value. | |
| static ShardKeyValues | Two (string name1, ShardKeyValue value1, string name2, ShardKeyValue value2) |
| Creates a ShardKeyValues collection with two values. | |
| static ShardKeyValues | Three (string name1, ShardKeyValue value1, string name2, ShardKeyValue value2, string name3, ShardKeyValue value3) |
| Creates a ShardKeyValues collection with three values. | |
| static ShardKeyValues | Four (string name1, ShardKeyValue value1, string name2, ShardKeyValue value2, string name3, ShardKeyValue value3, string name4, ShardKeyValue value4) |
| Creates a ShardKeyValues collection with four values. | |
Public Attributes | |
| string | Name |
| Gets the shard key value at the specified index. | |
Properties | |
| static ShardKeyValues | Empty [get] |
| Creates an empty ShardKeyValues collection. | |
| int | Count [get] |
| Gets the number of shard key values. | |
| string ShardKeyValue Value | this[int index] [get] |
Detailed Description
Collection of shard key column names and values.
Equivalent to Rust’s ShardKeyValues (SmallVec<[(&‘static str, ShardKeyValue); 4]>).
This struct is optimized for small collections (up to 4 shard key columns) which is the common case.
Definition at line 321 of file ShardKeyValue.cs.
Constructor & Destructor Documentation
◆ ShardKeyValues() [1/2]
| inline |
Creates a ShardKeyValues collection from the specified values.
Definition at line 329 of file ShardKeyValue.cs.
◆ ShardKeyValues() [2/2]
| inline |
Creates a ShardKeyValues collection from the specified values.
Definition at line 329 of file ShardKeyValue.cs.
Member Function Documentation
◆ Four() [1/2]
| static |
Creates a ShardKeyValues collection with four values.
◆ Four() [2/2]
| static |
Creates a ShardKeyValues collection with four values.
◆ GetEnumerator() [1/4]
| inline |
Gets an enumerator for the shard key values.
Definition at line 372 of file ShardKeyValue.cs.
◆ GetEnumerator() [2/4]
| IEnumerator IEnumerable. kinetica.Records.ShardKeyValues.GetEnumerator | ( | ) |
◆ GetEnumerator() [3/4]
| inline |
Gets an enumerator for the shard key values.
Definition at line 372 of file ShardKeyValue.cs.
◆ GetEnumerator() [4/4]
| IEnumerator IEnumerable. kinetica.Records.ShardKeyValues.GetEnumerator | ( | ) |
◆ Single() [1/2]
| static |
Creates a ShardKeyValues collection with a single value.
◆ Single() [2/2]
| static |
Creates a ShardKeyValues collection with a single value.
◆ Three() [1/2]
| static |
Creates a ShardKeyValues collection with three values.
◆ Three() [2/2]
| static |
Creates a ShardKeyValues collection with three values.
◆ Two() [1/2]
| static |
Creates a ShardKeyValues collection with two values.
◆ Two() [2/2]
| static |
Creates a ShardKeyValues collection with two values.
Member Data Documentation
◆ Name
| string kinetica.Records.ShardKeyValues.Name |
Gets the shard key value at the specified index.
Definition at line 361 of file ShardKeyValue.cs.
Property Documentation
◆ Count
| get |
Gets the number of shard key values.
Definition at line 358 of file ShardKeyValue.cs.
◆ Empty
| staticget |
Creates an empty ShardKeyValues collection.
Definition at line 326 of file ShardKeyValue.cs.
◆ this[int index]
| get |
Definition at line 361 of file ShardKeyValue.cs.
The documentation for this struct was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Records/ShardKeyValue.cs
- Kinetica/Records/ShardKeyValue.cs