Database and Connection#

featherstore.connection.connect(connection_string)#

Connects to a database.

Parameters

connection_string (str) – Path to the database directory

featherstore.connection.disconnect()#

Disconnects from the current database.

featherstore.connection.create_database(path, *, errors='raise', connect=True)#

Creates a new database.

Parameters
  • path (str) – Where to create the database.

  • errors (str, optional) – Whether or not to raise an error if the database directory already exist. Can be either raise or ignore, ignore tries to create a database in existing directory, by default raise

  • connect (bool) – Whether or not to connect to the created database, by default True

featherstore.connection.current_db()#

Fetches the active database.

Returns

The current database directory

Return type

str

featherstore.connection.is_connected()#

Checks if FeatherStore is connected to a database.

featherstore.connection.database_exists(path)#
class featherstore.connection.Connection(*args, **kwargs)#

Bases: object

classmethod disconnect()#
classmethod location()#
classmethod is_connected()#