### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »

# parallel.controller.sqlitedb

## Module: `parallel.controller.sqlitedb`

Inheritance diagram for `IPython.parallel.controller.sqlitedb`:

A TaskRecord backend using sqlite3

Authors:

- Min RK

## `SQLiteDB`

class `IPython.parallel.controller.sqlitedb.``SQLiteDB`(**kwargs)

  Bases: `IPython.parallel.controller.dictdb.BaseDB`

  SQLite3 TaskRecord backend.

  `__init__`(**kwargs)
  `add_record`(msg_id, rec)

    Add a new Task Record, by msg_id.

  classmethod `class_config_section`()

    Get the config class config section

  classmethod `class_get_help`()

    Get the help string for this class in ReST format.

  classmethod `class_get_trait_help`(trait)

    Get the help string for a single trait.

  classmethod `class_print_help`()

    Get the help string for a single trait and print it.

  classmethod `class_trait_names`(**metadata)

    Get a list of all the names of this classes traits.

    This method is just like the `trait_names()` method, but is unbound.

  classmethod `class_traits`(**metadata)

    Get a list of all the traits of this class.

    This method is just like the `traits()` method, but is unbound.

    The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

    This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

  `config`

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

  `created` = None
  `drop_matching_records`(check)

    Remove a record from the DB.

  `drop_record`(msg_id)

    Remove a record from the DB.

  `filename`

    A trait for unicode strings.

  `find_records`(check, keys=None)

    Find records matching a query dict, optionally extracting subset of keys.

    Returns list of matching records.

    Parameters :

    check: dict :

    > mongodb-style query argument

    keys: list of strs [optional] :

    > if specified, the subset of keys to extract. msg_id will always be included.

  `get_history`()

    get all msg_ids, ordered by time submitted.

  `get_record`(msg_id)

    Get a specific Task Record, by msg_id.

  `location`

    A trait for unicode strings.

  `log`

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

  `on_trait_change`(handler, name=None, remove=False)

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

    Parameters :

    handler : callable

    > A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

    name : list, str, None

    > If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    remove : bool

    > If False (the default), then install the handler. If True then unintall it.

  `session`

    A trait for unicode strings.

  `table`

    A trait for unicode strings.

  `trait_metadata`(traitname, key)

    Get metadata values for trait by key.

  `trait_names`(**metadata)

    Get a list of all the names of this classes traits.

  `traits`(**metadata)

    Get a list of all the traits of this class.

    The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

    This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

  `update_record`(msg_id, rec)

    Update the data in an existing record.

### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »