google-cloud-datastore 1.1.0 → 1.2.0

data/lib/google/cloud/datastore/v1/datastore_client_config.json

@@ -49,6 +49,11 @@
           "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
+        },
+        "ReserveIds": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
         }
       }
     }

data/lib/google/cloud/datastore/v1/doc/google/datastore/v1/datastore.rb

@@ -14,8 +14,19 @@
 
 module Google
   module Datastore
+    ##
+    # # Google Cloud Datastore API Contents
+    #
+    # | Class | Description |
+    # | ----- | ----------- |
+    # | [DatastoreClient][] | Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application. |
+    # | [Data Types][] | Data types for Google::Cloud::Datastore::V1 |
+    #
+    # [DatastoreClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-datastore/latest/google/datastore/v1/datastoreclient
+    # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-datastore/latest/google/datastore/v1/datatypes
+    #
     module V1
-      # The request for Datastore::Lookup.
+      # The request for {Google::Datastore::V1::Datastore::Lookup Datastore::Lookup}.
       # @!attribute [rw] project_id
       #   @return [String]
       #     The ID of the project against which to make the request.
@@ -27,7 +38,7 @@ module Google
       #     Keys of entities to look up.
       class LookupRequest; end
 
-      # The response for Datastore::Lookup.
+      # The response for {Google::Datastore::V1::Datastore::Lookup Datastore::Lookup}.
       # @!attribute [rw] found
       #   @return [Array<Google::Datastore::V1::EntityResult>]
       #     Entities found as +ResultType.FULL+ entities. The order of results in this
@@ -45,7 +56,7 @@ module Google
       #     order of the keys in the input.
       class LookupResponse; end
 
-      # The request for Datastore::RunQuery.
+      # The request for {Google::Datastore::V1::Datastore::RunQuery Datastore::RunQuery}.
       # @!attribute [rw] project_id
       #   @return [String]
       #     The ID of the project against which to make the request.
@@ -66,7 +77,7 @@ module Google
       #     The GQL query to run.
       class RunQueryRequest; end
 
-      # The response for Datastore::RunQuery.
+      # The response for {Google::Datastore::V1::Datastore::RunQuery Datastore::RunQuery}.
       # @!attribute [rw] batch
       #   @return [Google::Datastore::V1::QueryResultBatch]
       #     A batch of query results (always present).
@@ -75,33 +86,36 @@ module Google
       #     The parsed form of the +GqlQuery+ from the request, if it was set.
       class RunQueryResponse; end
 
-      # The request for Datastore::BeginTransaction.
+      # The request for {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
       # @!attribute [rw] project_id
       #   @return [String]
       #     The ID of the project against which to make the request.
+      # @!attribute [rw] transaction_options
+      #   @return [Google::Datastore::V1::TransactionOptions]
+      #     Options for a new transaction.
       class BeginTransactionRequest; end
 
-      # The response for Datastore::BeginTransaction.
+      # The response for {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
       # @!attribute [rw] transaction
       #   @return [String]
       #     The transaction identifier (always present).
       class BeginTransactionResponse; end
 
-      # The request for Datastore::Rollback.
+      # The request for {Google::Datastore::V1::Datastore::Rollback Datastore::Rollback}.
       # @!attribute [rw] project_id
       #   @return [String]
       #     The ID of the project against which to make the request.
       # @!attribute [rw] transaction
       #   @return [String]
       #     The transaction identifier, returned by a call to
-      #     Datastore::BeginTransaction.
+      #     {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
       class RollbackRequest; end
 
-      # The response for Datastore::Rollback.
+      # The response for {Google::Datastore::V1::Datastore::Rollback Datastore::Rollback}.
       # (an empty message).
       class RollbackResponse; end
 
-      # The request for Datastore::Commit.
+      # The request for {Google::Datastore::V1::Datastore::Commit Datastore::Commit}.
       # @!attribute [rw] project_id
       #   @return [String]
       #     The ID of the project against which to make the request.
@@ -112,7 +126,7 @@ module Google
       #   @return [String]
       #     The identifier of the transaction associated with the commit. A
       #     transaction identifier is returned by a call to
-      #     Datastore::BeginTransaction.
+      #     {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
       # @!attribute [rw] mutations
       #   @return [Array<Google::Datastore::V1::Mutation>]
       #     The mutations to perform.
@@ -121,10 +135,10 @@ module Google
       #     applied in order. The following sequences of mutations affecting a single
       #     entity are not permitted in a single +Commit+ request:
       #
-      #     - +insert+ followed by +insert+
-      #     - +update+ followed by +insert+
-      #     - +upsert+ followed by +insert+
-      #     - +delete+ followed by +update+
+      #     * +insert+ followed by +insert+
+      #     * +update+ followed by +insert+
+      #     * +upsert+ followed by +insert+
+      #     * +delete+ followed by +update+
       #
       #     When mode is +NON_TRANSACTIONAL+, no two mutations may affect a single
       #     entity.
@@ -135,7 +149,7 @@ module Google
           MODE_UNSPECIFIED = 0
 
           # Transactional: The mutations are either all applied, or none are applied.
-          # Learn about transactions {here}[https://cloud.google.com/datastore/docs/concepts/transactions].
+          # Learn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).
           TRANSACTIONAL = 1
 
           # Non-transactional: The mutations may not apply as all or none.
@@ -143,7 +157,7 @@ module Google
         end
       end
 
-      # The response for Datastore::Commit.
+      # The response for {Google::Datastore::V1::Datastore::Commit Datastore::Commit}.
       # @!attribute [rw] mutation_results
       #   @return [Array<Google::Datastore::V1::MutationResult>]
       #     The result of performing the mutations.
@@ -154,7 +168,7 @@ module Google
       #     updated.
       class CommitResponse; end
 
-      # The request for Datastore::AllocateIds.
+      # The request for {Google::Datastore::V1::Datastore::AllocateIds Datastore::AllocateIds}.
       # @!attribute [rw] project_id
       #   @return [String]
       #     The ID of the project against which to make the request.
@@ -164,13 +178,29 @@ module Google
       #     No key may be reserved/read-only.
       class AllocateIdsRequest; end
 
-      # The response for Datastore::AllocateIds.
+      # The response for {Google::Datastore::V1::Datastore::AllocateIds Datastore::AllocateIds}.
       # @!attribute [rw] keys
       #   @return [Array<Google::Datastore::V1::Key>]
       #     The keys specified in the request (in the same order), each with
       #     its key path completed with a newly allocated ID.
       class AllocateIdsResponse; end
 
+      # The request for {Google::Datastore::V1::Datastore::ReserveIds Datastore::ReserveIds}.
+      # @!attribute [rw] project_id
+      #   @return [String]
+      #     The ID of the project against which to make the request.
+      # @!attribute [rw] database_id
+      #   @return [String]
+      #     If not empty, the ID of the database against which to make the request.
+      # @!attribute [rw] keys
+      #   @return [Array<Google::Datastore::V1::Key>]
+      #     A list of keys with complete key paths whose numeric IDs should not be
+      #     auto-allocated.
+      class ReserveIdsRequest; end
+
+      # The response for {Google::Datastore::V1::Datastore::ReserveIds Datastore::ReserveIds}.
+      class ReserveIdsResponse; end
+
       # A mutation to apply to an entity.
       # @!attribute [rw] insert
       #   @return [Google::Datastore::V1::Entity]
@@ -221,7 +251,7 @@ module Google
       #   @return [String]
       #     The identifier of the transaction in which to read. A
       #     transaction identifier is returned by a call to
-      #     Datastore::BeginTransaction.
+      #     {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
       class ReadOptions
         # The possible values for read consistencies.
         module ReadConsistency
@@ -235,6 +265,28 @@ module Google
           EVENTUAL = 2
         end
       end
+
+      # Options for beginning a new transaction.
+      #
+      # Transactions can be created explicitly with calls to
+      # {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction} or implicitly by setting
+      # {Google::Datastore::V1::ReadOptions#new_transaction ReadOptions#new_transaction} in read requests.
+      # @!attribute [rw] read_write
+      #   @return [Google::Datastore::V1::TransactionOptions::ReadWrite]
+      #     The transaction should allow both reads and writes.
+      # @!attribute [rw] read_only
+      #   @return [Google::Datastore::V1::TransactionOptions::ReadOnly]
+      #     The transaction should only allow reads.
+      class TransactionOptions
+        # Options specific to read / write transactions.
+        # @!attribute [rw] previous_transaction
+        #   @return [String]
+        #     The transaction identifier of the transaction being retried.
+        class ReadWrite; end
+
+        # Options specific to read-only transactions.
+        class ReadOnly; end
+      end
     end
   end
 end

data/lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb

@@ -23,13 +23,13 @@ module Google
       #
       # Partition dimensions:
       #
-      # - May be +""+.
-      # - Must be valid UTF-8 bytes.
-      # - Must have values that match regex +[A-Za-z\d\.\-_]{1,100}+
-      # If the value of any dimension matches regex +__.*__+, the partition is
-      # reserved/read-only.
-      # A reserved/read-only partition ID is forbidden in certain documented
-      # contexts.
+      # * May be +""+.
+      # * Must be valid UTF-8 bytes.
+      # * Must have values that match regex +[A-Za-z\d\.\-_]{1,100}+
+      #   If the value of any dimension matches regex +__.*__+, the partition is
+      #   reserved/read-only.
+      #   A reserved/read-only partition ID is forbidden in certain documented
+      #   contexts.
       #
       # Foreign partition IDs (in which the project ID does
       # not match the context project ID ) are discouraged.
@@ -142,9 +142,9 @@ module Google
       #   @return [Google::Datastore::V1::Entity]
       #     An entity value.
       #
-      #     - May have no key.
-      #     - May have a key with an incomplete key path.
-      #     - May have a reserved/read-only key.
+      #     * May have no key.
+      #     * May have a key with an incomplete key path.
+      #     * May have a reserved/read-only key.
       # @!attribute [rw] array_value
       #   @return [Google::Datastore::V1::ArrayValue]
       #     An array value.

data/lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb

@@ -24,10 +24,10 @@ module Google
       #     The version of the entity, a strictly positive number that monotonically
       #     increases with changes to the entity.
       #
-      #     This field is set for +FULL+ entity
+      #     This field is set for {Google::Datastore::V1::EntityResult::ResultType::FULL +FULL+} entity
       #     results.
       #
-      #     For Missing entities in +LookupResponse+, this
+      #     For {Google::Datastore::V1::LookupResponse#missing missing} entities in +LookupResponse+, this
       #     is the version of the snapshot that was used to look up the entity, and it
       #     is always set except for eventually consistent reads.
       # @!attribute [rw] cursor
@@ -78,12 +78,12 @@ module Google
       #   @return [String]
       #     A starting point for the query results. Query cursors are
       #     returned in query result batches and
-      #     {can only be used to continue the same query}[https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets].
+      #     [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
       # @!attribute [rw] end_cursor
       #   @return [String]
       #     An ending point for the query results. Query cursors are
       #     returned in query result batches and
-      #     {can only be used to limit the same query}[https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets].
+      #     [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
       # @!attribute [rw] offset
       #   @return [Integer]
       #     The number of results to skip. Applies before limit, but after all other
@@ -200,11 +200,11 @@ module Google
         end
       end
 
-      # A {GQL query}[https://cloud.google.com/datastore/docs/apis/gql/gql_reference].
+      # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
       # @!attribute [rw] query_string
       #   @return [String]
       #     A string of the format described
-      #     {here}[https://cloud.google.com/datastore/docs/apis/gql/gql_reference].
+      #     [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
       # @!attribute [rw] allow_literals
       #   @return [true, false]
       #     When false, the query string must not contain any literals and instead must
@@ -284,7 +284,7 @@ module Google
           # cursor.
           MORE_RESULTS_AFTER_CURSOR = 4
 
-          # The query has been exhausted.
+          # The query is finished, and there are no more results.
           NO_MORE_RESULTS = 3
         end
       end

data/lib/google/cloud/datastore/v1/doc/overview.rb

@@ -0,0 +1,54 @@
+# Copyright 2017, Google Inc. 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.
+
+module Google
+  module Cloud
+    # rubocop:disable LineLength
+
+    ##
+    # # Ruby Client for Google Cloud Datastore API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    #
+    # [Google Cloud Datastore API][Product Documentation]:
+    # Accesses the schemaless NoSQL database to provide fully managed, robust,
+    # scalable storage for your application.
+    # - [Product Documentation][]
+    #
+    # ## Quick Start
+    # In order to use this library, you first need to go through the following
+    # steps:
+    #
+    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+    # 2. [Enable the Google Cloud Datastore API.](https://console.cloud.google.com/apis/api/datastore)
+    # 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Installation
+    # ```
+    # $ gem install google-cloud-datastore
+    # ```
+    #
+    # ### Next Steps
+    # - Read the [Google Cloud Datastore API Product documentation][Product Documentation]
+    #   to learn more about the product and see How-to Guides.
+    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+    #   to see the full list of Cloud APIs that we cover.
+    #
+    # [Product Documentation]: https://cloud.google.com/datastore
+    #
+    #
+    module Datastore
+      module V1
+      end
+    end
+  end
+end

data/lib/google/cloud/datastore/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Datastore
-      VERSION = "1.1.0"
+      VERSION = "1.2.0"
     end
   end
 end

data/lib/google/datastore/v1/datastore_pb.rb

@@ -32,6 +32,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   end
   add_message "google.datastore.v1.BeginTransactionRequest" do
     optional :project_id, :string, 8
+    optional :transaction_options, :message, 10, "google.datastore.v1.TransactionOptions"
   end
   add_message "google.datastore.v1.BeginTransactionResponse" do
     optional :transaction, :bytes, 1
@@ -66,6 +67,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "google.datastore.v1.AllocateIdsResponse" do
     repeated :keys, :message, 1, "google.datastore.v1.Key"
   end
+  add_message "google.datastore.v1.ReserveIdsRequest" do
+    optional :project_id, :string, 8
+    optional :database_id, :string, 9
+    repeated :keys, :message, 1, "google.datastore.v1.Key"
+  end
+  add_message "google.datastore.v1.ReserveIdsResponse" do
+  end
   add_message "google.datastore.v1.Mutation" do
     oneof :operation do
       optional :insert, :message, 4, "google.datastore.v1.Entity"
@@ -93,6 +101,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     value :STRONG, 1
     value :EVENTUAL, 2
   end
+  add_message "google.datastore.v1.TransactionOptions" do
+    oneof :mode do
+      optional :read_write, :message, 1, "google.datastore.v1.TransactionOptions.ReadWrite"
+      optional :read_only, :message, 2, "google.datastore.v1.TransactionOptions.ReadOnly"
+    end
+  end
+  add_message "google.datastore.v1.TransactionOptions.ReadWrite" do
+    optional :previous_transaction, :bytes, 1
+  end
+  add_message "google.datastore.v1.TransactionOptions.ReadOnly" do
+  end
 end
 
 module Google
@@ -111,10 +130,15 @@ module Google
       CommitResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.CommitResponse").msgclass
       AllocateIdsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.AllocateIdsRequest").msgclass
       AllocateIdsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.AllocateIdsResponse").msgclass
+      ReserveIdsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.ReserveIdsRequest").msgclass
+      ReserveIdsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.ReserveIdsResponse").msgclass
       Mutation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.Mutation").msgclass
       MutationResult = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.MutationResult").msgclass
       ReadOptions = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.ReadOptions").msgclass
       ReadOptions::ReadConsistency = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.ReadOptions.ReadConsistency").enummodule
+      TransactionOptions = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.TransactionOptions").msgclass
+      TransactionOptions::ReadWrite = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.TransactionOptions.ReadWrite").msgclass
+      TransactionOptions::ReadOnly = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.TransactionOptions.ReadOnly").msgclass
     end
   end
 end

data/lib/google/datastore/v1/datastore_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/datastore/v1/datastore.proto for package 'google.datastore.v1'
 # Original file comments:
-# Copyright 2016 Google Inc.
+# Copyright 2017 Google Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -52,6 +52,9 @@ module Google
           # Allocates IDs for the given keys, which is useful for referencing an entity
           # before it is inserted.
           rpc :AllocateIds, AllocateIdsRequest, AllocateIdsResponse
+          # Prevents the supplied keys' IDs from being auto-allocated by Cloud
+          # Datastore.
+          rpc :ReserveIds, ReserveIdsRequest, ReserveIdsResponse
         end
 
         Stub = Service.rpc_stub_class

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-datastore
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -17,42 +17,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: google-gax
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -214,6 +214,7 @@ files:
 - lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb
 - lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb
 - lib/google/cloud/datastore/v1/doc/google/protobuf/wrappers.rb
+- lib/google/cloud/datastore/v1/doc/overview.rb
 - lib/google/cloud/datastore/version.rb
 - lib/google/datastore/v1/datastore_pb.rb
 - lib/google/datastore/v1/datastore_services_pb.rb
@@ -239,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Datastore