Cloud Spanner V1 Client - Class TypeCode (1.104.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class TypeCode.

TypeCode is used as part of Type to indicate the type of a Cloud Spanner value.

Each legal value of a type can be encoded to or decoded from a JSON value, using the encodings described below. All Cloud Spanner values can be null, regardless of type; nulls are always encoded as a JSON null.

Protobuf type google.spanner.v1.TypeCode

Namespace

Google \ Cloud \ Spanner \ V1

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

TYPE_CODE_UNSPECIFIED

Value: 0

Not specified.

Generated from protobuf enum TYPE_CODE_UNSPECIFIED = 0;

BOOL

Value: 1

Encoded as JSON true or false.

Generated from protobuf enum BOOL = 1;

INT64

Value: 2

Encoded as string, in decimal format.

Generated from protobuf enum INT64 = 2;

FLOAT64

Value: 3

Encoded as number, or the strings "NaN", "Infinity", or "-Infinity".

Generated from protobuf enum FLOAT64 = 3;

FLOAT32

Value: 15

Encoded as number, or the strings "NaN", "Infinity", or "-Infinity".

Generated from protobuf enum FLOAT32 = 15;

TIMESTAMP

Value: 4

Encoded as string in RFC 3339 timestamp format. The time zone must be present, and must be "Z".

If the schema has the column option allow_commit_timestamp=true, the placeholder string "spanner.commit_timestamp()" can be used to instruct the system to insert the commit timestamp associated with the transaction commit.

Generated from protobuf enum TIMESTAMP = 4;

DATE

Value: 5

Encoded as string in RFC 3339 date format.

Generated from protobuf enum DATE = 5;

STRING

Value: 6

Encoded as string.

Generated from protobuf enum STRING = 6;

BYTES

Value: 7

Encoded as a base64-encoded string, as described in RFC 4648, section 4.

Generated from protobuf enum BYTES = 7;

PBARRAY

Value: 8

Encoded as list, where the list elements are represented according to array_element_type.

Generated from protobuf enum ARRAY = 8;

STRUCT

Value: 9

Encoded as list, where list element i is represented according to [struct_type.fields[i]][google.spanner.v1.StructType.fields].

Generated from protobuf enum STRUCT = 9;

NUMERIC

Value: 10

Encoded as string, in decimal format or scientific notation format.

Decimal format: [+-]Digits[.[Digits]] or <xref uid="\\Digits">+-</xref>.Digits Scientific notation: [+-]Digits[.[Digits]][ExponentIndicator[+-]Digits] or <xref uid="\\Digits">+-</xref>.Digits[ExponentIndicator[+-]Digits] (ExponentIndicator is "e" or "E")

Generated from protobuf enum NUMERIC = 10;

JSON

Value: 11

Encoded as a JSON-formatted string as described in RFC 7159. The following rules are applied when parsing JSON input:

  • Whitespace characters are not preserved.

  • If a JSON object has duplicate keys, only the first key is preserved.

  • Members of a JSON object are not guaranteed to have their order preserved.
  • JSON array elements will have their order preserved.

Generated from protobuf enum JSON = 11;

PROTO

Value: 13

Encoded as a base64-encoded string, as described in RFC 4648, section 4.

Generated from protobuf enum PROTO = 13;

ENUM

Value: 14

Encoded as string, in decimal format.

Generated from protobuf enum ENUM = 14;

INTERVAL

Value: 16

Encoded as string, in ISO8601 duration format - P[n]Y[n]M[n]DT[n]H[n]M[n[.fraction]]S where n is an integer.

For example, P1Y2M3DT4H5M6.5S represents time duration of 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6.5 seconds.

Generated from protobuf enum INTERVAL = 16;

UUID

Value: 17

Encoded as string, in lower-case hexa-decimal format, as described in RFC 9562, section 4.

Generated from protobuf enum UUID = 17;