Requests

Schemas of CRUD requests passed from one proxy to another.

These objects will be created either by the developer, who wishes to make a CRUD request directly in his code, or by a destination module, which will transform a concrete request (HTTP request, for example) into a CRUD request.

ReadParams

Parameters expected by the read method.

pydantic model crudcreator.schema.ReadParams

The parameters expected by the read method of the entity types. Contains the information required for a CRUD read request.

field dict_read_options: dict[str, Any] [Required]

Reading options. Will be read by proxies to potentially modify their behavior.

field list_filter_instance: list[FilterInstance] [Required]

Reading filters.

field list_read_field: list[str] [Required]

Fields to be read.

field transaction: AbstractTransaction [Required]

The open transaction.

CreateParams

Parameters expected by the create method for entities.

pydantic model crudcreator.schema.CreateParams

The parameters expected by the create method of the entity types. Contains the information required for a CRUD create request.

field dict_creator_options: dict[str, Any] [Required]

Creation options. Will be read by proxies to potentially modify their behavior.

field dict_creator_value: dict[str, Any] [Required]

Field values for the new entity to be created.

field transaction: AbstractTransaction [Required]

UpdateParams

Parameters expected by the update method.

pydantic model crudcreator.schema.UpdateParams

The parameters expected by the update method of the entity types. Contains the information required for a CRUD update request.

field dict_ids: dict[str, Any] [Required]

The value of the ids used to identify the entity to be modified.

field dict_updator_options: dict[str, Any] [Required]

Modification options. Will be read by proxies to potentially modify their behavior.

field dict_updator_value: dict[str, Any] [Required]

The new value of the fields to be updated.

field transaction: AbstractTransaction [Required]

DeleteParams

Parameters expected by the delete method for entities.

pydantic model crudcreator.schema.DeleteParams

Parameters expected by the delete method of entity types. Contains the information required for a CRUD delete request.

field dict_deletor_options: dict[str, Any] [Required]

Deletion options. Will be read by proxies to potentially modify their behavior.

field dict_deletor_value: dict[str, Any] [Required]

The value of the ids used to identify the entity to be modified.

field transaction: AbstractTransaction [Required]

UpdateOrCreateParams

Parameters expected by the update_or_create method for entities.

pydantic model crudcreator.schema.UpdateOrCreateParams

Parameters expected by the update_or_create method for entities.

field dict_ids: dict[str, Any] [Required]

The value of the ids used to identify the entity to be modified.

field dict_update_or_create_options: dict[str, Any] [Required]

Creation or modification options. Will be read by proxies to potentially modify their behavior.

field dict_update_or_create_value: dict[str, Any] [Required]

Field values for the new entity to be created (or updated).

field transaction_manager: AbstractTransactionManager [Required]