Database Manipulation¶

beacon.get_db_info()¶

Gets statistics about the database.

Returns:	basic database information

Creating Items¶

FIXME: Add description

beacon.add_item(url, type, parent, **kwargs)¶: Add an item to the database. This function can be used to add an Item as subitem to another. You can not add files that do not exist to a directory, but it is possible to add an Item with a http url to a directory or a meta item with http items as children.

FIXME: Describe the basic usage how the db works here.

beacon.register_inverted_index(name, min=None, max=None, split=None, ignore=None)¶: Registers a new inverted index with the database. An inverted index maps arbitrary terms to objects and allows you to query based on one or more terms. If the inverted index already exists with the given parameters, no action is performed. See kaa.db for details.

beacon.register_file_type_attrs(type_name, indexes=[], **attrs)¶: Registers one or more object attributes and/or multi-column indexes for the given type name. This function modifies the database as needed to accommodate new indexes and attributes, either by creating the object’s tables (in the case of a new object type) or by altering the object’s tables to add new columns or indexes.

beacon.register_track_type_attrs(type_name, indexes=[], **attrs)¶: Register new attrs and types for tracks. See L{register_file_type_attrs} for details. The only difference between this two functions is that this adds track_ to the type name.

class beacon.QExpr(operator, operand)¶: Flexible query expressions for use with Database.query()