activerecord-spanner-adapter 1.8.0 → 2.0.0

data/examples/snippets/Rakefile

@@ -7,19 +7,37 @@
 require_relative "config/environment"
 require "docker"
 
-desc "Lists all available samples."
-task :list do
-  samples = Dir.entries(".").select do |entry|
+def fetch_samples
+  Dir.entries(".").select do |entry|
     File.directory?(File.join(".", entry)) \
-     && !%w[. ..].include?(entry) \
-     && File.exist?(File.join(".", entry, "application.rb"))
+      && !%w[. ..].include?(entry) \
+      && File.exist?(File.join(".", entry, "application.rb"))
   end
+end
+
+desc "Lists all available samples."
+task :list do
+  samples = fetch_samples
   puts "Available samples: "
   samples.sort.each { |dir| puts "  #{dir}" }
   puts ""
   puts "Run a sample with the command `bundle exec rake run\\[<sample-name>\\]`"
 end
 
+desc "Runs all samples."
+task :all do
+  samples = fetch_samples
+  ar_version = ENV.fetch "AR_VERSION", "~> 7.1.0"
+  less_than_7_1 = ar_version.dup.to_s.sub("~>", "").strip < "7.1.0"
+  samples.delete "interleaved-tables" if less_than_7_1
+  samples.delete "interleaved-tables-before-7.1" unless less_than_7_1
+  samples.delete "bit-reversed-sequence" if less_than_7_1
+  samples.delete "query-logs" if less_than_7_1
+  samples.each do |sample|
+    run_sample sample
+  end
+end
+
 desc "Runs a simple ActiveRecord tutorial on a Spanner emulator."
 task :run, [:sample] do |_t, args|
   sample = args[:sample]
@@ -28,7 +46,11 @@ task :run, [:sample] do |_t, args|
     puts ""
     sample = "quickstart"
   end
+  run_sample sample
+end
 
+def run_sample sample
+  puts "Running #{sample}"
   puts "Downloading Spanner emulator image..."
   Docker::Image.create "fromImage" => "gcr.io/cloud-spanner-emulator/emulator:latest"
   puts "Creating Spanner emulator container..."

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

@@ -9,7 +9,7 @@ require_relative "../config/environment"
 require_relative "models/entity_with_array_types"
 
 class Application
-  def self.run # rubocop:disable Metrics/AbcSize
+  def self.run
     # Create a record with all array types.
     record = EntityWithArrayTypes.create \
       col_array_string: ["value1", "value2", "value3"],
@@ -35,10 +35,6 @@ class Application
     puts "Bytes array: #{record.col_array_bytes.map(&:read)}"
     puts "Date array: #{record.col_array_date}"
     puts "Timestamp array: #{record.col_array_timestamp}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

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

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

data/examples/snippets/bit-reversed-sequence/application.rb

@@ -22,10 +22,6 @@ class Application
 
     # List all singers, albums and tracks.
     list_singers_albums
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 
   def self.find_album singerid, albumid

data/examples/snippets/bit-reversed-sequence/config/database.yml

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

data/examples/snippets/bit-reversed-sequence/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"
 
@@ -14,7 +14,7 @@ last_names = %w[Wendelson Allison Peterson Johnson Henderson Ericsson Aronson Te
 adjectives = %w[daily happy blue generous cooked bad open]
 nouns = %w[windows potatoes bank street tree glass bottle]
 
-# Note: We do not use mutations to insert these rows, because letting the database generate the primary key means that
+# NOTE: We do not use mutations to insert these rows, because letting the database generate the primary key means that
 # we rely on a `THEN RETURN id` clause in the insert statement. This is only supported for DML statements, and not for
 # mutations.
 ActiveRecord::Base.transaction do

data/examples/snippets/bulk-insert/application.rb

@@ -46,7 +46,7 @@ class Application
       ]
     end
     puts ""
-    puts "Created a batch of #{singers.length} singers and #{albums.length} "\
+    puts "Created a batch of #{singers.length} singers and #{albums.length} " \
          "albums using a transaction with buffered mutations:"
     singers.each do |s|
       puts "  Created singer #{s.first_name} #{s.last_name} with id #{s.id}"
@@ -54,10 +54,6 @@ class Application
         puts "    with album #{a.title} with id #{a.id}"
       end
     end
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/bulk-insert/config/database.yml

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

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

@@ -43,10 +43,6 @@ class Application
     puts "Singer and album updated:"
     puts "#{singer.first_name} #{singer.last_name} (Last updated: #{singer.last_updated.strftime format})"
     puts "   #{album.title} (Last updated: #{album.last_updated.strftime format})"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

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

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

data/examples/snippets/config/environment.rb

@@ -4,11 +4,16 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
+require "logger" # https://github.com/rails/rails/issues/54260
 require "active_record"
 require "bundler"
 
 Dir["../../lib/*.rb"].each { |file| require file }
 
+if ActiveRecord.version >= Gem::Version.create("7.2.0")
+  ActiveRecord::ConnectionAdapters.register "spanner", "ActiveRecord::ConnectionAdapters::SpannerAdapter"
+end
+
 Bundler.require
 
 ActiveRecord::Base.establish_connection(

data/examples/snippets/create-records/application.rb

@@ -13,7 +13,7 @@ class Application
   def self.run
     # Creating a single record without an explicit transaction will automatically save it to the database.
     # It is not recommended to call Entity.create repeatedly to insert multiple records, as each call will
-    # use a separate Spanner transaction. Instead multiple records should be created by passing an array of
+    # use a separate Spanner transaction. Instead, multiple records should be created by passing an array of
     # entities to the Entity.create method.
     singer = Singer.create first_name: "Dave", last_name: "Allison"
     puts ""
@@ -32,10 +32,6 @@ class Application
     singers.each do |s|
       puts "  Created singer #{s.first_name} #{s.last_name} with id #{s.id}"
     end
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/create-records/config/database.yml

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

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

@@ -17,7 +17,7 @@ class Application
       puts "#{"#{singer.first_name} #{singer.last_name}".ljust 30}#{singer.birth_date}"
     end
 
-    # Update the birth date of a random singer using the current system time. Any time and timezone information will be
+    # Update the birthdate of a random singer using the current system time. Any time and timezone information will be
     # lost after saving the record as a DATE only contains the year, month and day-of-month information.
     singer = Singer.all.sample
     singer.update birth_date: Time.now
@@ -25,10 +25,6 @@ class Application
     puts ""
     puts "Updated birth date to current system time:"
     puts "#{"#{singer.first_name} #{singer.last_name}".ljust 30}#{singer.birth_date}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

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

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

data/examples/snippets/date-data-type/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"
 
 first_names = %w[Nelson Todd William Alex Dominique Adenoid Steve Nathan Beverly Annie Amy Norma Diana Regan Phyllis]

data/examples/snippets/generated-column/application.rb

@@ -27,10 +27,6 @@ class Application
     singer.reload
     puts ""
     puts "Singer updated: #{singer.full_name}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/generated-column/config/database.yml

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

data/examples/snippets/generated-column/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"
 
 first_names = %w[Pete Alice John Ethel Trudy Naomi Wendy Ruben Thomas Elly]

data/examples/snippets/hints/application.rb

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

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

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

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"