activerecord-spanner-adapter 1.8.0 → 2.1.0

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

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 

data/examples/snippets/interleaved-tables/application.rb

@@ -13,7 +13,7 @@ require_relative "models/track"
 class Application
   def self.run
     # List all singers, albums and tracks.
-    list_singers_albums_tracks
+    list_singers_albums
 
     # Create a new album with some tracks.
     create_new_album
@@ -28,10 +28,6 @@ class Application
     # Try to delete an album that has at least one track. This IS possible as tracks IS marked with
     # ON DELETE CASCADE.
     delete_album_with_tracks
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 
   def self.find_singer

data/examples/snippets/interleaved-tables/config/database.yml

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

data/examples/snippets/interleaved-tables/db/seeds.rb

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 require_relative "../models/track"

data/examples/snippets/interleaved-tables/models/album.rb

@@ -11,6 +11,10 @@ class Album < ActiveRecord::Base
 
   # `tracks` is defined as INTERLEAVE IN PARENT `albums`.
   # The primary key of `albums` is (`singerid`, `albumid`).
-  # Rails 7.1 requires using query_constraints to define a composite foreign key.
-  has_many :tracks, query_constraints: [:singerid, :albumid]
+  if ActiveRecord::VERSION::MAJOR >= 8
+    has_many :tracks, foreign_key: [:singerid, :albumid]
+  else
+    # Rails 7.1 requires using query_constraints to define a composite foreign key.
+    has_many :tracks, query_constraints: [:singerid, :albumid]
+  end
 end

data/examples/snippets/interleaved-tables/models/track.rb

@@ -8,7 +8,11 @@ class Track < ActiveRecord::Base
   # `tracks` is defined as INTERLEAVE IN PARENT `albums`.
   # The primary key of `albums` is (`singerid`, `albumid`).
   # Rails 7.1 requires a composite primary key in a belongs_to relationship to be specified as query_constraints.
-  belongs_to :album, query_constraints: [:singerid, :albumid]
+  if ActiveRecord::VERSION::MAJOR >= 8
+    belongs_to :album, foreign_key: [:singerid, :albumid]
+  else
+    belongs_to :album, query_constraints: [:singerid, :albumid]
+  end
 
   # `tracks` also has a `singerid` column that can be used to associate a Track with a Singer.
   belongs_to :singer, foreign_key: :singerid

data/examples/snippets/interleaved-tables-before-7.1/application.rb

@@ -13,7 +13,7 @@ require_relative "models/track"
 class Application
   def self.run
     # List all singers, albums and tracks.
-    list_singers_albums_tracks
+    list_singers_albums
 
     # Create a new album with some tracks.
     create_new_album
@@ -28,10 +28,6 @@ class Application
     # Try to delete an album that has at least one track. This IS possible as tracks IS marked with
     # ON DELETE CASCADE.
     delete_album_with_tracks
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 
   def self.find_singer

data/examples/snippets/interleaved-tables-before-7.1/config/database.yml

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

data/examples/snippets/interleaved-tables-before-7.1/db/seeds.rb

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 require_relative "../models/track"

data/examples/snippets/migrations/application.rb

@@ -16,10 +16,6 @@ class Application
     tables.rows.each do |row|
       puts row[:TABLE_NAME]
     end
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

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

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

data/examples/snippets/mutations/application.rb

@@ -22,7 +22,7 @@ class Application
       to_album = Album.where.not(id: from_album.id).sample
 
       puts ""
-      puts "Transferring 10,000 marketing budget from #{from_album.title} (#{from_album.marketing_budget}) "\
+      puts "Transferring 10,000 marketing budget from #{from_album.title} (#{from_album.marketing_budget}) " \
            "to #{to_album.title} (#{to_album.marketing_budget})"
       from_album.update marketing_budget: from_album.marketing_budget - 10000
       to_album.update marketing_budget: to_album.marketing_budget + 10000
@@ -37,10 +37,6 @@ class Application
     puts "Budgets after commit:"
     puts "Marketing budget #{from_album.title}: #{from_album.reload.marketing_budget}"
     puts "Marketing budget #{to_album.title}: #{to_album.reload.marketing_budget}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

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

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

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

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 

data/examples/snippets/optimistic-locking/application.rb

@@ -38,10 +38,6 @@ class Application
 
     singer.reload
     puts "Reloaded singer data: #{singer.first_name} #{singer.last_name}, version: #{singer.lock_version}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/optimistic-locking/config/database.yml

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

data/examples/snippets/optimistic-locking/db/seeds.rb

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 

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

@@ -38,10 +38,6 @@ class Application
     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
 

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

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

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

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 

data/examples/snippets/query-logs/application.rb

@@ -17,10 +17,6 @@ class Application
     puts "Query all Albums and include an automatically generated request tag"
     albums = Album.all
     puts "Queried #{albums.length} albums using an automatically generated request tag"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 
   def self.enable_query_logs
@@ -31,16 +27,9 @@ class Application
     # Query log comments *MUST* be prepended to be included as a request tag.
     ActiveRecord::QueryLogs.prepend_comment = true
 
-    # This block manually enables Query Logs without a full Rails application.
+    # Enable query logs in a non-Rails application.
     # This should normally not be needed in your application.
-    ActiveRecord::QueryLogs.taggings.merge!(
-      application:  "example-app",
-      action:       "run-test-application",
-      pid:          -> { Process.pid.to_s },
-      socket:       ->(context) { context[:connection].pool.db_config.socket },
-      db_host:      ->(context) { context[:connection].pool.db_config.host },
-      database:     ->(context) { context[:connection].pool.db_config.database }
-    )
+    enable_query_logs_without_rails
 
     ActiveRecord::QueryLogs.tags = [
       # The first tag *MUST* be the fixed value 'request_tag:true'.
@@ -58,6 +47,19 @@ class Application
       :database
     ]
   end
+
+  def self.enable_query_logs_without_rails
+    # This block manually enables Query Logs without a full Rails application.
+    # This should normally not be needed in your application.
+    ActiveRecord::QueryLogs.taggings = {
+      application:  "example-app",
+      action:       "run-test-application",
+      pid:          -> { Process.pid.to_s },
+      socket:       ->(context) { context[:connection].pool.db_config.socket },
+      db_host:      ->(context) { context[:connection].pool.db_config.host },
+      database:     ->(context) { context[:connection].pool.db_config.database }
+    }
+  end
 end
 
 Application.run

data/examples/snippets/query-logs/config/database.yml

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

data/examples/snippets/query-logs/db/seeds.rb

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 

data/examples/snippets/quickstart/application.rb

@@ -41,10 +41,6 @@ class Application
     Singer.where(last_name.matches("A%")).each do |s|
       puts "#{s.first_name} #{s.last_name}"
     end
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

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

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

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

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 

data/examples/snippets/read-only-transactions/application.rb

@@ -67,10 +67,6 @@ class Application
         puts "This error is expected."
       end
     end
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/read-only-transactions/config/database.yml

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

data/examples/snippets/read-only-transactions/db/seeds.rb

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 

data/examples/snippets/read-write-transactions/application.rb

@@ -10,7 +10,7 @@ require_relative "models/singer"
 require_relative "models/album"
 
 class Application
-  def self.run # rubocop:disable Metrics/AbcSize
+  def self.run
     from_album = nil
     to_album = nil
     # Use a read/write transaction to execute multiple statements as an atomic unit.
@@ -20,7 +20,7 @@ class Application
       to_album = Album.where.not(id: from_album.id).sample
 
       puts ""
-      puts "Transferring 10,000 marketing budget from #{from_album.title} (#{from_album.marketing_budget}) "\
+      puts "Transferring 10,000 marketing budget from #{from_album.title} (#{from_album.marketing_budget}) " \
            "to #{to_album.title} (#{to_album.marketing_budget})"
       from_album.update marketing_budget: from_album.marketing_budget - 10000
       to_album.update marketing_budget: to_album.marketing_budget + 10000
@@ -29,10 +29,6 @@ class Application
     puts "Budgets after update:"
     puts "Marketing budget #{from_album.title}: #{from_album.reload.marketing_budget}"
     puts "Marketing budget #{to_album.title}: #{to_album.reload.marketing_budget}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/read-write-transactions/config/database.yml

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

data/examples/snippets/read-write-transactions/db/seeds.rb

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 

data/examples/snippets/stale-reads/application.rb

@@ -53,10 +53,6 @@ class Application
     puts ""
     puts "Updated album title: #{album.title}"
     puts "Title somewhere during the last 10 seconds: #{album_max_staleness&.title}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/stale-reads/config/database.yml

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

data/examples/snippets/stale-reads/db/seeds.rb

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 

data/examples/snippets/tags/application.rb

@@ -22,10 +22,6 @@ class Application
       albums = Album.annotate("request_tag: query-all-albums", "transaction_tag: sample-transaction").all
       puts "Queried #{albums.length} albums using a request and a transaction tag"
     end
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

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

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

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

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 

data/examples/snippets/timestamp-data-type/application.rb

@@ -32,10 +32,6 @@ class Application
     # Simulate that the application is now running in the timezone America/Los_Angeles.
     Time.zone = "America/Los_Angeles"
     puts "#{'Meeting time in the local timezone (America/Los_Angeles):'.ljust 60} #{meeting.local_meeting_time}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/timestamp-data-type/config/database.yml

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

data/lib/active_record/connection_adapters/spanner/column.rb

@@ -10,16 +10,20 @@ module ActiveRecord
   module ConnectionAdapters
     module Spanner
       class Column < ConnectionAdapters::Column
-        # rubocop:disable Style/MethodDefParentheses
+        # rubocop:disable Style/OptionalBooleanParameter
         def initialize(name, default, sql_type_metadata = nil, null = true,
                        default_function = nil, collation: nil, comment: nil,
                        primary_key: false, **)
-          # rubocop:enable Style/MethodDefParentheses
+          # rubocop:enable Style/OptionalBooleanParameter
           super
           @primary_key = primary_key
         end
 
-        def has_default? # rubocop:disable Naming/PredicateName
+        def auto_incremented_by_db?
+          sql_type_metadata.is_identity
+        end
+
+        def has_default?
           super && !virtual?
         end
 

data/lib/active_record/connection_adapters/spanner/database_statements.rb

@@ -29,7 +29,7 @@ module ActiveRecord
         end
 
         def internal_execute sql, name = "SQL", binds = [],
-                             prepare: false, async: false, allow_retry: false # rubocop:disable Lint/UnusedMethodArgument, Metrics/LineLength
+                             prepare: false, async: false, allow_retry: false # rubocop:disable Lint/UnusedMethodArgument, /
           statement_type = sql_statement_type sql
           # Call `transform` to invoke any query transformers that might have been registered.
           sql = transform sql
@@ -65,7 +65,7 @@ module ActiveRecord
           end
 
           log_args = [sql, name]
-          log_args.concat [binds, type_casted_binds(binds)] if log_statement_binds
+          log_args.push binds, type_casted_binds(binds) if log_statement_binds
 
           log(*log_args) do
             types, params = to_types_and_params binds
@@ -83,12 +83,16 @@ module ActiveRecord
         end
 
         def append_request_tag_from_query_logs sql, binds
-          legacy_formatter_prefix = "/*request_tag:true,"
-          sql_commenter_prefix = "/*request_tag='true',"
-          if sql.start_with? legacy_formatter_prefix
-            append_request_tag_from_query_logs_with_format sql, binds, legacy_formatter_prefix
-          elsif sql.start_with? sql_commenter_prefix
-            append_request_tag_from_query_logs_with_format sql, binds, sql_commenter_prefix
+          possible_prefixes = [
+            "/*request_tag:true,",
+            "/*_request_tag='true',",
+            "/*_request_tag:true,",
+            "/*_request_tag='true',"
+          ]
+          possible_prefixes.each do |prefix|
+            if sql.start_with? prefix
+              append_request_tag_from_query_logs_with_format sql, binds, prefix
+            end
           end
         end
 
@@ -101,7 +105,7 @@ module ActiveRecord
           if options.request_tag == ""
             options.request_tag = request_tag
           else
-            options.request_tag += "," + request_tag
+            options.request_tag += ",#{request_tag}"
           end
 
           binds.append options
@@ -192,7 +196,7 @@ module ActiveRecord
           # and this RPC can return multiple partial result sets for DML as well. Only the last partial
           # result set will contain the statistics. Although there will never be any rows, this makes
           # sure that the stream is fully consumed.
-          result.rows.each { |_| }
+          result.rows.each { |_| } # rubocop:disable Lint/EmptyBlock
           return result.row_count if result.row_count
 
           raise ActiveRecord::StatementInvalid.new(
@@ -282,12 +286,12 @@ module ActiveRecord
         #
         def begin_isolated_db_transaction isolation
           if isolation.is_a? Hash
-            raise "Unsupported isolation level: #{isolation}" unless \
+            raise "Unsupported isolation level: #{isolation}" unless
               isolation[:timestamp] || isolation[:staleness] || isolation[:strong]
             raise "Only one option is supported. It must be one of `timestamp`, `staleness` or `strong`." \
               if isolation.count != 1
           else
-            raise "Unsupported isolation level: #{isolation}" unless \
+            raise "Unsupported isolation level: #{isolation}" unless
               [:serializable, :read_only, :buffered_mutations, :pdml].include? isolation
           end
 
@@ -312,26 +316,35 @@ module ActiveRecord
 
         # Translates binds to Spanner types and params.
         def to_types_and_params binds
-          types = binds.enum_for(:each_with_index).map do |bind, i|
+          types = to_types binds
+          params = to_params binds
+          [types, params]
+        end
+
+        def to_types binds
+          binds.enum_for(:each_with_index).to_h do |bind, i|
             type = :INT64
             if bind.respond_to? :type
               type = ActiveRecord::Type::Spanner::SpannerActiveRecordConverter
                      .convert_active_model_type_to_spanner(bind.type)
-            elsif bind.class == Symbol
+            elsif bind.instance_of? Symbol
               # This ensures that for example :environment is sent as the string 'environment' to Cloud Spanner.
               type = :STRING
-            elsif bind.class == TrueClass || bind.class == FalseClass
+            elsif bind.instance_of?(TrueClass) || bind.instance_of?(FalseClass)
               type = :BOOL
             end
             [
               # Generates binds for named parameters in the format `@p1, @p2, ...`
               "p#{i + 1}", type
             ]
-          end.to_h
-          params = binds.enum_for(:each_with_index).map do |bind, i|
+          end
+        end
+
+        def to_params binds
+          binds.enum_for(:each_with_index).to_h do |bind, i|
             type = if bind.respond_to? :type
                      bind.type
-                   elsif bind.class == Symbol
+                   elsif bind.instance_of? Symbol
                      # This ensures that for example :environment is sent as the string 'environment' to Cloud Spanner.
                      :STRING
                    else
@@ -343,8 +356,7 @@ module ActiveRecord
                     .serialize_with_transaction_isolation_level(type, bind_value, :dml)
 
             ["p#{i + 1}", value]
-          end.to_h
-          [types, params]
+          end
         end
 
         # An insert/update/delete statement could use mutations in some specific circumstances.
@@ -353,7 +365,7 @@ module ActiveRecord
         def should_use_mutation arel
           !@connection.current_transaction.nil? \
             && @connection.current_transaction.isolation == :buffered_mutations \
-            && can_use_mutation(arel) \
+            && can_use_mutation(arel)
         end
 
         def can_use_mutation arel
@@ -383,7 +395,7 @@ module ActiveRecord
           )
         end
 
-        COMMENT_REGEX = %r{(?:--.*\n)*|/\*(?:[^*]|\*[^/])*\*/}m.freeze \
+        COMMENT_REGEX = %r{(?:--.*\n)*|/\*(?:[^*]|\*[^/])*\*/}m \
             unless defined? ActiveRecord::ConnectionAdapters::AbstractAdapter::COMMENT_REGEX
         COMMENT_REGEX = ActiveRecord::ConnectionAdapters::AbstractAdapter::COMMENT_REGEX \
             if defined? ActiveRecord::ConnectionAdapters::AbstractAdapter::COMMENT_REGEX

data/lib/active_record/connection_adapters/spanner/quoting.rb

@@ -45,6 +45,7 @@ module ActiveRecord
         end
       end
     end
+
     module Spanner
       module Quoting
         def quote_column_name name
@@ -55,7 +56,7 @@ module ActiveRecord
           QUOTED_TABLE_NAMES[name] ||= "`#{name.to_s.gsub '.', '`.`'}`".freeze
         end
 
-        STR_ESCAPE_REGX = /[\n\r'\\]/.freeze
+        STR_ESCAPE_REGX = /[\n\r'\\]/
         STR_ESCAPE_VALUES = {
           "\n" => "\\n", "\r" => "\\r", "'" => "\\'", "\\" => "\\\\"
         }.freeze