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

   1 :class:`Query` -- A search query
   2 ================================
   3
   4 .. currentmodule:: notmuch
   5
   6 .. autoclass:: Query
   7
   8    .. automethod:: create
   9
  10    .. attribute:: Query.SORT
  11
  12      Defines constants that are used as the mode in which to open a database.
  13
  14      SORT.OLDEST_FIRST
  15        Sort by message date, oldest first.
  16
  17      SORT.NEWEST_FIRST
  18        Sort by message date, newest first.
  19
  20      SORT.MESSAGE_ID
  21        Sort by email message ID.
  22
  23      SORT.UNSORTED
  24        Do not apply a special sort order (returns results in document id
  25        order).
  26
  27    .. automethod:: set_sort
  28
  29    .. attribute::  sort
  30
  31       Instance attribute :attr:`sort` contains the sort order (see
  32       :attr:`Query.SORT`) if explicitly specified via
  33       :meth:`set_sort`. By default it is set to `None`.
  34
  35    .. automethod:: exclude_tag
  36
  37    .. automethod:: search_threads
  38
  39    .. automethod:: search_messages
  40
  41    .. automethod:: count_messages
  42
  43    .. automethod:: count_threads