pytuflow.TCF.bc_dbase

Contents

pytuflow.TCF.bc_dbase#

TCF.bc_dbase(context=None)#

Returns the BCDatabase database instance.

If more than one BCDatabase database instance exists, a Context object must be provided to resolve to the correct BCDatabase.

Parameters:

context (Context, optional) – A context object to resolve the correct BCDatabase database instance. Not required unless more than one BCDatabase database instance exists.

Returns:

The BCDatabase database instance.

Return type:

BCDatabase

Raises:
  • KeyError – If the BCDatabase database is not found in the control file.

  • ValueError – If more than one BCDatabase database is found and no context is provided to resolve the correct, or if the context does not resolve into a single BCDatabase database.

Example

>>> tcf = ... # assuming is an instance of TCF
>>> bc_dbase = tcf.bc_dbase()