Mongoid::AutoIncrement
Add SQL like auto-incrementing fields to your Mongoid documents. This gem is inspired by http://ihswebdesign.com/blog/autoincrement-in-mongodb-with-ruby/ and the mongomapper_id2 gem.
Installation
Add to Gemfile:
gem 'mongoid_auto_increment'
Getting Started
Just add auto_increment :field
to your Mongoid model where :field
is the
name of the auto-incremented field you want to create. Example:
class Book
include Mongoid::Document
field :title
field :author
auto_increment :sequence
end
auto_increment :sequence
will create a field of type Integer
named
sequence
for Book
. Whenever an instance of the model is created (intially
saved to mongoDB), the auto_increment
field will automatically be set to the
next number in the sequence.
You can add more than one auto-incremented field per model.
Options
auto_increment :sequence, collection: :some_collection
mongoid_auto_inc
keeps track of the current number in the sequence by
creating a separate document mongoDB to query and update. By default
auto_increment
will save this document to a mongoDB collection called
sequences
. If you wish to save to a different collection use the
:collection
option to specify its name.
auto_increment :sequence, step: 5
If desired, you can override the :step
, or increment amount (default is 1).
auto_increment :sequence, seed: 3333
Use the :seed
option to set the initial value of the auto-incremented field.
The first number assigned from the sequence will be the next number after the
seed value (including the step - so for seed: 1000, step: 5
, first value
will be 1005).
auto_increment :sequence, scope: :some_field_or_relation
auto_increment :sequence, scope: [ :some_field_or_relation, :another_field_or_relation ]
Use the :scope
option to scope an auto-incremented field to a query.
Similar to Mongoid, the scope may contain one or many fields or relations.
Each unique scope will result in it's own stream of incremented values.
Contributing to Mongoid::AutoIncrement
- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
- Fork the project
- Start a feature/bugfix branch
- Commit and push until you are happy with your contribution
- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
Support us
https://www.patreon.com/_proton
Copyright
(c) 2011-2023 Peter Savichev (proton) (c) 2010-2011 Jeff Smith
See LICENSE.txt for further details.