# cpl_core.database package — Common Python Library documentation

# cpl_core.database package

## Subpackages

- cpl_core.database.connection package
  - Submodules
  - cpl_core.database.connection.database_connection module
    - `DatabaseConnection`
      - `DatabaseConnection.connect()`
      - `DatabaseConnection.cursor`
      - `DatabaseConnection.server`
  - cpl_core.database.connection.database_connection_abc module
    - `DatabaseConnectionABC`
      - `DatabaseConnectionABC.connect()`
      - `DatabaseConnectionABC.cursor`
      - `DatabaseConnectionABC.server`
  - Module contents
    - cpl-core CPL core
    - `VersionInfo`
      - `VersionInfo.major`
      - `VersionInfo.micro`
      - `VersionInfo.minor`
- cpl_core.database.context package
  - Submodules
  - cpl_core.database.context.database_context module
    - `DatabaseContext`
      - `DatabaseContext.connect()`
      - `DatabaseContext.cursor`
      - `DatabaseContext.save_changes()`
      - `DatabaseContext.select()`
  - cpl_core.database.context.database_context_abc module
    - `DatabaseContextABC`
      - `DatabaseContextABC.connect()`
      - `DatabaseContextABC.cursor`
      - `DatabaseContextABC.save_changes()`
      - `DatabaseContextABC.select()`
  - Module contents
    - cpl-core CPL core
    - `VersionInfo`
      - `VersionInfo.major`
      - `VersionInfo.micro`
      - `VersionInfo.minor`

## Submodules

## cpl_core.database.database_settings module

class cpl_core.database.database_settings.DatabaseSettings(host: str | None = None, port: int | None = None, user: str | None = None, password: str | None = None, databse: str | None = None, charset: str | None = None, use_unicode: bool | None = None, buffered: bool | None = None, auth_plugin: bool | None = None)

  Bases: `ConfigurationModelABC`

  Represents settings for the database connection

  property auth_plugin: str | None
  property buffered: bool | None
  property charset: str | None
  property database: str | None
  property host: str | None
  property password: str | None
  property port: int | None
  property use_unicode: bool | None
  property user: str | None

## cpl_core.database.database_settings_name_enum module

class cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum(value)

  Bases: `Enum`

  An enumeration.

  auth_plugin = 'AuthPlugin'
  buffered = 'Buffered'
  charset = 'Charset'
  database = 'Database'
  host = 'Host'
  password = 'Password'
  port = 'Port'
  use_unicode = 'UseUnicode'
  user = 'User'

## cpl_core.database.table_abc module

class cpl_core.database.table_abc.TableABC

  Bases: `ABC`

  property created_at: datetime
  abstract property delete_string: str
  abstract property insert_string: str
  property modified_at: datetime
  abstract property udpate_string: str

## Module contents

### cpl-core CPL core

CPL core package

copyright:

  3. 2020 - 2023 sh-edraft.de

license:

  MIT, see LICENSE for more details.

class cpl_core.database.VersionInfo(major, minor, micro)

  Bases: `tuple`

  major

    Alias for field number 0

  micro

    Alias for field number 2

  minor

    Alias for field number 1