google-cloud-datastore 1.7.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a29b6748c619ac4ab18f6fdeb209b5abdbdab08ec6bd76fd31b751bb79a1d147
-  data.tar.gz: 3b77201abcdaead06a37eb19c39fdd2ba8e480eff2b191a05fd76547a8c0a93e
+  metadata.gz: 826035219f59542e1883c4bd94ae39ecd846bf15d5449a3494553fdf3f97b1b3
+  data.tar.gz: 4896e0241e4853b98c58ad176fc8d7497c6e48e57ef621227c6feeeadcdd8002
 SHA512:
-  metadata.gz: b9f41907d8ac7577068d992acb6c3cbffcc03a9167ac98c3ff5e1d10da677aebc5f7f3a73a70c3437775ade84eee2b2b519621dba8bce0ededc3ad648feab533
-  data.tar.gz: 8f973fce895ea84f1f6547a53a24c57ee3b9893d481ab9fdb6d9751ba43ee31b50f4f1b18204bc01bbd82bc8bdedcfa1831354ecf80a1f11068b125caf06e03e
+  metadata.gz: 462c9cea295f6f9c162b69f4b4494bd681928c5970a96eb1de89896535f732de81150fe2b3f7ef35a00396c7a917269c42e0fda6cdc70d974e984d309caf7dec
+  data.tar.gz: 4be0857cc53dab982c5542e04249b66bb2e6475666343623f778b1310e16f2de2f12861345dc2794289bd27beaf8e05269541f9b2f2c1f42f753a3113375a76e

data/AUTHENTICATION.md

@@ -76,7 +76,8 @@ The environment variables that google-cloud-datastore checks for project ID are:
 1. `DATASTORE_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that google-cloud-datastore checks for credentials are configured on {Google::Cloud::Datastore::V1::Credentials}:
+The environment variables that google-cloud-datastore checks for credentials are configured on
+{Google::Cloud::Datastore::Credentials}:
 
 1. `DATASTORE_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `DATASTORE_KEYFILE` - Path to JSON file, or JSON contents

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Release History
 
+### 2.0.0 / 2020-08-06
+
+This is a major update that removes the "low-level" client interface code, and
+instead adds the new `google-cloud-datastore-v1` gem as a dependency.
+The new dependency is a rewritten low-level client, produced by a next-
+generation client code generator, with improved performance and stability.
+
+This change should have no effect on the high-level interface that most users
+will use. The one exception is that the (mostly undocumented) `client_config`
+argument, for adjusting low-level parameters such as RPC retry settings on
+client objects, has been removed. If you need to adjust these parameters, use
+the configuration interface in `google-cloud-datastore-v1`.
+
+Substantial changes have been made in the low-level interfaces, however. If you
+are using the low-level classes under the `Google::Cloud::Datastore::V1` module,
+please review the docs for the new `google-cloud-datastore-v1` gem. In
+particular:
+
+* Some classes have been renamed, notably the client class itself.
+* The client constructor takes a configuration block instead of configuration
+  keyword arguments.
+* All RPC method arguments are now keyword arguments.
+
+### 1.8.2 / 2020-05-28
+
+#### Documentation
+
+* Fix a few broken links
+
+### 1.8.1 / 2020-05-19
+
+#### Bug Fixes
+
+* Adjusted some default timeout and retry settings
+
+### 1.8.0 / 2020-03-11
+
+#### Features
+
+* Support separate project setting for quota/billing
+
+### 1.7.3 / 2020-01-23
+
+#### Documentation
+
+* Update copyright year
+
 ### 1.7.2 / 2019-12-12
 
 #### Bug Fixes

data/TROUBLESHOOTING.md

@@ -24,14 +24,8 @@ improved, *please* create a new issue on GitHub so we can talk about it.
 
   - [New issue][gh-ruby]
 
-Or, you can ask questions on the [Google Cloud Platform Slack][slack-ruby]. You
-can use the "ruby" channel for general Ruby questions, or use the
-"google-cloud-ruby" channel if you have questions about this gem in particular.
-
 [so-ruby]: http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby+datastore
 
-[gh-search-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues?q=label%3A%22api%3A+datastore%22
-
-[gh-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues/new
+[gh-search-ruby]: https://github.com/googleapis/google-cloud-ruby/issues?q=label%3A%22api%3A+datastore%22
 
-[slack-ruby]: https://gcp-slack.appspot.com/
+[gh-ruby]: https://github.com/googleapis/google-cloud-ruby/issues/new

data/lib/google-cloud-datastore.rb

@@ -42,8 +42,6 @@ module Google
     #
     #   * `https://www.googleapis.com/auth/datastore`
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. See Google::Gax::CallSettings. Optional.
     #
     # @return [Google::Cloud::Datastore::Dataset]
     #
@@ -69,10 +67,9 @@ module Google
     #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
     #   datastore = gcloud.datastore scope: platform_scope
     #
-    def datastore scope: nil, timeout: nil, client_config: nil
+    def datastore scope: nil, timeout: nil
       Google::Cloud.datastore @project, @keyfile,
-                              scope: scope, timeout: (timeout || @timeout),
-                              client_config: client_config
+                              scope: scope, timeout: (timeout || @timeout)
     end
 
     ##
@@ -96,8 +93,6 @@ module Google
     #
     #   * `https://www.googleapis.com/auth/datastore`
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. See Google::Gax::CallSettings. Optional.
     #
     # @return [Google::Cloud::Datastore::Dataset]
     #
@@ -117,12 +112,11 @@ module Google
     #   datastore.save task
     #
     def self.datastore project_id = nil, credentials = nil, scope: nil,
-                       timeout: nil, client_config: nil
+                       timeout: nil
       require "google/cloud/datastore"
       Google::Cloud::Datastore.new project_id: project_id,
                                    credentials: credentials,
-                                   scope: scope, timeout: timeout,
-                                   client_config: client_config
+                                   scope: scope, timeout: timeout
     end
   end
 end
@@ -141,17 +135,17 @@ Google::Cloud.configure.add_config! :datastore do |config|
   default_emulator = Google::Cloud::Config.deferred do
     ENV["DATASTORE_EMULATOR_HOST"]
   end
+  default_scopes = [
+    "https://www.googleapis.com/auth/cloud-platform",
+    "https://www.googleapis.com/auth/datastore"
+  ]
 
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
-  config.add_field! :credentials, default_creds,
-                    match: [String, Hash, Google::Auth::Credentials],
-                    allow_nil: true
+  config.add_field! :credentials, default_creds, match: [String, Hash, Google::Auth::Credentials], allow_nil: true
   config.add_alias! :keyfile, :credentials
-  config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :scope, default_scopes, match: [String, Array]
   config.add_field! :timeout, nil, match: Integer
-  config.add_field! :client_config, nil, match: Hash
-  config.add_field! :emulator_host, default_emulator,
-                    match: String, allow_nil: true
-  config.add_field! :endpoint, nil, match: String
+  config.add_field! :emulator_host, default_emulator, match: String, allow_nil: true
+  config.add_field! :endpoint, "datastore.googleapis.com", match: String
 end

data/lib/google/cloud/datastore.rb

@@ -70,8 +70,6 @@ module Google
       #
       #   * `https://www.googleapis.com/auth/datastore`
       # @param [Integer] timeout Default timeout to use in requests. Optional.
-      # @param [Hash] client_config A hash of values to override the default
-      #   behavior of the API client. See Google::Gax::CallSettings. Optional.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
       # @param [String] emulator_host Datastore emulator host. Optional.
@@ -99,13 +97,17 @@ module Google
       #
       #   datastore.save task
       #
-      def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil,
-                   client_config: nil, endpoint: nil, emulator_host: nil,
-                   project: nil, keyfile: nil
+      def self.new project_id: nil,
+                   credentials: nil,
+                   scope: nil,
+                   timeout: nil,
+                   endpoint: nil,
+                   emulator_host: nil,
+                   project: nil,
+                   keyfile: nil
         project_id    ||= (project || default_project_id)
         scope         ||= configure.scope
         timeout       ||= configure.timeout
-        client_config ||= configure.client_config
         endpoint      ||= configure.endpoint
         emulator_host ||= configure.emulator_host
 
@@ -116,8 +118,7 @@ module Google
           return Datastore::Dataset.new(
             Datastore::Service.new(
               project_id, :this_channel_is_insecure,
-              host: emulator_host, timeout: timeout,
-              client_config: client_config
+              host: emulator_host, timeout: timeout
             )
           )
         end
@@ -136,7 +137,7 @@ module Google
         Datastore::Dataset.new(
           Datastore::Service.new(
             project_id, credentials,
-            host: endpoint, timeout: timeout, client_config: client_config
+            host: endpoint, timeout: timeout
           )
         )
       end
@@ -158,8 +159,6 @@ module Google
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       # * `timeout` - (Integer) Default timeout to use in requests.
-      # * `client_config` - (Hash) A hash of values to override the default
-      #   behavior of the API client.
       # * `endpoint` - (String) Override of the endpoint host name, or `nil`
       #   to use the default endpoint.
       # * `emulator_host` - (String) Host name of the emulator. Defaults to
@@ -191,4 +190,6 @@ module Google
       end
     end
   end
+  ## Legacy generated client namespace
+  Datastore = Cloud::Datastore unless const_defined? :Datastore
 end

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

@@ -136,16 +136,16 @@ module Google
         def mutations
           mutations = []
           mutations += @shared_upserts.map do |entity|
-            Google::Datastore::V1::Mutation.new upsert: entity.to_grpc
+            Google::Cloud::Datastore::V1::Mutation.new upsert: entity.to_grpc
           end
           mutations += @shared_inserts.map do |entity|
-            Google::Datastore::V1::Mutation.new insert: entity.to_grpc
+            Google::Cloud::Datastore::V1::Mutation.new insert: entity.to_grpc
           end
           mutations += @shared_updates.map do |entity|
-            Google::Datastore::V1::Mutation.new update: entity.to_grpc
+            Google::Cloud::Datastore::V1::Mutation.new update: entity.to_grpc
           end
           mutations += @shared_deletes.map do |key|
-            Google::Datastore::V1::Mutation.new delete: key.to_grpc
+            Google::Cloud::Datastore::V1::Mutation.new delete: key.to_grpc
           end
           mutations
         end

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

@@ -77,7 +77,7 @@ module Google
         end
 
         ##
-        # Gets an object from a Google::Datastore::V1::Value.
+        # Gets an object from a Google::Cloud::Datastore::V1::Value.
         def self.from_value grpc_value
           if grpc_value.value_type == :null_value
             return nil
@@ -110,9 +110,9 @@ module Google
         end
 
         ##
-        # Stores an object into a Google::Datastore::V1::Value.
+        # Stores an object into a Google::Cloud::Datastore::V1::Value.
         def self.to_value value
-          v = Google::Datastore::V1::Value.new
+          v = Google::Cloud::Datastore::V1::Value.new
           if NilClass === value
             v.null_value = :NULL_VALUE
           elsif TrueClass === value
@@ -133,7 +133,7 @@ module Google
           elsif String === value
             v.string_value = value
           elsif Array === value
-            v.array_value = Google::Datastore::V1::ArrayValue.new(
+            v.array_value = Google::Cloud::Datastore::V1::ArrayValue.new(
               values: value.map { |val| to_value val }
             )
           elsif value.respond_to? :to_time

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

@@ -14,7 +14,7 @@
 
 
 require "googleauth"
-require "google/cloud/datastore/v1/credentials"
+require "google/cloud/datastore/v1/datastore/credentials"
 
 module Google
   module Cloud
@@ -38,7 +38,7 @@ module Google
       #
       #   datastore.project_id #=> "my-todo-project"
       #
-      class Credentials < Google::Cloud::Datastore::V1::Credentials
+      class Credentials < Google::Cloud::Datastore::V1::Datastore::Credentials
       end
     end
   end

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

@@ -427,10 +427,10 @@ module Google
         end
 
         ##
-        # @private Convert the Entity to a Google::Datastore::V1::Entity
+        # @private Convert the Entity to a Google::Cloud::Datastore::V1::Entity
         # object.
         def to_grpc
-          grpc = Google::Datastore::V1::Entity.new(
+          grpc = Google::Cloud::Datastore::V1::Entity.new(
             properties: @properties.to_grpc
           )
           grpc.key = @key.to_grpc unless @key.nil?
@@ -439,7 +439,7 @@ module Google
         end
 
         ##
-        # @private Create a new Entity from a Google::Datastore::V1::Key
+        # @private Create a new Entity from a Google::Cloud::Datastore::V1::Key
         # object.
         def self.from_grpc grpc
           entity = Entity.new

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

@@ -49,7 +49,7 @@ module Google
         #   gql_query = Google::Cloud::Datastore::GqlQuery.new
         #
         def initialize
-          @grpc = Google::Datastore::V1::GqlQuery.new
+          @grpc = Google::Cloud::Datastore::V1::GqlQuery.new
         end
 
         ##
@@ -159,12 +159,12 @@ module Google
           new_named_bindings.map do |name, value|
             if value.is_a? Google::Cloud::Datastore::Cursor
               @grpc.named_bindings[name.to_s] = \
-                Google::Datastore::V1::GqlQueryParameter.new(
+                Google::Cloud::Datastore::V1::GqlQueryParameter.new(
                   cursor: value.to_grpc
                 )
             else
               @grpc.named_bindings[name.to_s] = \
-                Google::Datastore::V1::GqlQueryParameter.new(
+                Google::Cloud::Datastore::V1::GqlQueryParameter.new(
                   value: Convert.to_value(value)
                 )
             end
@@ -210,12 +210,12 @@ module Google
           new_positional_bindings.map do |value|
             if value.is_a? Google::Cloud::Datastore::Cursor
               @grpc.positional_bindings << \
-                Google::Datastore::V1::GqlQueryParameter.new(
+                Google::Cloud::Datastore::V1::GqlQueryParameter.new(
                   cursor: value.to_grpc
                 )
             else
               @grpc.positional_bindings << \
-                Google::Datastore::V1::GqlQueryParameter.new(
+                Google::Cloud::Datastore::V1::GqlQueryParameter.new(
                   value: Convert.to_value(value)
                 )
             end

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

@@ -268,7 +268,7 @@ module Google
         end
 
         ##
-        # @private Convert the Key to a Google::Datastore::V1::Key object.
+        # @private Convert the Key to a Google::Cloud::Datastore::V1::Key object.
         def to_grpc
           grpc_path = path.map do |pe_kind, pe_id_or_name|
             path_args = { kind: pe_kind }
@@ -277,11 +277,11 @@ module Google
             elsif pe_id_or_name.is_a? String
               path_args[:name] = pe_id_or_name unless pe_id_or_name.empty?
             end
-            Google::Datastore::V1::Key::PathElement.new path_args
+            Google::Cloud::Datastore::V1::Key::PathElement.new path_args
           end
-          grpc = Google::Datastore::V1::Key.new path: grpc_path
+          grpc = Google::Cloud::Datastore::V1::Key.new path: grpc_path
           if project || namespace
-            grpc.partition_id = Google::Datastore::V1::PartitionId.new(
+            grpc.partition_id = Google::Cloud::Datastore::V1::PartitionId.new(
               project_id: project.to_s, namespace_id: namespace.to_s
             )
           end
@@ -289,7 +289,7 @@ module Google
         end
 
         ##
-        # @private Create a new Key from a Google::Datastore::V1::Key
+        # @private Create a new Key from a Google::Cloud::Datastore::V1::Key
         # object.
         def self.from_grpc grpc
           return nil if grpc.nil?

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

@@ -73,7 +73,7 @@ module Google
         alias to_hash to_h
 
         def to_grpc
-          # Convert to Hash with Google::Datastore::V1::Value values.
+          # Convert to Hash with Google::Cloud::Datastore::V1::Value values.
           Hash[@hash.map { |k, v| [k.to_s, Convert.to_value(v)] }]
         end
 

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

@@ -61,7 +61,7 @@ module Google
         #   query = Google::Cloud::Datastore::Query.new
         #
         def initialize
-          @grpc = Google::Datastore::V1::Query.new
+          @grpc = Google::Cloud::Datastore::V1::Query.new
         end
 
         ##
@@ -83,7 +83,7 @@ module Google
         #
         def kind *kinds
           kinds.each do |kind|
-            grpc_kind = Google::Datastore::V1::KindExpression.new(
+            grpc_kind = Google::Cloud::Datastore::V1::KindExpression.new(
               name: kind
             )
             @grpc.kind << grpc_kind
@@ -177,15 +177,15 @@ module Google
         #   tasks = datastore.run query
         #
         def where name, operator, value
-          @grpc.filter ||= Google::Datastore::V1::Filter.new(
-            composite_filter: Google::Datastore::V1::CompositeFilter.new(
+          @grpc.filter ||= Google::Cloud::Datastore::V1::Filter.new(
+            composite_filter: Google::Cloud::Datastore::V1::CompositeFilter.new(
               op: :AND
             )
           )
           @grpc.filter.composite_filter.filters << \
-            Google::Datastore::V1::Filter.new(
-              property_filter: Google::Datastore::V1::PropertyFilter.new(
-                property: Google::Datastore::V1::PropertyReference.new(
+            Google::Cloud::Datastore::V1::Filter.new(
+              property_filter: Google::Cloud::Datastore::V1::PropertyFilter.new(
+                property: Google::Cloud::Datastore::V1::PropertyReference.new(
                   name: name
                 ),
                 op: Convert.to_prop_filter_op(operator),
@@ -273,8 +273,8 @@ module Google
         #   tasks = datastore.run query
         #
         def order name, direction = :asc
-          @grpc.order << Google::Datastore::V1::PropertyOrder.new(
-            property: Google::Datastore::V1::PropertyReference.new(
+          @grpc.order << Google::Cloud::Datastore::V1::PropertyOrder.new(
+            property: Google::Cloud::Datastore::V1::PropertyReference.new(
               name: name
             ),
             direction: prop_order_direction(direction)
@@ -384,8 +384,8 @@ module Google
         #
         def select *names
           names.each do |name|
-            grpc_projection = Google::Datastore::V1::Projection.new(
-              property: Google::Datastore::V1::PropertyReference.new(
+            grpc_projection = Google::Cloud::Datastore::V1::Projection.new(
+              property: Google::Cloud::Datastore::V1::PropertyReference.new(
                 name: name
               )
             )
@@ -414,7 +414,7 @@ module Google
         #
         def group_by *names
           names.each do |name|
-            grpc_property = Google::Datastore::V1::PropertyReference.new(
+            grpc_property = Google::Cloud::Datastore::V1::PropertyReference.new(
               name: name
             )
             @grpc.distinct_on << grpc_property