active_record_shards 3.11.3 → 3.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: '09b0da024cd5b13020b14dde7e822530b7f82fcc'
-  data.tar.gz: 0c2d9149aa653176d122c97fe632e6d47e00716a
+SHA256:
+  metadata.gz: d4685600c17b38021c0601061601098ee26dd330684fd60bfb16bc40e41248a7
+  data.tar.gz: 1afec8f57736de6fd69c005fbfd4eb8bb513f0dab58bbe775fc6b8ea1103ad30
 SHA512:
-  metadata.gz: 59ec6f7c8e6c8639beee8aea8ded4c0b8aa910b839c4f0350836077bc745692330a0106df273b7b78e46251c0b3a4fb0a27e6164a17475669eac8afea0444d5c
-  data.tar.gz: dd24e476ad1c062427b54e5898f5a33393547acfeb1d1faf63024b4b900c2144672d2c67c2c42023225ef63b0e0c69c3722c188f320f6d50fc28e0773f356e21
+  metadata.gz: 240eae47a63fec982f10f381bf561b427ecbebb8b1ce744cdf364854b8660130c0d71491cb613e2f0f477a6bfab3b343593a1381ffbb826cccfa3533a09f6a8d
+  data.tar.gz: 7b54a60c3c822fd85c774220964d80f576f6749ddf8821d033dab35655ccc65804ade2e5679604bc24fe2c8bf449d9da05da05eb216eb4057739f9c626b99888

data/README.md

@@ -7,6 +7,15 @@ switch between database connections. We've made the implementation very small, a
 
 ActiveRecord Shards has been used and tested on Rails 3.2, 4.2 and 5.0 and has in some form or another been used in production on a large Rails app for several years.
 
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Migrations](#migrations)
+  - [Example](#example)
+    - [Shared Model](#create-a-table-for-the-shared-not-sharded-model)
+    - [Sharded Model](#create-a-table-for-the-sharded-model)
+- [Usage](#usage)
+- [Debugging](#debugging)
+
 ## Installation
 
     $ gem install active_record_shards
@@ -17,79 +26,133 @@ and make sure to require 'active\_record\_shards' in some way.
 
 Add the slave and shard configuration to config/database.yml:
 
-    production:
-      adapter: mysql
-      encoding: utf8
-      database: my_app_main
-      pool: 5
-      host: db1
-      username: root
-      password:
+```yaml
+production:
+  adapter: mysql
+  encoding: utf8
+  database: my_app_main
+  pool: 5
+  host: db1
+  username: root
+  password:
+  slave:
+    host: db1_slave
+  shards:
+    1:
+      host: db_shard1
+      database: my_app_shard
+      slave:
+        host: db_shard1_slave
+    2:
+      host: db_shard2
+      database: my_app_shard
       slave:
-        host: db1_slave
-      shards:
-        1:
-          host: db_shard1
-          database: my_app_shard
-          slave:
-            host: db_shard1_slave
-        2:
-          host: db_shard2
-          database: my_app_shard
-          slave:
-            host: db_shard2_slave
+        host: db_shard2_slave
+```
 
 basically connections inherit configuration from the parent configuration file.
 
+## Migrations
+
+ActiveRecord Shards also patches migrations to support running migrations on a shared (not sharded) or a sharded database.
+Each migration class has to specify a shard spec indicating where to run the migration.
+
+Valid shard specs:
+
+* `:none` - Run this migration on the shared database, not any shards
+* `:all` - Run this migration on all of the shards, not the shared database
+
+#### Example
+
+###### Create a table for the shared (not sharded) model
+
+```ruby
+class CreateAccounts < ActiveRecord::Migration
+  shard :none
+
+  def change
+    create_table :accounts do |t|
+      # This is NOT necessary for the gem to work, we just use it in the examples below demonstrating one way to switch shards
+      t.integer :shard_id, null: false
+
+      t.string :name
+    end
+  end
+end
+```
+
+###### Create a table for the sharded model
+
+```ruby
+class CreateProjects < ActiveRecord::Migration
+  shard :all
+
+  def change
+    create_table :projects do |t|
+      t.references :account
+      t.string :name
+    end
+  end
+end
+```
+
 ## Usage
 
 Normally you have some models that live on a shared database, and you might need to query this data in order to know what shard to switch to.
 All the models that live on the shared database must be marked as not\_sharded:
 
-    class Account < ActiveRecord::Base
-      not_sharded
+```ruby
+class Account < ActiveRecord::Base
+  not_sharded
 
-      has_many :projects
-    end
+  has_many :projects
+end
 
-    class Project < ActiveRecord::Base
-      belongs_to :account
-    end
+class Project < ActiveRecord::Base
+  belongs_to :account
+end
+```
 
 So in this setup the accounts live on the shared database, but the projects are sharded. If accounts have a shard\_id column, you could lookup the account
 in a rack middleware and switch to the right shard:
 
-    class AccountMiddleware
-      def initialize(app)
-        @app = app
-      end
+```ruby
+class AccountMiddleware
+  def initialize(app)
+    @app = app
+  end
 
-      def call(env)
-        account = lookup_account(env)
+  def call(env)
+    account = lookup_account(env)
 
-        if account
-          ActiveRecord::Base.on_shard(account.shard_id) do
-            @app.call(env)
-          end
-        else
-          @app.call(env)
-        end
-      end
-
-      def lookup_account(env)
-        ...
+    if account
+      ActiveRecord::Base.on_shard(account.shard_id) do
+        @app.call(env)
       end
+    else
+      @app.call(env)
     end
+  end
+
+  def lookup_account(env)
+    # ...
+  end
+end
+```
 
 You can switch to the slave databases at any point by wrapping your code in an on\_slave block:
 
-    ActiveRecord::Base.on_slave do
-      Account.find_by_big_expensive_query
-    end
+```ruby
+ActiveRecord::Base.on_slave do
+  Account.find_by_big_expensive_query
+end
+```
 
 This will perform the query on the slave, and mark the returned instances as read only. There is also a shortcut for this:
 
-    Account.on_slave.find_by_big_expensive_query
+```ruby
+Account.on_slave.find_by_big_expensive_query
+```
 
 ## Debugging
 

data/lib/active_record_shards/connection_switcher-4-0.rb

@@ -22,7 +22,7 @@ module ActiveRecordShards
       spec = configurations[name]
 
       if spec.nil?
-        raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.inspect})"
+        raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.keys.inspect})"
       end
 
       # in 3.2 rails is asking for a connection pool in a map of these ConnectionSpecifications.  If we want to re-use connections,

data/lib/active_record_shards/connection_switcher-5-0.rb

@@ -4,7 +4,7 @@ module ActiveRecordShards
       name = current_shard_selection.resolve_connection_name(sharded: is_sharded?, configurations: configurations)
 
       unless configurations[name] || name == "primary"
-        raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.inspect})"
+        raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.keys.inspect})"
       end
 
       name

data/lib/active_record_shards/connection_switcher-5-1.rb

@@ -4,7 +4,7 @@ module ActiveRecordShards
       name = current_shard_selection.resolve_connection_name(sharded: is_sharded?, configurations: configurations)
 
       unless configurations[name] || name == "primary"
-        raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.inspect})"
+        raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.keys.inspect})"
       end
 
       name

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_shards
 version: !ruby/object:Gem::Version
-  version: 3.11.3
+  version: 3.11.4
 platform: ruby
 authors:
 - Mick Staugaard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-27 00:00:00.000000000 Z
+date: 2018-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -229,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple database switching for ActiveRecord.