sequel-schema-sharding 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a08abc2196b89b64cf69423f27b9b13b9383ddd1
-  data.tar.gz: 2b0fa4a892a5999c43554d88a384bc7a5e52aa82
+  metadata.gz: 9643f5ed78031832422c6535ae8fc932ecc2f94a
+  data.tar.gz: 1239e9c62b491cd34f05a5968ce290e1a254e0b8
 SHA512:
-  metadata.gz: 8a7429f701f5e2dd8f5ef8cb228696936c8f74ea61abf4e0735a0afacf2c8d177c2152b005f3bd1905c3030462a6cd6842f643bd7f08d759f8e7de101de1f381
-  data.tar.gz: a675c35851fb577cca32a4dc772f64a0134c4f2529f6afa1f9c5e3930a7a100085d04bf4aedd53f8c0fe5ab99b9a9f6891c446806834a69bddef0bed564b2909
+  metadata.gz: 6fb807e5d933e40ff9eaf95cbb5b91ead02b886783a3dcadc8a92b44b63560a30686ccb8597ee51ed7028a29d9a394d6310a517b0ae857b1b186f8e3353c0889
+  data.tar.gz: 48451f4bc2e91416321ad45c41e48042972d8e2b10bb220bfee337afbdeded0425fe2405b2dc92b404ee60c30438f3e7507f463bf10950a8eebfd3e617aaa062

data/README.md

@@ -188,6 +188,15 @@ return a dataset that is scoped to the current instance in the database,
 so that Sequel can update/delete/etc the record when you call methods on
 the instance that persist, ie `:destroy`, `:save`.
 
+## Read/write splitting
+
+When using this in conjunction with multiple replicas, you should call `read_only_shard_for`
+instead of `shard_for` when running a select query. This will ensure that anything that needs
+a valid connection while the query is being built will go to a `:read_only` server.
+
+This can be helpful when combined with server failover logic, to ensure that read
+queries do not try to reconnect to a downed master.
+
 ## Running tests
 
 ```bash

data/lib/sequel/schema-sharding/model.rb

@@ -56,6 +56,10 @@ module Sequel
           ds
         end
 
+        def read_only_shard_for(id)
+          shard_for(id).server(:read_only)
+        end
+
         # The result of a lookup for the given id. See Sequel::SchemaSharding::Finder::Result
         def result_for(id)
           Sequel::SchemaSharding::Finder.instance.lookup(self.implicit_table_name, id)

data/lib/sequel/schema-sharding/version.rb

@@ -1,5 +1,5 @@
 module Sequel
   module SchemaSharding
-    VERSION = "0.8.0"
+    VERSION = "0.9.0"
   end
 end

data/spec/schema-sharding/model_spec.rb

@@ -47,4 +47,34 @@ describe Sequel::SchemaSharding, 'Model' do
     end
   end
 
+  describe '#shard_for' do
+    let(:dataset) { model.shard_for(2356) }
+
+    it 'returns a dataset' do
+      expect(dataset).to be_a(Sequel::Dataset)
+    end
+
+    it 'connects to the shard for the given id' do
+      expect(dataset.db.opts[:database]).to eq('sequel_test_shard2')
+      expect(dataset.first_source).to eq(:sequel_logical_artists_17__artists)
+    end
+  end
+
+  describe '#read_only_shard_for' do
+    let(:dataset) { model.read_only_shard_for(2356) }
+
+    it 'returns a dataset' do
+      expect(dataset).to be_a(Sequel::Dataset)
+    end
+
+    it 'connects to the shard for the given id' do
+      expect(dataset.db.opts[:database]).to eq('sequel_test_shard2')
+      expect(dataset.first_source).to eq(:sequel_logical_artists_17__artists)
+    end
+
+    it 'is read_only' do
+      expect(dataset.opts[:server]).to eq(:read_only)
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-schema-sharding
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Paul Henry