clockworkdb.tsdb
================

.. py:module:: clockworkdb.tsdb


Classes
-------

.. autoapisummary::

   clockworkdb.tsdb.RepositoryMetaDataList
   clockworkdb.tsdb.RepositoryMetaData
   clockworkdb.tsdb.DatastoreMetaDataList
   clockworkdb.tsdb.DatastoreMetaData
   clockworkdb.tsdb.AccessMode
   clockworkdb.tsdb.DatastoreMatch
   clockworkdb.tsdb.Provider
   clockworkdb.tsdb.Engine
   clockworkdb.tsdb.Session
   clockworkdb.tsdb.Connection
   clockworkdb.tsdb.Datastore
   clockworkdb.tsdb.AliasSet
   clockworkdb.tsdb.AggregationType
   clockworkdb.tsdb.NativeDataType
   clockworkdb.tsdb.TimeSeries
   clockworkdb.tsdb.NativeCalendarType


Module Contents
---------------

.. py:class:: RepositoryMetaDataList

   .. py:method:: size() -> int


   .. py:method:: get(arg: int, /) -> RepositoryMetaData


.. py:class:: RepositoryMetaData

   .. py:method:: name() -> str


   .. py:method:: description() -> str


   .. py:method:: module() -> str


.. py:class:: DatastoreMetaDataList

   .. py:method:: size() -> int


   .. py:method:: get(arg: int, /) -> DatastoreMetaData


.. py:class:: DatastoreMetaData

   .. py:method:: path() -> str


.. py:class:: AccessMode

   .. py:method:: READ_ONLY() -> AccessMode
      :staticmethod:



   .. py:method:: READ_WRITE() -> AccessMode
      :staticmethod:



   .. py:method:: CREATE() -> AccessMode
      :staticmethod:



.. py:class:: DatastoreMatch

   .. py:method:: next() -> bool


   .. py:method:: name() -> str


.. py:class:: Provider

   .. py:method:: name() -> str


   .. py:method:: description() -> str


   .. py:method:: version() -> str


   .. py:method:: tsdb_version() -> str


   .. py:method:: config_template() -> str


.. py:class:: Engine

   .. py:method:: Instance() -> Engine
      :staticmethod:



   .. py:method:: version() -> str
      :staticmethod:



   .. py:method:: get_provider() -> Provider
                  get_provider(arg: str, /) -> Provider


   .. py:method:: get_session() -> Session
                  get_session(arg: _clockworkdb.observation.Observation, /) -> Session
                  get_session(arg: str, /) -> Session


   .. py:method:: get_repositories_meta_data() -> RepositoryMetaDataList


.. py:class:: Session

   .. py:method:: get_connection() -> Connection


   .. py:method:: name() -> _clockworkdb.scalar.String


.. py:class:: Connection

   .. py:method:: get_datastore(arg0: str, arg1: AccessMode, /) -> Datastore


   .. py:method:: delete_datastore(arg: str, /) -> None


   .. py:method:: get_datastores_meta_data() -> DatastoreMetaDataList


.. py:class:: Datastore

   .. py:method:: has_time_series(arg: str, /) -> bool


   .. py:method:: get_time_series(arg: str, /) -> TimeSeries


   .. py:method:: delete_time_series(arg: str, /) -> bool


   .. py:method:: create_time_series(arg0: str, arg1: NativeDataType, arg2: NativeCalendarType, arg3: AggregationType, /) -> TimeSeries


   .. py:method:: regex_name_search(arg: str, /) -> DatastoreMatch


   .. py:method:: save_time_series(time_series: TimeSeries, overwrite: bool = True) -> None


   .. py:method:: close() -> None


   .. py:method:: get_create_date() -> str


   .. py:method:: get_modify_date() -> str


   .. py:method:: get_description() -> str


.. py:class:: AliasSet

   .. py:method:: add(arg: str, /) -> bool


   .. py:method:: changed() -> bool


   .. py:method:: clear() -> None


   .. py:method:: remove(arg: str, /) -> None


   .. py:method:: size() -> int


   .. py:method:: get(arg: int, /) -> str


   .. py:method:: __str__() -> str


.. py:class:: AggregationType

   .. py:method:: AVERAGED() -> AggregationType
      :staticmethod:



   .. py:method:: BEGIN() -> AggregationType
      :staticmethod:



   .. py:method:: END() -> AggregationType
      :staticmethod:



   .. py:method:: HIGH() -> AggregationType
      :staticmethod:



   .. py:method:: LOW() -> AggregationType
      :staticmethod:



   .. py:method:: SUM() -> AggregationType
      :staticmethod:



   .. py:method:: name() -> str


.. py:class:: NativeDataType

   .. py:method:: BLOB() -> NativeDataType
      :staticmethod:



   .. py:method:: STRING() -> NativeDataType
      :staticmethod:



   .. py:method:: FLOAT() -> NativeDataType
      :staticmethod:



   .. py:method:: DOUBLE() -> NativeDataType
      :staticmethod:



   .. py:method:: INT() -> NativeDataType
      :staticmethod:



   .. py:method:: BOOL() -> NativeDataType
      :staticmethod:



   .. py:method:: name() -> str


   .. py:method:: __eq__(arg: NativeDataType, /) -> bool


.. py:class:: TimeSeries

   .. py:method:: name() -> str


   .. py:method:: exists() -> bool


   .. py:method:: get_alias_set() -> AliasSet


   .. py:method:: get_aggregation_type() -> AggregationType


   .. py:method:: get_attribute(arg: str, /) -> str


   .. py:method:: set_attribute(arg0: str, arg1: str, /) -> None


   .. py:method:: get_calendar() -> _clockworkdb.calendars.Calendar


   .. py:method:: get_create_date() -> str


   .. py:method:: get_modify_date() -> str


   .. py:method:: get_data_type() -> NativeDataType


   .. py:method:: get_observation(arg: int, /) -> _clockworkdb.observation.Observation
                  get_observation(arg: _clockworkdb.calendars.Date, /) -> _clockworkdb.observation.Observation


   .. py:method:: set_observation(arg0: int, arg1: _clockworkdb.observation.Observation, /) -> None
                  set_observation(arg0: _clockworkdb.calendars.Date, arg1: _clockworkdb.observation.Observation, /) -> None


   .. py:method:: as_float(arg: int, /) -> _clockworkdb.scalar.Float


   .. py:method:: get_first_date_int() -> int


   .. py:method:: get_last_date_int() -> int


   .. py:method:: get_first_date() -> _clockworkdb.calendars.Date


   .. py:method:: get_last_date() -> _clockworkdb.calendars.Date


   .. py:method:: save(arg: bool = True) -> None


.. py:class:: NativeCalendarType

   .. py:method:: value() -> int


   .. py:method:: Annual() -> NativeCalendarType
      :staticmethod:



   .. py:method:: SemiAnnual() -> NativeCalendarType
      :staticmethod:



   .. py:method:: Quarterly() -> NativeCalendarType
      :staticmethod:



   .. py:method:: Monthly() -> NativeCalendarType
      :staticmethod:



   .. py:method:: Weekly() -> NativeCalendarType
      :staticmethod:



   .. py:method:: Business() -> NativeCalendarType
      :staticmethod:



   .. py:method:: Daily() -> NativeCalendarType
      :staticmethod: