ORM Python Module

ORM for index server.

class pacifica.ingest.orm.BaseModel(*args, **kwargs)[source]

Auto-generated by pwiz.


alias of BaseModelDoesNotExist

class pacifica.ingest.orm.IngestState(*args, **kwargs)[source]

Map a python record to a mysql table.


alias of IngestStateDoesNotExist

classmethod atomic()[source]

Get the atomic context or decorator.

classmethod database_close()[source]

Close the database connection.

Closing already closed database is not a problem, so continue on.

classmethod database_connect()[source]

Make sure database is connected.

Trying to connect a second time does cause problems.

class pacifica.ingest.orm.IngestStateSystem(*args, **kwargs)[source]

Ingest State Schema Version Model.


alias of IngestStateSystemDoesNotExist

classmethod get_or_create_version()[source]

Set or create the current version of the schema.

classmethod get_version()[source]

Get the current version as a tuple.

classmethod is_equal()[source]

Check to see if schema version matches code version.

classmethod is_safe()[source]

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

class pacifica.ingest.orm.OrmSync[source]

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 orm_update class for the update between those versions.

Example Version Control:

class orm_update:
  versions = [
    (0, 1),
    (0, 2),
    (1, 0),
    (1, 1)

  def update_0_1_to_0_2():
  def update_0_2_to_1_0():

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


list of weak references to the object (if defined)

static dbconn_blocking()[source]

Wait for the db connection.

classmethod update_0_0_to_1_0()[source]

Update by adding the boolean column.

classmethod update_tables()[source]

Update the database to the current version.


Return the state of an ingest job as a json object.

pacifica.ingest.orm.update_state(job_id, state, task, task_percent, exception='')[source]

Update the state of an ingest job.