summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2019-09-09 05:38:03 -0400
committerNed Batchelder <ned@nedbatchelder.com>2019-09-09 05:38:03 -0400
commit692a0fc2ad8bbd8a3c4009460783e49e9558605a (patch)
tree28b59ce810bbd404b56af971a033cdeee422ff02 /doc
parent0b27364b24aabbaf52dff3ad4842ec07971f9adb (diff)
downloadpython-coveragepy-git-692a0fc2ad8bbd8a3c4009460783e49e9558605a.tar.gz
A little more in the db schema docs
Diffstat (limited to 'doc')
-rw-r--r--doc/dbschema.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/dbschema.rst b/doc/dbschema.rst
index c57de92e..34f4a92e 100644
--- a/doc/dbschema.rst
+++ b/doc/dbschema.rst
@@ -14,6 +14,18 @@ For most needs, the :class:`.CoverageData` API will be sufficient, and should
be preferred to accessing the database directly. Only advanced uses will need
to use the database.
+The schema can change without changing the major version of coverage.py, so be
+careful when accessing the database directly. The `coverage_schema` table has
+the schema number of the database. The schema described here corresponds to:
+
+.. copied_from: coverage/sqldata.py
+
+.. code::
+
+ SCHEMA_VERSION = 7
+
+.. end_copied_from
+
You can use SQLite tools such as the :mod:`sqlite3 <python:sqlite3>` module in
the Python standard library to access the data. Some data is stored in a
packed format that will need custom functions to access. See