Metadata Models

class InsertMetadata(*, error_description=None, errors=<factory>, inserted_idx=<factory>, existing_idx=<factory>)

Bases: BaseModel

Metadata returned by insertion / adding functions

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• error_description (str | None)

• errors (list[tuple[int, str]])

• inserted_idx (list[int])

• existing_idx (list[int])

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)

check_all_indices()

static merge(metadata)

Parameters:

metadata (Sequence[InsertMetadata])

Return type:

InsertMetadata

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class InsertCountsMetadata(*, n_inserted, n_existing, error_description=None, errors=<factory>)

Bases: BaseModel

Metadata returned by insertion / adding functions, only including counts

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• n_inserted (int)

• n_existing (int)

• error_description (str | None)

• errors (list[str])

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)

Parameters:

insert_meta (InsertMetadata)

Return type:

InsertCountsMetadata

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class DeleteMetadata(*, error_description=None, errors=<factory>, deleted_idx=<factory>, n_children_deleted=0)

Bases: BaseModel

Metadata returned by delete functions

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• error_description (str | None)

• errors (list[tuple[int, str]])

• deleted_idx (list[int])

• n_children_deleted (int)

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)

check_all_indices()

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class UpdateMetadata(*, error_description=None, errors=<factory>, updated_idx=<factory>, n_children_updated=0)

Bases: BaseModel

Metadata returned by update functions

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• error_description (str | None)

• errors (list[tuple[int, str]])

• updated_idx (list[int])

• n_children_updated (int)

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)

check_all_indices()

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class TaskReturnMetadata(*, error_description=None, rejected_info=<factory>, accepted_ids=<factory>)

Bases: BaseModel

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• error_description (str | None)

• rejected_info (list[tuple[int, str]])

• accepted_ids (list[int])

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)

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].