wutta/wuttjamaican
3
0
Fork 0
Code Issues Activity

docs: improve docs relating to app db, setup thereof

Browse source
This commit is contained in:
Lance Edgar 2024-12-08 12:19:42 -06:00
parent d70df11be6
commit 45ea5c5bdc
9 changed files with 241 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/glossary.rst
View file

@ -18,7 +18,10 @@ Glossary
The main :term:`database` used by the :term:`app`. There is
normally just one database (for simple apps) which uses
PostgreSQL for the backend. The app database contains the
:term:`settings table`.
:term:`settings table` as well as :term:`data models <data
model>`.
For more info see :doc:`narr/db/app`.
app dir
Folder containing app-specific config files, log files, etc.
@ -112,6 +115,10 @@ Glossary
data model
Usually, a Python class which maps to a :term:`database` table.
The :term:`app` (assuming it has an :term:`app database`) will
have an "official" set of data models, represented as the
:term:`app model`.
database
Generally refers to a relational database which may be queried
using SQL. More specifically, one supported by `SQLAlchemy`_.
@ -119,7 +126,7 @@ Glossary
.. _SQLAlchemy: https://www.sqlalchemy.org
Most :term:`apps<app>` will have at least one :term:`app
database`.
database`. See also :doc:`narr/db/index`.
db session
The "session" is a SQLAlchemy abstraction for an open database