ovsqlite-util(8)

1OVSQLITE-UTIL(8)          InterNetNews Documentation          OVSQLITE-UTIL(8)
2
3
4

NAME

6       ovsqlite-util - Overview manipulation utility for ovsqlite
7

SYNOPSIS

9       ovsqlite-util [-AFghioO] [-a article] [-n newsgroup] [-p path]
10

DESCRIPTION

12       ovsqlite-util is an administrative interface to the ovsqlite overview
13       method for INN.  It only works on ovsqlite overview databases, not on
14       any other type of INN overview.  (See dedicated ovdb_stat(8) and
15       tdx-util(8) programs for ovdb and tradindexed overview methods.)  It
16       allows the administrator to dump various information about the internal
17       state of the overview, audit it for errors, and fix these errors.
18
19       To audit the entire overview database for problems, use -A.  The checks
20       can take an extended period of time, depending on the number of
21       newsgroups and articles present in the overview database.  Any problems
22       found will be reported to standard error.  Use -F to correct the errors
23       found.
24
25       It is safe to run this utility while the server is running.  In case
26       fixes should be made to the database (when using the -F flag),
27       ovsqlite-util will properly pause the server before performing its
28       operations, and then resume it.
29
30       The number of overview records stored in the database can be obtained
31       with the "inndf -n" command.
32

REQUIREMENTS

34       The "DBI" Perl module with the "DBD::SQLite" driver must be installed
35       for this program to work.  They are present in most distributions as a
36       package named like "libdbd-sqlite3-perl", "perl-DBD-SQLite" or
37       "p5-DBD-SQLite".  They can also be directly installed from CPAN ("DBI"
38       and "DBD-SQLite" distributions available at
39       <https://metacpan.org/dist/DBI> and
40       <https://metacpan.org/dist/DBD-SQLite>).
41
42       Naturally, an ovsqlite overview database also needs being in use, as
43       detailed in the ovsqlite(5) manual page.
44

OPTIONS

46       -a article
47           The article number or numbers to act on.  article is a valid NNTP
48           range, meaning that it can be either a single article number or a
49           range of article numbers (like "1-5").  Either the start or the end
50           (or both) of the range may be omitted, in which case they will be
51           set to the first or last article number in the group.  Passing "-"
52           for article is therefore equivalent to not using the -a option at
53           all.
54
55           Only useful in combination with the -g, -o and -O options to dump
56           overview information.
57
58       -A  Audit the entire overview database for problems.  Currently, only
59           one consistency check is performed: the verification that the low
60           water mark, the high water mark and the article count of each
61           newsgroup match the reality of articles present in overview.  No
62           changes will be made to the database, but problems will be reported
63           to standard error.
64
65       -F  Audit the entire overview database for problems, fixing them as
66           they're detected where possible.  This runs the same checks as the
67           -A flag, and fixes the problems found.  Using this option takes
68           care of pausing and resuming INN so that the overview data are not
69           changed by another process during the operations.
70
71           To see what would be changed by -F, run ovsqlite-util with -A
72           first.
73
74       -g  Dump overall overview information for a particular group.  The
75           fields are, in order, the article number, the length of the
76           overview data, the time (in seconds since epoch) when the article
77           arrived on the server, the time (in seconds since epoch) when the
78           article should expire based on its Expires header field (or 0 if
79           there is no Expires header field), and the storage API token of the
80           article.
81
82           If this option is given, the -n option must also be given to
83           specify the newsgroup on which to act.
84
85       -i  Dump newsgroup-related overview information from the database.
86           This contains similar information to the server active file, such
87           as high and low water marks and moderation status, and is the
88           information that nnrpd hands out to clients.
89
90           The fields are, in order, the newsgroup name, the high water mark,
91           the low water mark, the count of articles in the group, the group
92           status, the time (in seconds since epoch) when that newsgroup was
93           last expired (or 0 if expireover hasn't run on it yet), and the
94           deletion status of that newsgroup (0 if not marked for removal
95           during the next expiration, and a positive value otherwise).
96
97           A particular newsgroup can be specified with the -n option.  If -n
98           is not given, the entire master index will be dumped.
99
100       -n newsgroup
101           Specify the newsgroup on which to act, required for the -g, -o, and
102           -O options, and optional for the -i option.
103
104       -o  Dump the overview information for a newsgroup, in the same format
105           as it would be returned to clients but with one modification.
106           Appended to the end of each entry will be four additional pieces of
107           data: the article number according to overview information labelled
108           with "Article:", the storage API token for that article labelled
109           with "Token:", the arrival date for that article on the server in
110           RFC 5322 date format labelled with "Arrived:", and the expiration
111           date for that article (from the Expires header field) in RFC 5322
112           date format if there is any, labelled with "Expires:".
113
114           If this option is given, the -n option must also be given to
115           specify the newsgroup on which to act.  By default, all of the
116           overview information for that newsgroup is dumped, but the -a
117           option may be given to restrict the dump to the information for a
118           single article or a range of article numbers.
119
120       -O  Dump the overview information for a newsgroup in the format used by
121           overchan as input.  Each line will start with the storage API
122           token, the arrival timestamp in seconds since epoch, the expires
123           timestamp in the same format (or 0 if there is no Expires header
124           field), and then the overview data.
125
126           If this option is given, the -n option must also be given to
127           specify the newsgroup on which to act.  By default, all of the
128           overview information for that newsgroup is dumped, but the -a
129           option may be given to restrict the dump to the information for a
130           single article or a range of article numbers.
131
132       -p path
133           Act on the overview database rooted in path, overriding the
134           overview path specified in the pathoverview parameter in inn.conf.
135

EXAMPLES

137       Dump newsgroup-related overview information for the overview database
138       in /news/overview, regardless of the overview path specified in
139       inn.conf:
140
141           ovsqlite-util -i -p /news/overview
142
143       Dump overall overview information for example.test:
144
145           ovsqlite-util -g -n example.test
146
147       Dump the complete overview information for example.test:
148
149           ovsqlite-util -o -n example.test
150
151       Dump the overview information for articles 45 and higher in
152       example.test:
153
154           ovsqlite-util -o -n example.test -a 45-
155
156       Audit the entire overview database for any problems:
157
158           ovsqlite-util -A
159

HISTORY

161       Written by Julien ELIE for InterNetNews.
162