Class LocalSecondaryIndex

Namespace

DynaSharp.Requests

Assembly

DynaSharp.dll

A local secondary index of a table that is created: the same partition key as the table, a different sort key.

public sealed record LocalSecondaryIndex : IEquatable<LocalSecondaryIndex>

Inheritance

object

LocalSecondaryIndex

Implements

IEquatable<LocalSecondaryIndex>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

Local secondary indexes can only be defined when the table is created and never removed. They share the throughput of the table, can be read with strong consistency, and limit every item collection (all items with one partition key value) to 10 GB. A table can have at most five.

Constructors

LocalSecondaryIndex()

public LocalSecondaryIndex()

Properties

IndexName

Gets the index name: 3 to 255 characters of letters, digits, underscore, hyphen and dot, unique within the table.

public required string IndexName { get; init; }

Property Value

string

KeySchema

Gets the key of the index: the partition key of the table followed by the sort key of the index.

public required IReadOnlyList<KeySchemaElement> KeySchema { get; init; }

Property Value

IReadOnlyList<KeySchemaElement>

Projection

Gets the attributes copied into the index.

public required IndexProjection Projection { get; init; }

Property Value

IndexProjection

Methods

Equals(LocalSecondaryIndex?)

public bool Equals(LocalSecondaryIndex? other)

Parameters

other LocalSecondaryIndex

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(LocalSecondaryIndex?, LocalSecondaryIndex?)

public static bool operator ==(LocalSecondaryIndex? left, LocalSecondaryIndex? right)

Parameters

left LocalSecondaryIndex

right LocalSecondaryIndex

Returns

bool

operator !=(LocalSecondaryIndex?, LocalSecondaryIndex?)

public static bool operator !=(LocalSecondaryIndex? left, LocalSecondaryIndex? right)

Parameters

left LocalSecondaryIndex

right LocalSecondaryIndex

Returns

bool