activerecord-spanner-adapter 0.6.0 → 1.0.1

data/release-please-config.json

@@ -0,0 +1,19 @@
+{
+  "bump-minor-pre-major": true,
+  "bump-patch-for-minor-pre-major": false,
+  "draft": false,
+  "include-component-in-tag": true,
+  "include-v-in-tag": true,
+  "prerelease": false,
+  "release-type": "ruby-yoshi",
+  "skip-github-release": false,
+  "separate-pull-requests": true,
+  "tag-separator": "/",
+  "sequential-calls": true,
+  "packages": {
+    ".": {
+      "component": "activerecord-spanner-adapter",
+      "version-file": "lib/activerecord_spanner_adapter/version.rb"
+    }
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-spanner-adapter
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-spanner
@@ -214,6 +214,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
+- ".github/blunderbuss.yml"
 - ".github/sync-repo-settings.yaml"
 - ".github/workflows/acceptance-tests-on-emulator.yaml"
 - ".github/workflows/acceptance-tests-on-production.yaml"
@@ -229,6 +230,7 @@ files:
 - ".kokoro/release.cfg"
 - ".kokoro/release.sh"
 - ".kokoro/trampoline_v2.sh"
+- ".release-please-manifest.json"
 - ".rubocop.yml"
 - ".toys/release.rb"
 - ".trampolinerc"
@@ -369,16 +371,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/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/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/migrations/README.md
 - examples/snippets/migrations/Rakefile
 - examples/snippets/migrations/application.rb
@@ -407,6 +408,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
@@ -481,6 +491,7 @@ files:
 - lib/activerecord_spanner_adapter/version.rb
 - lib/arel/visitors/spanner.rb
 - lib/spanner_client_ext.rb
+- release-please-config.json
 - renovate.json
 homepage: https://github.com/googleapis/ruby-spanner-activerecord
 licenses:
@@ -501,7 +512,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Rails ActiveRecord connector for Google Spanner Database

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/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/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/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