SQL#

The SQL module provides a SQL-based version of the DBContextStorage class. This class is used to store and retrieve context data from SQL databases. It allows Chatsky to easily store and retrieve context data in a format that is highly scalable and easy to work with.

The SQL module provides the ability to choose the backend of your choice from MySQL, PostgreSQL, or SQLite. You can choose the one that is most suitable for your use case and environment. MySQL and PostgreSQL are widely used open-source relational databases that are known for their reliability and scalability. SQLite is a self-contained, high-reliability, embedded, full-featured, public-domain, SQL database engine.

_sqlite_enable_foreign_key(dbapi_con, con_record)[source]#
_import_insert_for_dialect(dialect)[source]#
Return type:

Callable[[Table], Insert]

_get_upsert_stmt(dialect, insert_stmt, columns, unique)[source]#
class SQLContextStorage(path, rewrite_existing=False, partial_read_config=None, table_name_prefix='chatsky_table', database_id_length=255)[source]#

Bases: DBContextStorage

SQL-based version of the DBContextStorage. Compatible with MySQL, Postgresql, Sqlite. When using Sqlite on a Windows system, keep in mind that you have to use double backslashes ‘' instead of forward slashes ‘/’ in the file path.

MAIN table is represented by main table. Columns of the table are: id, current_turn_id, created_at updated_at, misc and framework_data.

TURNS table is represented by turns table. Columns of the table are: id, key, label, request and response.

Parameters:

  • path (str) – Standard sqlalchemy URI string. Examples: sqlite+aiosqlite://path_to_the_file/file_name, mysql+asyncmy://root:pass@localhost:3306/test, postgresql+asyncpg://postgres:pass@localhost:5430/test.

  • rewrite_existing (bool) – Whether TURNS modified locally should be updated in database or not.

  • partial_read_config (Optional[Dict[Literal['labels', 'requests', 'responses'], Union[Literal['__all__'], int, Set[int]]]]) – Dictionary of subscripts for all possible turn items.

  • table_name_prefix (str) – “namespace” prefix for the two tables created for context storing.

  • database_id_length (int) – Length of context ID column in the database.

property is_concurrent: bool#

If the database backend support asynchronous IO.

async _connect()[source]#
_check_availability()[source]#

Chech availability of the specified backend, raise error if not available.

Parameters:

custom_driver – custom driver is requested - no checks will be performed.

async _load_main_info(ctx_id)[source]#
Return type:

Optional[ContextMainInfo]

async _update_context(ctx_id, ctx_info, field_info)[source]#
Return type:

None

async _delete_context(ctx_id)[source]#
Return type:

None

async _load_field_latest(ctx_id, field_name)[source]#
Return type:

List[Tuple[int, bytes]]

async _load_field_keys(ctx_id, field_name)[source]#
Return type:

List[int]

async _load_field_items(ctx_id, field_name, keys)[source]#
Return type:

List[Tuple[int, bytes]]

async _clear_all()[source]#
Return type:

None