xref: /freebsd/contrib/kyua/doc/kyua-db-migrate.1.in (revision b0d29bc47dba79f6f38e67eabadfb4b32ffd9390)
1*b0d29bc4SBrooks Davis.\" Copyright 2013 The Kyua Authors.
2*b0d29bc4SBrooks Davis.\" All rights reserved.
3*b0d29bc4SBrooks Davis.\"
4*b0d29bc4SBrooks Davis.\" Redistribution and use in source and binary forms, with or without
5*b0d29bc4SBrooks Davis.\" modification, are permitted provided that the following conditions are
6*b0d29bc4SBrooks Davis.\" met:
7*b0d29bc4SBrooks Davis.\"
8*b0d29bc4SBrooks Davis.\" * Redistributions of source code must retain the above copyright
9*b0d29bc4SBrooks Davis.\"   notice, this list of conditions and the following disclaimer.
10*b0d29bc4SBrooks Davis.\" * Redistributions in binary form must reproduce the above copyright
11*b0d29bc4SBrooks Davis.\"   notice, this list of conditions and the following disclaimer in the
12*b0d29bc4SBrooks Davis.\"   documentation and/or other materials provided with the distribution.
13*b0d29bc4SBrooks Davis.\" * Neither the name of Google Inc. nor the names of its contributors
14*b0d29bc4SBrooks Davis.\"   may be used to endorse or promote products derived from this software
15*b0d29bc4SBrooks Davis.\"   without specific prior written permission.
16*b0d29bc4SBrooks Davis.\"
17*b0d29bc4SBrooks Davis.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18*b0d29bc4SBrooks Davis.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19*b0d29bc4SBrooks Davis.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20*b0d29bc4SBrooks Davis.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21*b0d29bc4SBrooks Davis.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22*b0d29bc4SBrooks Davis.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23*b0d29bc4SBrooks Davis.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24*b0d29bc4SBrooks Davis.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25*b0d29bc4SBrooks Davis.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26*b0d29bc4SBrooks Davis.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27*b0d29bc4SBrooks Davis.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*b0d29bc4SBrooks Davis.Dd October 13, 2014
29*b0d29bc4SBrooks Davis.Dt KYUA-DB-MIGRATE 1
30*b0d29bc4SBrooks Davis.Os
31*b0d29bc4SBrooks Davis.Sh NAME
32*b0d29bc4SBrooks Davis.Nm "kyua db-migrate"
33*b0d29bc4SBrooks Davis.Nd Upgrades the schema of an existing results file
34*b0d29bc4SBrooks Davis.Sh SYNOPSIS
35*b0d29bc4SBrooks Davis.Nm
36*b0d29bc4SBrooks Davis.Op Fl -results-file Ar file
37*b0d29bc4SBrooks Davis.Sh DESCRIPTION
38*b0d29bc4SBrooks DavisThe
39*b0d29bc4SBrooks Davis.Nm
40*b0d29bc4SBrooks Daviscommand migrates the schema of an existing database to the latest
41*b0d29bc4SBrooks Davisversion implemented in
42*b0d29bc4SBrooks Davis.Xr kyua 1 .
43*b0d29bc4SBrooks Davis.Pp
44*b0d29bc4SBrooks DavisThis operation is not reversible.
45*b0d29bc4SBrooks DavisHowever, a backup of the database is created in the same directory where the
46*b0d29bc4SBrooks Davisdatabase lives.
47*b0d29bc4SBrooks Davis.Pp
48*b0d29bc4SBrooks DavisThe following subcommand options are recognized:
49*b0d29bc4SBrooks Davis.Bl -tag -width XX
50*b0d29bc4SBrooks Davis.It Fl -results-file Ar path , Fl s Ar path
51*b0d29bc4SBrooks Davis__include__ results-file-flag-read.mdoc
52*b0d29bc4SBrooks Davis.El
53*b0d29bc4SBrooks Davis.Ss Results files
54*b0d29bc4SBrooks Davis__include__ results-files.mdoc
55*b0d29bc4SBrooks Davis.Sh EXIT STATUS
56*b0d29bc4SBrooks DavisThe
57*b0d29bc4SBrooks Davis.Nm
58*b0d29bc4SBrooks Daviscommand returns 0 on success or 1 if the migration fails.
59*b0d29bc4SBrooks Davis.Pp
60*b0d29bc4SBrooks DavisAdditional exit codes may be returned as described in
61*b0d29bc4SBrooks Davis.Xr kyua 1 .
62*b0d29bc4SBrooks Davis.Sh SEE ALSO
63*b0d29bc4SBrooks Davis.Xr kyua 1
64