forked from googleapis/python-spanner
/
param_types.py
75 lines (58 loc) · 2.63 KB
/
param_types.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# Copyright 2017 Google LLC All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Types exported from this package."""
from google.cloud.spanner_v1 import Type
from google.cloud.spanner_v1 import TypeAnnotationCode
from google.cloud.spanner_v1 import TypeCode
from google.cloud.spanner_v1 import StructType
# Scalar parameter types
STRING = Type(code=TypeCode.STRING)
BYTES = Type(code=TypeCode.BYTES)
BOOL = Type(code=TypeCode.BOOL)
INT64 = Type(code=TypeCode.INT64)
FLOAT64 = Type(code=TypeCode.FLOAT64)
FLOAT32 = Type(code=TypeCode.FLOAT32)
DATE = Type(code=TypeCode.DATE)
TIMESTAMP = Type(code=TypeCode.TIMESTAMP)
NUMERIC = Type(code=TypeCode.NUMERIC)
JSON = Type(code=TypeCode.JSON)
PG_NUMERIC = Type(code=TypeCode.NUMERIC, type_annotation=TypeAnnotationCode.PG_NUMERIC)
PG_JSONB = Type(code=TypeCode.JSON, type_annotation=TypeAnnotationCode.PG_JSONB)
PG_OID = Type(code=TypeCode.INT64, type_annotation=TypeAnnotationCode.PG_OID)
def Array(element_type):
"""Construct an array parameter type description protobuf.
:type element_type: :class:`~google.cloud.spanner_v1.types.Type`
:param element_type: the type of elements of the array
:rtype: :class:`google.cloud.spanner_v1.types.Type`
:returns: the appropriate array-type protobuf
"""
return Type(code=TypeCode.ARRAY, array_element_type=element_type)
def StructField(name, field_type):
"""Construct a field description protobuf.
:type name: str
:param name: the name of the field
:type field_type: :class:`google.cloud.spanner_v1.types.Type`
:param field_type: the type of the field
:rtype: :class:`google.cloud.spanner_v1.types.StructType.Field`
:returns: the appropriate struct-field-type protobuf
"""
return StructType.Field(name=name, type_=field_type)
def Struct(fields):
"""Construct a struct parameter type description protobuf.
:type fields: list of :class:`google.cloud.spanner_v1.types.StructType.Field`
:param fields: the fields of the struct
:rtype: :class:`type_pb2.Type`
:returns: the appropriate struct-type protobuf
"""
return Type(code=TypeCode.STRUCT, struct_type=StructType(fields=fields))