activerecord-turntable 1.1.2 → 2.0.0.rc1

data/README.rdoc

@@ -1,294 +0,0 @@
-= ActiveRecord::Turntable {<img src="https://badge.fury.io/rb/activerecord-turntable.png" alt="Gem Version" />}[http://badge.fury.io/rb/activerecord-turntable] {<img src="https://secure.travis-ci.org/drecom/activerecord-turntable.png" />}[http://travis-ci.org/drecom/activerecord-turntable] {<img src="https://gemnasium.com/drecom/activerecord-turntable.png" alt="Dependency Status" />}[https://gemnasium.com/drecom/activerecord-turntable] {<img src="https://coveralls.io/repos/drecom/activerecord-turntable/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/drecom/activerecord-turntable]
-
-ActiveRecord::Turntable is a database sharding extension for ActiveRecord.
-
-== Dependencies
-activerecord(>=3.0.0)
-
-== Supported Database
-Currently supports mysql only.
-
-== Installation
-
-Add 'activerecord-turntable' to Gemfile:
-
-    gem 'activerecord-turntable', '~>1.1.0'
-
-Run a bundle install:
-
-    bundle install
-
-Run install generator:
-
-    bundle exec rails g active_record:turntable:install
-
-generator creates Rails.root/config/turntable.yml
-
-== ActiveRecord::Turntable terms
-
-* Shard
-* Cluster - a cluster of shards.
-* Master - default ActiveRecord::Base's connection
-* Sequencer - a module that creates global sequence number
-
-== Example
-
-=== Example Databases Structure
-one main database(default ActiveRecord::Base connection) and
-three user databases sharded by user_id.
-
-                         +-------+
-                         |  App  |
-                         +-------+
-                             |
-       +---------+-----------+---------+---------+
-       |         |           |         |         |
-  +--------+ +---------+ +-------+ +-------+ +-------+
-  | Master | |Sequencer| |UserDB1| |UserDB2| |UserDB3|
-  +--------+ +---------+ +-------+ +-------+ +-------+
-
-=== Example Configuration
-
-Edit turntable.yml and database.yml. See below example config.
-
-example turntable.yml:
-
-    development:
-      clusters:
-        user_cluster: # <-- cluster name
-          algorithm: range # <-- only range or range_bsearch sharding is supported currently.
-          seq:
-            connection: user_seq_1
-          shards:
-            - connection: user_shard_1 # <-- shard name
-              less_than: 100           # <-- shard range(like mysql partitioning)
-            - connection: user_shard_2
-              less_than: 200
-            - connection: user_shard_3
-              less_than: 2000000000
-
-database.yml:
-    connection_spec: &spec
-      adapter: mysql2
-      encoding: utf8
-      reconnect: false
-      pool: 5
-      username: root
-      password: root
-      socket: /tmp/mysql.sock
-
-    development:
-      <<: *spec
-      database: sample_app_development
-      seq: # <-- sequence definition
-        user_seq_1:
-          <<: *spec
-          database: sample_app_user_seq_development
-      shards: # <-- shards definition
-        user_shard_1:
-          <<: *spec
-          database: sample_app_user1_development
-        user_shard_2:
-          <<: *spec
-          database: sample_app_user2_development
-        user_shard_3:
-          <<: *spec
-          database: sample_app_user3_development
-
-
-=== Migration Example
-
-Generate a model:
-
-  bundle exec rails g model user name:string
-
-Edit migration file:
-
-  class CreateUsers < ActiveRecord::Migration
-    clusters :user_cluster # <-- the cluster that executes migration
-
-    def change
-      create_table :users do |t|
-        t.string :name
-        t.timestamps
-      end
-      create_sequence_for(:users)
-    end
-  end
-
-then please execute rake tasks:
-
-  bundle exec rake db:create
-  bundle exec rake db:migrate
-
-Those rake tasks would be executed to shards too.
-
-=== Model Example
-add turntable [shard_key_name] to the model class:
-
-  class User < ActiveRecord::Base
-    turntable :user_cluster, :id
-    sequencer
-    has_one :status
-  end
-
-  class Status < ActiveRecord::Base
-    turntable :user_cluster, :user_id
-    sequencer
-    belongs_to :user
-  end
-
-== Usage
-
-=== Create
-    > User.create(name: "hoge")
-      (0.0ms) [Shard: user_seq_1] BEGIN
-      (0.3ms) [Shard: user_seq_1] UPDATE `users_id_seq` SET id=LAST_INSERT_ID(id+1)
-      (0.8ms) [Shard: user_seq_1] COMMIT
-      (0.1ms) [Shard: user_seq_1] SELECT LAST_INSERT_ID()
-      (0.1ms) [Shard: user_shard_1] BEGIN
-    [ActiveRecord::Turntable] Sending method: insert, sql: #<Arel::InsertManager:0x007f8503685b48>, shards: ["user_shard_1"]
-      SQL (0.8ms) [Shard: user_shard_1] INSERT INTO `users` (`created_at`, `id`, `name`, `updated_at`) VALUES ('2012-04-10 03:59:42', 2, 'hoge', '2012-04-10 03:59:42')
-      (0.4ms) [Shard: user_shard_1] COMMIT
-    => #<User id: 2, name: "hoge", created_at: "2012-04-10 03:59:42", updated_at: "2012-04-10 03:59:42">
-
-=== Retrieve
-    > user = User.find(2)
-    [ActiveRecord::Turntable] Sending method: select_all, sql: #<Arel::SelectManager:0x007f850466e668>, shards: ["user_shard_1"]
-      User Load (0.3ms) [Shard: user_shard_1] SELECT `users`.* FROM `users` WHERE `users`.`id` = 2 LIMIT 1
-    => #<User id: 2, name: "hoge", created_at: "2012-04-10 03:59:42", updated_at: "2012-04-10 03:59:42">
-
-=== Update
-    > user.update_attributes(name: "hogefoo")
-      (0.1ms) [Shard: user_shard_1] BEGIN
-    [ActiveRecord::Turntable] Sending method: update, sql: UPDATE `users` SET `name` = 'hogefoo', `updated_at` = '2012-04-10 04:07:52' WHERE `users`.`id` = 2, shards: ["user_shard_1"]
-      (0.3ms) [Shard: user_shard_1] UPDATE `users` SET `name` = 'hogefoo', `updated_at` = '2012-04-10 04:07:52' WHERE `users`.`id` = 2
-      (0.8ms) [Shard: user_shard_1] COMMIT
-    => true
-
-=== Delete
-    > user.destroy
-      (0.2ms) [Shard: user_shard_1] BEGIN
-    [ActiveRecord::Turntable] Sending method: delete, sql: #<Arel::DeleteManager:0x007f8503677ea8>, shards: ["user_shard_1"]
-      SQL (0.3ms) [Shard: user_shard_1] DELETE FROM `users` WHERE `users`.`id` = 2
-      (1.7ms) [Shard: user_shard_1] COMMIT
-    => #<User id: 2, name: "hogefoo", created_at: "2012-04-10 03:59:42", updated_at: "2012-04-10 04:07:52">
-
-=== Count
-
-    > User.count
-    [ActiveRecord::Turntable] Sending method: select_value, sql: #<Arel::SelectManager:0x007f9e82ccebb0>, shards: ["user_shard_1", "user_shard_2", "user_shard_3"]
-       (0.8ms) [Shard: user_shard_1] SELECT COUNT(*) FROM `users`
-       (0.3ms) [Shard: user_shard_2] SELECT COUNT(*) FROM `users`
-       (0.2ms) [Shard: user_shard_3] SELECT COUNT(*) FROM `users`
-    => 1
-
-=== Sequencer
-Sequencer provides generating global IDs.
-
-Add below to the migration:
-
-      create_sequence_for(:users) # <-- this line creates sequence table
-
-This will creates sequence table.
-
-Next, add sequencer to the model:
-
-  class User < ActiveRecord::Base
-    turntable :id
-    sequencer # <-- this line enables sequencer module
-    has_one :status
-  end
-
-
-=== Transaction
-    > user = User.find(2)
-    > user3 = User.create(name: "hoge3")
-    > User.shards_transaction([user, user3]) do
-    >   user.name  = "hogehoge"
-    >   user3.name = "hogehoge3"
-    >   user.save!
-    >   user3.save!
-    > end
-
-=== Send query to a specific shard.
-use with_shard method:
-
-    AR::Base.connection.with_shard(shard1) do
-      # something queries to shard1
-    end
-
-To access shard objects, use below:
-* AR::Base.connection.shards # \\{shard_name => shard_obj,....}
-* AR::Base#turntable_shard
-* AR::Base.connection.select_shard(shard_key_value) #=> shard
-
-=== Send query to all shards
-use with_all method:
-
-  User.connection.with_all do
-    User.order("created_at DESC").limit(3).all
-  end
-
-
-=== Migration
-If you specify cluster or shard, migration will be executed to the cluster(or shard) and master database.
-
-to specify cluster:
-
-    class CreateUsers < ActiveRecord::Migration
-      clusters :user_cluster
-      ....
-    end
-
-to specify shard:
-
-    class CreateUsers < ActiveRecord::Migration
-      shards :user_shard_01
-      ....
-    end
-
-if you would like to execute a migration to all databases in the environments, use :all symbol:
-
-    class CreateUsers < ActiveRecord::Migration
-      clusters :all
-      ....
-    end
-
-== Connection Management
-Rails's ConnectionManagement middleware keeps ActiveRecord's connection during the process is alive, but Turntable keeps more connections.
-This may cause flooding max connections on your database. So, we made a middleware that disconnects on each request.
-To use turntable's ConnectionManagement middleware, add below line to your initializer.
-
-      app.middleware.swap ActiveRecord::ConnectionAdapters::ConnectionManagement, ActiveRecord::Turntable::Rack::ConnectionManagement
-
-== Inability
-* Queries includes "ORDER BY", "GROUP BY" and "LIMIT" clauses cannot be distributed.
-* "has many through" and "habtm" relationships causes wrong results. ex) User-Friend-User relation
-
-== Thanks to
-ConnectionProxy, Distributed Migration implementation is inspired by Octopus and DataFabric.
-
-== License
-activerecord-turntable is released under the MIT license:
-
-Copyright (c) 2012 Drecom Co.,Ltd.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/gemfiles/rails3_0.gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gem 'activerecord', "~> 3.0.0"
-gem 'activesupport', "~> 3.0.0"
-gem 'mysql2', "< 0.3"
-
-gemspec :path => '../'

data/gemfiles/rails3_1.gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-gem 'activerecord', "~> 3.1.0"
-gem 'activesupport', "~> 3.1.0"
-
-gemspec :path => '../'

data/gemfiles/rails3_2.gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-gem 'activerecord', "~> 3.2.0"
-gem 'activesupport', "~> 3.2.0"
-
-gemspec :path => '../'

data/lib/active_record/turntable/compatible.rb

@@ -1,19 +0,0 @@
-#
-#=ActiveRecord::Turntable::Compatible
-#
-# for ActiveRecord versions compatibility
-#
-module ActiveRecord::Turntable
-  module Compatible
-    extend ActiveSupport::Concern
-
-    included do
-      # class_attributes
-      unless respond_to?(:class_attribute)
-        class << self
-          alias_method :class_attribute, :class_inheritable_accessor
-        end
-      end
-    end
-  end
-end

data/sample_app/.gitignore

@@ -1,16 +0,0 @@
-# See http://help.github.com/ignore-files/ for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-#   git config --global core.excludesfile ~/.gitignore_global
-
-# Ignore bundler config
-/.bundle
-
-# Ignore the default SQLite database.
-/db/*.sqlite3
-/db/schema*
-
-# Ignore all logfiles and tempfiles.
-/log/*.log
-/tmp

data/sample_app/Gemfile

@@ -1,41 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'rails', '3.2.2'
-
-# Bundle edge Rails instead:
-# gem 'rails', :git => 'git://github.com/rails/rails.git'
-
-gem 'mysql2'
-
-gem 'activerecord-turntable', '1.0.0'
-
-
-# Gems used only for assets and not required
-# in production environments by default.
-group :assets do
-  gem 'sass-rails',   '~> 3.2.3'
-  gem 'coffee-rails', '~> 3.2.1'
-
-  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
-  # gem 'therubyracer'
-
-  gem 'uglifier', '>= 1.0.3'
-end
-
-gem 'jquery-rails'
-gem 'pry-rails'
-
-# To use ActiveModel has_secure_password
-# gem 'bcrypt-ruby', '~> 3.0.0'
-
-# To use Jbuilder templates for JSON
-# gem 'jbuilder'
-
-# Use unicorn as the app server
-# gem 'unicorn'
-
-# Deploy with Capistrano
-# gem 'capistrano'
-
-# To use debugger
-# gem 'ruby-debug19', :require => 'ruby-debug'

data/sample_app/README.rdoc

@@ -1,261 +0,0 @@
-== Welcome to Rails
-
-Rails is a web-application framework that includes everything needed to create
-database-backed web applications according to the Model-View-Control pattern.
-
-This pattern splits the view (also called the presentation) into "dumb"
-templates that are primarily responsible for inserting pre-built data in between
-HTML tags. The model contains the "smart" domain objects (such as Account,
-Product, Person, Post) that holds all the business logic and knows how to
-persist themselves to a database. The controller handles the incoming requests
-(such as Save New Account, Update Product, Show Post) by manipulating the model
-and directing data to the view.
-
-In Rails, the model is handled by what's called an object-relational mapping
-layer entitled Active Record. This layer allows you to present the data from
-database rows as objects and embellish these data objects with business logic
-methods. You can read more about Active Record in
-link:files/vendor/rails/activerecord/README.html.
-
-The controller and view are handled by the Action Pack, which handles both
-layers by its two parts: Action View and Action Controller. These two layers
-are bundled in a single package due to their heavy interdependence. This is
-unlike the relationship between the Active Record and Action Pack that is much
-more separate. Each of these packages can be used independently outside of
-Rails. You can read more about Action Pack in
-link:files/vendor/rails/actionpack/README.html.
-
-
-== Getting Started
-
-1. At the command prompt, create a new Rails application:
-       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
-
-2. Change directory to <tt>myapp</tt> and start the web server:
-       <tt>cd myapp; rails server</tt> (run with --help for options)
-
-3. Go to http://localhost:3000/ and you'll see:
-       "Welcome aboard: You're riding Ruby on Rails!"
-
-4. Follow the guidelines to start developing your application. You can find
-the following resources handy:
-
-* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
-* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
-
-
-== Debugging Rails
-
-Sometimes your application goes wrong. Fortunately there are a lot of tools that
-will help you debug it and get it back on the rails.
-
-First area to check is the application log files. Have "tail -f" commands
-running on the server.log and development.log. Rails will automatically display
-debugging and runtime information to these files. Debugging info will also be
-shown in the browser on requests from 127.0.0.1.
-
-You can also log your own messages directly into the log file from your code
-using the Ruby logger class from inside your controllers. Example:
-
-  class WeblogController < ActionController::Base
-    def destroy
-      @weblog = Weblog.find(params[:id])
-      @weblog.destroy
-      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
-    end
-  end
-
-The result will be a message in your log file along the lines of:
-
-  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
-
-More information on how to use the logger is at http://www.ruby-doc.org/core/
-
-Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
-several books available online as well:
-
-* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
-* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
-
-These two books will bring you up to speed on the Ruby language and also on
-programming in general.
-
-
-== Debugger
-
-Debugger support is available through the debugger command when you start your
-Mongrel or WEBrick server with --debugger. This means that you can break out of
-execution at any point in the code, investigate and change the model, and then,
-resume execution! You need to install ruby-debug to run the server in debugging
-mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
-
-  class WeblogController < ActionController::Base
-    def index
-      @posts = Post.all
-      debugger
-    end
-  end
-
-So the controller will accept the action, run the first line, then present you
-with a IRB prompt in the server window. Here you can do things like:
-
-  >> @posts.inspect
-  => "[#<Post:0x14a6be8
-          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
-       #<Post:0x14a6620
-          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
-  >> @posts.first.title = "hello from a debugger"
-  => "hello from a debugger"
-
-...and even better, you can examine how your runtime objects actually work:
-
-  >> f = @posts.first
-  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
-  >> f.
-  Display all 152 possibilities? (y or n)
-
-Finally, when you're ready to resume execution, you can enter "cont".
-
-
-== Console
-
-The console is a Ruby shell, which allows you to interact with your
-application's domain model. Here you'll have all parts of the application
-configured, just like it is when the application is running. You can inspect
-domain models, change values, and save to the database. Starting the script
-without arguments will launch it in the development environment.
-
-To start the console, run <tt>rails console</tt> from the application
-directory.
-
-Options:
-
-* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
-  made to the database.
-* Passing an environment name as an argument will load the corresponding
-  environment. Example: <tt>rails console production</tt>.
-
-To reload your controllers and models after launching the console run
-<tt>reload!</tt>
-
-More information about irb can be found at:
-link:http://www.rubycentral.org/pickaxe/irb.html
-
-
-== dbconsole
-
-You can go to the command line of your database directly through <tt>rails
-dbconsole</tt>. You would be connected to the database with the credentials
-defined in database.yml. Starting the script without arguments will connect you
-to the development database. Passing an argument will connect you to a different
-database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
-PostgreSQL and SQLite 3.
-
-== Description of Contents
-
-The default directory structure of a generated Ruby on Rails application:
-
-  |-- app
-  |   |-- assets
-  |       |-- images
-  |       |-- javascripts
-  |       `-- stylesheets
-  |   |-- controllers
-  |   |-- helpers
-  |   |-- mailers
-  |   |-- models
-  |   `-- views
-  |       `-- layouts
-  |-- config
-  |   |-- environments
-  |   |-- initializers
-  |   `-- locales
-  |-- db
-  |-- doc
-  |-- lib
-  |   `-- tasks
-  |-- log
-  |-- public
-  |-- script
-  |-- test
-  |   |-- fixtures
-  |   |-- functional
-  |   |-- integration
-  |   |-- performance
-  |   `-- unit
-  |-- tmp
-  |   |-- cache
-  |   |-- pids
-  |   |-- sessions
-  |   `-- sockets
-  `-- vendor
-      |-- assets
-          `-- stylesheets
-      `-- plugins
-
-app
-  Holds all the code that's specific to this particular application.
-
-app/assets
-  Contains subdirectories for images, stylesheets, and JavaScript files.
-
-app/controllers
-  Holds controllers that should be named like weblogs_controller.rb for
-  automated URL mapping. All controllers should descend from
-  ApplicationController which itself descends from ActionController::Base.
-
-app/models
-  Holds models that should be named like post.rb. Models descend from
-  ActiveRecord::Base by default.
-
-app/views
-  Holds the template files for the view that should be named like
-  weblogs/index.html.erb for the WeblogsController#index action. All views use
-  eRuby syntax by default.
-
-app/views/layouts
-  Holds the template files for layouts to be used with views. This models the
-  common header/footer method of wrapping views. In your views, define a layout
-  using the <tt>layout :default</tt> and create a file named default.html.erb.
-  Inside default.html.erb, call <% yield %> to render the view using this
-  layout.
-
-app/helpers
-  Holds view helpers that should be named like weblogs_helper.rb. These are
-  generated for you automatically when using generators for controllers.
-  Helpers can be used to wrap functionality for your views into methods.
-
-config
-  Configuration files for the Rails environment, the routing map, the database,
-  and other dependencies.
-
-db
-  Contains the database schema in schema.rb. db/migrate contains all the
-  sequence of Migrations for your schema.
-
-doc
-  This directory is where your application documentation will be stored when
-  generated using <tt>rake doc:app</tt>
-
-lib
-  Application specific libraries. Basically, any kind of custom code that
-  doesn't belong under controllers, models, or helpers. This directory is in
-  the load path.
-
-public
-  The directory available for the web server. Also contains the dispatchers and the
-  default HTML files. This should be set as the DOCUMENT_ROOT of your web
-  server.
-
-script
-  Helper scripts for automation and generation.
-
-test
-  Unit and functional tests along with fixtures. When using the rails generate
-  command, template test files will be generated for you and placed in this
-  directory.
-
-vendor
-  External libraries that the application depends on. Also includes the plugins
-  subdirectory. If the app has frozen rails, those gems also go here, under
-  vendor/rails/. This directory is in the load path.

data/sample_app/Rakefile

@@ -1,7 +0,0 @@
-#!/usr/bin/env rake
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('../config/application', __FILE__)
-
-SampleApp::Application.load_tasks

data/sample_app/app/assets/javascripts/application.js

@@ -1,15 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// the compiled file.
-//
-// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
-// GO AFTER THE REQUIRES BELOW.
-//
-//= require jquery
-//= require jquery_ujs
-//= require_tree .