.. _cmfrontendref:


CM Frontend Reference
================================================

.. automodule:: exos.api.cmfrontend

.. seealso::

   :ref:`CM Frontend Overview <cmfrontend>`


Connection
------------------------------------------------

.. autofunction:: connect

.. autoclass:: Connection
  :members: cursor, commit, close


Cursor
------------------------------------------------

.. autoclass:: Cursor

  .. autoinstanceattribute:: retries
    :annotation:

  .. autoinstanceattribute:: retry_timeout
    :annotation:

  .. autoinstanceattribute:: vr_name
    :annotation:

  .. autoinstanceattribute:: messages
    :annotation:

  .. autoattribute:: connection
  .. autoattribute:: description
  .. autoattribute:: rowcount
  .. autoattribute:: rownumber
  .. autoattribute:: arraysize

  .. automethod:: execute

  .. automethod:: fetchrow
  .. automethod:: fetchrows
  .. automethod:: iterrow

  .. automethod:: fetchone
  .. automethod:: fetchall
  .. automethod:: next
  .. automethod:: __iter__

  .. automethod:: close


Request
------------------------------------------------

.. autofunction:: request

.. autoclass:: Table

  .. automethod:: __init__

  .. autoattribute:: module_name
  .. autoattribute:: table_name


.. autoclass:: Column

  .. automethod:: __init__

  .. autoattribute:: table
  .. autoattribute:: column_name
  .. autoattribute:: module_name
  .. autoattribute:: table_name

.. autoclass:: Request

  .. autoinstanceattribute:: outer_join
    :annotation:

  .. autoinstanceattribute:: op
    :annotation:

  .. autoinstanceattribute:: method
    :annotation:

  .. autoattribute:: tables
  .. autoattribute:: main_table
  .. autoattribute:: fields
  .. autoattribute:: indexes
  .. autoattribute:: params

  .. automethod:: add_index
  .. automethod:: add_param
  .. automethod:: add_field

  .. automethod:: copy
  .. automethod:: set_vr_name


Row
------------------------------------------------

.. autoclass:: Row

  .. autoinstanceattribute:: rowid
    :annotation:

  .. autoinstanceattribute:: opMsg
    :annotation:

  .. autoinstanceattribute:: field_values
    :annotation:


Errors
------------------------------------------------

.. autoclass:: ModuleUnavailable

  .. autoinstanceattribute:: module_name
    :annotation:

  .. automethod:: when_ready


PEP-249 Errors
------------------------------------------------

Error classes as defined and required by PEP-249.

.. autoclass:: Error
.. autoclass:: Warning
.. autoclass:: InterfaceError
.. autoclass:: DatabaseError
.. autoclass:: InternalError
.. autoclass:: OperationalError
.. autoclass:: ProgrammingError
.. autoclass:: IntegrityError
.. autoclass:: DataError
.. autoclass:: NotSupportedError


PEP-249 Types
------------------------------------------------

Types classes as defined and required by PEP-249.  Only the :data:`STRING` type
is currently used in cmfrontend.

.. autoclass:: STRING
.. autoclass:: BINARY
.. autoclass:: NUMBER
.. autoclass:: DATETIME
.. autoclass:: ROWID