google-cloud-spanner 1.16.2 → 2.0.0

data/lib/google/cloud/spanner/v1/doc/google/protobuf/timestamp.rb

@@ -1,113 +0,0 @@
-# Copyright 2020 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
-#
-#     https://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.
-
-
-module Google
-  module Protobuf
-    # A Timestamp represents a point in time independent of any time zone or local
-    # calendar, encoded as a count of seconds and fractions of seconds at
-    # nanosecond resolution. The count is relative to an epoch at UTC midnight on
-    # January 1, 1970, in the proleptic Gregorian calendar which extends the
-    # Gregorian calendar backwards to year one.
-    #
-    # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
-    # second table is needed for interpretation, using a [24-hour linear
-    # smear](https://developers.google.com/time/smear).
-    #
-    # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
-    # restricting to that range, we ensure that we can convert to and from [RFC
-    # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
-    #
-    # = Examples
-    #
-    # Example 1: Compute Timestamp from POSIX `time()`.
-    #
-    #     Timestamp timestamp;
-    #     timestamp.set_seconds(time(NULL));
-    #     timestamp.set_nanos(0);
-    #
-    # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
-    #
-    #     struct timeval tv;
-    #     gettimeofday(&tv, NULL);
-    #
-    #     Timestamp timestamp;
-    #     timestamp.set_seconds(tv.tv_sec);
-    #     timestamp.set_nanos(tv.tv_usec * 1000);
-    #
-    # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
-    #
-    #     FILETIME ft;
-    #     GetSystemTimeAsFileTime(&ft);
-    #     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
-    #
-    #     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
-    #     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
-    #     Timestamp timestamp;
-    #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
-    #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
-    #
-    # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
-    #
-    #     long millis = System.currentTimeMillis();
-    #
-    #     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
-    #         .setNanos((int) ((millis % 1000) * 1000000)).build();
-    #
-    #
-    # Example 5: Compute Timestamp from current time in Python.
-    #
-    #     timestamp = Timestamp()
-    #     timestamp.GetCurrentTime()
-    #
-    # = JSON Mapping
-    #
-    # In JSON format, the Timestamp type is encoded as a string in the
-    # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
-    # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
-    # where \\{year} is always expressed using four digits while \\{month}, \\{day},
-    # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
-    # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
-    # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
-    # is required. A proto3 JSON serializer should always use UTC (as indicated by
-    # "Z") when printing the Timestamp type and a proto3 JSON parser should be
-    # able to accept both UTC and other timezones (as indicated by an offset).
-    #
-    # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
-    # 01:30 UTC on January 15, 2017.
-    #
-    # In JavaScript, one can convert a Date object to this format using the
-    # standard
-    # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
-    # method. In Python, a standard `datetime.datetime` object can be converted
-    # to this format using
-    # [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
-    # the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
-    # the Joda Time's [`ISODateTimeFormat.dateTime()`](
-    # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
-    # ) to obtain a formatter capable of generating timestamps in this format.
-    # @!attribute [rw] seconds
-    #   @return [Integer]
-    #     Represents seconds of UTC time since Unix epoch
-    #     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
-    #     9999-12-31T23:59:59Z inclusive.
-    # @!attribute [rw] nanos
-    #   @return [Integer]
-    #     Non-negative fractions of a second at nanosecond resolution. Negative
-    #     second values with fractions must still have non-negative nanos values
-    #     that count forward in time. Must be from 0 to 999,999,999
-    #     inclusive.
-    class Timestamp; end
-  end
-end

data/lib/google/cloud/spanner/v1/doc/google/rpc/status.rb

@@ -1,39 +0,0 @@
-# Copyright 2020 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
-#
-#     https://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.
-
-
-module Google
-  module Rpc
-    # The `Status` type defines a logical error model that is suitable for
-    # different programming environments, including REST APIs and RPC APIs. It is
-    # used by [gRPC](https://github.com/grpc). Each `Status` message contains
-    # three pieces of data: error code, error message, and error details.
-    #
-    # You can find out more about this error model and how to work with it in the
-    # [API Design Guide](https://cloud.google.com/apis/design/errors).
-    # @!attribute [rw] code
-    #   @return [Integer]
-    #     The status code, which should be an enum value of {Google::Rpc::Code}.
-    # @!attribute [rw] message
-    #   @return [String]
-    #     A developer-facing error message, which should be in English. Any
-    #     user-facing error message should be localized and sent in the
-    #     {Google::Rpc::Status#details} field, or localized by the client.
-    # @!attribute [rw] details
-    #   @return [Array<Google::Protobuf::Any>]
-    #     A list of messages that carry the error details.  There is a common set of
-    #     message types for APIs to use.
-    class Status; end
-  end
-end

data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/keys.rb

@@ -1,150 +0,0 @@
-# Copyright 2020 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
-#
-#     https://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.
-
-
-module Google
-  module Spanner
-    module V1
-      # 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
-      # {Google::Spanner::V1::TypeCode here}.
-      #
-      # 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.
-      # @!attribute [rw] start_closed
-      #   @return [Google::Protobuf::ListValue]
-      #     If the start is closed, then the range includes all rows whose
-      #     first `len(start_closed)` key columns exactly match `start_closed`.
-      # @!attribute [rw] start_open
-      #   @return [Google::Protobuf::ListValue]
-      #     If the start is open, then the range excludes rows whose first
-      #     `len(start_open)` key columns exactly match `start_open`.
-      # @!attribute [rw] end_closed
-      #   @return [Google::Protobuf::ListValue]
-      #     If the end is closed, then the range includes all rows whose
-      #     first `len(end_closed)` key columns exactly match `end_closed`.
-      # @!attribute [rw] end_open
-      #   @return [Google::Protobuf::ListValue]
-      #     If the end is open, then the range excludes rows whose first
-      #     `len(end_open)` key columns exactly match `end_open`.
-      class KeyRange; end
-
-      # `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All
-      # the keys are expected to be in the same table or index. The keys need
-      # not be sorted in any particular way.
-      #
-      # If the same key is specified multiple times in the set (for example
-      # if two ranges, two keys, or a key and a range overlap), Cloud Spanner
-      # behaves as if the key were only specified once.
-      # @!attribute [rw] keys
-      #   @return [Array<Google::Protobuf::ListValue>]
-      #     A list of specific keys. Entries in `keys` should have exactly as
-      #     many elements as there are columns in the primary or index key
-      #     with which this `KeySet` is used.  Individual key values are
-      #     encoded as described {Google::Spanner::V1::TypeCode here}.
-      # @!attribute [rw] ranges
-      #   @return [Array<Google::Spanner::V1::KeyRange>]
-      #     A list of key ranges. See {Google::Spanner::V1::KeyRange KeyRange} for more information about
-      #     key range specifications.
-      # @!attribute [rw] all
-      #   @return [true, false]
-      #     For convenience `all` can be set to `true` to indicate that this
-      #     `KeySet` matches all keys in the table or index. Note that any keys
-      #     specified in `keys` or `ranges` are only yielded once.
-      class KeySet; end
-    end
-  end
-end

data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/mutation.rb

@@ -1,95 +0,0 @@
-# Copyright 2020 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
-#
-#     https://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.
-
-
-module Google
-  module Spanner
-    module V1
-      # A modification to one or more Cloud Spanner rows.  Mutations can be
-      # applied to a Cloud Spanner database by sending them in a
-      # {Google::Spanner::V1::Spanner::Commit Commit} call.
-      # @!attribute [rw] insert
-      #   @return [Google::Spanner::V1::Mutation::Write]
-      #     Insert new rows in a table. If any of the rows already exist,
-      #     the write or transaction fails with error `ALREADY_EXISTS`.
-      # @!attribute [rw] update
-      #   @return [Google::Spanner::V1::Mutation::Write]
-      #     Update existing rows in a table. If any of the rows does not
-      #     already exist, the transaction fails with error `NOT_FOUND`.
-      # @!attribute [rw] insert_or_update
-      #   @return [Google::Spanner::V1::Mutation::Write]
-      #     Like {Google::Spanner::V1::Mutation#insert insert}, except that if the row already exists, then
-      #     its column values are overwritten with the ones provided. Any
-      #     column values not explicitly written are preserved.
-      #
-      #     When using {Google::Spanner::V1::Mutation#insert_or_update insert_or_update}, just as when using {Google::Spanner::V1::Mutation#insert insert}, all `NOT
-      #     NULL` columns in the table must be given a value. This holds true
-      #     even when the row already exists and will therefore actually be updated.
-      # @!attribute [rw] replace
-      #   @return [Google::Spanner::V1::Mutation::Write]
-      #     Like {Google::Spanner::V1::Mutation#insert insert}, except that if the row already exists, it is
-      #     deleted, and the column values provided are inserted
-      #     instead. Unlike {Google::Spanner::V1::Mutation#insert_or_update insert_or_update}, this means any values not
-      #     explicitly written become `NULL`.
-      #
-      #     In an interleaved table, if you create the child table with the
-      #     `ON DELETE CASCADE` annotation, then replacing a parent row
-      #     also deletes the child rows. Otherwise, you must delete the
-      #     child rows before you replace the parent row.
-      # @!attribute [rw] delete
-      #   @return [Google::Spanner::V1::Mutation::Delete]
-      #     Delete rows from a table. Succeeds whether or not the named
-      #     rows were present.
-      class Mutation
-        # Arguments to {Google::Spanner::V1::Mutation#insert insert}, {Google::Spanner::V1::Mutation#update update}, {Google::Spanner::V1::Mutation#insert_or_update insert_or_update}, and
-        # {Google::Spanner::V1::Mutation#replace replace} operations.
-        # @!attribute [rw] table
-        #   @return [String]
-        #     Required. The table whose rows will be written.
-        # @!attribute [rw] columns
-        #   @return [Array<String>]
-        #     The names of the columns in {Google::Spanner::V1::Mutation::Write#table table} to be written.
-        #
-        #     The list of columns must contain enough columns to allow
-        #     Cloud Spanner to derive values for all primary key columns in the
-        #     row(s) to be modified.
-        # @!attribute [rw] values
-        #   @return [Array<Google::Protobuf::ListValue>]
-        #     The values to be written. `values` can contain more than one
-        #     list of values. If it does, then multiple rows are written, one
-        #     for each entry in `values`. Each list in `values` must have
-        #     exactly as many entries as there are entries in {Google::Spanner::V1::Mutation::Write#columns columns}
-        #     above. Sending multiple lists is equivalent to sending multiple
-        #     `Mutation`s, each containing one `values` entry and repeating
-        #     {Google::Spanner::V1::Mutation::Write#table table} and {Google::Spanner::V1::Mutation::Write#columns columns}. Individual values in each list are
-        #     encoded as described {Google::Spanner::V1::TypeCode here}.
-        class Write; end
-
-        # Arguments to {Google::Spanner::V1::Mutation#delete delete} operations.
-        # @!attribute [rw] table
-        #   @return [String]
-        #     Required. The table whose rows will be deleted.
-        # @!attribute [rw] key_set
-        #   @return [Google::Spanner::V1::KeySet]
-        #     Required. The primary keys of the rows within {Google::Spanner::V1::Mutation::Delete#table table} to delete.  The
-        #     primary keys must be specified in the order in which they appear in the
-        #     `PRIMARY KEY()` clause of the table's equivalent DDL statement (the DDL
-        #     statement used to create the table).
-        #     Delete is idempotent. The transaction will succeed even if some or all
-        #     rows do not exist.
-        class Delete; end
-      end
-    end
-  end
-end

data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/query_plan.rb

@@ -1,121 +0,0 @@
-# Copyright 2020 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
-#
-#     https://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.
-
-
-module Google
-  module Spanner
-    module V1
-      # Node information for nodes appearing in a {Google::Spanner::V1::QueryPlan#plan_nodes QueryPlan#plan_nodes}.
-      # @!attribute [rw] index
-      #   @return [Integer]
-      #     The `PlanNode`'s index in {Google::Spanner::V1::QueryPlan#plan_nodes node list}.
-      # @!attribute [rw] kind
-      #   @return [Google::Spanner::V1::PlanNode::Kind]
-      #     Used to determine the type of node. May be needed for visualizing
-      #     different kinds of nodes differently. For example, If the node is a
-      #     {Google::Spanner::V1::PlanNode::Kind::SCALAR SCALAR} node, it will have a condensed representation
-      #     which can be used to directly embed a description of the node in its
-      #     parent.
-      # @!attribute [rw] display_name
-      #   @return [String]
-      #     The display name for the node.
-      # @!attribute [rw] child_links
-      #   @return [Array<Google::Spanner::V1::PlanNode::ChildLink>]
-      #     List of child node `index`es and their relationship to this parent.
-      # @!attribute [rw] short_representation
-      #   @return [Google::Spanner::V1::PlanNode::ShortRepresentation]
-      #     Condensed representation for {Google::Spanner::V1::PlanNode::Kind::SCALAR SCALAR} nodes.
-      # @!attribute [rw] metadata
-      #   @return [Google::Protobuf::Struct]
-      #     Attributes relevant to the node contained in a group of key-value pairs.
-      #     For example, a Parameter Reference node could have the following
-      #     information in its metadata:
-      #
-      #         {
-      #           "parameter_reference": "param1",
-      #           "parameter_type": "array"
-      #         }
-      # @!attribute [rw] execution_stats
-      #   @return [Google::Protobuf::Struct]
-      #     The execution statistics associated with the node, contained in a group of
-      #     key-value pairs. Only present if the plan was returned as a result of a
-      #     profile query. For example, number of executions, number of rows/time per
-      #     execution etc.
-      class PlanNode
-        # Metadata associated with a parent-child relationship appearing in a
-        # {Google::Spanner::V1::PlanNode PlanNode}.
-        # @!attribute [rw] child_index
-        #   @return [Integer]
-        #     The node to which the link points.
-        # @!attribute [rw] type
-        #   @return [String]
-        #     The type of the link. For example, in Hash Joins this could be used to
-        #     distinguish between the build child and the probe child, or in the case
-        #     of the child being an output variable, to represent the tag associated
-        #     with the output variable.
-        # @!attribute [rw] variable
-        #   @return [String]
-        #     Only present if the child node is {Google::Spanner::V1::PlanNode::Kind::SCALAR SCALAR} and corresponds
-        #     to an output variable of the parent node. The field carries the name of
-        #     the output variable.
-        #     For example, a `TableScan` operator that reads rows from a table will
-        #     have child links to the `SCALAR` nodes representing the output variables
-        #     created for each column that is read by the operator. The corresponding
-        #     `variable` fields will be set to the variable names assigned to the
-        #     columns.
-        class ChildLink; end
-
-        # Condensed representation of a node and its subtree. Only present for
-        # `SCALAR` {Google::Spanner::V1::PlanNode PlanNode(s)}.
-        # @!attribute [rw] description
-        #   @return [String]
-        #     A string representation of the expression subtree rooted at this node.
-        # @!attribute [rw] subqueries
-        #   @return [Hash{String => Integer}]
-        #     A mapping of (subquery variable name) -> (subquery node id) for cases
-        #     where the `description` string of this node references a `SCALAR`
-        #     subquery contained in the expression subtree rooted at this node. The
-        #     referenced `SCALAR` subquery may not necessarily be a direct child of
-        #     this node.
-        class ShortRepresentation; end
-
-        # The kind of {Google::Spanner::V1::PlanNode PlanNode}. Distinguishes between the two different kinds of
-        # nodes that can appear in a query plan.
-        module Kind
-          # Not specified.
-          KIND_UNSPECIFIED = 0
-
-          # Denotes a Relational operator node in the expression tree. Relational
-          # operators represent iterative processing of rows during query execution.
-          # For example, a `TableScan` operation that reads rows from a table.
-          RELATIONAL = 1
-
-          # Denotes a Scalar node in the expression tree. Scalar nodes represent
-          # non-iterable entities in the query plan. For example, constants or
-          # arithmetic operators appearing inside predicate expressions or references
-          # to column names.
-          SCALAR = 2
-        end
-      end
-
-      # Contains an ordered list of nodes appearing in the query plan.
-      # @!attribute [rw] plan_nodes
-      #   @return [Array<Google::Spanner::V1::PlanNode>]
-      #     The nodes in the query plan. Plan nodes are returned in pre-order starting
-      #     with the plan root. Each {Google::Spanner::V1::PlanNode PlanNode}'s `id` corresponds to its index in
-      #     `plan_nodes`.
-      class QueryPlan; end
-    end
-  end
-end