activerecord-spanner-adapter 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55f265a14ddd7a176378a49090cbb3277aae66ce2c74913978ec9614289759fc
-  data.tar.gz: ae48998a381c0142063ac4499c8a0c13ece58bded34a72cbcc0371541ee02231
+  metadata.gz: f8f379074a93053e240a8dc13c74b3a3f85cf2b767830901fffd7bcf3bf2b3ba
+  data.tar.gz: f5ac8e18ed5cc732b753c40b36add02b164a39ea14396fa720371b7d65645684
 SHA512:
-  metadata.gz: fa104b38f89edc91eb78d05b5f89e232fb50847953061eae4e3c9eb12bf307f9a0cf69545eb06a0682c92b2ac7bce065b8d88f8fa148570b4720b47ccccad0d5
-  data.tar.gz: 3de12a8b087940d6234ecd902ea7b109a8319960700dd323c363da266aa299f211b003e50fb01e24ff5e4632e4372b5451e0d129168cacfa3541771263dc2703
+  metadata.gz: 39062a1c09f09cc4da8c1dd7d592905a61ae4b6e914aa88060572c9bda1dbe2626808ab92efcdef21ca18c61c7c116c3a4f55903c5829ff5044984e72e69763c
+  data.tar.gz: 41a26004516514ec6573e554ba664824105a5f0687d4a831057ff69a92ba9d329fbb185d310d9e5e2d6f1449470aaf573873ffddb038063166aee64c360f10d1

data/.toys/release.rb

@@ -14,5 +14,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-load_git remote: "https://github.com/googleapis/google-cloud-ruby.git",
-         path: ".toys/release"
+load_git remote: "https://github.com/googleapis/ruby-common-tools.git",
+         path: "toys/release"

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.7.0](https://www.github.com/googleapis/ruby-spanner-activerecord/compare/activerecord-spanner-adapter/v0.6.0...activerecord-spanner-adapter/v0.7.0) (2021-10-03)
+
+
+### Features
+
+* add support for query hints ([#134](https://www.github.com/googleapis/ruby-spanner-activerecord/issues/134)) ([f4b5b1e](https://www.github.com/googleapis/ruby-spanner-activerecord/commit/f4b5b1e5b959d43756258e84f95f26f375b7fba8))
+
 ## [0.6.0](https://www.github.com/googleapis/ruby-spanner-activerecord/compare/activerecord-spanner-adapter/v0.5.0...activerecord-spanner-adapter/v0.6.0) (2021-09-09)
 
 

data/acceptance/cases/models/query_test.rb

@@ -142,6 +142,30 @@ module ActiveRecord
 
         assert_equal [post], posts.to_a
       end
+
+      def test_statement_hint
+        post = Post.optimizer_hints("statement_hint: @{USE_ADDITIONAL_PARALLELISM=TRUE}")
+                   .select(:title).to_a.first
+
+        assert_nil post.id
+        assert_equal "Title - 1", post.title
+      end
+
+      def test_table_hint
+        post = Post.optimizer_hints("table_hint: posts@{FORCE_INDEX=_BASE_TABLE}")
+                   .select(:title).to_a.first
+
+        assert_nil post.id
+        assert_equal "Title - 1", post.title
+      end
+
+      def test_join_hint
+        post = Post.joins("inner join @{JOIN_TYPE=HASH_JOIN} comments on posts.id=comments.post_id")
+                   .select(:title).to_a.first
+
+        assert_nil post.id
+        assert_equal "Title - 1", post.title
+      end
     end
   end
 end

data/examples/rails/README.md

@@ -99,7 +99,7 @@ If you are not familiar with Active Record, you can read more about it on [Ruby
 ### Use Cloud Spanner adapter in Gemfile
 1. Edit the Gemfile file of the `blog` app and add the `activerecord-spanner-adapter` gem:
     ```ruby
-    gem 'activerecord-spanner-adapter', git: 'https://github.com/googleapis/ruby-spanner-activerecord.git'
+    gem 'activerecord-spanner-adapter'
     ```
 1. Install gems:
 

data/examples/snippets/generated-column/db/schema.rb

@@ -2,8 +2,8 @@
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
 #
-# This file is the source Rails uses to define your schema when running `rails
-# db:schema:load`. When creating a new database, `rails db:schema:load` tends to
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
 # be faster and is potentially less error prone than running all of your
 # migrations from scratch. Old migrations may fail to apply correctly if those
 # migrations use external dependencies or application code.
@@ -12,7 +12,7 @@
 
 ActiveRecord::Schema.define(version: 1) do
 
-  create_table "singers", force: :cascade do |t|
+  create_table "singers", id: { limit: 8 }, force: :cascade do |t|
     t.string "first_name", limit: 100
     t.string "last_name", limit: 200, null: false
     t.string "full_name", limit: 300, null: false

data/examples/snippets/hints/README.md

@@ -0,0 +1,19 @@
+# Sample - Query Hints
+
+This example shows how to use query hints Spanner ActiveRecord adapter. Statement hints and
+table hints can be specified using the optimizer_hints method. Join hints must be specified
+in a join string.
+
+See https://cloud.google.com/spanner/docs/query-syntax#sql_syntax for more information on
+the supported query hints.
+
+## Running the Sample
+
+The sample will automatically start a Spanner Emulator in a docker container and execute the sample
+against that emulator. The emulator will automatically be stopped when the application finishes.
+
+Run the application with the command
+
+```bash
+bundle exec rake run
+```

data/examples/snippets/hints/Rakefile

@@ -0,0 +1,13 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+require_relative "../config/environment"
+require "sinatra/activerecord/rake"
+
+desc "Sample showing how to work with generated columns in ActiveRecord."
+task :run do
+  Dir.chdir("..") { sh "bundle exec rake run[hints]" }
+end

data/examples/snippets/hints/application.rb

@@ -0,0 +1,47 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+require "io/console"
+require_relative "../config/environment"
+require_relative "models/singer"
+require_relative "models/album"
+
+class Application
+  def self.run
+    puts ""
+    puts "Listing all singers using additional parallelism:"
+    # A statement hint must be prefixed with 'statement_hint:'
+    Singer.optimizer_hints("statement_hint: @{USE_ADDITIONAL_PARALLELISM=TRUE}")
+          .order("last_name, first_name").each do |singer|
+      puts singer.full_name
+    end
+
+    puts ""
+    puts "Listing all singers using the index on full_name:"
+    # All table hints must be prefixed with 'table_hint:'.
+    # Queries may contain multiple table hints.
+    Singer.optimizer_hints("table_hint: singers@{FORCE_INDEX=index_singers_on_full_name}")
+          .order("full_name").each do |singer|
+      puts singer.full_name
+    end
+
+    puts ""
+    puts "Listing all singers with at least one album that starts with 'blue':"
+    # Join hints cannot be specified using an optimizer_hint. Instead, the join can
+    # be specified using a string that includes the join hint.
+    Singer.joins("INNER JOIN @{JOIN_METHOD=HASH_JOIN} albums " \
+                 "on singers.id=albums.singer_id AND albums.title LIKE 'blue%'")
+          .distinct.order("last_name, first_name").each do |singer|
+      puts singer.full_name
+    end
+
+    puts ""
+    puts "Press any key to end the application"
+    STDIN.getch
+  end
+end
+
+Application.run

data/examples/snippets/hints/config/database.yml

@@ -0,0 +1,8 @@
+development:
+  adapter: spanner
+  emulator_host: localhost:9010
+  project: test-project
+  instance: test-instance
+  database: testdb
+  pool: 5
+  timeout: 5000

data/examples/snippets/hints/db/migrate/01_create_tables.rb

@@ -0,0 +1,23 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class CreateTables < ActiveRecord::Migration[6.0]
+  def change
+    connection.ddl_batch do
+      create_table :singers do |t|
+        t.string :first_name, limit: 100
+        t.string :last_name, limit: 200, null: false
+        t.string :full_name, limit: 300, null: false, as: "COALESCE(first_name || ' ', '') || last_name", stored: true
+        t.index [:full_name], name: "index_singers_on_full_name"
+      end
+
+      create_table :albums do |t|
+        t.string :title
+        t.references :singer, index: false, foreign_key: true
+      end
+    end
+  end
+end

data/examples/snippets/hints/db/schema.rb

@@ -0,0 +1,28 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 1) do
+
+  create_table "albums", id: { limit: 8 }, force: :cascade do |t|
+    t.string "title"
+    t.integer "singer_id", limit: 8
+  end
+
+  create_table "singers", id: { limit: 8 }, force: :cascade do |t|
+    t.string "first_name", limit: 100
+    t.string "last_name", limit: 200, null: false
+    t.string "full_name", limit: 300, null: false
+    t.index ["full_name"], name: "index_singers_on_full_name", order: { full_name: :asc }
+  end
+
+  add_foreign_key "albums", "singers"
+end

data/examples/snippets/hints/db/seeds.rb

@@ -0,0 +1,29 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+require_relative "../../config/environment.rb"
+require_relative "../models/singer"
+require_relative "../models/album"
+
+first_names = %w[Pete Alice John Ethel Trudy Naomi Wendy Ruben Thomas Elly]
+last_names = %w[Wendelson Allison Peterson Johnson Henderson Ericsson Aronson Tennet Courtou]
+
+adjectives = %w[daily happy blue generous cooked bad open]
+nouns = %w[windows potatoes bank street tree glass bottle]
+
+# This ensures all the records are inserted using one read/write transaction that will use mutations instead of DML.
+ActiveRecord::Base.transaction isolation: :buffered_mutations do
+  singers = []
+  5.times do
+    singers << Singer.create(first_name: first_names.sample, last_name: last_names.sample)
+  end
+
+  albums = []
+  20.times do
+    singer = singers.sample
+    albums << Album.create(title: "#{adjectives.sample} #{nouns.sample}", singer: singer)
+  end
+end

data/examples/snippets/hints/models/album.rb

@@ -0,0 +1,9 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Album < ActiveRecord::Base
+  belongs_to :singer
+end

data/examples/snippets/hints/models/singer.rb

@@ -0,0 +1,9 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Singer < ActiveRecord::Base
+  has_many :albums
+end

data/examples/snippets/partitioned-dml/README.md

@@ -0,0 +1,16 @@
+# Sample - Partitioned DML
+
+This example shows how to use Partitioned DML with the Spanner ActiveRecord adapter.
+
+See https://cloud.google.com/spanner/docs/dml-partitioned for more information on Partitioned DML.
+
+## Running the Sample
+
+The sample will automatically start a Spanner Emulator in a docker container and execute the sample
+against that emulator. The emulator will automatically be stopped when the application finishes.
+
+Run the application with the command
+
+```bash
+bundle exec rake run
+```

data/examples/snippets/partitioned-dml/Rakefile

@@ -0,0 +1,13 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+require_relative "../config/environment"
+require "sinatra/activerecord/rake"
+
+desc "Sample showing how to work with Partitioned DML in ActiveRecord."
+task :run do
+  Dir.chdir("..") { sh "bundle exec rake run[partitioned-dml]" }
+end

data/examples/snippets/partitioned-dml/application.rb

@@ -0,0 +1,48 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+require "io/console"
+require_relative "../config/environment"
+require_relative "models/singer"
+require_relative "models/album"
+
+class Application
+  def self.run
+    singer_count = Singer.all.count
+    album_count = Album.all.count
+    puts ""
+    puts "Singers in the database: #{singer_count}"
+    puts "Albums in the database: #{album_count}"
+
+    puts ""
+    puts "Deleting all albums in the database using Partitioned DML"
+    # Note that a Partitioned DML transaction can contain ONLY ONE DML statement.
+    # If we want to delete all data in two different tables, we need to do so in two different PDML transactions.
+    Album.transaction isolation: :pdml do
+      count = Album.delete_all
+      puts "Deleted #{count} albums"
+    end
+
+    puts ""
+    puts "Deleting all singers in the database using Partitioned DML"
+    Singer.transaction isolation: :pdml do
+      count = Singer.delete_all
+      puts "Deleted #{count} singers"
+    end
+
+    singer_count = Singer.all.count
+    album_count = Album.all.count
+    puts ""
+    puts "Singers in the database: #{singer_count}"
+    puts "Albums in the database: #{album_count}"
+
+    puts ""
+    puts "Press any key to end the application"
+    STDIN.getch
+  end
+end
+
+Application.run

data/examples/snippets/partitioned-dml/config/database.yml

@@ -0,0 +1,8 @@
+development:
+  adapter: spanner
+  emulator_host: localhost:9010
+  project: test-project
+  instance: test-instance
+  database: testdb
+  pool: 5
+  timeout: 5000

data/examples/snippets/partitioned-dml/db/migrate/01_create_tables.rb

@@ -0,0 +1,21 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class CreateTables < ActiveRecord::Migration[6.0]
+  def change
+    connection.ddl_batch do
+      create_table :singers do |t|
+        t.string :first_name, limit: 100
+        t.string :last_name, limit: 200, null: false
+      end
+
+      create_table :albums do |t|
+        t.string :title
+        t.references :singer, index: false, foreign_key: true
+      end
+    end
+  end
+end

data/examples/snippets/partitioned-dml/db/schema.rb

@@ -0,0 +1,26 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 1) do
+
+  create_table "albums", id: { limit: 8 }, force: :cascade do |t|
+    t.string "title"
+    t.integer "singer_id", limit: 8
+  end
+
+  create_table "singers", id: { limit: 8 }, force: :cascade do |t|
+    t.string "first_name", limit: 100
+    t.string "last_name", limit: 200, null: false
+  end
+
+  add_foreign_key "albums", "singers"
+end

data/examples/snippets/partitioned-dml/db/seeds.rb

@@ -0,0 +1,29 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+require_relative "../../config/environment.rb"
+require_relative "../models/singer"
+require_relative "../models/album"
+
+first_names = %w[Pete Alice John Ethel Trudy Naomi Wendy Ruben Thomas Elly]
+last_names = %w[Wendelson Allison Peterson Johnson Henderson Ericsson Aronson Tennet Courtou]
+
+adjectives = %w[daily happy blue generous cooked bad open]
+nouns = %w[windows potatoes bank street tree glass bottle]
+
+# This ensures all the records are inserted using one read/write transaction that will use mutations instead of DML.
+ActiveRecord::Base.transaction isolation: :buffered_mutations do
+  singers = []
+  5.times do
+    singers << Singer.create(first_name: first_names.sample, last_name: last_names.sample)
+  end
+
+  albums = []
+  20.times do
+    singer = singers.sample
+    albums << Album.create(title: "#{adjectives.sample} #{nouns.sample}", singer: singer)
+  end
+end

data/examples/snippets/partitioned-dml/models/album.rb

@@ -0,0 +1,9 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Album < ActiveRecord::Base
+  belongs_to :singer
+end

data/examples/snippets/partitioned-dml/models/singer.rb

@@ -0,0 +1,9 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Singer < ActiveRecord::Base
+  has_many :albums
+end

data/lib/active_record/tasks/spanner_database_tasks.rb

@@ -18,7 +18,7 @@ module ActiveRecord
         @connection.create_database
       rescue Google::Cloud::Error => error
         if error.instance_of? Google::Cloud::AlreadyExistsError
-          raise ActiveRecord::Tasks::DatabaseAlreadyExists
+          raise ActiveRecord::DatabaseAlreadyExists
         end
 
         raise error

data/lib/activerecord_spanner_adapter/base.rb

@@ -15,7 +15,17 @@ module ActiveRecord
     # Creates an object (or multiple objects) and saves it to the database. This method will use mutations instead
     # of DML if there is no active transaction, or if the active transaction has been created with the option
     # isolation: :buffered_mutations.
+    def self.create! attributes = nil, &block
+      return super unless spanner_adapter?
+      return super if active_transaction?
+
+      transaction isolation: :buffered_mutations do
+        return super
+      end
+    end
+
     def self.create attributes = nil, &block
+      return super unless spanner_adapter?
       return super if active_transaction?
 
       transaction isolation: :buffered_mutations do
@@ -23,8 +33,16 @@ module ActiveRecord
       end
     end
 
+    def self.spanner_adapter?
+      connection.adapter_name == "spanner"
+    end
+
+    def self.buffered_mutations?
+      spanner_adapter? && connection&.current_spanner_transaction&.isolation == :buffered_mutations
+    end
+
     def self._insert_record values
-      return super unless Base.connection&.current_spanner_transaction&.isolation == :buffered_mutations
+      return super unless buffered_mutations?
 
       primary_key = self.primary_key
       primary_key_value = nil
@@ -48,7 +66,7 @@ module ActiveRecord
           values: [grpc_values.list_value]
         )
       )
-      Base.connection.current_spanner_transaction.buffer mutation
+      connection.current_spanner_transaction.buffer mutation
 
       primary_key_value
     end
@@ -56,6 +74,7 @@ module ActiveRecord
     # Deletes all records of this class. This method will use mutations instead of DML if there is no active
     # transaction, or if the active transaction has been created with the option isolation: :buffered_mutations.
     def self.delete_all
+      return super unless spanner_adapter?
       return super if active_transaction?
 
       transaction isolation: :buffered_mutations do
@@ -72,7 +91,8 @@ module ActiveRecord
     # of DML if there is no active transaction, or if the active transaction has been created with the option
     # isolation: :buffered_mutations.
     def update attributes
-      return super if Base.active_transaction?
+      return super unless self.class.spanner_adapter?
+      return super if self.class.active_transaction?
 
       transaction isolation: :buffered_mutations do
         return super
@@ -83,7 +103,8 @@ module ActiveRecord
     # of DML if there is no active transaction, or if the active transaction has been created with the option
     # isolation: :buffered_mutations.
     def destroy
-      return super if Base.active_transaction?
+      return super unless self.class.spanner_adapter?
+      return super if self.class.active_transaction?
 
       transaction isolation: :buffered_mutations do
         return super
@@ -110,7 +131,7 @@ module ActiveRecord
     private_class_method :_create_grpc_values_for_insert
 
     def _update_row attribute_names, attempted_action = "update"
-      return super unless Base.connection&.current_spanner_transaction&.isolation == :buffered_mutations
+      return super unless self.class.buffered_mutations?
 
       if locking_enabled?
         _execute_version_check attempted_action
@@ -129,7 +150,7 @@ module ActiveRecord
           values: [grpc_values.list_value]
         )
       )
-      Base.connection.current_spanner_transaction.buffer mutation
+      self.class.connection.current_spanner_transaction.buffer mutation
       1 # Affected rows
     end
 
@@ -161,13 +182,13 @@ module ActiveRecord
     end
 
     def destroy_row
-      return super unless Base.connection&.current_spanner_transaction&.isolation == :buffered_mutations
+      return super unless self.class.buffered_mutations?
 
       _delete_row
     end
 
     def _delete_row
-      return super unless Base.connection&.current_spanner_transaction&.isolation == :buffered_mutations
+      return super unless self.class.buffered_mutations?
       if locking_enabled?
         _execute_version_check "destroy"
       end
@@ -186,7 +207,7 @@ module ActiveRecord
           key_set: { keys: [list_value] }
         )
       )
-      Base.connection.current_spanner_transaction.buffer mutation
+      self.class.connection.current_spanner_transaction.buffer mutation
       1 # Affected rows
     end
 
@@ -210,7 +231,7 @@ module ActiveRecord
               "WHERE `#{self.class.primary_key}` = @id AND `#{locking_column}` = @lock_version"
       params = { "id" => id_in_database, "lock_version" => previous_lock_value }
       param_types = { "id" => :INT64, "lock_version" => :INT64 }
-      locked_row = Base.connection.raw_connection.execute_query sql, params: params, types: param_types
+      locked_row = self.class.connection.raw_connection.execute_query sql, params: params, types: param_types
       raise ActiveRecord::StaleObjectError.new(self, attempted_action) unless locked_row.rows.any?
     end
   end

data/lib/activerecord_spanner_adapter/version.rb

@@ -5,5 +5,5 @@
 # https://opensource.org/licenses/MIT.
 
 module ActiveRecordSpannerAdapter
-  VERSION = "0.6.0".freeze
+  VERSION = "0.7.0".freeze
 end

data/lib/arel/visitors/spanner.rb

@@ -14,11 +14,24 @@ module Arel # :nodoc: all
       end
     end
 
+    class StatementHint
+      attr_reader :value
+
+      def initialize value
+        @value = value
+      end
+    end
+
     class Spanner < Arel::Visitors::ToSql
       def compile node, collector = Arel::Collectors::SQLString.new
         collector.class.module_eval { attr_accessor :hints }
+        collector.class.module_eval { attr_accessor :table_hints }
+        collector.class.module_eval { attr_accessor :join_hints }
         collector.hints = {}
+        collector.table_hints = {}
+        collector.join_hints = {}
         sql, binds = accept(node, collector).value
+        sql = collector.hints[:statement_hint].value + sql if collector.hints[:statement_hint]
         binds << collector.hints[:staleness] if collector.hints[:staleness]
         [sql, binds]
       end
@@ -32,9 +45,25 @@ module Arel # :nodoc: all
         BIND_BLOCK
       end
 
+      def visit_table_hint v, collector
+        value = v.delete_prefix("table_hint:").strip
+        # TODO: This does not support FORCE_INDEX hints that reference an index that contains '@{' in the name.
+        start_of_hint_index = value.rindex "@{"
+        table_name = value[0, start_of_hint_index]
+        table_hint = value[start_of_hint_index, value.length]
+        collector.table_hints[table_name] = table_hint if table_name && table_hint
+      end
+
+      def visit_statement_hint v, collector
+        collector.hints[:statement_hint] = \
+          StatementHint.new v.delete_prefix("statement_hint:")
+      end
+
       # rubocop:disable Naming/MethodName
       def visit_Arel_Nodes_OptimizerHints o, collector
         o.expr.each do |v|
+          visit_table_hint v, collector if v.start_with? "table_hint:"
+          visit_statement_hint v, collector if v.start_with? "statement_hint:"
           if v.start_with? "max_staleness:"
             collector.hints[:staleness] = \
               StalenessHint.new max_staleness: v.delete_prefix("max_staleness:").to_f
@@ -59,6 +88,16 @@ module Arel # :nodoc: all
         collector
       end
 
+      def visit_Arel_Table o, collector
+        return super unless collector.table_hints[o.name]
+        if o.table_alias
+          collector << quote_table_name(o.name) << collector.table_hints[o.name] \
+                    << " " << quote_table_name(o.table_alias)
+        else
+          collector << quote_table_name(o.name) << collector.table_hints[o.name]
+        end
+      end
+
       def visit_Arel_Nodes_BindParam o, collector
         # Do not generate a query parameter if the value should be set to the PENDING_COMMIT_TIMESTAMP(), as that is
         # not supported as a parameter value by Cloud Spanner.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-spanner-adapter
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2021-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-spanner
@@ -369,6 +369,15 @@ files:
 - examples/snippets/generated-column/db/schema.rb
 - examples/snippets/generated-column/db/seeds.rb
 - examples/snippets/generated-column/models/singer.rb
+- examples/snippets/hints/README.md
+- examples/snippets/hints/Rakefile
+- examples/snippets/hints/application.rb
+- examples/snippets/hints/config/database.yml
+- examples/snippets/hints/db/migrate/01_create_tables.rb
+- examples/snippets/hints/db/schema.rb
+- examples/snippets/hints/db/seeds.rb
+- examples/snippets/hints/models/album.rb
+- examples/snippets/hints/models/singer.rb
 - examples/snippets/interleaved-tables/README.md
 - examples/snippets/interleaved-tables/Rakefile
 - examples/snippets/interleaved-tables/application.rb
@@ -407,6 +416,15 @@ files:
 - examples/snippets/optimistic-locking/db/seeds.rb
 - examples/snippets/optimistic-locking/models/album.rb
 - examples/snippets/optimistic-locking/models/singer.rb
+- examples/snippets/partitioned-dml/README.md
+- examples/snippets/partitioned-dml/Rakefile
+- examples/snippets/partitioned-dml/application.rb
+- examples/snippets/partitioned-dml/config/database.yml
+- examples/snippets/partitioned-dml/db/migrate/01_create_tables.rb
+- examples/snippets/partitioned-dml/db/schema.rb
+- examples/snippets/partitioned-dml/db/seeds.rb
+- examples/snippets/partitioned-dml/models/album.rb
+- examples/snippets/partitioned-dml/models/singer.rb
 - examples/snippets/quickstart/README.md
 - examples/snippets/quickstart/Rakefile
 - examples/snippets/quickstart/application.rb