git.notmuchmail.org Git - notmuch/blob - bindings/python/docs/source/database.rst

   1 :class:`Database` -- The underlying notmuch database
   2 ====================================================
   3
   4 .. currentmodule:: notmuch
   5
   6 .. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
   7
   8    .. automethod:: create
   9
  10    .. automethod:: open(path, status=MODE.READ_ONLY)
  11
  12    .. automethod:: get_path
  13
  14    .. automethod:: get_version
  15
  16    .. automethod:: needs_upgrade
  17
  18    .. automethod:: upgrade
  19
  20    .. automethod:: begin_atomic
  21
  22    .. automethod:: end_atomic
  23
  24    .. automethod:: get_directory
  25
  26    .. automethod:: add_message
  27
  28    .. automethod:: remove_message
  29
  30    .. automethod:: find_message
  31
  32    .. automethod:: find_message_by_filename
  33
  34    .. automethod:: get_all_tags
  35
  36    .. automethod:: create_query
  37
  38    .. attribute:: Database.MODE
  39
  40      Defines constants that are used as the mode in which to open a database.
  41
  42      MODE.READ_ONLY
  43        Open the database in read-only mode
  44
  45      MODE.READ_WRITE
  46        Open the database in read-write mode
  47
  48    .. autoattribute:: db_p