Skip to content

Many

Queries like find many.

ManyMixin

Queries like find many.

Source code in src\ramifice\commons\many.py 
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
class ManyMixin:
    """Queries like `find many`."""

    @classmethod
    async def find_many(
        cls,
        filter: Any | None = None,
        projection: Any | None = None,
        skip: int = 0,
        limit: int = 0,
        no_cursor_timeout: bool = False,
        cursor_type: int = CursorType.NON_TAILABLE,
        sort: Any | None = None,
        allow_partial_results: bool = False,
        oplog_replay: bool = False,
        batch_size: int = 0,
        collation: Any | None = None,
        hint: Any | None = None,
        max_scan: Any | None = None,
        max_time_ms: Any | None = None,
        max: Any | None = None,
        min: Any | None = None,
        return_key: bool = False,
        show_record_id: bool = False,
        comment: Any | None = None,
        session: Any | None = None,
        allow_disk_use: Any | None = None,
    ) -> list[dict[str, Any]]:
        """Find documents."""
        # Get collection for current model.
        collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
        # Correcting filter.
        if filter is not None:
            filter = correct_mongo_filter(cls, filter)
        # Get documents.
        doc_list: list[dict[str, Any]] = []
        cursor: AsyncCursor = collection.find(
            filter=filter,
            projection=projection,
            skip=skip,
            limit=limit or cls.META["db_query_docs_limit"],
            no_cursor_timeout=no_cursor_timeout,
            cursor_type=cursor_type,
            sort=sort,
            allow_partial_results=allow_partial_results,
            oplog_replay=oplog_replay,
            batch_size=batch_size,
            collation=collation,
            hint=hint,
            max_scan=max_scan,
            max_time_ms=max_time_ms,
            max=max,
            min=min,
            return_key=return_key,
            show_record_id=show_record_id,
            comment=comment,
            session=session,
            allow_disk_use=allow_disk_use,
        )
        field_name_and_type = cls.META["field_name_and_type"]
        async for mongo_doc in cursor:
            doc_list.append(password_to_none(field_name_and_type, mongo_doc))
        return doc_list

    @classmethod
    async def find_many_to_raw_docs(
        cls,
        filter: Any | None = None,
        projection: Any | None = None,
        skip: int = 0,
        limit: int = 0,
        no_cursor_timeout: bool = False,
        cursor_type: int = CursorType.NON_TAILABLE,
        sort: Any | None = None,
        allow_partial_results: bool = False,
        oplog_replay: bool = False,
        batch_size: int = 0,
        collation: Any | None = None,
        hint: Any | None = None,
        max_scan: Any | None = None,
        max_time_ms: Any | None = None,
        max: Any | None = None,
        min: Any | None = None,
        return_key: bool = False,
        show_record_id: bool = False,
        comment: Any | None = None,
        session: Any | None = None,
        allow_disk_use: Any | None = None,
    ) -> list[dict[str, Any]]:
        """Find documents and convert to a raw documents.

        Special changes:
            _id to str
            password to None
            date to str
            datetime to str
        """
        # Get collection for current model.
        collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
        # Correcting filter.
        if filter is not None:
            filter = correct_mongo_filter(cls, filter)
        # Get documents.
        doc_list: list[dict[str, Any]] = []
        cursor: AsyncCursor = collection.find(
            filter=filter,
            projection=projection,
            skip=skip,
            limit=limit or cls.META["db_query_docs_limit"],
            no_cursor_timeout=no_cursor_timeout,
            cursor_type=cursor_type,
            sort=sort,
            allow_partial_results=allow_partial_results,
            oplog_replay=oplog_replay,
            batch_size=batch_size,
            collation=collation,
            hint=hint,
            max_scan=max_scan,
            max_time_ms=max_time_ms,
            max=max,
            min=min,
            return_key=return_key,
            show_record_id=show_record_id,
            comment=comment,
            session=session,
            allow_disk_use=allow_disk_use,
        )
        inst_model_dict = {key: val for key, val in cls().__dict__.items() if not callable(val) and not val.ignored}
        lang = translations.CURRENT_LOCALE
        async for mongo_doc in cursor:
            doc_list.append(
                mongo_doc_to_raw_doc(
                    inst_model_dict,
                    mongo_doc,
                    lang,
                ),
            )
        return doc_list

    @classmethod
    async def find_many_to_json(
        cls,
        filter: Any | None = None,
        projection: Any | None = None,
        skip: int = 0,
        limit: int = 0,
        no_cursor_timeout: bool = False,
        cursor_type: int = CursorType.NON_TAILABLE,
        sort: Any | None = None,
        allow_partial_results: bool = False,
        oplog_replay: bool = False,
        batch_size: int = 0,
        collation: Any | None = None,
        hint: Any | None = None,
        max_scan: Any | None = None,
        max_time_ms: Any | None = None,
        max: Any | None = None,
        min: Any | None = None,
        return_key: bool = False,
        show_record_id: bool = False,
        comment: Any | None = None,
        session: Any | None = None,
        allow_disk_use: Any | None = None,
    ) -> str | None:
        """Find documents and convert to a json string."""
        # Get collection for current model.
        collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
        # Correcting filter.
        if filter is not None:
            filter = correct_mongo_filter(cls, filter)
        # Get documents.
        doc_list: list[dict[str, Any]] = []
        cursor: AsyncCursor = collection.find(
            filter=filter,
            projection=projection,
            skip=skip,
            limit=limit or cls.META["db_query_docs_limit"],
            no_cursor_timeout=no_cursor_timeout,
            cursor_type=cursor_type,
            sort=sort,
            allow_partial_results=allow_partial_results,
            oplog_replay=oplog_replay,
            batch_size=batch_size,
            collation=collation,
            hint=hint,
            max_scan=max_scan,
            max_time_ms=max_time_ms,
            max=max,
            min=min,
            return_key=return_key,
            show_record_id=show_record_id,
            comment=comment,
            session=session,
            allow_disk_use=allow_disk_use,
        )
        inst_model_dict = {key: val for key, val in cls().__dict__.items() if not callable(val) and not val.ignored}
        lang = translations.CURRENT_LOCALE
        async for mongo_doc in cursor:
            doc_list.append(
                mongo_doc_to_raw_doc(
                    inst_model_dict,
                    mongo_doc,
                    lang,
                ),
            )
        return orjson.dumps(doc_list).decode("utf-8") if len(doc_list) > 0 else None

    @classmethod
    async def delete_many(
        cls,
        filter: Any,
        collation: Any | None = None,
        hint: Any | None = None,
        session: Any | None = None,
        let: Any | None = None,
        comment: Any | None = None,
    ) -> DeleteResult:
        """Delete one or more documents matching the filter."""
        # Raises a panic if the Model cannot be removed.
        if not cls.META["is_delete_doc"]:
            msg = (
                f"Model: `{cls.META['full_model_name']}` > "
                + "META param: `is_delete_doc` (False) => "
                + "Documents of this Model cannot be removed from the database!"
            )
            logger.error(msg)
            raise ForbiddenDeleteDocError(msg)
        # Get collection for current model.
        collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
        # Correcting filter.
        if filter is not None:
            filter = correct_mongo_filter(cls, filter)
        # Delete documents.
        result: DeleteResult = await collection.delete_many(
            filter=filter,
            collation=collation,
            hint=hint,
            session=session,
            let=let,
            comment=comment,
        )
        return result

delete_many(filter, collation=None, hint=None, session=None, let=None, comment=None) async classmethod

Delete one or more documents matching the filter.

Source code in src\ramifice\commons\many.py 
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
@classmethod
async def delete_many(
    cls,
    filter: Any,
    collation: Any | None = None,
    hint: Any | None = None,
    session: Any | None = None,
    let: Any | None = None,
    comment: Any | None = None,
) -> DeleteResult:
    """Delete one or more documents matching the filter."""
    # Raises a panic if the Model cannot be removed.
    if not cls.META["is_delete_doc"]:
        msg = (
            f"Model: `{cls.META['full_model_name']}` > "
            + "META param: `is_delete_doc` (False) => "
            + "Documents of this Model cannot be removed from the database!"
        )
        logger.error(msg)
        raise ForbiddenDeleteDocError(msg)
    # Get collection for current model.
    collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
    # Correcting filter.
    if filter is not None:
        filter = correct_mongo_filter(cls, filter)
    # Delete documents.
    result: DeleteResult = await collection.delete_many(
        filter=filter,
        collation=collation,
        hint=hint,
        session=session,
        let=let,
        comment=comment,
    )
    return result

find_many(filter=None, projection=None, skip=0, limit=0, no_cursor_timeout=False, cursor_type=CursorType.NON_TAILABLE, sort=None, allow_partial_results=False, oplog_replay=False, batch_size=0, collation=None, hint=None, max_scan=None, max_time_ms=None, max=None, min=None, return_key=False, show_record_id=False, comment=None, session=None, allow_disk_use=None) async classmethod

Find documents.

Source code in src\ramifice\commons\many.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
@classmethod
async def find_many(
    cls,
    filter: Any | None = None,
    projection: Any | None = None,
    skip: int = 0,
    limit: int = 0,
    no_cursor_timeout: bool = False,
    cursor_type: int = CursorType.NON_TAILABLE,
    sort: Any | None = None,
    allow_partial_results: bool = False,
    oplog_replay: bool = False,
    batch_size: int = 0,
    collation: Any | None = None,
    hint: Any | None = None,
    max_scan: Any | None = None,
    max_time_ms: Any | None = None,
    max: Any | None = None,
    min: Any | None = None,
    return_key: bool = False,
    show_record_id: bool = False,
    comment: Any | None = None,
    session: Any | None = None,
    allow_disk_use: Any | None = None,
) -> list[dict[str, Any]]:
    """Find documents."""
    # Get collection for current model.
    collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
    # Correcting filter.
    if filter is not None:
        filter = correct_mongo_filter(cls, filter)
    # Get documents.
    doc_list: list[dict[str, Any]] = []
    cursor: AsyncCursor = collection.find(
        filter=filter,
        projection=projection,
        skip=skip,
        limit=limit or cls.META["db_query_docs_limit"],
        no_cursor_timeout=no_cursor_timeout,
        cursor_type=cursor_type,
        sort=sort,
        allow_partial_results=allow_partial_results,
        oplog_replay=oplog_replay,
        batch_size=batch_size,
        collation=collation,
        hint=hint,
        max_scan=max_scan,
        max_time_ms=max_time_ms,
        max=max,
        min=min,
        return_key=return_key,
        show_record_id=show_record_id,
        comment=comment,
        session=session,
        allow_disk_use=allow_disk_use,
    )
    field_name_and_type = cls.META["field_name_and_type"]
    async for mongo_doc in cursor:
        doc_list.append(password_to_none(field_name_and_type, mongo_doc))
    return doc_list

find_many_to_json(filter=None, projection=None, skip=0, limit=0, no_cursor_timeout=False, cursor_type=CursorType.NON_TAILABLE, sort=None, allow_partial_results=False, oplog_replay=False, batch_size=0, collation=None, hint=None, max_scan=None, max_time_ms=None, max=None, min=None, return_key=False, show_record_id=False, comment=None, session=None, allow_disk_use=None) async classmethod

Find documents and convert to a json string.

Source code in src\ramifice\commons\many.py 
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
@classmethod
async def find_many_to_json(
    cls,
    filter: Any | None = None,
    projection: Any | None = None,
    skip: int = 0,
    limit: int = 0,
    no_cursor_timeout: bool = False,
    cursor_type: int = CursorType.NON_TAILABLE,
    sort: Any | None = None,
    allow_partial_results: bool = False,
    oplog_replay: bool = False,
    batch_size: int = 0,
    collation: Any | None = None,
    hint: Any | None = None,
    max_scan: Any | None = None,
    max_time_ms: Any | None = None,
    max: Any | None = None,
    min: Any | None = None,
    return_key: bool = False,
    show_record_id: bool = False,
    comment: Any | None = None,
    session: Any | None = None,
    allow_disk_use: Any | None = None,
) -> str | None:
    """Find documents and convert to a json string."""
    # Get collection for current model.
    collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
    # Correcting filter.
    if filter is not None:
        filter = correct_mongo_filter(cls, filter)
    # Get documents.
    doc_list: list[dict[str, Any]] = []
    cursor: AsyncCursor = collection.find(
        filter=filter,
        projection=projection,
        skip=skip,
        limit=limit or cls.META["db_query_docs_limit"],
        no_cursor_timeout=no_cursor_timeout,
        cursor_type=cursor_type,
        sort=sort,
        allow_partial_results=allow_partial_results,
        oplog_replay=oplog_replay,
        batch_size=batch_size,
        collation=collation,
        hint=hint,
        max_scan=max_scan,
        max_time_ms=max_time_ms,
        max=max,
        min=min,
        return_key=return_key,
        show_record_id=show_record_id,
        comment=comment,
        session=session,
        allow_disk_use=allow_disk_use,
    )
    inst_model_dict = {key: val for key, val in cls().__dict__.items() if not callable(val) and not val.ignored}
    lang = translations.CURRENT_LOCALE
    async for mongo_doc in cursor:
        doc_list.append(
            mongo_doc_to_raw_doc(
                inst_model_dict,
                mongo_doc,
                lang,
            ),
        )
    return orjson.dumps(doc_list).decode("utf-8") if len(doc_list) > 0 else None

find_many_to_raw_docs(filter=None, projection=None, skip=0, limit=0, no_cursor_timeout=False, cursor_type=CursorType.NON_TAILABLE, sort=None, allow_partial_results=False, oplog_replay=False, batch_size=0, collation=None, hint=None, max_scan=None, max_time_ms=None, max=None, min=None, return_key=False, show_record_id=False, comment=None, session=None, allow_disk_use=None) async classmethod

Find documents and convert to a raw documents.

Special changes

_id to str password to None date to str datetime to str

Source code in src\ramifice\commons\many.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
@classmethod
async def find_many_to_raw_docs(
    cls,
    filter: Any | None = None,
    projection: Any | None = None,
    skip: int = 0,
    limit: int = 0,
    no_cursor_timeout: bool = False,
    cursor_type: int = CursorType.NON_TAILABLE,
    sort: Any | None = None,
    allow_partial_results: bool = False,
    oplog_replay: bool = False,
    batch_size: int = 0,
    collation: Any | None = None,
    hint: Any | None = None,
    max_scan: Any | None = None,
    max_time_ms: Any | None = None,
    max: Any | None = None,
    min: Any | None = None,
    return_key: bool = False,
    show_record_id: bool = False,
    comment: Any | None = None,
    session: Any | None = None,
    allow_disk_use: Any | None = None,
) -> list[dict[str, Any]]:
    """Find documents and convert to a raw documents.

    Special changes:
        _id to str
        password to None
        date to str
        datetime to str
    """
    # Get collection for current model.
    collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
    # Correcting filter.
    if filter is not None:
        filter = correct_mongo_filter(cls, filter)
    # Get documents.
    doc_list: list[dict[str, Any]] = []
    cursor: AsyncCursor = collection.find(
        filter=filter,
        projection=projection,
        skip=skip,
        limit=limit or cls.META["db_query_docs_limit"],
        no_cursor_timeout=no_cursor_timeout,
        cursor_type=cursor_type,
        sort=sort,
        allow_partial_results=allow_partial_results,
        oplog_replay=oplog_replay,
        batch_size=batch_size,
        collation=collation,
        hint=hint,
        max_scan=max_scan,
        max_time_ms=max_time_ms,
        max=max,
        min=min,
        return_key=return_key,
        show_record_id=show_record_id,
        comment=comment,
        session=session,
        allow_disk_use=allow_disk_use,
    )
    inst_model_dict = {key: val for key, val in cls().__dict__.items() if not callable(val) and not val.ignored}
    lang = translations.CURRENT_LOCALE
    async for mongo_doc in cursor:
        doc_list.append(
            mongo_doc_to_raw_doc(
                inst_model_dict,
                mongo_doc,
                lang,
            ),
        )
    return doc_list