Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
markpbaggett committed Jan 6, 2020
1 parent 995d9bb commit d42a4cb
Show file tree
Hide file tree
Showing 7 changed files with 1,057 additions and 22 deletions.
17 changes: 15 additions & 2 deletions docs/moldybread.html
Original file line number Diff line number Diff line change
Expand Up @@ -837,6 +837,8 @@ <h1 class="title">MOLDY BREAD</h1>
<li><a class="reference" id="find-objects-missing-a-particular-datastream_toc" href="#find-objects-missing-a-particular-datastream">Find Objects Missing a Particular Datastream</a></li>
<li><a class="reference" id="download-datastream-histories-as-xml_toc" href="#download-datastream-histories-as-xml">Download Datastream Histories as XML</a></li>
<li><a class="reference" id="download-datastream-at-date_toc" href="#download-datastream-at-date">Download Datastream at Date</a></li>
<li><a class="reference" id="validate-checksums_toc" href="#validate-checksums">Validate Checksums</a></li>
<li><a class="reference" id="find-unique-datastreams_toc" href="#find-unique-datastreams">Find Unique Datastreams</a></li>
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
<ul class="simple simple-toc-section">
Expand Down Expand Up @@ -919,7 +921,18 @@ <h1><a class="toc-backref" id="download-datastream-histories-as-xml" href="#down
<h1><a class="toc-backref" id="download-datastream-at-date" href="#download-datastream-at-date">Download Datastream at Date</a></h1><p>Serializes to disk the a datatream at a specific date for all results in a result set.</p>
<p>Example command:</p>
<pre class="listing">
moldybread -o get_datastream_at_date -n test -d RELS-EXT -dt 2019-12-19 -y /full/path/to/my/yaml/file.yml</pre></p>
moldybread -o get_datastream_at_date -n test -d RELS-EXT -dt 2019-12-19 -y /full/path/to/my/yaml/file.yml</pre>
<h1><a class="toc-backref" id="validate-checksums" href="#validate-checksums">Validate Checksums</a></h1><p>You can check whether the current checksum of a datastream for an object matches the original checksum. If not, the objects with bad datastreams are listed:</p>
<p>Example command:</p>
<pre class="listing">
moldybread -o validate_checksums -n test -d OBJ -y /full/path/to/my/yaml/file.yml</pre><p>Or, you can check whether the current checksum for all current versions of datastreams belonging to an object match the checksum of that datastream on ingest.</p>
<p>Example command:</p>
<pre class="listing">
moldybread -o validate_checksums -n test -y /full/path/to/my/yaml/file.yml</pre>
<h1><a class="toc-backref" id="find-unique-datastreams" href="#find-unique-datastreams">Find Unique Datastreams</a></h1><p>You can get a list of unique datastreams from objects across a result set.</p>
<p>Example command:</p>
<pre class="listing">
moldybread -o find_distinct_datastreams -n test -y /full/path/to/my/yaml/file.yml</pre></p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
Expand All @@ -933,7 +946,7 @@ <h1><a class="toc-backref" href="#6">Imports</a></h1>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small>Made with Nim. Generated: 2020-01-02 02:19:25 UTC</small>
<small>Made with Nim. Generated: 2020-01-06 01:46:36 UTC</small>
</div>
</div>
</div>
Expand Down
2 changes: 2 additions & 0 deletions docs/moldybread.idx
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ Purge Old Versions of a Datastream moldybread.html#purge-old-versions-of-a-datas
Find Objects Missing a Particular Datastream moldybread.html#find-objects-missing-a-particular-datastream Find Objects Missing a Particular Datastream
Download Datastream Histories as XML moldybread.html#download-datastream-histories-as-xml Download Datastream Histories as XML
Download Datastream at Date moldybread.html#download-datastream-at-date Download Datastream at Date
Validate Checksums moldybread.html#validate-checksums Validate Checksums
Find Unique Datastreams moldybread.html#find-unique-datastreams Find Unique Datastreams
Loading

0 comments on commit d42a4cb

Please sign in to comment.