aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 8a12f985cdb78e1fadb729227451eabe85dc6a92 (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
yaqlite
=======

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


## Usage
	$ sqlite3 test.db <<EOF
	CREATE TABLE "restaurants" (
		id INTEGER PRIMARY KEY,

		name TEXT,
		description TEXT,
		rating INTEGER
	);
	EOF

	$ yaqlite insert --database test.db restaurants <<EOF
	name: Western Restaurant Nekoya
	description: |-
	  Located in the business district, this restaurant serves a wide variety of cuisine for all tastes and appetites.

	  Enjoy hearty dishes like the beef stew, and conclude with a chocolate parfait so light and airy you'll think you're eating a cloud.
	rating: 5
	EOF

	$ yaqlite select --database test.db restaurants 1
	---
	name: Western Restaurant Nekoya
	description: |
	  Located in the business district, this restaurant serves a wide variety of cuisine for all tastes and appetites.

	  Enjoy hearty dishes like the beef stew, and conclude with a chocolate parfait so light and airy you'll think you're eating a cloud.
	rating: 5


## Install
Mac OS X users can install with MacPorts, after [adding a custom repository
source][teddywing ports repository]:

	$ sudo port install yaqlite

[teddywing ports repository]: https://github.com/teddywing/macports-ports#adding-this-repository-source

To compile from source or install on other platforms:

	$ cargo install --git https://github.com/teddywing/yaqlite.git


## License
Copyright © 2022 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
COPYING file).