ormar/docs/api/models/mixins/save-prepare-mixin.md

models.mixins.save_mixin

SavePrepareMixin Objects

class SavePrepareMixin(RelationMixin,  AliasMixin)

Used to prepare models to be saved in database

prepare_model_to_save

 | @classmethod
 | prepare_model_to_save(cls, new_kwargs: dict) -> dict

Combines all preparation methods before saving. Removes primary key for if it's nullable or autoincrement pk field, and it's set to None. Substitute related models with their primary key values as fk column. Populates the default values for field with default set and no value. Translate columns into aliases (db names).

Arguments:

• new_kwargs (Dict[str, str]): dictionary of model that is about to be saved

Returns:

(Dict[str, str]): dictionary of model that is about to be saved

_remove_not_ormar_fields

 | @classmethod
 | _remove_not_ormar_fields(cls, new_kwargs: dict) -> dict

Removes primary key for if it's nullable or autoincrement pk field, and it's set to None.

Arguments:

• new_kwargs (Dict[str, str]): dictionary of model that is about to be saved

Returns:

(Dict[str, str]): dictionary of model that is about to be saved

_remove_pk_from_kwargs

 | @classmethod
 | _remove_pk_from_kwargs(cls, new_kwargs: dict) -> dict

Removes primary key for if it's nullable or autoincrement pk field, and it's set to None.

Arguments:

• new_kwargs (Dict[str, str]): dictionary of model that is about to be saved

Returns:

(Dict[str, str]): dictionary of model that is about to be saved

parse_non_db_fields

 | @classmethod
 | parse_non_db_fields(cls, model_dict: Dict) -> Dict

Receives dictionary of model that is about to be saved and changes uuid fields to strings in bulk_update.

Arguments:

• model_dict (Dict): dictionary of model that is about to be saved

Returns:

(Dict): dictionary of model that is about to be saved

substitute_models_with_pks

 | @classmethod
 | substitute_models_with_pks(cls, model_dict: Dict) -> Dict

Receives dictionary of model that is about to be saved and changes all related models that are stored as foreign keys to their fk value.

Arguments:

• model_dict (Dict): dictionary of model that is about to be saved

Returns:

(Dict): dictionary of model that is about to be saved

populate_default_values

 | @classmethod
 | populate_default_values(cls, new_kwargs: Dict) -> Dict

Receives dictionary of model that is about to be saved and populates the default value on the fields that have the default value set, but no actual value was passed by the user.

Arguments:

• new_kwargs (Dict): dictionary of model that is about to be saved

Returns:

(Dict): dictionary of model that is about to be saved

validate_choices

 | @classmethod
 | validate_choices(cls, new_kwargs: Dict) -> Dict

Receives dictionary of model that is about to be saved and validates the fields with choices set to see if the value is allowed.

Arguments:

• new_kwargs (Dict): dictionary of model that is about to be saved

Returns:

(Dict): dictionary of model that is about to be saved

_upsert_model

 | @staticmethod
 | async _upsert_model(instance: "Model", save_all: bool, previous_model: Optional["Model"], relation_field: Optional["ForeignKeyField"], update_count: int) -> int

Method updates given instance if:

• instance is not saved or
• instance have no pk or
• save_all=True flag is set

and instance is not pk_only.

If relation leading to instance is a ManyToMany also the through model is saved

Arguments:

• instance (Model): current model to upsert
• save_all (bool): flag if all models should be saved or only not saved ones
• relation_field (Optional[ForeignKeyField]): field with relation
• previous_model (Model): previous model from which method came
• update_count (int): no of updated models

Returns:

(int): no of updated models

_upsert_through_model

 | @staticmethod
 | async _upsert_through_model(instance: "Model", previous_model: "Model", relation_field: "ForeignKeyField") -> None

Upsert through model for m2m relation.

Arguments:

• instance (Model): current model to upsert
• relation_field (Optional[ForeignKeyField]): field with relation
• previous_model (Model): previous model from which method came

_update_relation_list

 | async _update_relation_list(fields_list: Collection["ForeignKeyField"], follow: bool, save_all: bool, relation_map: Dict, update_count: int) -> int

Internal method used in save_related to follow deeper from related models and update numbers of updated related instances.

Arguments:

• fields_list (Collection["ForeignKeyField"]): list of ormar fields to follow and save
• relation_map (Dict): map of relations to follow
• follow (bool): flag to trigger deep save - by default only directly related models are saved with follow=True also related models of related models are saved
• update_count (int): internal parameter for recursive calls - number of updated instances

Returns:

(int): tuple of update count and visited