doveadm-fts(1)

1DOVEADM-FTS(1)                      Dovecot                     DOVEADM-FTS(1)
2
3
4

NAME

6       doveadm-fts - Manipulate the Full Text Search (FTS) index
7

SYNOPSIS

9       doveadm [-Dv] fts command [OPTIONS] [ARGUMENTS]
10

DESCRIPTION

12       The doveadm fts COMMANDS can be used to manipulate the Full Text Search
13       (FTS) index.
14

OPTIONS

16       Global doveadm(1) options:
17
18       -D     Enables verbosity and debug messages.
19
20       -o setting=value
21              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
22              cot.conf  and from the userdb with the given value.  In order to
23              override multiple settings, the -o option may be specified  mul‐
24              tiple times.
25
26       -v     Enables verbosity, including progress counter.
27
28       This  command  uses  by  default the output formatter flow (without the
29       key= prefix).
30
31       Command specific options:
32
33       -A     If the -A option is present, the command will be  performed  for
34              all  users.   Using this option in combination with system users
35              from userdb { driver = passwd } is not recommended,  because  it
36              contains  also  users  with  a lower UID than the one configured
37              with the first_valid_uid setting.
38
39              When the SQL userdb module is used  make  sure  that  the  iter‐
40              ate_query  setting  in /etc/dovecot/dovecot-sql.conf.ext matches
41              your database layout.  When using the LDAP userdb  module,  make
42              sure  that  the  iterate_attrs  and  iterate_filter  settings in
43              /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema.  Oth‐
44              erwise doveadm(1) will be unable to iterate over all users.
45
46       -F file
47              Execute the command for all the users in the file.  This is sim‐
48              ilar to the -A option, but instead of getting the list of  users
49              from  the  userdb,  they are read from the given file.  The file
50              contains one username per line.
51
52       -S socket_path
53              The option's argument is either an absolute path to a local UNIX
54              domain  socket, or a hostname and port (hostname:port), in order
55              to connect a remote host via a TCP socket.
56
57              This allows an administrator to execute doveadm(1) mail commands
58              through the given socket.
59
60       -u user/mask
61              Run  the command only for the given user.  It's also possible to
62              use '*' and '?' wildcards (e.g. -u *@example.org).
63              When neither the -A option, nor  the  -F file  option,  nor  the
64              -u user was specified, the command will be executed with the en‐
65              vironment of the currently logged in user.
66

ARGUMENTS

68       namespace
69              The name of a namespace, e.g. the name of the shared  namespace.
70              When  no  namespace was given, the user's private namespace will
71              be used.
72

COMMANDS

74   fts optimize
75       doveadm fts optimize [-u user|-A|-F file] [-S socket_path] [namespace]
76
77       Optimize the full text search index.  This is also  done  automatically
78       by the full text search engines, but this enforces it to happen.
79
80   fts rescan
81       doveadm fts rescan [-u user|-A|-F file] [-S socket_path] [namespace]
82
83       Scan  what  mails exist in the full text search index and compare those
84       to what actually exist in mailboxes.  This removes mails from the index
85       that  have  already  been expunged and makes sure that the next doveadm
86       index will index all the missing mails (if any).  Note  that  currently
87       most  FTS  backends  do  not  implement this properly, but instead they
88       delete all the FTS indexes. This may change in the future versions.
89
90   fts check fast
91       doveadm fts check fast [-u user|-A|-F  file]  [-S  socket_path]  [--re‐
92       fresh] [--print-mismatches-only] [namespace]
93
94       This  command exists only when the fts_dovecot plugin (Dovecot Pro FTS)
95       is loaded.
96
97       This command can be used to check FTS indexes for consistency. It  per‐
98       forms a fast check using only information in local caches (fts.S, meta‐
99       cache).
100
101       --refresh
102              Refresh any necessary local caches for the command to  run  suc‐
103              cessfully.  This can be used if the command otherwise fails with
104              exit code 68.
105
106       --print-mismatches-only
107              Print only mailboxes that have inconsistencies.
108
109       Exit codes:
110
111       0      The mailbox is fully consistent
112
113       2      The mailbox is not fully consistent
114
115       68     There is not enough  information  in  local  metacache  to  know
116              whether  the  mailbox  is fully consistent. Use either the --re‐
117              fresh parameter or the "full" check.
118
119   fts check full
120       doveadm fts check full [-u user|-A|-F file] [-S socket_path]  [--print-
121       details] [--print-mismatches-only] [namespace]
122
123       This  command exists only when the fts_dovecot plugin (Dovecot Pro FTS)
124       is loaded.
125
126       This command can be used to check FTS indexes for consistency. It  per‐
127       forms a full check to give detailed output of inconsistencies.
128
129       --print-details
130              Print  also  IMAP  UID  numbers  and  FTS triplet names for each
131              email.
132
133       --print-mismatches-only
134              Print only mailboxes (or emails, with --print-details that  have
135              inconsistencies.
136
137       Exit codes:
138
139       0      The mailbox is fully consistent
140
141       2      The mailbox is not fully consistent
142

REPORTING BUGS

144       Report  bugs, including doveconf -n output, to the Dovecot Mailing List
145       <dovecot@dovecot.org>.  Information about reporting bugs  is  available
146       at: http://dovecot.org/bugreport.html
147