fix: add --list-models
option for import/export commands
also rename the command decorators for consistency
This commit is contained in:
parent
7ee551d446
commit
15b2cb07ba
8 changed files with 230 additions and 47 deletions
31
docs/glossary.rst
Normal file
31
docs/glossary.rst
Normal file
|
@ -0,0 +1,31 @@
|
|||
.. _glossary:
|
||||
|
||||
Glossary
|
||||
========
|
||||
|
||||
.. glossary::
|
||||
:sorted:
|
||||
|
||||
import handler
|
||||
This a type of :term:`handler` which is responsible for a
|
||||
particular set of data import/export task(s).
|
||||
|
||||
The import handler manages data connections and transactions, and
|
||||
invokes one or more :term:`importers <importer>` to process the
|
||||
data.
|
||||
|
||||
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.
|
||||
|
||||
See also :term:`import handler` which can "contain" one or more
|
||||
importers.
|
||||
|
||||
Note that "importer/exporter" is the more proper term to use here
|
||||
but it is often shortened to just "importer" for convenience.
|
|
@ -22,6 +22,7 @@ database`, it may be used for any "source → target" data flow.
|
|||
:maxdepth: 2
|
||||
:caption: Documentation
|
||||
|
||||
glossary
|
||||
narr/install
|
||||
narr/cli
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue