跳转至

CRUDPlus API 参考

CRUDPlus 类是执行 CRUD 操作和关系查询的主要接口。

类定义

sqlalchemy_crud_plus.crud.CRUDPlus

Bases: Generic[Model]

Source code in sqlalchemy_crud_plus/crud.py
 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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
class CRUDPlus(Generic[Model]):
    def __init__(self, model: type[Model]):
        self.model = model
        self.primary_key = self._get_primary_key()

    def _get_primary_key(self) -> Column | list[Column]:
        """
        Dynamically retrieve the primary key column(s) for the model.
        """
        mapper = inspect(self.model)
        primary_key = mapper.primary_key
        if len(primary_key) == 1:
            return primary_key[0]
        else:
            return list(primary_key)

    def _get_pk_filter(self, pk: Any | Sequence[Any]) -> list[ColumnExpressionArgument[bool]]:
        """
        Get the primary key filter(s).

        :param pk: Single value for simple primary key, or tuple for composite primary key
        :return:
        """
        if isinstance(self.primary_key, list):
            if len(pk) != len(self.primary_key):
                raise CompositePrimaryKeysError(f'Expected {len(self.primary_key)} values for composite primary key')
            return [column == value for column, value in zip(self.primary_key, pk)]
        else:
            return [self.primary_key == pk]

    async def create_model(
        self,
        session: AsyncSession,
        obj: CreateSchema,
        flush: bool = False,
        commit: bool = False,
        **kwargs,
    ) -> Model:
        """
        Create a new instance of a model.

        :param session: The SQLAlchemy async session
        :param obj: The Pydantic schema containing data to be saved
        :param flush: If `True`, flush all object changes to the database
        :param commit: If `True`, commits the transaction immediately
        :param kwargs: Additional model data not included in the pydantic schema
        :return:
        """
        obj_data = obj.model_dump()
        if kwargs:
            obj_data.update(kwargs)

        ins = self.model(**obj_data)
        session.add(ins)

        if flush:
            await session.flush()
        if commit:
            await session.commit()

        return ins

    async def create_models(
        self,
        session: AsyncSession,
        objs: list[CreateSchema],
        flush: bool = False,
        commit: bool = False,
        **kwargs,
    ) -> list[Model]:
        """
        Create new instances of a model.

        :param session: The SQLAlchemy async session
        :param objs: The Pydantic schema list containing data to be saved
        :param flush: If `True`, flush all object changes to the database
        :param commit: If `True`, commits the transaction immediately
        :param kwargs: Additional model data not included in the pydantic schema
        :return:
        """
        ins_list = []
        for obj in objs:
            obj_data = obj.model_dump()
            if kwargs:
                obj_data.update(kwargs)
            ins = self.model(**obj_data)
            ins_list.append(ins)

        session.add_all(ins_list)

        if flush:
            await session.flush()
        if commit:
            await session.commit()

        return ins_list

    async def bulk_create_models(
        self,
        session: AsyncSession,
        objs: list[dict[str, Any]],
        render_nulls: bool = False,
        flush: bool = False,
        commit: bool = False,
        **kwargs,
    ) -> Sequence[Row[Any] | RowMapping | Any]:
        """
        Create new instances of a model.

        :param session: The SQLAlchemy async session
        :param objs: The dict list containing data to be saved,The dict data should be aligned with the model column
        :param render_nulls: render null values instead of ignoring them
        :param flush: If `True`, flush all object changes to the database
        :param commit: If `True`, commits the transaction immediately
        :param kwargs: Additional model data not included in the dict
        :return:
        """
        stmt = insert(self.model).values(**kwargs).execution_options(render_nulls=render_nulls).returning(self.model)
        result = await session.execute(stmt, objs)

        if flush:
            await session.flush()
        if commit:
            await session.commit()

        return result.scalars().all()

    async def count(
        self,
        session: AsyncSession,
        *whereclause: ColumnExpressionArgument[bool],
        join_conditions: JoinConditions | None = None,
        **kwargs,
    ) -> int:
        """
        Count records that match specified filters.

        :param session: SQLAlchemy async session
        :param whereclause: Additional WHERE clauses
        :param join_conditions: JOIN conditions for relationships
        :param kwargs: Filter expressions using field__operator=value syntax
        :return:
        """
        filters = list(whereclause)

        if kwargs:
            filters.extend(parse_filters(self.model, **kwargs))

        if isinstance(self.primary_key, list):
            stmt = select(func.count()).select_from(self.model)
        else:
            stmt = select(func.count(self.primary_key)).select_from(self.model)

        if filters:
            stmt = stmt.where(*filters)

        if join_conditions:
            stmt = apply_join_conditions(self.model, stmt, join_conditions)

        query = await session.execute(stmt)
        total_count = query.scalar()
        return total_count if total_count is not None else 0

    async def exists(
        self,
        session: AsyncSession,
        *whereclause: ColumnExpressionArgument[bool],
        join_conditions: JoinConditions | None = None,
        **kwargs,
    ) -> bool:
        """
        Check whether records that match the specified filters exist.

        :param session: SQLAlchemy async session
        :param whereclause: Additional WHERE clauses
        :param join_conditions: JOIN conditions for relationships
        :param kwargs: Filter expressions using field__operator=value syntax
        :return:
        """
        filters = list(whereclause)

        if kwargs:
            filters.extend(parse_filters(self.model, **kwargs))

        stmt = select(self.model).where(*filters).limit(1)

        if join_conditions:
            stmt = apply_join_conditions(self.model, stmt, join_conditions)

        query = await session.execute(stmt)
        return query.scalars().first() is not None

    async def select_model(
        self,
        session: AsyncSession,
        pk: Any | Sequence[Any],
        *whereclause: ColumnExpressionArgument[bool],
        load_options: LoadOptions | None = None,
        load_strategies: LoadStrategies | None = None,
        join_conditions: JoinConditions | None = None,
        **kwargs: Any,
    ) -> Model | None:
        """
        Query by primary key(s) with optional relationship loading and joins.

        :param session: SQLAlchemy async session
        :param pk: Primary key value(s) - single value or tuple for composite keys
        :param whereclause: Additional WHERE clauses
        :param load_options: SQLAlchemy loading options
        :param load_strategies: Relationship loading strategies
        :param join_conditions: JOIN conditions for relationships
        :param kwargs: Filter expressions using field__operator=value syntax
        :return:
        """
        filters = list(whereclause)
        filters.extend(self._get_pk_filter(pk))

        if kwargs:
            filters.extend(parse_filters(self.model, **kwargs))

        stmt = select(self.model).where(*filters)

        if load_options:
            stmt = stmt.options(*load_options)

        if join_conditions:
            stmt = apply_join_conditions(self.model, stmt, join_conditions)

        if load_strategies:
            rel_options = build_load_strategies(self.model, load_strategies)
            if rel_options:
                stmt = stmt.options(*rel_options)

        query = await session.execute(stmt)
        return query.scalars().first()

    async def select_model_by_column(
        self,
        session: AsyncSession,
        *whereclause: ColumnExpressionArgument[bool],
        load_options: LoadOptions | None = None,
        load_strategies: LoadStrategies | None = None,
        join_conditions: JoinConditions | None = None,
        **kwargs: Any,
    ) -> Model | None:
        """
        Query by column with optional relationship loading and joins.

        :param session: SQLAlchemy async session
        :param whereclause: Additional WHERE clauses
        :param load_options: SQLAlchemy loading options
        :param load_strategies: Relationship loading strategies
        :param join_conditions: JOIN conditions for relationships
        :param kwargs: Filter expressions using field__operator=value syntax
        :return:
        """
        stmt = await self.select(
            *whereclause,
            load_options=load_options,
            load_strategies=load_strategies,
            join_conditions=join_conditions,
            **kwargs,
        )

        query = await session.execute(stmt)
        return query.scalars().first()

    async def select(
        self,
        *whereclause: ColumnExpressionArgument[bool],
        load_options: LoadOptions | None = None,
        load_strategies: LoadStrategies | None = None,
        join_conditions: JoinConditions | None = None,
        **kwargs,
    ) -> Select:
        """
        Construct the SQLAlchemy selection.

        :param whereclause: WHERE clauses to apply to the query
        :param load_options: SQLAlchemy loading options
        :param load_strategies: Relationship loading strategies
        :param join_conditions: JOIN conditions for relationships
        :param kwargs: Query expressions
        :return:
        """
        filters = list(whereclause)
        filters.extend(parse_filters(self.model, **kwargs))
        stmt = select(self.model).where(*filters)

        if join_conditions:
            stmt = apply_join_conditions(self.model, stmt, join_conditions)

        if load_options:
            stmt = stmt.options(*load_options)

        if load_strategies:
            rel_options = build_load_strategies(self.model, load_strategies)
            if rel_options:
                stmt = stmt.options(*rel_options)

        return stmt

    async def select_order(
        self,
        sort_columns: SortColumns,
        sort_orders: SortOrders = None,
        *whereclause: ColumnExpressionArgument[bool],
        load_options: LoadOptions | None = None,
        load_strategies: LoadStrategies | None = None,
        join_conditions: JoinConditions | None = None,
        **kwargs: Any,
    ) -> Select:
        """
        Construct SQLAlchemy selection with sorting.

        :param sort_columns: Column names to sort by
        :param sort_orders: Sort orders ('asc' or 'desc')
        :param whereclause: WHERE clauses to apply to the query
        :param load_options: SQLAlchemy loading options
        :param load_strategies: Relationship loading strategies
        :param join_conditions: JOIN conditions for relationships
        :param kwargs: Query expressions
        :return:
        """
        stmt = await self.select(
            *whereclause,
            load_options=load_options,
            load_strategies=load_strategies,
            join_conditions=join_conditions,
            **kwargs,
        )
        sorted_stmt = apply_sorting(self.model, stmt, sort_columns, sort_orders)
        return sorted_stmt

    async def select_models(
        self,
        session: AsyncSession,
        *whereclause: ColumnExpressionArgument[bool],
        load_options: LoadOptions | None = None,
        load_strategies: LoadStrategies | None = None,
        join_conditions: JoinConditions | None = None,
        limit: int | None = None,
        offset: int | None = None,
        **kwargs: Any,
    ) -> Sequence[Model]:
        """
        Query all rows that match the specified filters with optional relationship loading and joins.

        :param session: SQLAlchemy async session
        :param whereclause: Additional WHERE clauses
        :param load_options: SQLAlchemy loading options
        :param load_strategies: Relationship loading strategies
        :param join_conditions: JOIN conditions for relationships
        :param limit: Maximum number of results to return
        :param offset: Number of results to skip
        :param kwargs: Filter expressions using field__operator=value syntax
        :return:
        """
        stmt = await self.select(
            *whereclause,
            load_options=load_options,
            load_strategies=load_strategies,
            join_conditions=join_conditions,
            **kwargs,
        )

        if limit is not None:
            stmt = stmt.limit(limit)
        if offset is not None:
            stmt = stmt.offset(offset)

        query = await session.execute(stmt)
        return query.scalars().all()

    async def select_models_order(
        self,
        session: AsyncSession,
        sort_columns: SortColumns,
        sort_orders: SortOrders = None,
        *whereclause: ColumnExpressionArgument[bool],
        load_options: LoadOptions | None = None,
        load_strategies: LoadStrategies | None = None,
        join_conditions: JoinConditions | None = None,
        limit: int | None = None,
        offset: int | None = None,
        **kwargs: Any,
    ) -> Sequence[Model]:
        """
        Query all rows that match the specified filters and sort by columns
        with optional relationship loading and joins.

        :param session: SQLAlchemy async session
        :param sort_columns: Column names to sort by
        :param sort_orders: Sort orders ('asc' or 'desc')
        :param whereclause: Additional WHERE clauses
        :param load_options: SQLAlchemy loading options
        :param load_strategies: Relationship loading strategies
        :param join_conditions: JOIN conditions for relationships
        :param limit: Maximum number of results to return
        :param offset: Number of results to skip
        :param kwargs: Filter expressions using field__operator=value syntax
        :return:
        """
        stmt = await self.select_order(
            sort_columns,
            sort_orders,
            *whereclause,
            load_options=load_options,
            load_strategies=load_strategies,
            join_conditions=join_conditions,
            **kwargs,
        )

        if limit is not None:
            stmt = stmt.limit(limit)
        if offset is not None:
            stmt = stmt.offset(offset)

        query = await session.execute(stmt)
        return query.scalars().all()

    async def update_model(
        self,
        session: AsyncSession,
        pk: Any | Sequence[Any],
        obj: UpdateSchema | dict[str, Any],
        flush: bool = False,
        commit: bool = False,
        **kwargs,
    ) -> int:
        """
        Update an instance by model's primary key

        :param session: The SQLAlchemy async session.
        :param pk: Single value for simple primary key, or tuple for composite primary key.
        :param obj: A pydantic schema or dictionary containing the update data
        :param flush: If `True`, flush all object changes to the database. Default is `False`.
        :param commit: If `True`, commits the transaction immediately. Default is `False`.
        :param kwargs: Additional model data not included in the pydantic schema.
        :return:
        """
        filters = self._get_pk_filter(pk)
        data = obj if isinstance(obj, dict) else obj.model_dump(exclude_unset=True)
        data.update(kwargs)
        stmt = update(self.model).where(*filters).values(**data)
        result = await session.execute(stmt)

        if flush:
            await session.flush()
        if commit:
            await session.commit()

        return result.rowcount

    async def update_model_by_column(
        self,
        session: AsyncSession,
        obj: UpdateSchema | dict[str, Any],
        allow_multiple: bool = False,
        flush: bool = False,
        commit: bool = False,
        **kwargs,
    ) -> int:
        """
        Update records by model column filters.

        :param session: The SQLAlchemy async session
        :param obj: A Pydantic schema or dictionary containing the update data
        :param allow_multiple: If `True`, allows updating multiple records that match the filters
        :param flush: If `True`, flush all object changes to the database
        :param commit: If `True`, commits the transaction immediately
        :param kwargs: Filter expressions using field__operator=value syntax
        :return:
        """
        filters = parse_filters(self.model, **kwargs)

        if not filters:
            raise ValueError('At least one filter condition must be provided for update operation')

        if not allow_multiple:
            total_count = await self.count(session, *filters)
            if total_count > 1:
                raise MultipleResultsError(f'Only one record is expected to be updated, found {total_count} records.')

        data = obj if isinstance(obj, dict) else obj.model_dump(exclude_unset=True)
        stmt = update(self.model).where(*filters).values(**data)
        result = await session.execute(stmt)

        if flush:
            await session.flush()
        if commit:
            await session.commit()

        return result.rowcount

    async def bulk_update_models(
        self,
        session: AsyncSession,
        objs: list[UpdateSchema | dict[str, Any]],
        pk_mode: bool = True,
        flush: bool = False,
        commit: bool = False,
        **kwargs,
    ) -> int:
        """
        Bulk update multiple instances with different data for each record.

        :param session: The SQLAlchemy async session
        :param objs: To save a list of Pydantic schemas or dict for data
        :param pk_mode: Primary key mode, when enabled, the data must contain the primary key data
        :param flush: If `True`, flush all object changes to the database
        :param commit: If `True`, commits the transaction immediately
        :param kwargs: Filter expressions using field__operator=value syntax
        :return:
        """
        if not pk_mode:
            filters = parse_filters(self.model, **kwargs)

            if not filters:
                raise ValueError('At least one filter condition must be provided for update operation')

            datas = [obj if isinstance(obj, dict) else obj.model_dump(exclude_unset=True) for obj in objs]
            stmt = update(self.model).where(*filters)
            conn = await session.connection()
            await conn.execute(stmt, datas)
        else:
            datas = [obj if isinstance(obj, dict) else obj.model_dump(exclude_unset=True) for obj in objs]
            await session.execute(update(self.model), datas)

        if flush:
            await session.flush()
        if commit:
            await session.commit()

        return len(datas)

    async def delete_model(
        self,
        session: AsyncSession,
        pk: Any | Sequence[Any],
        flush: bool = False,
        commit: bool = False,
    ) -> int:
        """
        Delete an instance by model's primary key

        :param session: The SQLAlchemy async session.
        :param pk: Single value for simple primary key, or tuple for composite primary key.
        :param flush: If `True`, flush all object changes to the database. Default is `False`.
        :param commit: If `True`, commits the transaction immediately. Default is `False`.
        :return:
        """
        filters = self._get_pk_filter(pk)

        stmt = delete(self.model).where(*filters)
        result = await session.execute(stmt)

        if flush:
            await session.flush()
        if commit:
            await session.commit()

        return result.rowcount

    async def delete_model_by_column(
        self,
        session: AsyncSession,
        allow_multiple: bool = False,
        logical_deletion: bool = False,
        deleted_flag_column: str = 'del_flag',
        flush: bool = False,
        commit: bool = False,
        **kwargs,
    ) -> int:
        """
        Delete records by model column filters.

        :param session: The SQLAlchemy async session
        :param allow_multiple: If `True`, allows deleting multiple records that match the filters
        :param logical_deletion: If `True`, enable logical deletion instead of physical deletion
        :param deleted_flag_column: Column name for logical deletion flag
        :param flush: If `True`, flush all object changes to the database
        :param commit: If `True`, commits the transaction immediately
        :param kwargs: Filter expressions using field__operator=value syntax
        :return:
        """
        if logical_deletion:
            if not hasattr(self.model, deleted_flag_column):
                raise ModelColumnError(f'Column {deleted_flag_column} is not found in {self.model}')

        filters = parse_filters(self.model, **kwargs)

        if not filters:
            raise ValueError('At least one filter condition must be provided for delete operation')

        if not allow_multiple:
            total_count = await self.count(session, *filters)
            if total_count > 1:
                raise MultipleResultsError(f'Only one record is expected to be deleted, found {total_count} records.')

        stmt = (
            update(self.model).where(*filters).values(**{deleted_flag_column: True})
            if logical_deletion
            else delete(self.model).where(*filters)
        )

        result = await session.execute(stmt)

        if flush:
            await session.flush()
        if commit:
            await session.commit()

        return result.rowcount

create_model async

create_model(session: AsyncSession, obj: CreateSchema, flush: bool = False, commit: bool = False, **kwargs) -> Model

Create a new instance of a model.

参数:

名称 类型 描述 默认
session AsyncSession

The SQLAlchemy async session

必需
obj CreateSchema

The Pydantic schema containing data to be saved

必需
flush bool

If True, flush all object changes to the database

False
commit bool

If True, commits the transaction immediately

False
kwargs

Additional model data not included in the pydantic schema

{}

返回:

类型 描述
Model
源代码位于: sqlalchemy_crud_plus/crud.py
async def create_model(
    self,
    session: AsyncSession,
    obj: CreateSchema,
    flush: bool = False,
    commit: bool = False,
    **kwargs,
) -> Model:
    """
    Create a new instance of a model.

    :param session: The SQLAlchemy async session
    :param obj: The Pydantic schema containing data to be saved
    :param flush: If `True`, flush all object changes to the database
    :param commit: If `True`, commits the transaction immediately
    :param kwargs: Additional model data not included in the pydantic schema
    :return:
    """
    obj_data = obj.model_dump()
    if kwargs:
        obj_data.update(kwargs)

    ins = self.model(**obj_data)
    session.add(ins)

    if flush:
        await session.flush()
    if commit:
        await session.commit()

    return ins

create_models async

create_models(session: AsyncSession, objs: list[CreateSchema], flush: bool = False, commit: bool = False, **kwargs) -> list[Model]

Create new instances of a model.

参数:

名称 类型 描述 默认
session AsyncSession

The SQLAlchemy async session

必需
objs list[CreateSchema]

The Pydantic schema list containing data to be saved

必需
flush bool

If True, flush all object changes to the database

False
commit bool

If True, commits the transaction immediately

False
kwargs

Additional model data not included in the pydantic schema

{}

返回:

类型 描述
list[Model]
源代码位于: sqlalchemy_crud_plus/crud.py
async def create_models(
    self,
    session: AsyncSession,
    objs: list[CreateSchema],
    flush: bool = False,
    commit: bool = False,
    **kwargs,
) -> list[Model]:
    """
    Create new instances of a model.

    :param session: The SQLAlchemy async session
    :param objs: The Pydantic schema list containing data to be saved
    :param flush: If `True`, flush all object changes to the database
    :param commit: If `True`, commits the transaction immediately
    :param kwargs: Additional model data not included in the pydantic schema
    :return:
    """
    ins_list = []
    for obj in objs:
        obj_data = obj.model_dump()
        if kwargs:
            obj_data.update(kwargs)
        ins = self.model(**obj_data)
        ins_list.append(ins)

    session.add_all(ins_list)

    if flush:
        await session.flush()
    if commit:
        await session.commit()

    return ins_list

bulk_create_models async

bulk_create_models(session: AsyncSession, objs: list[dict[str, Any]], render_nulls: bool = False, flush: bool = False, commit: bool = False, **kwargs) -> Sequence[Row[Any] | RowMapping | Any]

Create new instances of a model.

参数:

名称 类型 描述 默认
session AsyncSession

The SQLAlchemy async session

必需
objs list[dict[str, Any]]

The dict list containing data to be saved,The dict data should be aligned with the model column

必需
render_nulls bool

render null values instead of ignoring them

False
flush bool

If True, flush all object changes to the database

False
commit bool

If True, commits the transaction immediately

False
kwargs

Additional model data not included in the dict

{}

返回:

类型 描述
Sequence[Row[Any] | RowMapping | Any]
源代码位于: sqlalchemy_crud_plus/crud.py
async def bulk_create_models(
    self,
    session: AsyncSession,
    objs: list[dict[str, Any]],
    render_nulls: bool = False,
    flush: bool = False,
    commit: bool = False,
    **kwargs,
) -> Sequence[Row[Any] | RowMapping | Any]:
    """
    Create new instances of a model.

    :param session: The SQLAlchemy async session
    :param objs: The dict list containing data to be saved,The dict data should be aligned with the model column
    :param render_nulls: render null values instead of ignoring them
    :param flush: If `True`, flush all object changes to the database
    :param commit: If `True`, commits the transaction immediately
    :param kwargs: Additional model data not included in the dict
    :return:
    """
    stmt = insert(self.model).values(**kwargs).execution_options(render_nulls=render_nulls).returning(self.model)
    result = await session.execute(stmt, objs)

    if flush:
        await session.flush()
    if commit:
        await session.commit()

    return result.scalars().all()

count async

count(session: AsyncSession, *whereclause: ColumnExpressionArgument[bool], join_conditions: JoinConditions | None = None, **kwargs) -> int

Count records that match specified filters.

参数:

名称 类型 描述 默认
session AsyncSession

SQLAlchemy async session

必需
whereclause ColumnExpressionArgument[bool]

Additional WHERE clauses

()
join_conditions JoinConditions | None

JOIN conditions for relationships

None
kwargs

Filter expressions using field__operator=value syntax

{}

返回:

类型 描述
int
源代码位于: sqlalchemy_crud_plus/crud.py
async def count(
    self,
    session: AsyncSession,
    *whereclause: ColumnExpressionArgument[bool],
    join_conditions: JoinConditions | None = None,
    **kwargs,
) -> int:
    """
    Count records that match specified filters.

    :param session: SQLAlchemy async session
    :param whereclause: Additional WHERE clauses
    :param join_conditions: JOIN conditions for relationships
    :param kwargs: Filter expressions using field__operator=value syntax
    :return:
    """
    filters = list(whereclause)

    if kwargs:
        filters.extend(parse_filters(self.model, **kwargs))

    if isinstance(self.primary_key, list):
        stmt = select(func.count()).select_from(self.model)
    else:
        stmt = select(func.count(self.primary_key)).select_from(self.model)

    if filters:
        stmt = stmt.where(*filters)

    if join_conditions:
        stmt = apply_join_conditions(self.model, stmt, join_conditions)

    query = await session.execute(stmt)
    total_count = query.scalar()
    return total_count if total_count is not None else 0

exists async

exists(session: AsyncSession, *whereclause: ColumnExpressionArgument[bool], join_conditions: JoinConditions | None = None, **kwargs) -> bool

Check whether records that match the specified filters exist.

参数:

名称 类型 描述 默认
session AsyncSession

SQLAlchemy async session

必需
whereclause ColumnExpressionArgument[bool]

Additional WHERE clauses

()
join_conditions JoinConditions | None

JOIN conditions for relationships

None
kwargs

Filter expressions using field__operator=value syntax

{}

返回:

类型 描述
bool
源代码位于: sqlalchemy_crud_plus/crud.py
async def exists(
    self,
    session: AsyncSession,
    *whereclause: ColumnExpressionArgument[bool],
    join_conditions: JoinConditions | None = None,
    **kwargs,
) -> bool:
    """
    Check whether records that match the specified filters exist.

    :param session: SQLAlchemy async session
    :param whereclause: Additional WHERE clauses
    :param join_conditions: JOIN conditions for relationships
    :param kwargs: Filter expressions using field__operator=value syntax
    :return:
    """
    filters = list(whereclause)

    if kwargs:
        filters.extend(parse_filters(self.model, **kwargs))

    stmt = select(self.model).where(*filters).limit(1)

    if join_conditions:
        stmt = apply_join_conditions(self.model, stmt, join_conditions)

    query = await session.execute(stmt)
    return query.scalars().first() is not None

select_model async

select_model(session: AsyncSession, pk: Any | Sequence[Any], *whereclause: ColumnExpressionArgument[bool], load_options: LoadOptions | None = None, load_strategies: LoadStrategies | None = None, join_conditions: JoinConditions | None = None, **kwargs: Any) -> Model | None

Query by primary key(s) with optional relationship loading and joins.

参数:

名称 类型 描述 默认
session AsyncSession

SQLAlchemy async session

必需
pk Any | Sequence[Any]

Primary key value(s) - single value or tuple for composite keys

必需
whereclause ColumnExpressionArgument[bool]

Additional WHERE clauses

()
load_options LoadOptions | None

SQLAlchemy loading options

None
load_strategies LoadStrategies | None

Relationship loading strategies

None
join_conditions JoinConditions | None

JOIN conditions for relationships

None
kwargs Any

Filter expressions using field__operator=value syntax

{}

返回:

类型 描述
Model | None
源代码位于: sqlalchemy_crud_plus/crud.py
async def select_model(
    self,
    session: AsyncSession,
    pk: Any | Sequence[Any],
    *whereclause: ColumnExpressionArgument[bool],
    load_options: LoadOptions | None = None,
    load_strategies: LoadStrategies | None = None,
    join_conditions: JoinConditions | None = None,
    **kwargs: Any,
) -> Model | None:
    """
    Query by primary key(s) with optional relationship loading and joins.

    :param session: SQLAlchemy async session
    :param pk: Primary key value(s) - single value or tuple for composite keys
    :param whereclause: Additional WHERE clauses
    :param load_options: SQLAlchemy loading options
    :param load_strategies: Relationship loading strategies
    :param join_conditions: JOIN conditions for relationships
    :param kwargs: Filter expressions using field__operator=value syntax
    :return:
    """
    filters = list(whereclause)
    filters.extend(self._get_pk_filter(pk))

    if kwargs:
        filters.extend(parse_filters(self.model, **kwargs))

    stmt = select(self.model).where(*filters)

    if load_options:
        stmt = stmt.options(*load_options)

    if join_conditions:
        stmt = apply_join_conditions(self.model, stmt, join_conditions)

    if load_strategies:
        rel_options = build_load_strategies(self.model, load_strategies)
        if rel_options:
            stmt = stmt.options(*rel_options)

    query = await session.execute(stmt)
    return query.scalars().first()

select_model_by_column async

select_model_by_column(session: AsyncSession, *whereclause: ColumnExpressionArgument[bool], load_options: LoadOptions | None = None, load_strategies: LoadStrategies | None = None, join_conditions: JoinConditions | None = None, **kwargs: Any) -> Model | None

Query by column with optional relationship loading and joins.

参数:

名称 类型 描述 默认
session AsyncSession

SQLAlchemy async session

必需
whereclause ColumnExpressionArgument[bool]

Additional WHERE clauses

()
load_options LoadOptions | None

SQLAlchemy loading options

None
load_strategies LoadStrategies | None

Relationship loading strategies

None
join_conditions JoinConditions | None

JOIN conditions for relationships

None
kwargs Any

Filter expressions using field__operator=value syntax

{}

返回:

类型 描述
Model | None
源代码位于: sqlalchemy_crud_plus/crud.py
async def select_model_by_column(
    self,
    session: AsyncSession,
    *whereclause: ColumnExpressionArgument[bool],
    load_options: LoadOptions | None = None,
    load_strategies: LoadStrategies | None = None,
    join_conditions: JoinConditions | None = None,
    **kwargs: Any,
) -> Model | None:
    """
    Query by column with optional relationship loading and joins.

    :param session: SQLAlchemy async session
    :param whereclause: Additional WHERE clauses
    :param load_options: SQLAlchemy loading options
    :param load_strategies: Relationship loading strategies
    :param join_conditions: JOIN conditions for relationships
    :param kwargs: Filter expressions using field__operator=value syntax
    :return:
    """
    stmt = await self.select(
        *whereclause,
        load_options=load_options,
        load_strategies=load_strategies,
        join_conditions=join_conditions,
        **kwargs,
    )

    query = await session.execute(stmt)
    return query.scalars().first()

select async

select(*whereclause: ColumnExpressionArgument[bool], load_options: LoadOptions | None = None, load_strategies: LoadStrategies | None = None, join_conditions: JoinConditions | None = None, **kwargs) -> Select

Construct the SQLAlchemy selection.

参数:

名称 类型 描述 默认
whereclause ColumnExpressionArgument[bool]

WHERE clauses to apply to the query

()
load_options LoadOptions | None

SQLAlchemy loading options

None
load_strategies LoadStrategies | None

Relationship loading strategies

None
join_conditions JoinConditions | None

JOIN conditions for relationships

None
kwargs

Query expressions

{}

返回:

类型 描述
Select
源代码位于: sqlalchemy_crud_plus/crud.py
async def select(
    self,
    *whereclause: ColumnExpressionArgument[bool],
    load_options: LoadOptions | None = None,
    load_strategies: LoadStrategies | None = None,
    join_conditions: JoinConditions | None = None,
    **kwargs,
) -> Select:
    """
    Construct the SQLAlchemy selection.

    :param whereclause: WHERE clauses to apply to the query
    :param load_options: SQLAlchemy loading options
    :param load_strategies: Relationship loading strategies
    :param join_conditions: JOIN conditions for relationships
    :param kwargs: Query expressions
    :return:
    """
    filters = list(whereclause)
    filters.extend(parse_filters(self.model, **kwargs))
    stmt = select(self.model).where(*filters)

    if join_conditions:
        stmt = apply_join_conditions(self.model, stmt, join_conditions)

    if load_options:
        stmt = stmt.options(*load_options)

    if load_strategies:
        rel_options = build_load_strategies(self.model, load_strategies)
        if rel_options:
            stmt = stmt.options(*rel_options)

    return stmt

select_order async

select_order(sort_columns: SortColumns, sort_orders: SortOrders = None, *whereclause: ColumnExpressionArgument[bool], load_options: LoadOptions | None = None, load_strategies: LoadStrategies | None = None, join_conditions: JoinConditions | None = None, **kwargs: Any) -> Select

Construct SQLAlchemy selection with sorting.

参数:

名称 类型 描述 默认
sort_columns SortColumns

Column names to sort by

必需
sort_orders SortOrders

Sort orders ('asc' or 'desc')

None
whereclause ColumnExpressionArgument[bool]

WHERE clauses to apply to the query

()
load_options LoadOptions | None

SQLAlchemy loading options

None
load_strategies LoadStrategies | None

Relationship loading strategies

None
join_conditions JoinConditions | None

JOIN conditions for relationships

None
kwargs Any

Query expressions

{}

返回:

类型 描述
Select
源代码位于: sqlalchemy_crud_plus/crud.py
async def select_order(
    self,
    sort_columns: SortColumns,
    sort_orders: SortOrders = None,
    *whereclause: ColumnExpressionArgument[bool],
    load_options: LoadOptions | None = None,
    load_strategies: LoadStrategies | None = None,
    join_conditions: JoinConditions | None = None,
    **kwargs: Any,
) -> Select:
    """
    Construct SQLAlchemy selection with sorting.

    :param sort_columns: Column names to sort by
    :param sort_orders: Sort orders ('asc' or 'desc')
    :param whereclause: WHERE clauses to apply to the query
    :param load_options: SQLAlchemy loading options
    :param load_strategies: Relationship loading strategies
    :param join_conditions: JOIN conditions for relationships
    :param kwargs: Query expressions
    :return:
    """
    stmt = await self.select(
        *whereclause,
        load_options=load_options,
        load_strategies=load_strategies,
        join_conditions=join_conditions,
        **kwargs,
    )
    sorted_stmt = apply_sorting(self.model, stmt, sort_columns, sort_orders)
    return sorted_stmt

select_models async

select_models(session: AsyncSession, *whereclause: ColumnExpressionArgument[bool], load_options: LoadOptions | None = None, load_strategies: LoadStrategies | None = None, join_conditions: JoinConditions | None = None, limit: int | None = None, offset: int | None = None, **kwargs: Any) -> Sequence[Model]

Query all rows that match the specified filters with optional relationship loading and joins.

参数:

名称 类型 描述 默认
session AsyncSession

SQLAlchemy async session

必需
whereclause ColumnExpressionArgument[bool]

Additional WHERE clauses

()
load_options LoadOptions | None

SQLAlchemy loading options

None
load_strategies LoadStrategies | None

Relationship loading strategies

None
join_conditions JoinConditions | None

JOIN conditions for relationships

None
limit int | None

Maximum number of results to return

None
offset int | None

Number of results to skip

None
kwargs Any

Filter expressions using field__operator=value syntax

{}

返回:

类型 描述
Sequence[Model]
源代码位于: sqlalchemy_crud_plus/crud.py
async def select_models(
    self,
    session: AsyncSession,
    *whereclause: ColumnExpressionArgument[bool],
    load_options: LoadOptions | None = None,
    load_strategies: LoadStrategies | None = None,
    join_conditions: JoinConditions | None = None,
    limit: int | None = None,
    offset: int | None = None,
    **kwargs: Any,
) -> Sequence[Model]:
    """
    Query all rows that match the specified filters with optional relationship loading and joins.

    :param session: SQLAlchemy async session
    :param whereclause: Additional WHERE clauses
    :param load_options: SQLAlchemy loading options
    :param load_strategies: Relationship loading strategies
    :param join_conditions: JOIN conditions for relationships
    :param limit: Maximum number of results to return
    :param offset: Number of results to skip
    :param kwargs: Filter expressions using field__operator=value syntax
    :return:
    """
    stmt = await self.select(
        *whereclause,
        load_options=load_options,
        load_strategies=load_strategies,
        join_conditions=join_conditions,
        **kwargs,
    )

    if limit is not None:
        stmt = stmt.limit(limit)
    if offset is not None:
        stmt = stmt.offset(offset)

    query = await session.execute(stmt)
    return query.scalars().all()

select_models_order async

select_models_order(session: AsyncSession, sort_columns: SortColumns, sort_orders: SortOrders = None, *whereclause: ColumnExpressionArgument[bool], load_options: LoadOptions | None = None, load_strategies: LoadStrategies | None = None, join_conditions: JoinConditions | None = None, limit: int | None = None, offset: int | None = None, **kwargs: Any) -> Sequence[Model]

Query all rows that match the specified filters and sort by columns with optional relationship loading and joins.

参数:

名称 类型 描述 默认
session AsyncSession

SQLAlchemy async session

必需
sort_columns SortColumns

Column names to sort by

必需
sort_orders SortOrders

Sort orders ('asc' or 'desc')

None
whereclause ColumnExpressionArgument[bool]

Additional WHERE clauses

()
load_options LoadOptions | None

SQLAlchemy loading options

None
load_strategies LoadStrategies | None

Relationship loading strategies

None
join_conditions JoinConditions | None

JOIN conditions for relationships

None
limit int | None

Maximum number of results to return

None
offset int | None

Number of results to skip

None
kwargs Any

Filter expressions using field__operator=value syntax

{}

返回:

类型 描述
Sequence[Model]
源代码位于: sqlalchemy_crud_plus/crud.py
async def select_models_order(
    self,
    session: AsyncSession,
    sort_columns: SortColumns,
    sort_orders: SortOrders = None,
    *whereclause: ColumnExpressionArgument[bool],
    load_options: LoadOptions | None = None,
    load_strategies: LoadStrategies | None = None,
    join_conditions: JoinConditions | None = None,
    limit: int | None = None,
    offset: int | None = None,
    **kwargs: Any,
) -> Sequence[Model]:
    """
    Query all rows that match the specified filters and sort by columns
    with optional relationship loading and joins.

    :param session: SQLAlchemy async session
    :param sort_columns: Column names to sort by
    :param sort_orders: Sort orders ('asc' or 'desc')
    :param whereclause: Additional WHERE clauses
    :param load_options: SQLAlchemy loading options
    :param load_strategies: Relationship loading strategies
    :param join_conditions: JOIN conditions for relationships
    :param limit: Maximum number of results to return
    :param offset: Number of results to skip
    :param kwargs: Filter expressions using field__operator=value syntax
    :return:
    """
    stmt = await self.select_order(
        sort_columns,
        sort_orders,
        *whereclause,
        load_options=load_options,
        load_strategies=load_strategies,
        join_conditions=join_conditions,
        **kwargs,
    )

    if limit is not None:
        stmt = stmt.limit(limit)
    if offset is not None:
        stmt = stmt.offset(offset)

    query = await session.execute(stmt)
    return query.scalars().all()

update_model async

update_model(session: AsyncSession, pk: Any | Sequence[Any], obj: UpdateSchema | dict[str, Any], flush: bool = False, commit: bool = False, **kwargs) -> int

Update an instance by model's primary key

参数:

名称 类型 描述 默认
session AsyncSession

The SQLAlchemy async session.

必需
pk Any | Sequence[Any]

Single value for simple primary key, or tuple for composite primary key.

必需
obj UpdateSchema | dict[str, Any]

A pydantic schema or dictionary containing the update data

必需
flush bool

If True, flush all object changes to the database. Default is False.

False
commit bool

If True, commits the transaction immediately. Default is False.

False
kwargs

Additional model data not included in the pydantic schema.

{}

返回:

类型 描述
int
源代码位于: sqlalchemy_crud_plus/crud.py
async def update_model(
    self,
    session: AsyncSession,
    pk: Any | Sequence[Any],
    obj: UpdateSchema | dict[str, Any],
    flush: bool = False,
    commit: bool = False,
    **kwargs,
) -> int:
    """
    Update an instance by model's primary key

    :param session: The SQLAlchemy async session.
    :param pk: Single value for simple primary key, or tuple for composite primary key.
    :param obj: A pydantic schema or dictionary containing the update data
    :param flush: If `True`, flush all object changes to the database. Default is `False`.
    :param commit: If `True`, commits the transaction immediately. Default is `False`.
    :param kwargs: Additional model data not included in the pydantic schema.
    :return:
    """
    filters = self._get_pk_filter(pk)
    data = obj if isinstance(obj, dict) else obj.model_dump(exclude_unset=True)
    data.update(kwargs)
    stmt = update(self.model).where(*filters).values(**data)
    result = await session.execute(stmt)

    if flush:
        await session.flush()
    if commit:
        await session.commit()

    return result.rowcount

update_model_by_column async

update_model_by_column(session: AsyncSession, obj: UpdateSchema | dict[str, Any], allow_multiple: bool = False, flush: bool = False, commit: bool = False, **kwargs) -> int

Update records by model column filters.

参数:

名称 类型 描述 默认
session AsyncSession

The SQLAlchemy async session

必需
obj UpdateSchema | dict[str, Any]

A Pydantic schema or dictionary containing the update data

必需
allow_multiple bool

If True, allows updating multiple records that match the filters

False
flush bool

If True, flush all object changes to the database

False
commit bool

If True, commits the transaction immediately

False
kwargs

Filter expressions using field__operator=value syntax

{}

返回:

类型 描述
int
源代码位于: sqlalchemy_crud_plus/crud.py
async def update_model_by_column(
    self,
    session: AsyncSession,
    obj: UpdateSchema | dict[str, Any],
    allow_multiple: bool = False,
    flush: bool = False,
    commit: bool = False,
    **kwargs,
) -> int:
    """
    Update records by model column filters.

    :param session: The SQLAlchemy async session
    :param obj: A Pydantic schema or dictionary containing the update data
    :param allow_multiple: If `True`, allows updating multiple records that match the filters
    :param flush: If `True`, flush all object changes to the database
    :param commit: If `True`, commits the transaction immediately
    :param kwargs: Filter expressions using field__operator=value syntax
    :return:
    """
    filters = parse_filters(self.model, **kwargs)

    if not filters:
        raise ValueError('At least one filter condition must be provided for update operation')

    if not allow_multiple:
        total_count = await self.count(session, *filters)
        if total_count > 1:
            raise MultipleResultsError(f'Only one record is expected to be updated, found {total_count} records.')

    data = obj if isinstance(obj, dict) else obj.model_dump(exclude_unset=True)
    stmt = update(self.model).where(*filters).values(**data)
    result = await session.execute(stmt)

    if flush:
        await session.flush()
    if commit:
        await session.commit()

    return result.rowcount

bulk_update_models async

bulk_update_models(session: AsyncSession, objs: list[UpdateSchema | dict[str, Any]], pk_mode: bool = True, flush: bool = False, commit: bool = False, **kwargs) -> int

Bulk update multiple instances with different data for each record.

参数:

名称 类型 描述 默认
session AsyncSession

The SQLAlchemy async session

必需
objs list[UpdateSchema | dict[str, Any]]

To save a list of Pydantic schemas or dict for data

必需
pk_mode bool

Primary key mode, when enabled, the data must contain the primary key data

True
flush bool

If True, flush all object changes to the database

False
commit bool

If True, commits the transaction immediately

False
kwargs

Filter expressions using field__operator=value syntax

{}

返回:

类型 描述
int
源代码位于: sqlalchemy_crud_plus/crud.py
async def bulk_update_models(
    self,
    session: AsyncSession,
    objs: list[UpdateSchema | dict[str, Any]],
    pk_mode: bool = True,
    flush: bool = False,
    commit: bool = False,
    **kwargs,
) -> int:
    """
    Bulk update multiple instances with different data for each record.

    :param session: The SQLAlchemy async session
    :param objs: To save a list of Pydantic schemas or dict for data
    :param pk_mode: Primary key mode, when enabled, the data must contain the primary key data
    :param flush: If `True`, flush all object changes to the database
    :param commit: If `True`, commits the transaction immediately
    :param kwargs: Filter expressions using field__operator=value syntax
    :return:
    """
    if not pk_mode:
        filters = parse_filters(self.model, **kwargs)

        if not filters:
            raise ValueError('At least one filter condition must be provided for update operation')

        datas = [obj if isinstance(obj, dict) else obj.model_dump(exclude_unset=True) for obj in objs]
        stmt = update(self.model).where(*filters)
        conn = await session.connection()
        await conn.execute(stmt, datas)
    else:
        datas = [obj if isinstance(obj, dict) else obj.model_dump(exclude_unset=True) for obj in objs]
        await session.execute(update(self.model), datas)

    if flush:
        await session.flush()
    if commit:
        await session.commit()

    return len(datas)

delete_model async

delete_model(session: AsyncSession, pk: Any | Sequence[Any], flush: bool = False, commit: bool = False) -> int

Delete an instance by model's primary key

参数:

名称 类型 描述 默认
session AsyncSession

The SQLAlchemy async session.

必需
pk Any | Sequence[Any]

Single value for simple primary key, or tuple for composite primary key.

必需
flush bool

If True, flush all object changes to the database. Default is False.

False
commit bool

If True, commits the transaction immediately. Default is False.

False

返回:

类型 描述
int
源代码位于: sqlalchemy_crud_plus/crud.py
async def delete_model(
    self,
    session: AsyncSession,
    pk: Any | Sequence[Any],
    flush: bool = False,
    commit: bool = False,
) -> int:
    """
    Delete an instance by model's primary key

    :param session: The SQLAlchemy async session.
    :param pk: Single value for simple primary key, or tuple for composite primary key.
    :param flush: If `True`, flush all object changes to the database. Default is `False`.
    :param commit: If `True`, commits the transaction immediately. Default is `False`.
    :return:
    """
    filters = self._get_pk_filter(pk)

    stmt = delete(self.model).where(*filters)
    result = await session.execute(stmt)

    if flush:
        await session.flush()
    if commit:
        await session.commit()

    return result.rowcount

delete_model_by_column async

delete_model_by_column(session: AsyncSession, allow_multiple: bool = False, logical_deletion: bool = False, deleted_flag_column: str = 'del_flag', flush: bool = False, commit: bool = False, **kwargs) -> int

Delete records by model column filters.

参数:

名称 类型 描述 默认
session AsyncSession

The SQLAlchemy async session

必需
allow_multiple bool

If True, allows deleting multiple records that match the filters

False
logical_deletion bool

If True, enable logical deletion instead of physical deletion

False
deleted_flag_column str

Column name for logical deletion flag

'del_flag'
flush bool

If True, flush all object changes to the database

False
commit bool

If True, commits the transaction immediately

False
kwargs

Filter expressions using field__operator=value syntax

{}

返回:

类型 描述
int
源代码位于: sqlalchemy_crud_plus/crud.py
async def delete_model_by_column(
    self,
    session: AsyncSession,
    allow_multiple: bool = False,
    logical_deletion: bool = False,
    deleted_flag_column: str = 'del_flag',
    flush: bool = False,
    commit: bool = False,
    **kwargs,
) -> int:
    """
    Delete records by model column filters.

    :param session: The SQLAlchemy async session
    :param allow_multiple: If `True`, allows deleting multiple records that match the filters
    :param logical_deletion: If `True`, enable logical deletion instead of physical deletion
    :param deleted_flag_column: Column name for logical deletion flag
    :param flush: If `True`, flush all object changes to the database
    :param commit: If `True`, commits the transaction immediately
    :param kwargs: Filter expressions using field__operator=value syntax
    :return:
    """
    if logical_deletion:
        if not hasattr(self.model, deleted_flag_column):
            raise ModelColumnError(f'Column {deleted_flag_column} is not found in {self.model}')

    filters = parse_filters(self.model, **kwargs)

    if not filters:
        raise ValueError('At least one filter condition must be provided for delete operation')

    if not allow_multiple:
        total_count = await self.count(session, *filters)
        if total_count > 1:
            raise MultipleResultsError(f'Only one record is expected to be deleted, found {total_count} records.')

    stmt = (
        update(self.model).where(*filters).values(**{deleted_flag_column: True})
        if logical_deletion
        else delete(self.model).where(*filters)
    )

    result = await session.execute(stmt)

    if flush:
        await session.flush()
    if commit:
        await session.commit()

    return result.rowcount