1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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
|
Working with Controllers and Repositories
-----------------------------------------
We've been working our way up the stack, starting with the database models, and now we
are ready to use the repository in an actual route. Let's see how we can use this in a
controller.
.. tip:: The full code for this tutorial can be found below in the :ref:`Full Code <03-repo-full-code>` section.
First, we create a simple function that returns an instance of ``AuthorRepository``.
This function will be used to inject a repository instance into our controller routes.
Note that we are only passing in the database session in this example with no other
parameters.
.. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_async_repository.py
:language: python
:caption: ``app.py``
:lines: 82-84
:linenos:
Because we'll be using the SQLAlchemy plugin in Litestar, the session is automatically
configured as a dependency.
By default, the repository doesn't add any additional query options to your base
statement, but provides the flexibility to override it, allowing you to pass your own
statement:
.. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_async_repository.py
:language: python
:caption: ``app.py``
:lines: 87-94
:linenos:
In this instance, we enhance the repository function by adding a ``selectinload``
option. This option configures the specified relationship to load via
`SELECT .. IN ...` loading pattern, optimizing the query execution.
Next, we define the ``AuthorController``. This controller exposes five routes for
interacting with the ``Author`` model:
.. dropdown:: ``AuthorController`` (click to toggle)
.. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_async_repository.py
:language: python
:caption: ``app.py``
:lines: 120-199
:linenos:
In our list detail endpoint, we use the pagination filter for limiting the amount of
data returned, allowing us to retrieve large datasets in smaller, more manageable chunks.
In the above examples, we've used the asynchronous repository implementation. However,
Litestar also supports synchronous database drivers with an identical implementation.
Here's a corresponding synchronous version of the previous example:
.. dropdown:: Synchronous Repository (click to toggle)
.. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_sync_repository.py
:language: python
:caption: ``app.py``
:linenos:
The examples above enable a feature-complete CRUD service that includes pagination! In
the next section, we'll explore how to extend the built-in repository to add additional
functionality to our application.
.. _03-repo-full-code:
Full Code
---------
.. dropdown:: Full Code (click to toggle)
.. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_async_repository.py
:language: python
:caption: ``app.py``
:emphasize-lines: 82-84, 87-94, 120-199
:linenos:
|
