google-cloud-datastore 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5cb153ea77e6581236392f42ec5755cde46733fc2331d6c6b7f204e171c4006
-  data.tar.gz: 57e1bde4b98c1f21b7d65d56255d66b79ab19c7d0a62d03d67fdbc90027fe1ca
+  metadata.gz: ded45a15f44ec5a2e095ef0369db26c2a4a65e59c2af1e08bb8f6028736062ea
+  data.tar.gz: 8d7321547294a1c1ab492df132e19300a0466f252e74f9c7122fb7941bbaeac7
 SHA512:
-  metadata.gz: 950fa042833ec644777f8b2e89ed0078f4c4629f4f32d6833b6de20d7f4f09a4563c96fbb9515a0eb6e3d76ace6d610e63178033a6d6318a0b2b897b91ccfb4e
-  data.tar.gz: 4c6757326810a722fc9c2543bcbb0135b15ad698cd5b9b5bfdfe33ae4f84bf8e9df437d8838784f0a71c3debf7c51d8a6be70ed671efc9382cefddd10ec2c672
+  metadata.gz: 8a4039bbc1c34698507c3b7a1e2c22b011f4df3ea66a57927c7dd147c4468d97c85f15b49efa6c06dcb124815ad5fc4098eeaa8e6f54d23570489e6da0d8dbf3
+  data.tar.gz: af0981ba4ea2bd054ba35ddd372399addbbb5e0d0c8e4032f518b48ab03065771af8a6185dea29483a9948ae42147011c0f6a100c747dd08100736780a5cb286

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 2.5.0 (2023-02-09)
+
+#### Features
+
+* Added support for multiple database ([#20038](https://github.com/googleapis/google-cloud-ruby/issues/20038)) 
+
 ### 2.4.0 (2023-02-02)
 
 #### Features

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

@@ -84,6 +84,26 @@ module Google
         end
         alias project project_id
 
+        ##
+        # The Datastore database connected to.
+        #
+        # @return [String] ID of the database
+        #
+        # @example
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new(
+        #     project_id: "my-todo-project",
+        #     credentials: "/path/to/keyfile.json",
+        #     database_id: "my-database"
+        #   )
+        #
+        #   datastore.database_id #=> "my-database"
+        #
+        def database_id
+          service.database
+        end
+
         ##
         # Generate IDs for a Key before creating an entity.
         #

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

@@ -69,6 +69,27 @@ module Google
         alias dataset_id project
         alias dataset_id= project=
 
+        ##
+        # The database of the Key.
+        #
+        # @return [String]
+        #
+        # @example
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new(
+        #     project: "my-todo-project",
+        #     database: "my-todo-database",
+        #     keyfile: "/path/to/keyfile.json"
+        #   )
+        #
+        #   task = datastore.find "Task", "sampleTask"
+        #   task.key.database #=> "my-todo-database"
+        #
+        attr_accessor :database
+        alias database_id database
+        alias database_id= database=
+
         ##
         # The namespace of the Key.
         #
@@ -281,9 +302,9 @@ module Google
             Google::Cloud::Datastore::V1::Key::PathElement.new path_args
           end
           grpc = Google::Cloud::Datastore::V1::Key.new path: grpc_path
-          if project || namespace
+          if project || database || namespace
             grpc.partition_id = Google::Cloud::Datastore::V1::PartitionId.new(
-              project_id: project.to_s, namespace_id: namespace.to_s
+              project_id: project.to_s, database_id: database.to_s, namespace_id: namespace.to_s
             )
           end
           grpc
@@ -304,6 +325,7 @@ module Google
           end
           if key_grpc.partition_id
             key.project = key_grpc.partition_id.project_id
+            key.database = key_grpc.partition_id.database_id
             key.namespace = key_grpc.partition_id.namespace_id
           end
           key.parent = Key.from_grpc key_grpc if key_grpc.path.count.positive?

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

@@ -29,14 +29,16 @@ module Google
         attr_accessor :credentials
         attr_accessor :host
         attr_accessor :timeout
+        attr_accessor :database
 
         ##
         # Creates a new Service instance.
-        def initialize project, credentials, host: nil, timeout: nil
+        def initialize project, credentials, database, host: nil, timeout: nil
           @project = project
           @credentials = credentials
           @host = host
           @timeout = timeout
+          @database = database
         end
 
         def service
@@ -47,7 +49,7 @@ module Google
             config.endpoint = host if host
             config.lib_name = "gccl"
             config.lib_version = Google::Cloud::Datastore::VERSION
-            config.metadata = { "google-cloud-resource-prefix": "projects/#{@project}" }
+            config.metadata = { "google-cloud-resource-prefix": "projects/#{@project}/databases/#{database}" }
           end
         end
         attr_accessor :mocked_service
@@ -56,7 +58,7 @@ module Google
         # Allocate IDs for incomplete keys.
         # (This is useful for referencing an entity before it is inserted.)
         def allocate_ids *incomplete_keys
-          service.allocate_ids project_id: project, keys: incomplete_keys
+          service.allocate_ids project_id: project, database_id: database, keys: incomplete_keys
         end
 
         ##
@@ -64,7 +66,7 @@ module Google
         def lookup *keys, consistency: nil, transaction: nil
           read_options = generate_read_options consistency, transaction
 
-          service.lookup project_id: project, keys: keys, read_options: read_options
+          service.lookup project_id: project, database_id: database, keys: keys, read_options: read_options
         end
 
         # Query for entities.
@@ -82,6 +84,7 @@ module Google
           end
 
           service.run_query project_id: project,
+                            database_id: database,
                             partition_id: partition_id,
                             read_options: read_options,
                             query: query,
@@ -125,7 +128,7 @@ module Google
             )
             transaction_options.read_write = rw
           end
-          service.begin_transaction project_id: project, transaction_options: transaction_options
+          service.begin_transaction project_id: project, database_id: database, transaction_options: transaction_options
         end
 
         ##
@@ -133,17 +136,18 @@ module Google
         # some entities.
         def commit mutations, transaction: nil
           mode = transaction.nil? ? :NON_TRANSACTIONAL : :TRANSACTIONAL
-          service.commit project_id: project, mode: mode, mutations: mutations, transaction: transaction
+          service.commit project_id: project, database_id: database, mode: mode,
+                         mutations: mutations, transaction: transaction
         end
 
         ##
         # Roll back a transaction.
         def rollback transaction
-          service.rollback project_id: project, transaction: transaction
+          service.rollback project_id: project, database_id: database, transaction: transaction
         end
 
         def inspect
-          "#{self.class}(#{@project})"
+          "#{self.class}(#{@project})(#{database})"
         end
 
         protected

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Datastore
-      VERSION = "2.4.0".freeze
+      VERSION = "2.5.0".freeze
     end
   end
 end

data/lib/google/cloud/datastore.rb

@@ -74,6 +74,8 @@ module Google
       #   If the param is nil, uses the default endpoint.
       # @param [String] emulator_host Datastore emulator host. Optional.
       #   If the param is nil, uses the value of the `emulator_host` config.
+      # @param [String] database_id Identifier for a Datastore database in the project. If not
+      #   present, the default database of the project will be used.
       # @param [String] project Alias for the `project_id` argument. Deprecated.
       # @param [String] keyfile Alias for the `credentials` argument.
       #   Deprecated.
@@ -103,13 +105,15 @@ module Google
                    timeout: nil,
                    endpoint: nil,
                    emulator_host: nil,
+                   database_id: nil,
                    project: nil,
                    keyfile: nil
-        project_id    ||= (project || default_project_id)
-        scope         ||= configure.scope
-        timeout       ||= configure.timeout
-        endpoint      ||= configure.endpoint
+        project_id = get_project_id project_id, project
+        scope ||= configure.scope
+        timeout ||= configure.timeout
+        endpoint ||= configure.endpoint
         emulator_host ||= configure.emulator_host
+        database_id ||= configure.database_id
 
         if emulator_host
           project_id = project_id.to_s # Always cast to a string
@@ -117,7 +121,7 @@ module Google
 
           return Datastore::Dataset.new(
             Datastore::Service.new(
-              project_id, :this_channel_is_insecure,
+              project_id, :this_channel_is_insecure, database_id,
               host: emulator_host, timeout: timeout
             )
           )
@@ -136,7 +140,7 @@ module Google
 
         Datastore::Dataset.new(
           Datastore::Service.new(
-            project_id, credentials,
+            project_id, credentials, database_id,
             host: endpoint, timeout: timeout
           )
         )
@@ -175,6 +179,14 @@ module Google
         Google::Cloud.configure.datastore
       end
 
+      ##
+      # @private Default project.
+      def self.get_project_id project_id, project
+        project_id || project || Google::Cloud.configure.datastore.project_id ||
+          Google::Cloud.configure.project_id ||
+          Google::Cloud.env.project_id
+      end
+
       ##
       # @private Default project.
       def self.default_project_id

data/lib/google-cloud-datastore.rb

@@ -67,9 +67,10 @@ module Google
     #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
     #   datastore = gcloud.datastore scope: platform_scope
     #
-    def datastore scope: nil, timeout: nil
+    def datastore scope: nil, timeout: nil, database_id: nil
       Google::Cloud.datastore @project, @keyfile,
-                              scope: scope, timeout: (timeout || @timeout)
+                              scope: scope, timeout: (timeout || @timeout),
+                              database_id: database_id
     end
 
     ##
@@ -112,11 +113,12 @@ module Google
     #   datastore.save task
     #
     def self.datastore project_id = nil, credentials = nil, scope: nil,
-                       timeout: nil
+                       timeout: nil, database_id: nil
       require "google/cloud/datastore"
       Google::Cloud::Datastore.new project_id: project_id,
                                    credentials: credentials,
-                                   scope: scope, timeout: timeout
+                                   scope: scope, timeout: timeout,
+                                   database_id: database_id
     end
   end
 end
@@ -136,8 +138,7 @@ Google::Cloud.configure.add_config! :datastore do |config|
     ENV["DATASTORE_EMULATOR_HOST"]
   end
   default_scopes = [
-    "https://www.googleapis.com/auth/cloud-platform",
-    "https://www.googleapis.com/auth/datastore"
+    "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
@@ -149,4 +150,5 @@ Google::Cloud.configure.add_config! :datastore do |config|
   config.add_field! :timeout, nil, match: Integer
   config.add_field! :emulator_host, default_emulator, match: String, allow_nil: true
   config.add_field! :endpoint, "datastore.googleapis.com", match: String
+  config.add_field! :database_id, "", match: String
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-datastore
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2023-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core