Metadata Models#

class InsertMetadata[source]#

Bases: BaseModel

Metadata returned by insertion / adding functions

Fields#
Field	Type	Required	Default
`error_description`	`str` \| `None`	No	`None`
`errors`	`list`[`tuple`[`int`, `str`]]	No	factory
`existing_idx`	`list`[`int`]	No	factory
`inserted_idx`	`list`[`int`]	No	factory

Validators#
Validator	Mode	Fields
`check_all_indices`	after	model
`sort_fields`	before	`errors`, `inserted_idx`, `existing_idx`

error_description: str | None#

errors: list[tuple[int, str]]#

inserted_idx: list[int]#

existing_idx: list[int]#

property n_inserted#

property n_existing#

property n_errors#

property error_idx#

property success#

property error_string#

classmethod sort_fields(v)[source]#

check_all_indices()[source]#

static merge(metadata)[source]#

Parameters:: metadata (Sequence[InsertMetadata])
Return type:: InsertMetadata

class InsertCountsMetadata[source]#

Bases: BaseModel

Metadata returned by insertion / adding functions, only including counts

Fields#
Field	Type	Required	Default
`error_description`	`str` \| `None`	No	`None`
`errors`	`list`[`str`]	No	factory
`n_existing`	`int`	Yes
`n_inserted`	`int`	Yes

n_inserted: int#

n_existing: int#

error_description: str | None#

errors: list[str]#

property n_errors#

property success#

property error_string#

static from_insert_metadata(insert_meta)[source]#

Parameters:: insert_meta (InsertMetadata)
Return type:: InsertCountsMetadata

class DeleteMetadata[source]#

Bases: BaseModel

Metadata returned by delete functions

Fields#
Field	Type	Required	Default
`deleted_idx`	`list`[`int`]	No	factory
`error_description`	`str` \| `None`	No	`None`
`errors`	`list`[`tuple`[`int`, `str`]]	No	factory
`n_children_deleted`	`int`	No	`0`

Validators#
Validator	Mode	Fields
`check_all_indices`	after	model
`sort_fields`	before	`errors`, `deleted_idx`

error_description: str | None#

errors: list[tuple[int, str]]#

deleted_idx: list[int]#

n_children_deleted: int#

property n_deleted#

property n_errors#

property error_idx#

property success#

property error_string#

classmethod sort_fields(v)[source]#

check_all_indices()[source]#

class UpdateMetadata[source]#

Bases: BaseModel

Metadata returned by update functions

Fields#
Field	Type	Required	Default
`error_description`	`str` \| `None`	No	`None`
`errors`	`list`[`tuple`[`int`, `str`]]	No	factory
`n_children_updated`	`int`	No	`0`
`updated_idx`	`list`[`int`]	No	factory

Validators#
Validator	Mode	Fields
`check_all_indices`	after	model
`sort_fields`	before	`errors`, `updated_idx`

error_description: str | None#

errors: list[tuple[int, str]]#

updated_idx: list[int]#

n_children_updated: int#

property n_updated#

property n_errors#

property error_idx#

property success#

property error_string#

classmethod sort_fields(v)[source]#

check_all_indices()[source]#

class TaskReturnMetadata[source]#

Bases: BaseModel

Metadata returned to managers that have sent completed tasks back to the server

Fields#
Field	Type	Required	Default
`accepted_ids`	`list`[`int`]	No	factory
`error_description`	`str` \| `None`	No	`None`
`rejected_info`	`list`[`tuple`[`int`, `str`]]	No	factory

Validators#
Validator	Mode	Fields
`sort_fields`	before	`rejected_info`, `accepted_ids`

error_description: str | None#

rejected_info: list[tuple[int, str]]#

accepted_ids: list[int]#

property n_accepted#

property n_rejected#

property rejected_ids#

property success#

property error_string#

classmethod sort_fields(v)[source]#