dataset/docs/commands.html at main · caltechlibrary/dataset · GitHub

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
<!DOCTYPE html>
<html>
<head>
    <title>Dataset Project</title>
    <link href='https://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
    <link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
</head>
<body>
<header>
<a href="http://library.caltech.edu" title="link to Caltech Library Homepage"><img src="https://caltechlibrary.github.io/assets/liblogo.gif" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
    <li><a href="/">Home</a></li>
    <li><a href="../">README</a></li>
    <li><a href="../LICENSE">LICENSE</a></li>
    <li><a href="../INSTALL.html">INSTALL</a></li>
    <li><a href="../user_manual.html">User Manual</a></li>
    <li><a href="../about.html">About</a></li>
	<li><a href="../search.html">Search</a></li>
    <li><a href="https://github.com/caltechlibrary/dataset">GitHub</a></li>
</ul>
</nav>

<section>
<h1 id="commands">commands</h1>
<p>Documentation on individual commands can be see with</p>
<pre class="shell"><code>    dataset -help COMMAND_NAME</code></pre>
<p>where “COMMAND_NAME” is</p>
<p>replaced with one of the commands below –</p>
<ul>
<li><a href="init.html">init</a> - initialize a new collection if none
exists, requires a path to collection</li>
<li><a href="keys.html">keys</a> - returns the keys to stdout, one key
per line</li>
<li><a href="haskey.html">has-key</a> - returns true is key is in
collection, false otherwise</li>
<li><a href="create.html">create</a> - creates a new JSON document or
replace an existing one in collection</li>
<li><a href="read.html">read</a> - displays a JSON document to
stdout</li>
<li><a href="update.html">update</a> - updates a JSON document in
collection</li>
<li><a href="delete.html">delete</a> - removes a JSON document from
collection</li>
<li><a href="count.html">count</a> - returns a count of keys in a
collection</li>
<li>Attachments
<ul>
<li><a href="attachments.html">attachments</a> - lists any attached
content for JSON document</li>
<li><a href="attach.html">attach</a> - attaches a non-JSON content to a
JSON record</li>
<li><a href="retrieve.html">retrieve</a> - returns attachments for a
JSON document</li>
<li><a href="prune.html">prune</a> - remove attachments to a JSON
document</li>
</ul></li>
<li><a href="dump.html">dump</a> - export collection to a JSON lines
file</li>
<li><a href="load.html">load</a> - import a collection using a JSON
lines file</li>
</ul>
<p>NOTE: The options create, update can read JSON documents piped from
standard in if you use the ‘-i -’ or ‘-include -’ option. Likewise keys
can be read from standard input with the ‘-i -’ or ‘-include -’ options
for read, list, keys and count.</p>
</section>

<footer>
<span>&copy; 2022 <a href="https://www.library.caltech.edu/copyright">Caltech Library</a></span>
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
<span><a href="mailto:library@caltech.edu">Email Us</a></span>
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
</footer>
</body>
</html>