docs/delete.html

<!DOCTYPE html>
<html>
<head>
    <title>Caltech Library's Digital Library Development Sandbox</title>
    <link rel="stylesheet" href="/css/site.css">
</head>
<body>
<header>
<a href="https://library.caltech.edu"><img src="/assets/liblogo.gif" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
<li>
<a href="/">Home</a>
</li>
<li>
<a href="../">Up</a>
</li>
<li>
<a href="../">README</a>
</li>
<li>
<a href="../license.html">LICENSE</a>
</li>
<li>
<a href="../install.html">INSTALL</a>
</li>
<li>
<a href="./">Documentation</a>
</li>
<li>
<a href="../how-to/">Tutorials</a>
</li>
<li>
<a href="topics.html">Topics</a>
</li>
<li>
<a href="https://github.com/caltechlibrary/dataset">Github</a>
</li>
<li>
<a href="https://github.com/caltechlibrary/dataset/releases/">Releases</a>
</li>
</ul>
</nav>

<section>
<h1 id="delete">
delete
</h1>
<h2 id="syntax">
Syntax
</h2>
<pre><code>    dataset delete COLLECTION_NAME KEY</code></pre>
<h2 id="description">
Description
</h2>
<ul>
<li>
delete - removes a JSON document from collection
<ul>
<li>
requires JSON document name
</li>
</ul>
</li>
</ul>
<h2 id="usage">
Usage
</h2>
<p>
This usage example will delete the JSON document withe the key <em>r1</em> in the collection named “publications.ds”.
</p>
<pre class="shell"><code>    dataset delete publications.ds r1</code></pre>
<p>
Related topics: <a href="create.html">create</a>, <a href="read.html">read</a>, and <a href="update.html">update</a>
</p>
</section>

<footer>
<span><h1><A href="https://caltech.edu">Caltech</a></h1></span>
<span>&copy; 2021 <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>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
<span><a href="mailto:library@caltech.edu">Email Us</a></span>
<a class="cl-hide" href="sitemap.xml">Site Map</a>
</footer>
</body>
</html>