diff options
| author | David Bremner <david@tethera.net> | 2025-02-15 15:30:43 -0400 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2025-02-22 07:01:47 -0400 |
| commit | d526797ad198e394bb8b4909f43976b76fb347f1 (patch) | |
| tree | b924eefb8a1278afb988387a67e9fe413738003e /contrib/python-legacy/docs/source/database.rst | |
| parent | 9782c8651192c1496541bd8949b7991c41528b3f (diff) | |
python: move legacy python bindings to contrib.
This forces us to verify the build and test suite completes without
the legacy python bindings.
As of this commit the legacy python bindings are unsupported by
notmuch. They are provided in contrib/ for now, but will most likely
eventually be removed from there as well. We recommend that
downstream/distro packagers phase out their packages for the legacy
python bindings.
Diffstat (limited to 'contrib/python-legacy/docs/source/database.rst')
| -rw-r--r-- | contrib/python-legacy/docs/source/database.rst | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/contrib/python-legacy/docs/source/database.rst b/contrib/python-legacy/docs/source/database.rst new file mode 100644 index 00000000..660de91d --- /dev/null +++ b/contrib/python-legacy/docs/source/database.rst @@ -0,0 +1,54 @@ +:class:`Database` -- The underlying notmuch database +==================================================== + +.. currentmodule:: notmuch + +.. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]]) + + .. automethod:: create + + .. automethod:: open(path, status=MODE.READ_ONLY) + + .. automethod:: close + + .. automethod:: get_path + + .. automethod:: get_version + + .. automethod:: needs_upgrade + + .. automethod:: upgrade + + .. automethod:: begin_atomic + + .. automethod:: end_atomic + + .. automethod:: get_directory + + .. automethod:: index_file + + .. automethod:: remove_message + + .. automethod:: find_message + + .. automethod:: find_message_by_filename + + .. automethod:: get_all_tags + + .. automethod:: create_query + + .. automethod:: get_config + + .. automethod:: get_configs + + .. automethod:: set_config + + .. attribute:: Database.MODE + + Defines constants that are used as the mode in which to open a database. + + MODE.READ_ONLY + Open the database in read-only mode + + MODE.READ_WRITE + Open the database in read-write mode |