diff --git a/.gitignore b/.gitignore index 4d174aa..4a82c50 100644 --- a/.gitignore +++ b/.gitignore @@ -1,19 +1,10 @@ -# Editor temporary files and local virtual environment. *.swp *~ /.ve -# Python caches. __pycache__ /.pytest_cache -# Coverage and documentation. -/.coverage* +/.coverage /htmlcov /docs/_build -# Kingfisher /.env -/error.log -/info.log -# SchemaSpy -/postgresql.jar -/schemaspy.jar /schemaspy diff --git a/docs/_static/erd.png b/docs/_static/erd.png index e34f56a..87004ac 100644 Binary files a/docs/_static/erd.png and b/docs/_static/erd.png differ diff --git a/docs/database.rst b/docs/database.rst index b218e47..dbec87f 100644 --- a/docs/database.rst +++ b/docs/database.rst @@ -40,8 +40,8 @@ If the ``release_type`` is "record", then the record's ``compiledRelease`` field Foreign key relationships exist on all `tables `__ (but not `views `__) within a schema, as shown in the Entity Relationship Diagram (click on the image and zoom in to read more easily). -.. image:: _static/erd.png - :target: _static/erd.png +.. image:: _static/relationships.real.compact.png + :target: _static/relationships.real.compact.png This diagram can help to identify JOIN conditions. For example, all tables can be joined with the ``release_summary_no_data`` and ``release_summary`` tables on the ``id`` column. diff --git a/docs/develop/howtos.rst b/docs/develop/howtos.rst index b7f464e..cc2b44b 100644 --- a/docs/develop/howtos.rst +++ b/docs/develop/howtos.rst @@ -66,4 +66,9 @@ Add a schema with the ``--tables-only`` option: ./manage.py add 123 diagram --tables-only -`Use SchemaSpy `__ to generate a diagram, copying the output to ``docs/_static/erd.png``. +Then, `update `__ the :ref:`erd`. For example: + +.. code-block:: bash + + java -jar schemaspy.jar -t pgsql -dp postgresql.jar -o schemaspy -norows -host localhost -db kingfisher_summarize -s summary_collection_1 -u MYUSER + mv schemaspy/diagrams/summary/relationships.real.compact.png docs/_static/