Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/huacnlee/mongoid_auto_increment_id
Override id field to MySQL like auto increment for Mongoid.
https://github.com/huacnlee/mongoid_auto_increment_id
auto-increment mongodb mongoid mongoid-plugin
Last synced: 12 days ago
JSON representation
Override id field to MySQL like auto increment for Mongoid.
- Host: GitHub
- URL: https://github.com/huacnlee/mongoid_auto_increment_id
- Owner: huacnlee
- License: mit
- Created: 2011-09-16T08:51:11.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2020-12-15T02:45:05.000Z (almost 4 years ago)
- Last Synced: 2024-10-04T11:54:59.100Z (about 1 month ago)
- Topics: auto-increment, mongodb, mongoid, mongoid-plugin
- Language: Ruby
- Homepage:
- Size: 62.5 KB
- Stars: 65
- Watchers: 5
- Forks: 18
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
This gem for change Mongoid id field as Integer like MySQL.
Idea from MongoDB document: [How to Make an Auto Incrementing Field](http://www.mongodb.org/display/DOCS/How+to+Make+an+Auto+Incrementing+Field)
> NOTE!
> This Gem has helped [Ruby China](https://ruby-china.org) in pass 4 years，and produce over million rows, it's work very will.
> In now, Ruby China ([Homeland](https://github.com/ruby-china/homeland)) has changed to ActiveRecord to use PostgreSQL as Database, so may be I don't have time keep this gem compatible with new versions of Mongoid.
> But even that, I am be sure that this gem still working for Mongoid 5.0 and lower version.
## Status
- [](https://rubygems.org/gems/mongoid_auto_increment_id)
- [](http://travis-ci.org/huacnlee/mongoid_auto_increment_id)
## Installation
```ruby
# Mongoid 3.0.x
gem 'mongoid_auto_increment_id', "0.6.1"
# Mongoid 3.1.x
gem 'mongoid_auto_increment_id', "0.6.2"
# Mongoid 4.x
gem 'mongoid_auto_increment_id', "0.7.0"
# Mongoid 5.x
gem 'mongoid_auto_increment_id', "0.8.1"
```
## Configure
If you want use sequence cache to reduce MongoDB write, you can enable cache:
config/initializes/mongoid_auto_increment_id.rb
```ruby
# Mongoid::AutoIncrementId.cache_store = ActiveSupport::Cache::MemoryStore.new
# First call will generate 200 ids and caching in cache_store
# Then the next 199 ids will return from cache_store
# Until 200 ids used, it will generate next 200 ids again.
Mongoid::AutoIncrementId.seq_cache_size = 200
```
> NOTE: mongoid_auto_increment_id is very fast in default config, you may don't need enable that, if you project not need insert huge rows in a moment.
## USAGE
```ruby
ruby > post = Post.new(:title => "Hello world")
=> #
ruby > post.save
=> true
ruby > post.inspect
=> "#"
ruby > Post.find("6")
=> "#"
ruby > Post.find(6)
=> "#"
ruby > Post.desc(:_id).all.to_a.collect { |row| row.id }
=> [20,19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1]
```
## Performance
This is a branchmark results run in MacBook Pro Retina.
with `mongoid_auto_increment_id`:
```
user system total real
Generate 1 0.000000 0.000000 0.000000 ( 0.004301)
Post current: 1
Generate 100 0.070000 0.000000 0.070000 ( 0.091638)
Post current: 101
Generate 10,000 7.300000 0.570000 7.870000 ( 9.962469)
Post current: 10101
```
without:
```
user system total real
Generate 1 0.000000 0.000000 0.000000 ( 0.002569)
Post current: 1
Generate 100 0.050000 0.000000 0.050000 ( 0.052045)
Post current: 101
Generate 10,000 5.220000 0.170000 5.390000 ( 5.389207)
Post current: 10101
```