contrib/kyua/doc/kyua-db-migrate.1.in

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