❭ API reference ❭ data_base ❭

data_base_register

Registry of databases.

The data base registry keeps a ledger linking data base IDs to data base paths. This is particularly useful to share databases, and moving databases to other file systems.

The registry should ideally be located in an obvious place. The default registry is .data_base_register.db in the data_base module itself. Newly created data_bases are automatically added to the registry. Accessing someone elses database is possible if:

  1. Its location is on the same filesystem and you have the absolute path. In this case, you can simply open the path and the db will register itself to your registry.

  2. You know the unique ID of the database. In this case, you can use data_base.get_db_by_unique_id().

  3. Someone else has registered the database in a registry that you have access to. In this case, you can use assimilate_remote_register().

See also

register_this_database()

Classes

DataBaseRegister

Two column registry mapping data bases to their locations.

Functions

register_db(unique_id, db_basedir)

Register a database.

deregister_db(unique_id)

Deregister a database.

assimilate_remote_register(remote_path, local_path)

Assimilate a remote register.