wutta/wuttjamaican
3
0
Fork 0
Code Issues Activity

Add basic database docs

Browse source
This commit is contained in:
Lance Edgar 2023-11-24 19:14:48 -06:00
parent b59e83907c
commit 64af49ffdf
7 changed files with 167 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/glossary.rst
View file

@ -15,9 +15,10 @@ Glossary
overall, or the :term:`app name`, or the :term:`app handler`.
app database
The main database used by the :term:`app`. There is normally
just one database (for simple apps) which uses PostgreSQL for the
backend.
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`.
app dir
Folder containing app-specific config files, log files, etc.
@ -74,6 +75,15 @@ Glossary
values obtained from the :term:`settings table` as opposed to
:term:`config file`. See also :doc:`narr/config/settings`.
database
Generally refers to a relational database which may be queried
using SQL. More specifically, one supported by `SQLAlchemy`_.
.. _SQLAlchemy: https://www.sqlalchemy.org
Most :term:`apps<app>` will have at least one :term:`app
database`.
entry point
This refers to a "setuptools-style" entry point specifically,
which is a mechanism used to register "plugins" and the like.