ORM Python Module

ORM for index server.

class pacifica.uniqueid.orm.OrmSync

Special module for syncing the orm.

This module should incorporate a schema migration strategy.

The supported versions migrating forward must be in a versions array containing tuples for major and minor versions.

The version tuples are directly translated to method names in the OrmSync class for the update between those versions.

Example Version Control:

class OrmSync:
    versions = [
        (0, 1),
        (0, 2),
        (1, 0),
        (1, 1)
    ]
    def update_0_1_to_0_2():
        pass
    def update_0_2_to_1_0():
        pass

The body of an update method should follow peewee migration practices. http://docs.peewee-orm.com/en/latest/peewee/playhouse.html#migrate

static dbconn_blocking()

Wait for the db connection.

classmethod update_0_0_to_1_0()

Update by adding the boolean column.

classmethod update_tables()

Update the database to the current version.

versions = [(0, 0), (1, 0)]

class pacifica.uniqueid.orm.UniqueIndex(*args, **kwargs)

Auto-generated by pwiz maps a python record to a mysql table.

DoesNotExist

alias of UniqueIndexDoesNotExist

_meta = <peewee.Metadata object>

_schema = <peewee.SchemaManager object>

classmethod atomic()

Get the atomic context or decorator.

classmethod database_close()

Close the database connection.

Closing already closed database throws an error so catch it and continue on.

classmethod database_connect()

Make sure database is connected.

Trying to connect a second time doesnt cause any problems.

idid = <CharField: UniqueIndex.idid>

index = <BigIntegerField: UniqueIndex.index>

class pacifica.uniqueid.orm.UniqueIndexBase(*args, **kwargs)

UniqueIndex base model for database setup.

DoesNotExist

alias of UniqueIndexBaseDoesNotExist

_meta = <peewee.Metadata object>

_schema = <peewee.SchemaManager object>

id = <AutoField: UniqueIndexBase.id>

class pacifica.uniqueid.orm.UniqueIndexSystem(*args, **kwargs)

UniqueIndex Schema Version Model.

DoesNotExist

alias of UniqueIndexSystemDoesNotExist

_meta = <peewee.Metadata object>

_schema = <peewee.SchemaManager object>

classmethod get_or_create_version()

Set or create the current version of the schema.

classmethod get_version()

Get the current version as a tuple.

classmethod is_equal()

Check to see if schema version matches code version.

classmethod is_safe()

Check to see if the schema version is safe for the code.

part = <CharField: UniqueIndexSystem.part>

value = <IntegerField: UniqueIndexSystem.value>

pacifica.uniqueid.orm.update_index(id_range, id_mode)

Update the index for a mode and returns a unique start and stop index.