# Google Cloud Spanner v1 API - Class KeyRange (5.13.0-beta07)

5.13.0-beta07 5.13.0-beta06 5.12.0 (latest) 5.11.0 5.10.0 5.9.0 5.8.0 5.7.0 5.6.0 5.5.0 5.4.0 5.3.0 5.2.0 5.1.0 5.0.0 4.6.0 4.5.0 4.4.0 4.3.0 4.2.0 4.1.0 4.0.0 3.15.1 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0

    public sealed class KeyRange : IMessage<KeyRange>, IEquatable<KeyRange>, IDeepCloneable<KeyRange>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Spanner v1 API class KeyRange.

KeyRange represents a range of rows in a table or index.

A range has a start key and an end key. These keys can be open or
closed, indicating if the range includes rows with that key.

Keys are represented by lists, where the ith value in the list
corresponds to the ith component of the table or index primary key.
Individual values are encoded as described
\[here\]\[google.spanner.v1.TypeCode\].

For example, consider the following table definition:

    CREATE TABLE UserEvents (
      UserName STRING(MAX),
      EventDate STRING(10)
    ) PRIMARY KEY(UserName, EventDate);

The following keys name rows in this table:

    ["Bob", "2014-09-23"]
    ["Alfred", "2015-06-12"]

Since the `UserEvents` table's `PRIMARY KEY` clause names two
columns, each `UserEvents` key has two elements; the first is the
`UserName`, and the second is the `EventDate`.

Key ranges with multiple components are interpreted
lexicographically by component using the table or index key's declared
sort order. For example, the following range returns all events for
user `"Bob"` that occurred in the year 2015:

    "start_closed": ["Bob", "2015-01-01"]
    "end_closed": ["Bob", "2015-12-31"]

Start and end keys can omit trailing key components. This affects the
inclusion and exclusion of rows that exactly match the provided key
components: if the key is closed, then rows that exactly match the
provided components are included; if the key is open, then rows
that exactly match are not included.

For example, the following range includes all events for `"Bob"` that
occurred during and after the year 2000:

    "start_closed": ["Bob", "2000-01-01"]
    "end_closed": ["Bob"]

The next example retrieves all events for `"Bob"`:

    "start_closed": ["Bob"]
    "end_closed": ["Bob"]

To retrieve events before the year 2000:

    "start_closed": ["Bob"]
    "end_open": ["Bob", "2000-01-01"]

The following range includes all rows in the table:

    "start_closed": []
    "end_closed": []

This range returns all users whose `UserName` begins with any
character from A to C:

    "start_closed": ["A"]
    "end_open": ["D"]

This range returns all users whose `UserName` begins with B:

    "start_closed": ["B"]
    "end_open": ["C"]

Key ranges honor column sort order. For example, suppose a table is
defined as follows:

    CREATE TABLE DescendingSortedTable {
      Key INT64,
      ...
    ) PRIMARY KEY(Key DESC);

The following range retrieves all rows with key values between 1
and 100 inclusive:

    "start_closed": ["100"]
    "end_closed": ["1"]

Note that 100 is passed as the start, and 1 is passed as the end,
because `Key` is a descending column in the schema.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> KeyRange

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[KeyRange](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.KeyRange), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[KeyRange](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.KeyRange), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[KeyRange](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.KeyRange), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Spanner.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1)

## Assembly

Google.Cloud.Spanner.V1.dll

## Constructors

### KeyRange()

    public KeyRange()

### KeyRange(KeyRange)

    public KeyRange(KeyRange other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.KeyRange` |

## Properties

### EndClosed

    public ListValue EndClosed { get; set; }

If the end is closed, then the range includes all rows whose
first `len(end_closed)` key columns exactly match `end_closed`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.ListValue.html` |   |

### EndKeyTypeCase

    public KeyRange.EndKeyTypeOneofCase EndKeyTypeCase { get; }

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.KeyRangehttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.KeyRange.EndKeyTypeOneofCase` |   |

### EndOpen

    public ListValue EndOpen { get; set; }

If the end is open, then the range excludes rows whose first
`len(end_open)` key columns exactly match `end_open`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.ListValue.html` |   |

### StartClosed

    public ListValue StartClosed { get; set; }

If the start is closed, then the range includes all rows whose
first `len(start_closed)` key columns exactly match `start_closed`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.ListValue.html` |   |

### StartKeyTypeCase

    public KeyRange.StartKeyTypeOneofCase StartKeyTypeCase { get; }

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.KeyRangehttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.KeyRange.StartKeyTypeOneofCase` |   |

### StartOpen

    public ListValue StartOpen { get; set; }

If the start is open, then the range excludes rows whose first
`len(start_open)` key columns exactly match `start_open`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.ListValue.html` |   |