blob: ecaa8be0a2ee09f97fc9bd3b6308386bf2b1fb85 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
'\" t
.\" Title: yaqlite
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 03/27/2022
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "YAQLITE" "1" "03/27/2022" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
yaqlite \- YAML interface for SQLite
.SH "SYNOPSIS"
.sp
\fIyaqlite\fR [\-\-help] [\-\-version] <command> [<args>]
.SH "DESCRIPTION"
.sp
A bridge between YAML and SQLite\&. Enables inserting YAML records into a database and selecting records as YAML\&.
.SH "OPTIONS"
.PP
\-h, \-\-help
.RS 4
Print usage help\&.
.RE
.PP
\-V, \-\-version
.RS 4
Print the program version\&.
.RE
.SH "COMMANDS"
.PP
\fBinsert\fR
.RS 4
Insert a record from YAML\&.
.RE
.PP
\fBselect\fR
.RS 4
Select a record as YAML\&.
.RE
.SH "INSERT COMMAND"
.SS "Insert Synopsis"
.sp
\fIyaqlite insert\fR [<options>] <table\-name> [<input\-file>]
.SS "Insert Description"
.sp
Insert a YAML\-formatted record into <table\-name>\&. The YAML is read from <input\-file> if specified\&. If <input\-file> is "\-" or empty, YAML is read from standard input\&.
.SS "Insert Options"
.PP
\-\-database
.RS 4
The database to insert into\&.
.RE
.SH "SELECT COMMAND"
.SS "Select Synopsis"
.sp
\fIyaqlite select\fR [<options>] <table\-name> <record\-id>
.SS "Select Description"
.sp
Select a record by <record\-id> from <table\-name>\&. The record will output in YAML format to standard output\&.
.SS "Select Options"
.PP
\-\-database
.RS 4
The database to select from\&.
.RE
.PP
\-\-exclude\-column
.RS 4
Exclude the given column from the YAML output\&. This option can be given multiple times to exclude several columns\&.
.RE
.PP
\-\-include\-primary\-key
.RS 4
Include the primary key field in the YAML output\&. By default, the primary key is excluded\&.
.RE
.PP
\-\-primary_key
.RS 4
Name of the column to that matches <record\-id>\&. Defaults to the table\(cqs primary key\&.
.RE
|
