# Google Cloud Spanner v1 API - Struct SpannerNumeric (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 struct SpannerNumeric : IEquatable<SpannerNumeric>, IComparable<SpannerNumeric>, IComparable

Reference documentation and code samples for the Google Cloud Spanner v1 API struct SpannerNumeric.

Representation of the Spanner NUMERIC type, which has 38 digits of precision,
and a fixed scale of 9 decimal places to the right of the decimal point

## Implements

[IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric), [IComparable](https://learn.microsoft.com/dotnet/api/system.icomparable-1)[SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric), [IComparable](https://learn.microsoft.com/dotnet/api/system.icomparable)

## Inherited Members

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

## 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

## Properties

### Epsilon

    public static SpannerNumeric Epsilon { get; }

The smallest positive value for [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric), equal to 0.000000001.

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

### MaxValue

    public static SpannerNumeric MaxValue { get; }

The maximum valid value for [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric), equal to 99999999999999999999999999999.999999999.

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

### MinValue

    public static SpannerNumeric MinValue { get; }

The minimum valid value for [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric), equal to -99999999999999999999999999999.999999999.

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

### Zero

    public static SpannerNumeric Zero { get; }

Zero represented as a [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric). This is the default value for the type.

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

## Methods

### CompareTo(SpannerNumeric)

    public int CompareTo(SpannerNumeric other)

Compares this value with `other`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` The value to compare with this one |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` | A negative integer if this value is less than `other`; a positive integer if it's greater than `other`; zero if they're equal. |

### FromDecimal(decimal, LossOfPrecisionHandling)

    public static SpannerNumeric FromDecimal(decimal value, LossOfPrecisionHandling lossOfPrecisionHandling)

Converts a [decimal](https://learn.microsoft.com/dotnet/api/system.decimal) value to [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric),

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://learn.microsoft.com/dotnet/api/system.decimal` The value to convert |
| `lossOfPrecisionHandling` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.LossOfPrecisionHandling` How to handle values with signficant digits that would be lost by the conversion. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` | The converted value. |

**Remarks** This conversion may silently lose precision, depending on `lossOfPrecisionHandling`.

### GetHashCode()

    public override int GetHashCode()

Returns a hash code for this value.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` | A hash code for this value. |

**Overrides** [ValueType.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode)

### Parse(string)

    public static SpannerNumeric Parse(string text)

Parses a textual representation as a [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `text` | `https://learn.microsoft.com/dotnet/api/system.string` The text to parse. Must not be null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` | The parsed value. |

**Remarks**
`text` must be a representation of a decimal value which can be represented by [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric),
using "." as a decimal place where one is specified, and a leading "-" for negative values. Leading zeroes and insignificant
trailing digits are permitted.

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.formatexception` | The value could not be parsed as a [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric). |

### ToDecimal(LossOfPrecisionHandling)

    public decimal ToDecimal(LossOfPrecisionHandling lossOfPrecisionHandling)

Converts this value to [decimal](https://learn.microsoft.com/dotnet/api/system.decimal),

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `lossOfPrecisionHandling` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.LossOfPrecisionHandling` How to handle values with signficant digits that would be lost by the conversion. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.decimal` | The converted value. |

**Remarks** This conversion may silently lose precision, depending on `lossOfPrecisionHandling`, but
will always throw [OverflowException](https://learn.microsoft.com/dotnet/api/system.overflowexception) if value is out of the range of [decimal](https://learn.microsoft.com/dotnet/api/system.decimal).

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.overflowexception` | This value is outside the range of [decimal](https://learn.microsoft.com/dotnet/api/system.decimal). |

### ToString()

    public override string ToString()

Returns a canonical string representation of this value. This always uses "." as a decimal point,
and only includes as many decimal places as are required to completely represent the value. If
the value is between -1 and 1 exclusive, a "0" character is included before the decimal point.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | A canonical string representation of this value. |

**Overrides** [ValueType.ToString()](https://learn.microsoft.com/dotnet/api/system.valuetype.tostring)

### TryParse(string, out SpannerNumeric)

    public static bool TryParse(string text, out SpannerNumeric value)

Attempts to parse a textual representation of a [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric) value.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `text` | `https://learn.microsoft.com/dotnet/api/system.string` The text to parse. Must not be null. |
| `value` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` The parsed value, or 0 on failure. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` | `true` if `text` was parsed successfully; `false` otherwise. |

**Remarks** See [Parse(string)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric#Google_Cloud_Spanner_V1_SpannerNumeric_Parse_System_String_) for format details. This method will return `true` if and only if
[Parse(string)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric#Google_Cloud_Spanner_V1_SpannerNumeric_Parse_System_String_) would return without an exception.

## Operators

### operator +(SpannerNumeric, SpannerNumeric)

    public static SpannerNumeric operator +(SpannerNumeric lhs, SpannerNumeric rhs)

Returns the result of adding two [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric) values together.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `lhs` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` The first value to add. |
| `rhs` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` The second value to add. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` | The result of adding the two values. |

### operator ==(SpannerNumeric, SpannerNumeric)

    public static bool operator ==(SpannerNumeric lhs, SpannerNumeric rhs)

Compares two values for equality.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `lhs` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` The first value to compare. |
| `rhs` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` The second value to compare. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` | `true` if the two arguments are equal; `false` otherwise. |

### explicit operator decimal(SpannerNumeric)

    public static explicit operator decimal(SpannerNumeric value)

Explicit conversion from [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric) to [decimal](https://learn.microsoft.com/dotnet/api/system.decimal).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` The numeric value to convert. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.decimal` | The result of the conversion. |

**Remarks** This conversion may silently lose precision, but will throw [OverflowException](https://learn.microsoft.com/dotnet/api/system.overflowexception) if the value is out of
range of [decimal](https://learn.microsoft.com/dotnet/api/system.decimal). Use [ToDecimal(LossOfPrecisionHandling)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric#Google_Cloud_Spanner_V1_SpannerNumeric_ToDecimal_Google_Cloud_Spanner_V1_LossOfPrecisionHandling_) passing in [Throw](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.LossOfPrecisionHandling#Google_Cloud_Spanner_V1_LossOfPrecisionHandling_Throw)
for the second argument to avoid any information loss.

### explicit operator SpannerNumeric(decimal)

    public static explicit operator SpannerNumeric(decimal value)

Explicit conversion from [decimal](https://learn.microsoft.com/dotnet/api/system.decimal) to [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://learn.microsoft.com/dotnet/api/system.decimal` The decimal value to convert. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` | The result of the conversion. |

**Remarks** This conversion may silently lose precision. Use [FromDecimal(decimal, LossOfPrecisionHandling)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric#Google_Cloud_Spanner_V1_SpannerNumeric_FromDecimal_System_Decimal_Google_Cloud_Spanner_V1_LossOfPrecisionHandling_) passing in [Throw](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.LossOfPrecisionHandling#Google_Cloud_Spanner_V1_LossOfPrecisionHandling_Throw)
for the second argument to avoid any information loss.

### implicit operator SpannerNumeric(int)

    public static implicit operator SpannerNumeric(int value)

Implicit conversion from [int](https://learn.microsoft.com/dotnet/api/system.int32) to [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://learn.microsoft.com/dotnet/api/system.int32` The integer value to convert. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` | The result of the conversion. |

**Remarks** This conversion exists to avoid ambiguity between the 64-bit conversions when using an integer literal.

### implicit operator SpannerNumeric(long)

    public static implicit operator SpannerNumeric(long value)

Implicit conversion from [long](https://learn.microsoft.com/dotnet/api/system.int64) to [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://learn.microsoft.com/dotnet/api/system.int64` The integer value to convert. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` | The result of the conversion. |

### implicit operator SpannerNumeric(ulong)

    public static implicit operator SpannerNumeric(ulong value)

Implicit conversion from [ulong](https://learn.microsoft.com/dotnet/api/system.uint64) to [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://learn.microsoft.com/dotnet/api/system.uint64` The integer value to convert. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` | The result of the conversion. |

### operator !=(SpannerNumeric, SpannerNumeric)

    public static bool operator !=(SpannerNumeric lhs, SpannerNumeric rhs)

Compares two values for inequality.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `lhs` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` The first value to compare. |
| `rhs` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` The second value to compare. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` | `false` if the two arguments are equal; `true` otherwise. |

### operator -(SpannerNumeric, SpannerNumeric)

    public static SpannerNumeric operator -(SpannerNumeric lhs, SpannerNumeric rhs)

Returns the result of subtracting one [SpannerNumeric](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric) value from another.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `lhs` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` The value to subtract from. |
| `rhs` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` The value to subtract. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` | The result of subtracting `rhs` from `lhs`. |

### operator -(SpannerNumeric)

    public static SpannerNumeric operator -(SpannerNumeric value)

The unary negation operator.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` The value to negate. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` | The negation of `value`. |

### operator +(SpannerNumeric)

    public static SpannerNumeric operator +(SpannerNumeric value)

The unary plus operator, provided mainly for consistency.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` The value to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SpannerNumeric` | The original value. |