xref: /minix3/external/bsd/kyua-cli/dist/doc/kyua-db-exec.1.in (revision 11be35a165022172ed3cea20f2b5df0307540b0e)
1*11be35a1SLionel Sambuc.\" Copyright 2012 Google Inc.
2*11be35a1SLionel Sambuc.\" All rights reserved.
3*11be35a1SLionel Sambuc.\"
4*11be35a1SLionel Sambuc.\" Redistribution and use in source and binary forms, with or without
5*11be35a1SLionel Sambuc.\" modification, are permitted provided that the following conditions are
6*11be35a1SLionel Sambuc.\" met:
7*11be35a1SLionel Sambuc.\"
8*11be35a1SLionel Sambuc.\" * Redistributions of source code must retain the above copyright
9*11be35a1SLionel Sambuc.\"   notice, this list of conditions and the following disclaimer.
10*11be35a1SLionel Sambuc.\" * Redistributions in binary form must reproduce the above copyright
11*11be35a1SLionel Sambuc.\"   notice, this list of conditions and the following disclaimer in the
12*11be35a1SLionel Sambuc.\"   documentation and/or other materials provided with the distribution.
13*11be35a1SLionel Sambuc.\" * Neither the name of Google Inc. nor the names of its contributors
14*11be35a1SLionel Sambuc.\"   may be used to endorse or promote products derived from this software
15*11be35a1SLionel Sambuc.\"   without specific prior written permission.
16*11be35a1SLionel Sambuc.\"
17*11be35a1SLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18*11be35a1SLionel Sambuc.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19*11be35a1SLionel Sambuc.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20*11be35a1SLionel Sambuc.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21*11be35a1SLionel Sambuc.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22*11be35a1SLionel Sambuc.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23*11be35a1SLionel Sambuc.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24*11be35a1SLionel Sambuc.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25*11be35a1SLionel Sambuc.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26*11be35a1SLionel Sambuc.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27*11be35a1SLionel Sambuc.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*11be35a1SLionel Sambuc.Dd September 9, 2012
29*11be35a1SLionel Sambuc.Dt KYUA-DB-EXEC 1
30*11be35a1SLionel Sambuc.Os
31*11be35a1SLionel Sambuc.Sh NAME
32*11be35a1SLionel Sambuc.Nm db-exec
33*11be35a1SLionel Sambuc.Nd Executes a SQL statement in the store database
34*11be35a1SLionel Sambuc.Sh SYNOPSIS
35*11be35a1SLionel Sambuc.Nm
36*11be35a1SLionel Sambuc.Op Fl -no-headers
37*11be35a1SLionel Sambuc.Op Fl -store Ar file
38*11be35a1SLionel Sambuc.Ar statement
39*11be35a1SLionel Sambuc.Sh DESCRIPTION
40*11be35a1SLionel SambucThe
41*11be35a1SLionel Sambuc.Nm
42*11be35a1SLionel Sambuccommand provides a way to execute an arbitrary SQL statement within the
43*11be35a1SLionel Sambucdatabase.  This command is mostly intended to aid in debugging, but can
44*11be35a1SLionel Sambucalso be used to extract information from the database when the current
45*11be35a1SLionel Sambucinterfaces do not provide the desired functionality.
46*11be35a1SLionel Sambuc.Pp
47*11be35a1SLionel SambucThe
48*11be35a1SLionel Sambuc.Nm
49*11be35a1SLionel Sambuccommand takes one or more arguments, all of which are concatenated to form
50*11be35a1SLionel Sambuca single SQL statement.  Once the staement is executed,
51*11be35a1SLionel Sambuc.Nm
52*11be35a1SLionel Sambucprints the resulting table on the screen, if any.
53*11be35a1SLionel Sambuc.Pp
54*11be35a1SLionel SambucThe following subcommand options are recognized:
55*11be35a1SLionel Sambuc.Bl -tag -width XX
56*11be35a1SLionel Sambuc.It Fl -no-headers
57*11be35a1SLionel SambucAvoids printing the headers of the table in the output of the command.
58*11be35a1SLionel Sambuc.It Fl -store Ar path , Fl s Ar path
59*11be35a1SLionel SambucSpecifies the database to use.  Defaults to
60*11be35a1SLionel Sambuc.Pa ~/.kyua/store.db .
61*11be35a1SLionel SambucThe database is created if it does not exist.
62*11be35a1SLionel Sambuc.El
63*11be35a1SLionel Sambuc.Sh EXIT STATUS
64*11be35a1SLionel SambucThe
65*11be35a1SLionel Sambuc.Nm
66*11be35a1SLionel Sambuccommand returns 0 on success or 1 if the SQL statement is invalid or fails
67*11be35a1SLionel Sambucto run.
68*11be35a1SLionel Sambuc.Pp
69*11be35a1SLionel SambucAdditional exit codes may be returned as described in
70*11be35a1SLionel Sambuc.Xr kyua 1 .
71*11be35a1SLionel Sambuc.Sh SEE ALSO
72*11be35a1SLionel Sambuc.Xr kyua 1 ,
73*11be35a1SLionel Sambuc.Xr kyua-test 1
74