Welcome to the python-comdb2 documentation!

comdb2 Python interfaces to Comdb2 databases

This package provides Python interfaces to Comdb2 databases.

Two different Python submodules are provided for interacting with Comdb2 databases.

comdb2.dbapi2 provides an interface that conforms to the Python Database API Specification v2.0. If you’re already familiar with the Python DB-API, or if you intend to use libraries that expect to be given DB-API compliant connections, this module is likely to be the best fit for you. Additionally, if a better way of communicating with a Comdb2 database than libcdb2api is ever introduced, this module will be upgraded to it under the hood.

comdb2.cdb2 provides a thin, pythonic wrapper over cdb2api. If you’re more familiar with libcdb2api than with the Python DB-API and you don’t anticipate a need to interact with libraries that require DB-API compliant connections, this module may be simpler to get started with.

Contents

• comdb2.dbapi2 DBAPI-2.0 compatible Comdb2 API
  • Overview
    • Basic Usage
    • Graceful Teardown and Error Handling
    • Controlling the Type Used For Result Rows
    • Parameter Binding
      • By Name
      • By Position
    • Types
    • Autocommit Mode
    • DB-API Compliance
  • API Documentation
    • Constants
      • apilevel
      • threadsafety
      • paramstyle
    • Connections and Cursors
      • connect()
      • Connection
        • Connection.close()
        • Connection.commit()
        • Connection.cursor()
        • Connection.rollback()
        • Connection.row_factory
      • Cursor
        • Cursor.__iter__()
        • Cursor.arraysize
        • Cursor.callproc()
        • Cursor.close()
        • Cursor.connection
        • Cursor.description
        • Cursor.execute()
        • Cursor.executemany()
        • Cursor.fetchall()
        • Cursor.fetchmany()
        • Cursor.fetchone()
        • Cursor.rowcount
        • Cursor.setinputsizes()
        • Cursor.setoutputsize()
    • Type Objects
      • STRING
      • BINARY
      • NUMBER
      • DATETIME
      • ROWID
    • Type Constructors
      • Timestamp()
      • TimestampFromTicks()
      • Binary()
    • DatetimeUs
      • DatetimeUs
        • DatetimeUs.fromdatetime()
      • TimestampUs()
      • TimestampUsFromTicks()
      • ColumnType
    • Exceptions
      • Error
      • Warning
      • InterfaceError
      • DatabaseError
      • InternalError
      • OperationalError
      • ProgrammingError
      • IntegrityError
      • UniqueKeyConstraintError
      • ForeignKeyConstraintError
      • NonNullConstraintError
      • DataError
      • NotSupportedError
      • comdb2.dbapi2.Connection.Error
      • comdb2.dbapi2.Connection.Warning
      • comdb2.dbapi2.Connection.InterfaceError
      • comdb2.dbapi2.Connection.DatabaseError
      • comdb2.dbapi2.Connection.InternalError
      • comdb2.dbapi2.Connection.OperationalError
      • comdb2.dbapi2.Connection.ProgrammingError
      • comdb2.dbapi2.Connection.IntegrityError
      • comdb2.dbapi2.Connection.DataError
      • comdb2.dbapi2.Connection.NotSupportedError
• comdb2.cdb2 Thin, pythonic wrapper over cdb2api
  • Overview
    • Basic Usage
    • Graceful Teardown and Error Handling
    • Controlling the Type Used For Result Rows
    • Parameter Binding
      • By Name
      • By Position
    • Types
  • API Documentation
    • Handles
      • Handle
        • Handle.__iter__()
        • Handle.close()
        • Handle.column_names()
        • Handle.column_types()
        • Handle.execute()
        • Handle.get_effects()
        • Handle.row_factory
    • Exceptions
      • Error
        • Error.error_code
        • Error.error_message
    • DatetimeUs
      • DatetimeUs
        • DatetimeUs.fromdatetime()
    • Effects
      • Effects
        • Effects.num_affected
        • Effects.num_deleted
        • Effects.num_inserted
        • Effects.num_selected
        • Effects.num_updated
    • Enumerations
      • ColumnType
      • TYPE
      • ConnectionFlags
      • HANDLE_FLAGS
      • ERROR_CODE
• Comdb2 to Python Type Mappings
  • NULL
  • Numeric Types
  • String and Blob Types
  • Date and Time Types
  • Decimal Type
  • C Array Types
• comdb2.factories Factory functions for use with Comdb2 handles
  • dict_row_factory()
  • namedtuple_row_factory()
• Best Practices, Tips, and Tricks

Indices and tables

• Index

• Module Index

• Search Page