Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noma4i/ar_shard
ActiveRecord Model Sharding
https://github.com/noma4i/ar_shard
activerecord multibase shards
Last synced: 3 days ago
JSON representation
ActiveRecord Model Sharding
- Host: GitHub
- URL: https://github.com/noma4i/ar_shard
- Owner: noma4i
- License: mit
- Created: 2020-08-15T03:12:16.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-18T02:26:03.000Z (about 4 years ago)
- Last Synced: 2024-05-08T22:15:26.768Z (6 months ago)
- Topics: activerecord, multibase, shards
- Language: Ruby
- Homepage:
- Size: 21.5 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# AR Shard
[](https://badge.fury.io/rb/ar_shard)
[](https://travis-ci.com/noma4i/ar_shard)
AR Shard is non-intrusive extenstion for ActiveRecord to add threadsafe Model based sharding or just multidatabase connection. As this gem uses connection_handlers it can work only with ActiveRecord version 5 and above.
## Features
- Multiple Databases support for Rails5
- Define config as a Proc
- Shard only part of you ActiveRecord w/o sharing connection
- Work with you Sharded Model and AR model at the same time
- Threadsafe. Battle-tested with Sidekiq and 4 mixed Databases
## Limitations
- Doesn't care about migrations
- Due to nature of connection_handlers all DB connections are established at boot time
- if data structure is different between databases you should use `ModelName.reset_column_information`
## Installation
Add this line to your application’s Gemfile:
```ruby
gem 'ar_shard', '~> 1.0'
```
## Usage
Define your separate AR like:
```ruby
class ShardRecord < ActiveRecord::Base
self.abstract_class = true
connected_shards shards: [
{ shard_1: { adapter: 'sqlite3', database: 'shard_1' } },
{ shard_2: { adapter: 'postgresql', database: 'shard_2' } },
{ shard_3: { adapter: 'sqlite3', database: 'shard_3' } }
]
end
```
or with Proc
```ruby
class ShardRecord < ActiveRecord::Base
self.abstract_class = true
connected_shards shards: -> { YAML.load_file('path/to/config/shards.yml') }
end
```
Where `shards.yml` is like:
```yaml
- shard_1:
adapter: mysql2
host: blabla
username: blabla
password: secret
database: remote_database_name
port: 3306
pool: 10
- shard_2:
adapter: postgresql
host: blabla
username: blabla
password: secret
database: shard_name
port: 5432
pool: 10
```
given we have models like:
```ruby
class User < ActiveRecord::Base
end
class Sharded::User < ShardRecord
end
```
AR Shard is isolating and rotating connections. Same like Rails Multibase support but without overlap.
Now we can do crazy things like:
```ruby
# Connecting to another DB
ShardRecord.with_shard(:shard_name) do
Sharded::User.find_each do |user|
# Working with our DB and another at the same time!
u = User.find_by(email: user.email)
u.update(name: user.name)
end
end
```
## Contributing
- [Report bugs](https://github.com/noma4i/ar_shard/issues)
- Fix bugs and [submit pull requests](https://github.com/noma4i/ar_shard/pulls)
To get started with development:
```sh
git clone https://github.com/noma4i/ar_shard.git
cd ar_shard
bundle install
bundle exec appraisal rake test
```
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).