mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-12-29 12:51:43 +01:00
ca1e232e5f
Put a prominent warning into the docstring of Database.close, make the function show up in the sphinx doc and refer to the warning in the paragraph mentioning the context manager protocol. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
50 lines
1,020 B
ReStructuredText
50 lines
1,020 B
ReStructuredText
: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:: 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
|