Skip to content

Commit a0b9f2a

Browse files
committed
deploy: 4c9b997
1 parent 9b84084 commit a0b9f2a

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

β€Žrunning/maintenance/index.html

+12-13
Original file line numberDiff line numberDiff line change
@@ -2345,22 +2345,21 @@ <h3 id="use-cases">Use Cases<a class="headerlink" href="#use-cases" title="Perma
23452345
<p>Chroma Ops is designed to help you maintain a healthy Chroma database. It can also be used for inspecting the state of your database. The following use cases are supported:</p>
23462346
<ul>
23472347
<li>πŸ“¦ Database Maintenance</li>
2348-
<li><a href="#info"><code>db info</code></a> - gathers general information about your Chroma persistent database</li>
2349-
<li><a href="#clean"><code>db clean</code></a> - cleans up the database from unused files (for now only orphanated HNSW segment directories)</li>
2348+
<li><a href="#database-info"><code>db info</code></a> - gathers general information about your Chroma persistent database</li>
2349+
<li><a href="#database-clean"><code>db clean</code></a> - cleans up the database from unused files (for now only orphanated HNSW segment directories)</li>
23502350
<li>πŸ“ Write-Ahead Log (WAL) Maintenance</li>
2351-
<li><a href="#info-1"><code>wal info</code></a> - gathers information about the Write-Ahead Log (WAL)</li>
2352-
<li><a href="#commit"><code>wal commit</code></a> - commits the WAL to all collections with outstanding changes</li>
2353-
<li><a href="#clean-1"><code>wal clean</code></a> - cleans up the WAL from committed transactions. Recent Chroma version automatically prune the WAL so this is not needed unless you have older version of Chroma or disabled automatic WAL pruning.</li>
2354-
<li><a href="#export"><code>wal export</code></a> - exports the WAL to a <code>jsonl</code> file. This can be used for debugging and for auditing.</li>
2355-
<li><a href="#configuration"><code>wal config</code></a> - allows you to configure the WAL for your Chroma database.</li>
2351+
<li><a href="#wal-info"><code>wal info</code></a> - gathers information about the Write-Ahead Log (WAL)</li>
2352+
<li><a href="#wal-commit"><code>wal commit</code></a> - commits the WAL to all collections with outstanding changes</li>
2353+
<li><a href="#wal-export"><code>wal export</code></a> - exports the WAL to a <code>jsonl</code> file. This can be used for debugging and for auditing.</li>
2354+
<li><a href="#wal-configuration"><code>wal config</code></a> - allows you to configure the WAL for your Chroma database.</li>
23562355
<li>πŸ” Full Text Search (FTS) Maintenance</li>
2357-
<li><a href="#rebuild"><code>fts rebuild</code></a> - rebuilds the FTS index for all collections or change the tokenizer.</li>
2356+
<li><a href="#fts-rebuild"><code>fts rebuild</code></a> - rebuilds the FTS index for all collections or change the tokenizer.</li>
23582357
<li>🧬 Vector Index (HNSW) Maintenance</li>
2359-
<li><a href="#info-2"><code>hnsw info</code></a> - gathers information about the HNSW index for a given collection</li>
2360-
<li><a href="#rebuild-1"><code>hnsw rebuild</code></a> - rebuilds the HNSW index for a given collection and allows the modification of otherwise immutable (construction-only) parameters. Useful command to keep your HNSW index healthy and prevent fragmentation.</li>
2361-
<li><a href="#configuration-1"><code>hnsw config</code></a> - allows you to configure the HNSW index for your Chroma database.</li>
2358+
<li><a href="#hnsw-info"><code>hnsw info</code></a> - gathers information about the HNSW index for a given collection</li>
2359+
<li><a href="#hnsw-rebuild"><code>hnsw rebuild</code></a> - rebuilds the HNSW index for a given collection and allows the modification of otherwise immutable (construction-only) parameters. Useful command to keep your HNSW index healthy and prevent fragmentation.</li>
2360+
<li><a href="#hnsw-configuration"><code>hnsw config</code></a> - allows you to configure the HNSW index for your Chroma database.</li>
23622361
<li>πŸ“Έ Collection Maintenance</li>
2363-
<li><a href="#snapshot"><code>collection snapshot</code></a> - creates a snapshot of a collection. The snapshots are self-contained and are meant to be used for backup and restore.</li>
2362+
<li><a href="#collection-snapshot"><code>collection snapshot</code></a> - creates a snapshot of a collection. The snapshots are self-contained and are meant to be used for backup and restore.</li>
23642363
</ul>
23652364
<div class="admonition tip">
23662365
<p class="admonition-title">Need help/Need more?</p>
@@ -2737,7 +2736,7 @@ <h5 id="hnsw-rebuild">HNSW Rebuild<a class="headerlink" href="#hnsw-rebuild" tit
27372736
</span><span id="__span-19-53"><a id="__codelineno-19-53" name="__codelineno-19-53" href="#__codelineno-19-53"></a><span class="go">β”‚ Fragmentation level β”‚ 0.00% β”‚</span>
27382737
</span><span id="__span-19-54"><a id="__codelineno-19-54" name="__codelineno-19-54" href="#__codelineno-19-54"></a><span class="go">β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜</span>
27392738
</span></code></pre></div>
2740-
<h5 id="hnsw-config">HNSW Config<a class="headerlink" href="#hnsw-config" title="Permanent link">&para;</a></h5>
2739+
<h5 id="hnsw-configuration">HNSW Configuration<a class="headerlink" href="#hnsw-configuration" title="Permanent link">&para;</a></h5>
27412740
<p><em>What it does</em>: Configures the HNSW index for your Chroma database.</p>
27422741
<p><em>Why it's useful</em>: This command is useful for configuring the HNSW index for your Chroma database.</p>
27432742
<div class="language-bash highlight"><pre><span></span><code><span id="__span-20-1"><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a>chops<span class="w"> </span>hnsw<span class="w"> </span>config<span class="w"> </span>/path/to/persist_dir<span class="w"> </span>--collection<span class="w"> </span>&lt;collection_name&gt;

β€Žsearch/search_index.json

+1-1
Large diffs are not rendered by default.

0 commit comments

Comments
Β (0)