wutta/wuttasync
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add some narrative docs to explain basic concepts

Browse source 
still needs a lot of work i'm sure..gotta start somewhere
This commit is contained in:
Lance Edgar 2024-12-07 18:14:11 -06:00
parent ba8f57ddc1
commit b3e4e91df8
11 changed files with 522 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/glossary.rst
View file

@ -12,20 +12,19 @@ Glossary
The import handler manages data connections and transactions, and
invokes one or more :term:`importers <importer>` to process the
data.
data. See also :ref:`import-handler-vs-importer`.
Note that "import/export handler" is the more proper term to use
here but it is often shortened to just "import handler" for
convenience.
importer
In the context of WuttaSync, this refers to a type of object
which can process data for an import/export job, i.e. create,
update or delete records on the "target" based on the "source"
data it reads.
This refers to a Python class/instance responsible for processing
a particular :term:`data model` for an import/export job.
See also :term:`import handler` which can "contain" one or more
importers.
For instance there is usually one importer per table, when
importing to the :term:`app database` (regardless of source).
See also :ref:`import-handler-vs-importer`.
Note that "importer/exporter" is the more proper term to use here
but it is often shortened to just "importer" for convenience.