dataset/docs/init.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
<!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="init">init</h1>
<h2 id="syntax">Syntax</h2>
<pre class="shell"><code>    dataset init COLLECTION_NAME [DSN_URI]</code></pre>
<h2 id="description">Description</h2>
<p><em>init</em> creates a collection. Collections are created on local
disc.</p>
<h2 id="usage">Usage</h2>
<p>The following example command create a dataset collection named
“data.ds”.</p>
<pre class="shell"><code>    dataset init data.ds</code></pre>
<p>NOTE: After each evocation of <code>dataset init</code> if all went
well you will be shown an <code>OK</code> if everything went OK,
otherwise an error message.</p>
<p>By default dataset cli creates pairtree collections. You can now
optionally store your documents in a SQL database (e.g. SQLite3, MySQL
8). This can improve performance for large collections as well as
support multi-user or multi-process concurrent use of a collection. To
use a SQL storage engine you need to provide a “DSN_URI”. The DSN_URI is
formed by setting the “protocl” of the URL to either “sqlite://” or
“mysql://” followed by a DSN (data source name) as described by the
database/sql package in Go.</p>
<p>This examples shows using SQLite3 storage for the JSON documents in a
“collection.db” stored inside the “data.ds” collection.</p>
<pre class="shell"><code>    dataset init data.ds &quot;sqlite://collection.db&quot;</code></pre>
<p>Here’s a variation using MySQL 8 as the storage engine storing the
collection in the “collections” database.</p>
<pre class="shell"><code>    dataset init data.ds &quot;mysql://DB_USER:DB_PASSWD@/collections&quot;</code></pre>
</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>