activerecord-spanner-adapter 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8f379074a93053e240a8dc13c74b3a3f85cf2b767830901fffd7bcf3bf2b3ba
-  data.tar.gz: f5ac8e18ed5cc732b753c40b36add02b164a39ea14396fa720371b7d65645684
+  metadata.gz: e91546c93ad037bfaa453c4e80f0f9bd3ce5f6ced1e98cfd74ea92a8495996ec
+  data.tar.gz: 1180932c1f3644a0338b856f1b170ed5a4aa2735ac8410071981db28697c7bf4
 SHA512:
-  metadata.gz: 39062a1c09f09cc4da8c1dd7d592905a61ae4b6e914aa88060572c9bda1dbe2626808ab92efcdef21ca18c61c7c116c3a4f55903c5829ff5044984e72e69763c
-  data.tar.gz: 41a26004516514ec6573e554ba664824105a5f0687d4a831057ff69a92ba9d329fbb185d310d9e5e2d6f1449470aaf573873ffddb038063166aee64c360f10d1
+  metadata.gz: cbb029027fc34279f095294df20756d1bcfa2a077b45919d4447d4be8a29f7fb5bbb911896b8a5a3441766af735a0ec3ad38b4dfae2527ef401c1d4e9a39132e
+  data.tar.gz: 33a6509c950572f3880dc9d48c34dc35784909b46fc1d1226f2e20c57c77e734c53149f6620be17a8d3e85b4e086624bf545dae5bcc91a671cd1089cad885b36

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.0.0](https://www.github.com/googleapis/ruby-spanner-activerecord/compare/activerecord-spanner-adapter/v0.7.1...activerecord-spanner-adapter/v1.0.0) (2021-12-07)
+
+
+### Features
+
+* release 1.0.0 ([#146](https://www.github.com/googleapis/ruby-spanner-activerecord/issues/146)) ([15ce616](https://www.github.com/googleapis/ruby-spanner-activerecord/commit/15ce6161fd052aaf6a1f078e65c0f836e8d640f3))
+
+### [0.7.1](https://www.github.com/googleapis/ruby-spanner-activerecord/compare/activerecord-spanner-adapter/v0.7.0...activerecord-spanner-adapter/v0.7.1) (2021-11-21)
+
+
+### Performance Improvements
+
+* inline BeginTransaction with first statement in the transaction ([#139](https://www.github.com/googleapis/ruby-spanner-activerecord/issues/139)) ([ed88647](https://www.github.com/googleapis/ruby-spanner-activerecord/commit/ed88647a4df995b4f4221ac056f9204ee45ce90f))
+
 ## [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)
 
 
@@ -24,7 +38,6 @@
 * Add support for NUMERIC type ([#73](https://www.github.com/googleapis/ruby-spanner-activerecord/issues/73)) ([176cf99](https://www.github.com/googleapis/ruby-spanner-activerecord/commit/176cf99dc8c26b3fd34d9e85d82a91dbde2b15c8))
 * Add support for ARRAY data type ([#86](https://www.github.com/googleapis/ruby-spanner-activerecord/issues/86)) ([0c66a62](https://www.github.com/googleapis/ruby-spanner-activerecord/commit/0c66a620cab968779de04faf48e03eec643ebea9))
 * google-cloud-spanner version upgraded to 2.2 ([#55](https://www.github.com/googleapis/ruby-spanner-activerecord/issues/55)) ([d7581d6](https://www.github.com/googleapis/ruby-spanner-activerecord/commit/d7581d60bd9a9e7b9989565449119f73e2caa694))
-* Support interleaved tables ([#83](https://www.github.com/googleapis/ruby-spanner-activerecord/issues/83)) ([82265f9](https://www.github.com/googleapis/ruby-spanner-activerecord/commit/82265f94ace79964639a2c65554714752be39724))
 * retry session not found ([#81](https://www.github.com/googleapis/ruby-spanner-activerecord/issues/81)) ([88fd3b7](https://www.github.com/googleapis/ruby-spanner-activerecord/commit/88fd3b70a03a90de2b667bb0f2e86efe5dc9328b))
 * support and test multiple ActiveRecord versions ([#107](https://www.github.com/googleapis/ruby-spanner-activerecord/issues/107)) ([db9d96c](https://www.github.com/googleapis/ruby-spanner-activerecord/commit/db9d96c44b9560f6904209df1a9aa42bf50a5844))
 * support DDL batches on connection ([#72](https://www.github.com/googleapis/ruby-spanner-activerecord/issues/72)) ([0d18cd4](https://www.github.com/googleapis/ruby-spanner-activerecord/commit/0d18cd49641bdb567012d6ac88b1909461d42551))

data/README.md

@@ -4,7 +4,7 @@
 
 ![rubocop](https://github.com/googleapis/ruby-spanner-activerecord/workflows/rubocop/badge.svg)
 
-This project provides a Cloud Spanner adapter for ActiveRecord. It has the __Preview__ release status and supports the following versions:
+This project provides a Cloud Spanner adapter for ActiveRecord. It supports the following versions:
 
 - ActiveRecord 6.0.x with Ruby 2.6 and 2.7.
 - ActiveRecord 6.1.x with Ruby 2.6 and higher.
@@ -69,7 +69,6 @@ Some noteworthy examples in the snippets directory:
 - [mutations](examples/snippets/mutations): Shows how you can use [mutations instead of DML](https://cloud.google.com/spanner/docs/dml-versus-mutations)
   for inserting, updating and deleting data in a Cloud Spanner database. Mutations can have a significant performance
   advantage compared to DML statements, but do not allow read-your-writes semantics during a transaction.
-- [interleaved-tables](examples/snippets/interleaved-tables): Shows how to create and work with a hierarchy of `INTERLEAVED IN` tables.
 - [array-data-type](examples/snippets/array-data-type): Shows how to work with `ARRAY` data types.
 
 ## Limitations
@@ -93,4 +92,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Activerecord::Spanner project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/googleapis/ruby-spanner-activerecord/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Activerecord::Spanner project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/googleapis/ruby-spanner-activerecord/blob/master/CODE_OF_CONDUCT.md).

data/lib/activerecord_spanner_adapter/connection.rb

@@ -208,27 +208,53 @@ module ActiveRecordSpannerAdapter
         self.current_transaction = nil
       end
 
-      begin
-        session.execute_query \
-          sql,
-          params: converted_params,
-          types: types,
-          transaction: transaction_selector || single_use_selector,
-          seqno: (current_transaction&.next_sequence_number)
-      rescue Google::Cloud::AbortedError
-        # Mark the current transaction as aborted to prevent any unnecessary further requests on the transaction.
-        current_transaction&.mark_aborted
-        raise
-      rescue Google::Cloud::NotFoundError => e
-        if session_not_found?(e) || transaction_not_found?(e)
-          reset!
-          # Force a retry of the entire transaction if this statement was executed as part of a transaction.
-          # Otherwise, just retry the statement itself.
-          raise_aborted_err if current_transaction&.active?
-          retry
-        end
-        raise
+      selector = transaction_selector || single_use_selector
+      execute_sql_request sql, converted_params, types, selector
+    end
+
+    def execute_sql_request sql, converted_params, types, selector
+      res = session.execute_query \
+        sql,
+        params: converted_params,
+        types: types,
+        transaction: selector,
+        seqno: (current_transaction&.next_sequence_number)
+      current_transaction.grpc_transaction = res.metadata.transaction \
+          if current_transaction && res&.metadata&.transaction
+      res
+    rescue Google::Cloud::AbortedError
+      # Mark the current transaction as aborted to prevent any unnecessary further requests on the transaction.
+      current_transaction&.mark_aborted
+      raise
+    rescue Google::Cloud::NotFoundError => e
+      if session_not_found?(e) || transaction_not_found?(e)
+        reset!
+        # Force a retry of the entire transaction if this statement was executed as part of a transaction.
+        # Otherwise, just retry the statement itself.
+        raise_aborted_err if current_transaction&.active?
+        retry
+      end
+      raise
+    rescue Google::Cloud::Error => e
+      # Check if it was the first statement in a transaction that included a BeginTransaction
+      # option in the request. If so, execute an explicit BeginTransaction and then retry the
+      # request without the BeginTransaction option.
+      if current_transaction && selector&.begin&.read_write
+        selector = create_transaction_after_failed_first_statement e
+        retry
       end
+      # It was not the first statement, so propagate the error.
+      raise
+    end
+
+    # Creates a transaction using a BeginTransaction RPC. This is used if the first statement of a
+    # transaction fails, as that also means that no transaction id was returned.
+    def create_transaction_after_failed_first_statement original_error
+      transaction = current_transaction.force_begin_read_write
+      Google::Spanner::V1::TransactionSelector.new id: transaction.transaction_id
+    rescue Google::Cloud::Error
+      # Raise the original error if the BeginTransaction RPC also fails.
+      raise original_error
     end
 
     # Transactions

data/lib/activerecord_spanner_adapter/information_schema.rb

@@ -62,7 +62,8 @@ module ActiveRecordSpannerAdapter
     end
 
     def table_columns table_name, column_name: nil
-      sql = +"SELECT COLUMN_NAME, SPANNER_TYPE, IS_NULLABLE, COLUMN_DEFAULT, ORDINAL_POSITION"
+      sql = +"SELECT COLUMN_NAME, SPANNER_TYPE, IS_NULLABLE,"
+      sql << " CAST(COLUMN_DEFAULT AS STRING) AS COLUMN_DEFAULT, ORDINAL_POSITION"
       sql << " FROM INFORMATION_SCHEMA.COLUMNS"
       sql << " WHERE TABLE_NAME=%<table_name>s"
       sql << " AND COLUMN_NAME=%<column_name>s" if column_name

data/lib/activerecord_spanner_adapter/transaction.rb

@@ -30,28 +30,37 @@ module ActiveRecordSpannerAdapter
       @mutations << mutation
     end
 
+    # Begins the transaction.
+    #
+    # Read-only and PDML transactions are started by executing a BeginTransaction RPC.
+    # Read/write transactions are not really started by this method, and instead a
+    # transaction selector is prepared that will be included with the first statement
+    # on the transaction.
     def begin
       raise "Nested transactions are not allowed" if @state != :INITIALIZED
       begin
-        @grpc_transaction =
-          case @isolation
-          when Hash
-            if @isolation[:timestamp]
-              @connection.session.create_snapshot timestamp: @isolation[:timestamp]
-            elsif @isolation[:staleness]
-              @connection.session.create_snapshot staleness: @isolation[:staleness]
-            elsif @isolation[:strong]
-              @connection.session.create_snapshot strong: true
-            else
-              raise "Invalid snapshot argument: #{@isolation}"
-            end
-          when :read_only
-            @connection.session.create_snapshot strong: true
-          when :pdml
-            @connection.session.create_pdml
+        case @isolation
+        when Hash
+          if @isolation[:timestamp]
+            @grpc_transaction = @connection.session.create_snapshot timestamp: @isolation[:timestamp]
+          elsif @isolation[:staleness]
+            @grpc_transaction = @connection.session.create_snapshot staleness: @isolation[:staleness]
+          elsif @isolation[:strong]
+            @grpc_transaction = @connection.session.create_snapshot strong: true
           else
-            @connection.session.create_transaction
+            raise "Invalid snapshot argument: #{@isolation}"
           end
+        when :read_only
+          @grpc_transaction = @connection.session.create_snapshot strong: true
+        when :pdml
+          @grpc_transaction = @connection.session.create_pdml
+        else
+          @begin_transaction_selector = Google::Spanner::V1::TransactionSelector.new \
+            begin: Google::Spanner::V1::TransactionOptions.new(
+              read_write: Google::Spanner::V1::TransactionOptions::ReadWrite.new
+            )
+
+        end
         @state = :STARTED
       rescue Google::Cloud::NotFoundError => e
         if @connection.session_not_found? e
@@ -66,6 +75,12 @@ module ActiveRecordSpannerAdapter
       end
     end
 
+    # Forces a BeginTransaction RPC for a read/write transaction. This is used by a
+    # connection if the first statement of a transaction failed.
+    def force_begin_read_write
+      @grpc_transaction = @connection.session.create_transaction
+    end
+
     def next_sequence_number
       @sequence_number += 1 if @committable
     end
@@ -74,7 +89,10 @@ module ActiveRecordSpannerAdapter
       raise "This transaction is not active" unless active?
 
       begin
-        @connection.session.commit_transaction @grpc_transaction, @mutations if @committable
+        # Start a transaction with an explicit BeginTransaction RPC if the transaction only contains mutations.
+        force_begin_read_write if @committable && !@mutations.empty? && !@grpc_transaction
+
+        @connection.session.commit_transaction @grpc_transaction, @mutations if @committable && @grpc_transaction
         @state = :COMMITTED
       rescue Google::Cloud::NotFoundError => e
         if @connection.session_not_found? e
@@ -93,7 +111,7 @@ module ActiveRecordSpannerAdapter
     def rollback
       # Allow rollback after abort and/or a failed commit.
       raise "This transaction is not active" unless active? || @state == :FAILED || @state == :ABORTED
-      if active?
+      if active? && @grpc_transaction
         # We do a shoot-and-forget rollback here, as the error that caused the transaction to be rolled back could
         # also have invalidated the transaction (e.g. `Session not found`). If the rollback fails for any other
         # reason, we also do not need to retry it or propagate the error to the application, as the transaction will
@@ -113,11 +131,24 @@ module ActiveRecordSpannerAdapter
       @state = :ABORTED
     end
 
+    # Sets the underlying gRPC transaction to use for this Transaction.
+    # This is used for queries/DML statements that inlined the BeginTransaction option and returned
+    # a transaction in the metadata.
+    def grpc_transaction= grpc
+      @grpc_transaction = Google::Cloud::Spanner::Transaction.from_grpc grpc, @connection.session
+    end
+
     def transaction_selector
       return unless active?
 
-      Google::Spanner::V1::TransactionSelector.new \
-        id: @grpc_transaction.transaction_id
+      # Use the transaction that has been started by a BeginTransaction RPC or returned by a
+      # statement, if present.
+      return Google::Spanner::V1::TransactionSelector.new id: @grpc_transaction.transaction_id \
+          if @grpc_transaction
+
+      # Return a transaction selector that will instruct the statement to also start a transaction
+      # and return its id as a side effect.
+      @begin_transaction_selector
     end
   end
 end

data/lib/activerecord_spanner_adapter/version.rb

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

data/lib/spanner_client_ext.rb

@@ -95,6 +95,10 @@ module Google
         end
       end
 
+      class Results
+        attr_reader :metadata
+      end
+
       class Transaction
         attr_accessor :seqno, :commit
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-spanner-adapter
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-spanner
@@ -378,16 +378,6 @@ files:
 - 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
-- examples/snippets/interleaved-tables/config/database.yml
-- examples/snippets/interleaved-tables/db/migrate/01_create_tables.rb
-- examples/snippets/interleaved-tables/db/schema.rb
-- examples/snippets/interleaved-tables/db/seeds.rb
-- examples/snippets/interleaved-tables/models/album.rb
-- examples/snippets/interleaved-tables/models/singer.rb
-- examples/snippets/interleaved-tables/models/track.rb
 - examples/snippets/migrations/README.md
 - examples/snippets/migrations/Rakefile
 - examples/snippets/migrations/application.rb

data/examples/snippets/interleaved-tables/README.md

@@ -1,152 +0,0 @@
-# Sample - Interleaved Tables
-
-This example shows how to use interleaved tables with the Spanner ActiveRecord adapter.
-
-See https://cloud.google.com/spanner/docs/schema-and-data-model#creating-interleaved-tables for more information
-on interleaved tables if you are not familiar with this concept.
-
-## Creating Interleaved Tables in ActiveRecord
-You can create interleaved tables using migrations in ActiveRecord by using the following Spanner ActiveRecord specific
-methods that are defined on `TableDefinition`:
-* `interleave_in`: Specifies which parent table a child table should be interleaved in and optionally whether
-  deletes of a parent record should automatically cascade delete all child records. 
-* `parent_key`: Creates a column that is a reference to (a part of) the primary key of the parent table. Each child
-  table must include all the primary key columns of the parent table as a `parent_key`.
-  
-Cloud Spanner requires a child table to include the exact same primary key columns as the parent table in addition to
-the primary key column(s) of the child table. This means that the default `id` primary key column of ActiveRecord is
-not usable in combination with interleaved tables. Instead each primary key column should be prefixed with the table
-name of the table that it references, or use some other unique name.
-
-This example uses the following table schema:
-
-```sql
-CREATE TABLE singers (
-    singerid INT64 NOT NULL,
-    first_name STRING(MAX),
-    last_name STRING(MAX)
-) PRIMARY KEY (singerid);
-
-CREATE TABLE albums (
-    albumid INT64 NOT NULL,
-    singerid INT64 NOT NULL,
-    title STRING(MAX)
-) PRIMARY KEY (singerid, albumid), INTERLEAVE IN PARENT singers;
-
-CREATE TABLE tracks (
-    trackid INT64 NOT NULL,
-    singerid INT64 NOT NULL,
-    albumid INT64 NOT NULL,
-    title STRING(MAX),
-    duration NUMERIC
-) PRIMARY KEY (singerid, albumid, trackid), INTERLEAVE IN PARENT albums ON DELETE CASCADE;
-```
-
-This schema can be created in ActiveRecord as follows:
-
-```ruby
-create_table :singers, id: false do |t|
-    # Explicitly define the primary key with a custom name to prevent all primary key columns from being named `id`.
-    t.primary_key :singerid
-    t.string :first_name
-    t.string :last_name
-end
-
-create_table :albums, id: false do |t|
-    # Interleave the `albums` table in the parent table `singers`.
-    t.interleave_in :singers
-    t.primary_key :albumid
-    # `singerid` is defined as a `parent_key` which makes it a part of the primary key in the table definition, but
-    # it is not presented to ActiveRecord as part of the primary key, to prevent ActiveRecord from considering this
-    # to be an entity with a composite primary key (which is not supported by ActiveRecord).
-    t.parent_key :singerid
-    t.string :title
-end
-
-create_table :tracks, id: false do |t|
-    # Interleave the `tracks` table in the parent table `albums` and cascade delete all tracks that belong to an
-    # album when an album is deleted.
-    t.interleave_in :albums, :cascade
-    # `trackid` is considered the only primary key column by ActiveRecord.
-    t.primary_key :trackid
-    # `singerid` and `albumid` form the parent key of `tracks`. These are part of the primary key definition in the
-    # database, but are presented as parent keys to ActiveRecord.
-    t.parent_key :singerid
-    t.parent_key :albumid
-    t.string :title
-    t.numeric :duration
-end
-```
-
-## Models for Interleaved Tables
-An interleaved table parent/child relationship must be modelled as a `belongs_to`/`has_many` association in
-ActiveRecord. As the columns that are used to reference a parent record use a custom column name, it is required to also
-include the custom column name in the `belongs_to` and `has_many` definitions.
-
-Instances of these models can be used in the same way as any other association in ActiveRecord, but with a couple of
-inherent limitations:
-* It is not possible to change the parent record of a child record. For instance, changing the singer of an album in the
-  above example is impossible, as Cloud Spanner does not allow such an update.
-* It is not possible to de-reference a parent record by setting it to null.
-* It is only possible to delete a parent record with existing child records, if the child records are also deleted. This
-  can be done by enabling ON DELETE CASCADE in Cloud Spanner, or by deleting the child records using ActiveRecord.
-
-### Example Models
-
-```ruby
-class Singer < ActiveRecord::Base
-  # `albums` is defined as INTERLEAVE IN PARENT `singers`. The primary key of `albums` is (`singerid`, `albumid`), but
-  # only `albumid` is used by ActiveRecord as the primary key. The `singerid` column is defined as a `parent_key` of
-  # `albums` (see also the `db/migrate/01_create_tables.rb` file).
-  has_many :albums, foreign_key: "singerid"
-
-  # `tracks` is defined as INTERLEAVE IN PARENT `albums`. The primary key of `tracks` is
-  # (`singerid`, `albumid`, `trackid`), but only `trackid` is used by ActiveRecord as the primary key. The `singerid`
-  # and `albumid` columns are defined as `parent_key` of `tracks` (see also the `db/migrate/01_create_tables.rb` file).
-  # The `singerid` column can therefore be used to associate tracks with a singer without the need to go through albums.
-  # Note also that the inclusion of `singerid` as a column in `tracks` is required in order to make `tracks` a child
-  # table of `albums` which has primary key (`singerid`, `albumid`).
-  has_many :tracks, foreign_key: "singerid"
-end
-
-class Album < ActiveRecord::Base
-  # `albums` is defined as INTERLEAVE IN PARENT `singers`. The primary key of `singers` is `singerid`.
-  belongs_to :singer, foreign_key: "singerid"
-
-  # `tracks` is defined as INTERLEAVE IN PARENT `albums`. The primary key of `albums` is (`singerid`, `albumid`), but
-  # only `albumid` is used by ActiveRecord as the primary key. The `singerid` column is defined as a `parent_key` of
-  # `albums` (see also the `db/migrate/01_create_tables.rb` file).
-  has_many :tracks, foreign_key: "albumid"
-end
-
-class Track < ActiveRecord::Base
-  # `tracks` is defined as INTERLEAVE IN PARENT `albums`. The primary key of `albums` is ()`singerid`, `albumid`).
-  belongs_to :album, foreign_key: "albumid"
-
-  # `tracks` also has a `singerid` column should be used to associate a Track with a Singer.
-  belongs_to :singer, foreign_key: "singerid"
-
-  # Override the default initialize method to automatically set the singer attribute when an album is given.
-  def initialize attributes = nil
-    super
-    self.singer ||= album&.singer
-  end
-
-  def album=value
-    super
-    # Ensure the singer of this track is equal to the singer of the album that is set.
-    self.singer = value&.singer
-  end
-end
-```
-
-## 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/interleaved-tables/Rakefile

@@ -1,13 +0,0 @@
-# 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 interleaved tables in ActiveRecord."
-task :run do
-  Dir.chdir("..") { sh "bundle exec rake run[interleaved-tables]" }
-end

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

@@ -1,109 +0,0 @@
-# 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"
-require_relative "models/track"
-
-class Application
-  def self.run
-    # List all singers, albums and tracks.
-    list_singers_albums_tracks
-
-    # Create a new album with some tracks.
-    create_new_album
-
-    # Try to update the singer of an album. This is not possible as albums are interleaved in singers.
-    update_singer_of_album
-
-    # Try to delete a singer that has at least one album. This is NOT possible as albums is NOT marked with
-    # ON DELETE CASCADE.
-    delete_singer_with_albums
-
-    # 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.list_singers_albums_tracks
-    puts ""
-    puts "Listing all singers with corresponding albums and tracks"
-    Singer.all.order("last_name, first_name").each do |singer|
-      puts "#{singer.first_name} #{singer.last_name} has #{singer.albums.count} albums:"
-      singer.albums.order("title").each do |album|
-        puts "  #{album.title} has #{album.tracks.count} tracks:"
-        album.tracks.each do |track|
-          puts "    #{track.title}"
-        end
-      end
-    end
-  end
-
-  def self.create_new_album
-    # Create a new album with some tracks.
-    puts ""
-    singer = Singer.all.sample
-    puts "Creating a new album for #{singer.first_name} #{singer.last_name}"
-    album = singer.albums.build title: "New Title"
-    album.tracks.build title: "Track 1", duration: 3.5, singer: singer
-    album.tracks.build title: "Track 2", duration: 3.6, singer: singer
-    # This will save the album and corresponding tracks in one transaction.
-    album.save!
-
-    album.reload
-    puts "Album #{album.title} has #{album.tracks.count} tracks:"
-    album.tracks.order("title").each do |track|
-      puts "  #{track.title} with duration #{track.duration}"
-    end
-  end
-
-  def self.update_singer_of_album
-    # It is not possible to change the singer of an album or the album of a track. This is because the associations
-    # between these are not traditional foreign keys, but an immutable parent-child relationship.
-    album = Album.all.sample
-    new_singer = Singer.all.except(album.singer).sample
-    # This will fail as we cannot assign a new singer to an album as it is an INTERLEAVE IN PARENT relationship.
-    begin
-      album.update! singer: new_singer
-      raise StandardError, "Unexpected error: Updating the singer of an album should not be possible."
-    rescue ActiveRecord::StatementInvalid
-      puts ""
-      puts "Failed to update the singer of an album. This is expected."
-    end
-  end
-
-  def self.delete_singer_with_albums
-    # Deleting a singer that has albums is not possible, as the INTERLEAVE IN PARENT of albums is not marked with
-    # ON DELETE CASCADE.
-    singer = Album.all.sample.singer
-    begin
-      singer.delete
-      raise StandardError, "Unexpected error: Updating the singer of an album should not be possible."
-    rescue ActiveRecord::StatementInvalid
-      puts ""
-      puts "Failed to delete a singer that has #{singer.albums.count} albums. This is expected."
-    end
-  end
-
-  def self.delete_album_with_tracks
-    # Deleting an album with tracks is supported, as the INTERLEAVE IN PARENT relationship between tracks and albums is
-    # marked with ON DELETE CASCADE.
-    puts ""
-    puts "Total track count: #{Track.count}"
-    album = Track.all.sample.album
-    puts "Deleting album #{album.title} with #{album.tracks.count} tracks"
-    album.delete
-    puts "Total track count after deletion: #{Track.count}"
-  end
-end
-
-Application.run

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

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

data/examples/snippets/interleaved-tables/db/migrate/01_create_tables.rb

@@ -1,44 +0,0 @@
-# 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
-    # Execute the entire migration as one DDL batch.
-    connection.ddl_batch do
-      create_table :singers, id: false do |t|
-        # Explicitly define the primary key with a custom name to prevent all primary key columns from being named `id`.
-        t.primary_key :singerid
-        t.string :first_name
-        t.string :last_name
-      end
-
-      create_table :albums, id: false do |t|
-        # Interleave the `albums` table in the parent table `singers`.
-        t.interleave_in :singers
-        t.primary_key :albumid
-        # `singerid` is defined as a `parent_key` which makes it a part of the primary key in the table definition, but
-        # it is not presented to ActiveRecord as part of the primary key, to prevent ActiveRecord from considering this
-        # to be an entity with a composite primary key (which is not supported by ActiveRecord).
-        t.parent_key :singerid
-        t.string :title
-      end
-
-      create_table :tracks, id: false do |t|
-        # Interleave the `tracks` table in the parent table `albums` and cascade delete all tracks that belong to an
-        # album when an album is deleted.
-        t.interleave_in :albums, :cascade
-        # `trackid` is considered the only primary key column by ActiveRecord.
-        t.primary_key :trackid
-        # `singerid` and `albumid` form the parent key of `tracks`. These are part of the primary key definition in the
-        # database, but are presented as parent keys to ActiveRecord.
-        t.parent_key :singerid
-        t.parent_key :albumid
-        t.string :title
-        t.numeric :duration
-      end
-    end
-  end
-end

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

@@ -1,32 +0,0 @@
-# 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 `rails
-# db:schema:load`. When creating a new database, `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", primary_key: "albumid", force: :cascade do |t|
-    t.integer "singerid", limit: 8, null: false
-    t.string "title"
-  end
-
-  create_table "singers", primary_key: "singerid", force: :cascade do |t|
-    t.string "first_name"
-    t.string "last_name"
-  end
-
-  create_table "tracks", primary_key: "trackid", force: :cascade do |t|
-    t.integer "singerid", limit: 8, null: false
-    t.integer "albumid", limit: 8, null: false
-    t.string "title"
-    t.decimal "duration"
-  end
-
-end

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

@@ -1,40 +0,0 @@
-# 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"
-require_relative "../models/track"
-
-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]
-
-verbs = %w[operate waste package chew yield express polish stress slip want cough campaign cultivate report park refer]
-adverbs = %w[directly right hopefully personally economically privately supposedly consequently fully later urgently]
-
-durations = [3.14, 5.4, 3.3, 4.1, 5.0, 3.2, 3.0, 3.5, 4.0, 4.5, 5.5, 6.0]
-
-# 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
-
-  200.times do
-    album = albums.sample
-    Track.create title: "#{verbs.sample} #{adverbs.sample}", duration: durations.sample, album: album
-  end
-end

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

@@ -1,15 +0,0 @@
-# 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
-  # `albums` is defined as INTERLEAVE IN PARENT `singers`. The primary key of `singers` is `singerid`.
-  belongs_to :singer, foreign_key: "singerid"
-
-  # `tracks` is defined as INTERLEAVE IN PARENT `albums`. The primary key of `albums` is (`singerid`, `albumid`), but
-  # only `albumid` is used by ActiveRecord as the primary key. The `singerid` column is defined as a `parent_key` of
-  # `albums` (see also the `db/migrate/01_create_tables.rb` file).
-  has_many :tracks, foreign_key: "albumid"
-end

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

@@ -1,20 +0,0 @@
-# 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
-  # `albums` is defined as INTERLEAVE IN PARENT `singers`. The primary key of `albums` is (`singerid`, `albumid`), but
-  # only `albumid` is used by ActiveRecord as the primary key. The `singerid` column is defined as a `parent_key` of
-  # `albums` (see also the `db/migrate/01_create_tables.rb` file).
-  has_many :albums, foreign_key: "singerid"
-
-  # `tracks` is defined as INTERLEAVE IN PARENT `albums`. The primary key of `tracks` is
-  # (`singerid`, `albumid`, `trackid`), but only `trackid` is used by ActiveRecord as the primary key. The `singerid`
-  # and `albumid` columns are defined as `parent_key` of `tracks` (see also the `db/migrate/01_create_tables.rb` file).
-  # The `singerid` column can therefore be used to associate tracks with a singer without the need to go through albums.
-  # Note also that the inclusion of `singerid` as a column in `tracks` is required in order to make `tracks` a child
-  # table of `albums` which has primary key (`singerid`, `albumid`).
-  has_many :tracks, foreign_key: "singerid"
-end

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

@@ -1,25 +0,0 @@
-# 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 Track < ActiveRecord::Base
-  # `tracks` is defined as INTERLEAVE IN PARENT `albums`. The primary key of `albums` is ()`singerid`, `albumid`).
-  belongs_to :album, foreign_key: "albumid"
-
-  # `tracks` also has a `singerid` column should be used to associate a Track with a Singer.
-  belongs_to :singer, foreign_key: "singerid"
-
-  # Override the default initialize method to automatically set the singer attribute when an album is given.
-  def initialize attributes = nil
-    super
-    self.singer ||= album&.singer
-  end
-
-  def album=value
-    super
-    # Ensure the singer of this track is equal to the singer of the album that is set.
-    self.singer = value&.singer
-  end
-end