ahvn.adapter.db module

class ahvn.adapter.db.ORMUKFAdapter(*args, **kwargs)

Bases: BaseUKFAdapter

Simplified ORM adapter that only provides access to entity classes and conversion methods.

This adapter creates SQLAlchemy ORM entities dynamically based on the included fields and provides conversion methods between UKF objects and ORM entities.

virtual_fields = ('id', 'expiration_timestamp')

__init__(*args, **kwargs)

Initialize the ORM adapter with specified field inclusion.

Parameters:

• name – Name of the adapter instance.

• include – List of BaseUKF field names to include in the ORM schema. If None, includes all available BaseUKF fields plus virtual fields. The ‘id’ field is always included automatically.

• exclude – List of BaseUKF field names to exclude from the ORM schema. If None, excludes no fields.

• *args – Additional positional arguments.

• **kwargs – Additional configuration parameters.

Returns:

None

main_table_name()

Return type:

str

dims_table_name(dim_name)

Return type:

str

Parameters:

dim_name (str)

table_names()

Get all table names managed by this adapter.

Return type:

List[str]

from_ukf(ukf)

Convert a BaseUKF object to a ORMUKFMainEntity object.

Parameters:

ukf (BaseUKF) – BaseUKF object to convert.

Return type:

Dict[str, ExportableEntity]

Returns:

A dictionary mapping table names to their corresponding ORM entity instances. main key corresponds to the main entity, and other keys correspond to dimension entities. The main will always be the first item in the dictionary.

entities(kls)

Return type:

list[BaseUKF]

Parameters:

kls (Iterable[BaseUKF])

entity_mappings(kls)

Convert a list of BaseUKF objects to dictionary mappings for bulk insert.

This method generates mappings suitable for SQLAlchemy’s bulk_insert_mappings(), which is significantly more efficient than add_all() for large batches.

Parameters:

kls (Iterable[BaseUKF]) – Iterable of BaseUKF objects to convert.

Return type:

Dict[str, List[Dict[str, Any]]]

Returns:

A dictionary mapping table names to lists of dictionaries. Each dictionary represents a row to be inserted. The ‘main’ table is always first, followed by dimension tables.

to_ukf_data(entity)

Convert a ORMUKFMainEntity object to a dictionary suitable for BaseUKF initialization.

Parameters:

entity (ExportableEntity) – The ORM entity to convert.

Return type:

Dict[str, Any]

Returns:

A dictionary of field names and values for BaseUKF initialization.

from_result(result)

Convert a query result from the backend to the appropriate entity representation.

Parameters:

result (SQLResponse) – The raw result from a backend query.

Return type:

Dict[str, Any]

Returns:

The converted entity representation.