aboutsummaryrefslogtreecommitdiffstats
path: root/doc/yaqlite.1.txt
blob: e5ec47e0a4c6bd47fb1fe8a5351d9c29f6fa3083 (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
yaqlite(1)
==========

NAME
----
yaqlite - YAML interface for SQLite

SYNOPSIS
--------
'yaqlite' [--help] [--version] <command> [<args>]

DESCRIPTION
-----------
A bridge between YAML and SQLite. Enables inserting YAML records into a
database and selecting records as YAML.

OPTIONS
-------
-h, --help::
	Print usage help.

-V, --version::
	Print the program version.

COMMANDS
--------
*insert*::
	Insert a record from YAML.

*select*::
	Select a record as YAML.

INSERT COMMAND
--------------

Insert Synopsis
~~~~~~~~~~~~~~~
'yaqlite insert' [<options>] <table-name> [<input-file>]

Insert Description
~~~~~~~~~~~~~~~~~~
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.

Insert Options
~~~~~~~~~~~~~~
--database::
	The database to insert into.

SELECT COMMAND
--------------

Select Synopsis
~~~~~~~~~~~~~~~
'yaqlite select' [<options>] <table-name> <record-id>

Select Description
~~~~~~~~~~~~~~~~~~
Select a record by <record-id> from <table-name>. The record will output in
YAML format to standard output.

Select Options
~~~~~~~~~~~~~~
--database::
	The database to select from.

--exclude-column::
	Exclude the given column from the YAML output. This option can be given
	multiple times to exclude several columns.

--include-primary-key::
	Include the primary key field in the YAML output. By default, the primary
	key is excluded.

--primary_key::
	Name of the column to that matches <record-id>. Defaults to the table's
	primary key.