xref: /freebsd/contrib/kyua/doc/kyua-db-exec.1.in (revision cc68614da8232d8baaca0ae0d0dd8f890f06623e)
1.\" Copyright 2012 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-EXEC 1
30.Os
31.Sh NAME
32.Nm "kyua db-exec"
33.Nd Executes a SQL statement in a results file
34.Sh SYNOPSIS
35.Nm
36.Op Fl -no-headers
37.Op Fl -results-file Ar file
38.Ar statement
39.Sh DESCRIPTION
40The
41.Nm
42command provides a way to execute an arbitrary SQL statement within the
43database.
44This command is mostly intended to aid in debugging, but can also be used to
45extract information from the database when the current interfaces do not
46provide the desired functionality.
47.Pp
48The input database must exist.
49It makes no sense to use
50.Nm
51on a nonexistent or empty database.
52.Pp
53The
54.Nm
55command takes one or more arguments, all of which are concatenated to form
56a single SQL statement.
57Once the statement is executed,
58.Nm
59prints the resulting table on the screen, if any.
60.Pp
61The following subcommand options are recognized:
62.Bl -tag -width XX
63.It Fl -no-headers
64Avoids printing the headers of the table in the output of the command.
65.It Fl -results-file Ar path , Fl s Ar path
66__include__ results-file-flag-read.mdoc
67.El
68.Ss Results files
69__include__ results-files.mdoc
70.Sh EXIT STATUS
71The
72.Nm
73command returns 0 on success or 1 if the SQL statement is invalid or fails
74to run.
75.Pp
76Additional exit codes may be returned as described in
77.Xr kyua 1 .
78.Sh SEE ALSO
79.Xr kyua 1 ,
80.Xr kyua-test 1
81