1KYUA-DB-MIGRATE(1)        BSD General Commands Manual       KYUA-DB-MIGRATE(1)
2

NAME

4     kyua db-migrate — Upgrades the schema of an existing results file
5

SYNOPSIS

7     kyua db-migrate [--results-file file]
8

DESCRIPTION

10     The kyua db-migrate command migrates the schema of an existing database
11     to the latest version implemented in kyua(1).
12
13     This operation is not reversible.  However, a backup of the database is
14     created in the same directory where the database lives.
15
16     The following subcommand options are recognized:
17
18     --results-file path, -s path
19         Specifies the results file to operate on.  Defaults to ‘LATEST’,
20         which causes kyua db-migrate to automatically load the latest results
21         file from the current test suite.
22
23         The following values are accepted:
24
25         ‘LATEST’
26             Requests the load of the latest results file available for the
27             test suite rooted at the current directory.
28
29         Directory
30             Requests the load of the latest results file available for the
31             test suite rooted at the given directory.
32
33         Test suite name
34             Requests the load of the latest results file available for the
35             given test suite.
36
37         Results identifier
38             Requests the load of a specific results file.
39
40         Explicit file name (aka everything else)
41             Load the specified results file.
42
43         See Results files for more details.
44
45   Results files
46     Results files contain, as their name implies, the results of the execu‐
47     tion of a test suite.  Each test suite executed by kyua-test(1) generates
48     a new results file, and such results files can be loaded later on by
49     inspection commands such as kyua-report(1) to analyze their contents.
50
51     Results files support identifier-based lookups and also path name
52     lookups.  The differences between the two are described below.
53
54     The default naming scheme for the results files provides simple support
55     for identifier-based lookups and historical recording of test suite runs.
56     Each results file is given an identifier derived from the test suite that
57     generated it and the time the test suite was run.  Kyua can later look up
58     results files by these fileds.
59
60     The identifier follows this pattern:
61
62           <test_suite>.<YYYYMMDD>-<HHMMSS>-<uuuuuu>
63
64     where ‘test_suite’ is the path to the root of the test suite that was run
65     with all slashes replaced by underscores and ‘YYYYMMDD-HHMMSS-uuuuuu’ is
66     a timestamp with microsecond resolution.
67
68     When using the default naming scheme, results files are stored in the
69     ~/.kyua/store/ subdirectory and each file holds a name of the form:
70
71           ~/.kyua/store/results.<identifier>.db
72
73     Results files are simple SQLite databases with the schema described in
74     the /usr/share/kyua/store/schema_v?.sql files.  For details on the
75     schema, please refer to the heavily commented SQL file.
76

EXIT STATUS

78     The kyua db-migrate command returns 0 on success or 1 if the migration
79     fails.
80
81     Additional exit codes may be returned as described in kyua(1).
82

SEE ALSO

84     kyua(1)
85
86BSD                            October 13, 2014                            BSD
Impressum