pytuflow.TCF.rainfall_dbase

pytuflow.TCF.rainfall_dbase#

TCF.rainfall_dbase(context=None)#

Returns the RainfallDatabase database instance.

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

Parameters:

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

Returns:

The RainfallDatabase database instance.

Return type:

RainfallDatabase

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

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

Example

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