`ovo.core.database.sql_db`¶

Module Contents¶

Classes¶

API¶

class ovo.core.database.sql_db.SqlDBEngine(db_url: str, verbose: bool = False, read_only: bool = False)¶

Bases: ovo.core.database.cache_clearing.CacheClearingEngine

init()¶

_create_session() → sqlalchemy.orm.Session¶

_check_updated(obj: ovo.core.database.models.Base)¶

check_read_only()¶

save(obj: ovo.core.database.models.Base)¶

save_all(objs: Sequence[ovo.core.database.models.Base])¶

remove(model: Type[ovo.core.database.base_db.T], *id_args, **kwargs)¶

save_value(model: Type[ovo.core.database.base_db.T], column: str, value, **kwargs)¶

select(model: Type[ovo.core.database.base_db.T], limit: int = None, order_by=None, **kwargs) → Sequence[ovo.core.database.base_db.T]¶

count(model: Type[ovo.core.database.base_db.T], **kwargs) → int¶

count_distinct(model: Type[ovo.core.database.base_db.T], field='id', group_by=None, **kwargs) → int | dict[Any, int]¶

_create_query(session, model: Type[ovo.core.database.base_db.T], columns=None, order_by=None, limit=None, id_args=None, **kwargs)¶

_create_order_by(model: Type[ovo.core.database.base_db.T], order_by)¶

_create_order_by_single(model: Type[ovo.core.database.base_db.T], order_by)¶

_create_filters(model: Type[ovo.core.database.base_db.T], kwargs)¶

get(model: Type[ovo.core.database.base_db.T], *id_args, **kwargs) → ovo.core.database.base_db.T¶

get_value(model: Type[ovo.core.database.base_db.T], column: str, *id_args, raw=False, **kwargs)¶

select_values(model: Type[ovo.core.database.base_db.T], column: str, order_by=None, **kwargs) → list¶

select_dict(model: Type[ovo.core.database.base_db.T], key_column: str, value_column: str, order_by=None, **kwargs) → dict¶

select_unique_values(model: Type[ovo.core.database.base_db.T], column: str, **kwargs) → set¶

select_dataframe(model: Type[ovo.core.database.base_db.T], index_col: str = 'id', order_by=None, limit='unset', **kwargs) → pandas.DataFrame¶

select_descriptor_values(descriptor_key: str, design_ids: list[str]) → pandas.Series¶: Select values of a single descriptor for multiple designs.

select_design_descriptors(design_id: str, descriptor_keys: list[str]) → pandas.Series¶: Select values of multiple descriptors for a single design.

select_wide_descriptor_table(design_ids: list[str], descriptor_keys: list[str], **kwargs) → pandas.DataFrame¶

get_design_accepted_values(design_ids: list[str])¶