docs

openapi/db/dbmodel.py

@@ -4,19 +4,26 @@
 from sqlalchemy.sql import and_
 
 from ..db.container import Database
+from ..types import Records
 from .compile import QueryType, Select, compile_query, count
 
 
 class CrudDB(Database):
     """A :class:`.Database` with additional methods for CRUD operations"""
 
-    async def db_select(self, table: Table, filters: Dict, *, conn=None, consumer=None):
+    async def db_select(
+        self, table: Table, filters: Dict, *, conn=None, consumer=None
+    ) -> Records:
+        """Select rows from a given table"""
         query = self.get_query(table, table.select(), consumer, filters)
         sql, args = compile_query(query)
         async with self.ensure_connection(conn) as conn:
             return await conn.fetch(sql, *args)
 
-    async def db_delete(self, table: Table, filters: Dict, *, conn=None, consumer=None):
+    async def db_delete(
+        self, table: Table, filters: Dict, *, conn=None, consumer=None
+    ) -> Records:
+        """Delete rows from a given table"""
         query = self.get_query(
             table, table.delete().returning(*table.columns), consumer, filters
         )

openapi/db/path.py

@@ -10,7 +10,7 @@
 from ..data.pagination import PaginatedData, Pagination
 from ..db.dbmodel import CrudDB
 from ..spec.path import ApiPath
-from ..types import DataType, SchemaTypeOrStr, StrDict
+from ..types import DataType, Records, SchemaTypeOrStr, StrDict
 from .compile import Select, Update, compile_query, count
 
 unique_regex = re.compile(r"Key \((?P<column>(\w+,? ?)+)\)=\((?P<value>.+)\)")
@@ -207,8 +207,8 @@ async def delete_one(
         table: Optional[sa.Table] = None,
         query_schema: SchemaTypeOrStr = "query_schema",
         conn: Optional[Connection] = None,
-    ):
-        """delete a single model
+    ) -> Records:
+        """Delete a single model
         """
         table = table if table is not None else self.db_table
         if filters is None:
@@ -225,7 +225,7 @@ async def delete_list(
         query: Optional[StrDict] = None,
         table: Optional[sa.Table] = None,
         conn: Optional[Connection] = None,
-    ):
+    ) -> Records:
         """delete multiple models
         """
         table = table if table is not None else self.db_table

openapi/types.py

@@ -1,4 +1,6 @@
 from typing import Any, Dict, List, Union
+
+from asyncpg import Record
 from multidict import MultiDict
 
 PrimitiveType = Union[int, float, bool, str]
@@ -9,3 +11,4 @@
 SchemaTypeOrStr = Union[str, SchemaType]
 StrDict = Dict[str, Any]
 QueryType = Union[StrDict, MultiDict]
+Records = List[Record]