google-cloud-spanner 3.55.0__py3-none-any.whl

google/cloud/spanner_v1/types/type.py

@@ -0,0 +1,288 @@
+# -*- coding: utf-8 -*-
+# Copyright 2025 Google LLC
+#
+# 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.
+#
+from __future__ import annotations
+
+from typing import MutableMapping, MutableSequence
+
+import proto  # type: ignore
+
+
+__protobuf__ = proto.module(
+    package="google.spanner.v1",
+    manifest={
+        "TypeCode",
+        "TypeAnnotationCode",
+        "Type",
+        "StructType",
+    },
+)
+
+
+class TypeCode(proto.Enum):
+    r"""``TypeCode`` is used as part of [Type][google.spanner.v1.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; ``null``\ s are always encoded
+    as a JSON ``null``.
+
+    Values:
+        TYPE_CODE_UNSPECIFIED (0):
+            Not specified.
+        BOOL (1):
+            Encoded as JSON ``true`` or ``false``.
+        INT64 (2):
+            Encoded as ``string``, in decimal format.
+        FLOAT64 (3):
+            Encoded as ``number``, or the strings ``"NaN"``,
+            ``"Infinity"``, or ``"-Infinity"``.
+        FLOAT32 (15):
+            Encoded as ``number``, or the strings ``"NaN"``,
+            ``"Infinity"``, or ``"-Infinity"``.
+        TIMESTAMP (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.
+        DATE (5):
+            Encoded as ``string`` in RFC 3339 date format.
+        STRING (6):
+            Encoded as ``string``.
+        BYTES (7):
+            Encoded as a base64-encoded ``string``, as described in RFC
+            4648, section 4.
+        ARRAY (8):
+            Encoded as ``list``, where the list elements are represented
+            according to
+            [array_element_type][google.spanner.v1.Type.array_element_type].
+        STRUCT (9):
+            Encoded as ``list``, where list element ``i`` is represented
+            according to
+            [struct_type.fields[i]][google.spanner.v1.StructType.fields].
+        NUMERIC (10):
+            Encoded as ``string``, in decimal format or scientific
+            notation format. Decimal format: ``[+-]Digits[.[Digits]]``
+            or ``[+-][Digits].Digits``
+
+            Scientific notation:
+            ``[+-]Digits[.[Digits]][ExponentIndicator[+-]Digits]`` or
+            ``[+-][Digits].Digits[ExponentIndicator[+-]Digits]``
+            (ExponentIndicator is ``"e"`` or ``"E"``)
+        JSON (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.
+        PROTO (13):
+            Encoded as a base64-encoded ``string``, as described in RFC
+            4648, section 4.
+        ENUM (14):
+            Encoded as ``string``, in decimal format.
+        INTERVAL (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.
+        UUID (17):
+            Encoded as ``string``, in lower-case hexa-decimal format, as
+            described in RFC 9562, section 4.
+    """
+    TYPE_CODE_UNSPECIFIED = 0
+    BOOL = 1
+    INT64 = 2
+    FLOAT64 = 3
+    FLOAT32 = 15
+    TIMESTAMP = 4
+    DATE = 5
+    STRING = 6
+    BYTES = 7
+    ARRAY = 8
+    STRUCT = 9
+    NUMERIC = 10
+    JSON = 11
+    PROTO = 13
+    ENUM = 14
+    INTERVAL = 16
+    UUID = 17
+
+
+class TypeAnnotationCode(proto.Enum):
+    r"""``TypeAnnotationCode`` is used as a part of
+    [Type][google.spanner.v1.Type] to disambiguate SQL types that should
+    be used for a given Cloud Spanner value. Disambiguation is needed
+    because the same Cloud Spanner type can be mapped to different SQL
+    types depending on SQL dialect. TypeAnnotationCode doesn't affect
+    the way value is serialized.
+
+    Values:
+        TYPE_ANNOTATION_CODE_UNSPECIFIED (0):
+            Not specified.
+        PG_NUMERIC (2):
+            PostgreSQL compatible NUMERIC type. This annotation needs to
+            be applied to [Type][google.spanner.v1.Type] instances
+            having [NUMERIC][google.spanner.v1.TypeCode.NUMERIC] type
+            code to specify that values of this type should be treated
+            as PostgreSQL NUMERIC values. Currently this annotation is
+            always needed for
+            [NUMERIC][google.spanner.v1.TypeCode.NUMERIC] when a client
+            interacts with PostgreSQL-enabled Spanner databases.
+        PG_JSONB (3):
+            PostgreSQL compatible JSONB type. This annotation needs to
+            be applied to [Type][google.spanner.v1.Type] instances
+            having [JSON][google.spanner.v1.TypeCode.JSON] type code to
+            specify that values of this type should be treated as
+            PostgreSQL JSONB values. Currently this annotation is always
+            needed for [JSON][google.spanner.v1.TypeCode.JSON] when a
+            client interacts with PostgreSQL-enabled Spanner databases.
+        PG_OID (4):
+            PostgreSQL compatible OID type. This
+            annotation can be used by a client interacting
+            with PostgreSQL-enabled Spanner database to
+            specify that a value should be treated using the
+            semantics of the OID type.
+    """
+    TYPE_ANNOTATION_CODE_UNSPECIFIED = 0
+    PG_NUMERIC = 2
+    PG_JSONB = 3
+    PG_OID = 4
+
+
+class Type(proto.Message):
+    r"""``Type`` indicates the type of a Cloud Spanner value, as might be
+    stored in a table cell or returned from an SQL query.
+
+    Attributes:
+        code (google.cloud.spanner_v1.types.TypeCode):
+            Required. The [TypeCode][google.spanner.v1.TypeCode] for
+            this type.
+        array_element_type (google.cloud.spanner_v1.types.Type):
+            If [code][google.spanner.v1.Type.code] ==
+            [ARRAY][google.spanner.v1.TypeCode.ARRAY], then
+            ``array_element_type`` is the type of the array elements.
+        struct_type (google.cloud.spanner_v1.types.StructType):
+            If [code][google.spanner.v1.Type.code] ==
+            [STRUCT][google.spanner.v1.TypeCode.STRUCT], then
+            ``struct_type`` provides type information for the struct's
+            fields.
+        type_annotation (google.cloud.spanner_v1.types.TypeAnnotationCode):
+            The
+            [TypeAnnotationCode][google.spanner.v1.TypeAnnotationCode]
+            that disambiguates SQL type that Spanner will use to
+            represent values of this type during query processing. This
+            is necessary for some type codes because a single
+            [TypeCode][google.spanner.v1.TypeCode] can be mapped to
+            different SQL types depending on the SQL dialect.
+            [type_annotation][google.spanner.v1.Type.type_annotation]
+            typically is not needed to process the content of a value
+            (it doesn't affect serialization) and clients can ignore it
+            on the read path.
+        proto_type_fqn (str):
+            If [code][google.spanner.v1.Type.code] ==
+            [PROTO][google.spanner.v1.TypeCode.PROTO] or
+            [code][google.spanner.v1.Type.code] ==
+            [ENUM][google.spanner.v1.TypeCode.ENUM], then
+            ``proto_type_fqn`` is the fully qualified name of the proto
+            type representing the proto/enum definition.
+    """
+
+    code: "TypeCode" = proto.Field(
+        proto.ENUM,
+        number=1,
+        enum="TypeCode",
+    )
+    array_element_type: "Type" = proto.Field(
+        proto.MESSAGE,
+        number=2,
+        message="Type",
+    )
+    struct_type: "StructType" = proto.Field(
+        proto.MESSAGE,
+        number=3,
+        message="StructType",
+    )
+    type_annotation: "TypeAnnotationCode" = proto.Field(
+        proto.ENUM,
+        number=4,
+        enum="TypeAnnotationCode",
+    )
+    proto_type_fqn: str = proto.Field(
+        proto.STRING,
+        number=5,
+    )
+
+
+class StructType(proto.Message):
+    r"""``StructType`` defines the fields of a
+    [STRUCT][google.spanner.v1.TypeCode.STRUCT] type.
+
+    Attributes:
+        fields (MutableSequence[google.cloud.spanner_v1.types.StructType.Field]):
+            The list of fields that make up this struct. Order is
+            significant, because values of this struct type are
+            represented as lists, where the order of field values
+            matches the order of fields in the
+            [StructType][google.spanner.v1.StructType]. In turn, the
+            order of fields matches the order of columns in a read
+            request, or the order of fields in the ``SELECT`` clause of
+            a query.
+    """
+
+    class Field(proto.Message):
+        r"""Message representing a single field of a struct.
+
+        Attributes:
+            name (str):
+                The name of the field. For reads, this is the column name.
+                For SQL queries, it is the column alias (e.g., ``"Word"`` in
+                the query ``"SELECT 'hello' AS Word"``), or the column name
+                (e.g., ``"ColName"`` in the query
+                ``"SELECT ColName FROM Table"``). Some columns might have an
+                empty name (e.g., ``"SELECT UPPER(ColName)"``). Note that a
+                query result can contain multiple fields with the same name.
+            type_ (google.cloud.spanner_v1.types.Type):
+                The type of the field.
+        """
+
+        name: str = proto.Field(
+            proto.STRING,
+            number=1,
+        )
+        type_: "Type" = proto.Field(
+            proto.MESSAGE,
+            number=2,
+            message="Type",
+        )
+
+    fields: MutableSequence[Field] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=1,
+        message=Field,
+    )
+
+
+__all__ = tuple(sorted(__protobuf__.manifest))

google_cloud_spanner-3.55.0.dist-info/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.