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:: close
  13
  14    .. automethod:: get_path
  15
  16    .. automethod:: get_version
  17
  18    .. automethod:: needs_upgrade
  19
  20    .. automethod:: upgrade
  21
  22    .. automethod:: begin_atomic
  23
  24    .. automethod:: end_atomic
  25
  26    .. automethod:: get_directory
  27
  28    .. automethod:: index_file
  29
  30    .. automethod:: remove_message
  31
  32    .. automethod:: find_message
  33
  34    .. automethod:: find_message_by_filename
  35
  36    .. automethod:: get_all_tags
  37
  38    .. automethod:: create_query
  39
  40    .. automethod:: get_config
  41
  42    .. automethod:: get_configs
  43
  44    .. automethod:: set_config
  45
  46    .. attribute:: Database.MODE
  47
  48      Defines constants that are used as the mode in which to open a database.
  49
  50      MODE.READ_ONLY
  51        Open the database in read-only mode
  52
  53      MODE.READ_WRITE
  54        Open the database in read-write mode