dataset/docs/keys.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
<!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="keys">keys</h1>
<h2 id="syntax">Syntax</h2>
<pre class="shell"><code>    dataset keys COLLECTION_NAME</code></pre>
<h2 id="description">Description</h2>
<p>List the JSON_DOCUMENT_ID available in a collection. Key order is not
guaranteed. Keys are forced to lower case when the record is created in
the dataset (as of version 1.0.2). Note combining “keys” with a pipe and
POSIX commands like “sort” can given a rich pallet of ways to work with
your dataset collection’s keys.</p>
<h2 id="examples">Examples</h2>
<p>Here are three examples usage. Notice the sorting is handled by the
POSIX sort command which lets you sort ascending or descending including
sorting number strings.</p>
<pre class="shell"><code>    dataset keys COLLECTION_NAME
    dataset keys COLLECTION_NAME | sort
    dataset keys COLLECTION_NAME | sort -n</code></pre>
<h2 id="getting-a-sample-of-keys">Getting a “sample” of keys</h2>
<p>The <strong>dataset</strong> command respects an option named
<code>-sample N</code> where N is the size (number) of the keys to
include in the sample. The sample is taken after any filters are applied
but may be less than requested size if the the filtered results are few
than the sample size. The basic process is to get a set of keys,
randomly sort the keys, then return the top N number of those keys.</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>