diff options
| author | David Bremner <bremner@debian.org> | 2012-04-04 23:27:01 -0300 |
|---|---|---|
| committer | David Bremner <bremner@debian.org> | 2012-04-04 23:27:01 -0300 |
| commit | 4adefd4c497a1977db36317ed34c406565fb201d (patch) | |
| tree | 1d1d7c6cea688d8ef71f70a9a022165f60be3140 /bindings/python/docs/source/database.rst | |
| parent | 954cf155718a5a7576a7a578d836b76e15d312a4 (diff) | |
| parent | 331f0cac61802606e0103c35453656d2299cbfe3 (diff) | |
Merge tag 'debian/0.12-1' into squeeze-backports
notmuch Debian 0.12-1 upload (same as 0.12 + debian changelog fix)
Conflicts:
debian/changelog
Diffstat (limited to 'bindings/python/docs/source/database.rst')
| -rw-r--r-- | bindings/python/docs/source/database.rst | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/bindings/python/docs/source/database.rst b/bindings/python/docs/source/database.rst new file mode 100644 index 00000000..ee71085f --- /dev/null +++ b/bindings/python/docs/source/database.rst @@ -0,0 +1,48 @@ +: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:: get_path + + .. automethod:: get_version + + .. automethod:: needs_upgrade + + .. automethod:: upgrade + + .. automethod:: begin_atomic + + .. automethod:: end_atomic + + .. automethod:: get_directory + + .. automethod:: add_message + + .. automethod:: remove_message + + .. automethod:: find_message + + .. automethod:: find_message_by_filename + + .. automethod:: get_all_tags + + .. automethod:: create_query + + .. 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 + + .. autoattribute:: db_p |