Elasticsearch Sequence Generator
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lovely
.gitignore
CHANGES.rst
MANIFEST.in
README.rst
bootstrap.py
buildout.cfg
crate.cfg
setup.py

README.rst

lovely.essequence: sequence generator

An integer id sequence generator using elasticsearch to create bulks of ids. Elasticsearch can not create integer ids for newly created documents. This package helps to be able to create unique integer ids in a distributed system.

Features

  • makes sure multiple processes are able to create unique ids
  • optimized by requesting multiple ids with a single Elasticsearch request

Elasticsearch Setup

Note

It is important to enable dynamic scripting in elasticsearch. Add this to your yaml configuration file:

script.disable_dynamic: false

The sequences must be assigned to an elasticsearch client instance:

>>> from elasticsearch import Elasticsearch
>>> es_client = Elasticsearch(['localhost:%s' % crate_port])

To globally assign the client to all sequences in the application the client can be assigned to the class property ES:

>>> from lovely.essequence import Sequence
>>> Sequence.ES = es_client

Usage

There is a Sequence class:

>>> from lovely.essequence import Sequence

It must be instantiated with the name of a sequence:

>>> s1 = Sequence('s1')

Now the iids can be requested:

>>> s1.next()
1
>>> s1.next()
2

Multiple sequence instances for the same sequence name use the same bulk:

>>> s2 = Sequence('s1', bulk_size=100)
>>> s2.next()
3

After the bulk size has been consumed the request of the next bulk is transparently handled inside the next method:: Consume all the cached ids from s1:

>>> for i in range(10): s1.next()
4
5
6
7
8
9
10
11
12
13

Multiple independed sequences can be used:

>>> other = Sequence('other')
>>> other.next()
1

Transforming the provided iid

A transformation function can be provided to transform the provided integer value into something else when calling next:

>>> asstring = Sequence('other', transform=str)
>>> isinstance(asstring.next(), str)
True

>>> def transformer(iid):
...     return {'iid': iid}
>>> Sequence('other', transform=transformer).next()
{'iid': 3}

Resetting a Sequence

For testing purposes it is possible to reset a sequence.

Note

Resetting a sequence will not work correct if multiple processes use the same sequence. This is for testing only.

>>> s1 = Sequence('reset')
>>> s2 = Sequence('reset')
>>> s1.next()
1
>>> s2.next()
2
>>> from lovely.essequence.sequence import testing_reset_sequences
>>> testing_reset_sequences()
>>> s2.next()
1
>>> s1.next()
2

License

The MIT License (MIT) Copyright (c) 2016, Lovely Systems GmbH

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.