neosqlite.results module

class neosqlite.results.InsertOneResult(inserted_id: Any)

Bases: object

Represents the result of a single insert operation.

__init__(inserted_id: Any)

Initialize an InsertOneResult object.

Parameters:

inserted_id (Any) – The ID of the inserted document.

property inserted_id: Any

The ID of the inserted document.

Returns:

The ID of the inserted document.

Return type:

Any

class neosqlite.results.InsertManyResult(inserted_ids: list[Any])

Bases: object

Represents the result of a multiple insert operation.

__init__(inserted_ids: list[Any])

Initialize an InsertManyResult object.

Parameters:

inserted_ids (list[Any]) – The IDs of the inserted documents.

property inserted_ids: list[Any]

The IDs of the inserted documents.

Returns:

The IDs of the inserted documents.

Return type:

list[Any]

class neosqlite.results.UpdateResult(matched_count: int, modified_count: int, upserted_id: Any | None)

Bases: object

Represents the result of a single update operation.

__init__(matched_count: int, modified_count: int, upserted_id: Any | None)

Initialize an UpdateResult object.

Parameters:

• matched_count (int) – The number of documents that matched the filter criteria.

• modified_count (int) – The number of documents that were modified.

• upserted_id (Any | None) – The ID of the inserted document if an upsert operation was performed; None otherwise.

property matched_count: int

The number of documents that matched the filter criteria.

Returns:

The number of documents that matched the filter criteria.

Return type:

int

property modified_count: int

The number of documents that were modified.

Returns:

The number of documents that were modified.

Return type:

int

property upserted_id: Any | None

The ID of the inserted document.

Returns:

The ID of the inserted document if an upsert operation was

performed; None otherwise.

Return type:

Any | None

class neosqlite.results.DeleteResult(deleted_count: int)

Bases: object

Represents the result of a single delete operation.

__init__(deleted_count: int)

Initialize a DeleteResult object with the count of deleted documents.

Parameters:

deleted_count (int) – The number of documents that were deleted.

property deleted_count: int

The number of documents that were deleted.

Returns:

The number of documents that were deleted.

Return type:

int

class neosqlite.results.BulkWriteResult(inserted_count: int, matched_count: int, modified_count: int, deleted_count: int, upserted_count: int)

Bases: object

Represents the result of a bulk write operation.

__init__(inserted_count: int, matched_count: int, modified_count: int, deleted_count: int, upserted_count: int)

Initialize a BulkWriteResult object with counts of various operations.

Parameters:

• inserted_count (int) – The number of documents that were inserted.

• matched_count (int) – The number of documents that matched the filter criteria.

• modified_count (int) – The number of documents that were modified.

• deleted_count (int) – The number of documents that were deleted.

• upserted_count (int) – The number of documents that were upserted.