|
1 | 1 |
|
2 | 2 | <section id="dipdup"> |
3 | | -<h1>dipdup<a class="headerlink" href="#dipdup" title="Permalink to this headline">¶</a></h1> |
| 3 | +<h1>dipdup<a class="headerlink" href="#dipdup" title="Permalink to this heading">¶</a></h1> |
4 | 4 | <p>Manage and run DipDup indexers.</p> |
5 | 5 | <p>Full docs: <a class="reference external" href="https://dipdup.net/docs">https://dipdup.net/docs</a></p> |
6 | 6 | <p>Report an issue: <a class="reference external" href="https://github.com/dipdup-net/dipdup-py/issues">https://github.com/dipdup-net/dipdup-py/issues</a></p> |
|
33 | 33 | </dd></dl> |
34 | 34 |
|
35 | 35 | <section id="dipdup-cache"> |
36 | | -<h2>cache<a class="headerlink" href="#dipdup-cache" title="Permalink to this headline">¶</a></h2> |
| 36 | +<h2>cache<a class="headerlink" href="#dipdup-cache" title="Permalink to this heading">¶</a></h2> |
37 | 37 | <p>Manage internal cache.</p> |
38 | 38 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup cache <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
39 | 39 | </pre></div> |
40 | 40 | </div> |
41 | 41 | <section id="dipdup-cache-clear"> |
42 | | -<h3>clear<a class="headerlink" href="#dipdup-cache-clear" title="Permalink to this headline">¶</a></h3> |
| 42 | +<h3>clear<a class="headerlink" href="#dipdup-cache-clear" title="Permalink to this heading">¶</a></h3> |
43 | 43 | <p>Clear request cache of DipDup datasources.</p> |
44 | 44 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup cache clear <span class="o">[</span>OPTIONS<span class="o">]</span> |
45 | 45 | </pre></div> |
46 | 46 | </div> |
47 | 47 | </section> |
48 | 48 | <section id="dipdup-cache-show"> |
49 | | -<h3>show<a class="headerlink" href="#dipdup-cache-show" title="Permalink to this headline">¶</a></h3> |
| 49 | +<h3>show<a class="headerlink" href="#dipdup-cache-show" title="Permalink to this heading">¶</a></h3> |
50 | 50 | <p>Show information about DipDup disk caches.</p> |
51 | 51 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup cache show <span class="o">[</span>OPTIONS<span class="o">]</span> |
52 | 52 | </pre></div> |
53 | 53 | </div> |
54 | 54 | </section> |
55 | 55 | </section> |
56 | 56 | <section id="dipdup-config"> |
57 | | -<h2>config<a class="headerlink" href="#dipdup-config" title="Permalink to this headline">¶</a></h2> |
| 57 | +<h2>config<a class="headerlink" href="#dipdup-config" title="Permalink to this heading">¶</a></h2> |
58 | 58 | <p>Commands to manage DipDup configuration.</p> |
59 | 59 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup config <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
60 | 60 | </pre></div> |
61 | 61 | </div> |
62 | 62 | <section id="dipdup-config-env"> |
63 | | -<h3>env<a class="headerlink" href="#dipdup-config-env" title="Permalink to this headline">¶</a></h3> |
| 63 | +<h3>env<a class="headerlink" href="#dipdup-config-env" title="Permalink to this heading">¶</a></h3> |
64 | 64 | <p>Dump environment variables used in DipDup config.</p> |
65 | 65 | <p>If variable is not set, default value will be used.</p> |
66 | 66 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup config env <span class="o">[</span>OPTIONS<span class="o">]</span> |
|
75 | 75 |
|
76 | 76 | </section> |
77 | 77 | <section id="dipdup-config-export"> |
78 | | -<h3>export<a class="headerlink" href="#dipdup-config-export" title="Permalink to this headline">¶</a></h3> |
| 78 | +<h3>export<a class="headerlink" href="#dipdup-config-export" title="Permalink to this heading">¶</a></h3> |
79 | 79 | <p>Print config after resolving all links and templates.</p> |
80 | 80 | <p>WARNING: Avoid sharing output with 3rd-parties when <cite>–unsafe</cite> flag set - it may contain secrets!</p> |
81 | 81 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup config <span class="nb">export</span> <span class="o">[</span>OPTIONS<span class="o">]</span> |
|
91 | 91 | </section> |
92 | 92 | </section> |
93 | 93 | <section id="dipdup-hasura"> |
94 | | -<h2>hasura<a class="headerlink" href="#dipdup-hasura" title="Permalink to this headline">¶</a></h2> |
| 94 | +<h2>hasura<a class="headerlink" href="#dipdup-hasura" title="Permalink to this heading">¶</a></h2> |
95 | 95 | <p>Hasura integration related commands.</p> |
96 | 96 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup hasura <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
97 | 97 | </pre></div> |
98 | 98 | </div> |
99 | 99 | <section id="dipdup-hasura-configure"> |
100 | | -<h3>configure<a class="headerlink" href="#dipdup-hasura-configure" title="Permalink to this headline">¶</a></h3> |
| 100 | +<h3>configure<a class="headerlink" href="#dipdup-hasura-configure" title="Permalink to this heading">¶</a></h3> |
101 | 101 | <p>Configure Hasura GraphQL Engine to use with DipDup.</p> |
102 | 102 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup hasura configure <span class="o">[</span>OPTIONS<span class="o">]</span> |
103 | 103 | </pre></div> |
|
112 | 112 | </section> |
113 | 113 | </section> |
114 | 114 | <section id="dipdup-init"> |
115 | | -<h2>init<a class="headerlink" href="#dipdup-init" title="Permalink to this headline">¶</a></h2> |
| 115 | +<h2>init<a class="headerlink" href="#dipdup-init" title="Permalink to this heading">¶</a></h2> |
116 | 116 | <p>Generate project tree, missing callbacks and types.</p> |
117 | 117 | <p>This command is idempotent, meaning it won’t overwrite previously generated files unless asked explicitly.</p> |
118 | 118 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup init <span class="o">[</span>OPTIONS<span class="o">]</span> |
|
133 | 133 |
|
134 | 134 | </section> |
135 | 135 | <section id="dipdup-migrate"> |
136 | | -<h2>migrate<a class="headerlink" href="#dipdup-migrate" title="Permalink to this headline">¶</a></h2> |
| 136 | +<h2>migrate<a class="headerlink" href="#dipdup-migrate" title="Permalink to this heading">¶</a></h2> |
137 | 137 | <p>Migrate project to the new spec version.</p> |
138 | 138 | <p>If you’re getting <cite>MigrationRequiredError</cite> after updating DipDup, this command will fix imports and type annotations to match the current <cite>spec_version</cite>. Review and commit changes after running it.</p> |
139 | 139 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup migrate <span class="o">[</span>OPTIONS<span class="o">]</span> |
140 | 140 | </pre></div> |
141 | 141 | </div> |
142 | 142 | </section> |
143 | 143 | <section id="dipdup-run"> |
144 | | -<h2>run<a class="headerlink" href="#dipdup-run" title="Permalink to this headline">¶</a></h2> |
| 144 | +<h2>run<a class="headerlink" href="#dipdup-run" title="Permalink to this heading">¶</a></h2> |
145 | 145 | <p>Run indexer.</p> |
146 | 146 | <p>Execution can be gracefully interrupted with <cite>Ctrl+C</cite> or <cite>SIGTERM</cite> signal.</p> |
147 | 147 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup run <span class="o">[</span>OPTIONS<span class="o">]</span> |
|
174 | 174 |
|
175 | 175 | </section> |
176 | 176 | <section id="dipdup-schema"> |
177 | | -<h2>schema<a class="headerlink" href="#dipdup-schema" title="Permalink to this headline">¶</a></h2> |
| 177 | +<h2>schema<a class="headerlink" href="#dipdup-schema" title="Permalink to this heading">¶</a></h2> |
178 | 178 | <p>Manage database schema.</p> |
179 | 179 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup schema <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
180 | 180 | </pre></div> |
181 | 181 | </div> |
182 | 182 | <section id="dipdup-schema-approve"> |
183 | | -<h3>approve<a class="headerlink" href="#dipdup-schema-approve" title="Permalink to this headline">¶</a></h3> |
| 183 | +<h3>approve<a class="headerlink" href="#dipdup-schema-approve" title="Permalink to this heading">¶</a></h3> |
184 | 184 | <p>Continue to use existing schema after reindexing was triggered.</p> |
185 | 185 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup schema approve <span class="o">[</span>OPTIONS<span class="o">]</span> |
186 | 186 | </pre></div> |
187 | 187 | </div> |
188 | 188 | </section> |
189 | 189 | <section id="dipdup-schema-export"> |
190 | | -<h3>export<a class="headerlink" href="#dipdup-schema-export" title="Permalink to this headline">¶</a></h3> |
| 190 | +<h3>export<a class="headerlink" href="#dipdup-schema-export" title="Permalink to this heading">¶</a></h3> |
191 | 191 | <p>Print SQL schema including scripts from <cite>sql/on_reindex</cite>.</p> |
192 | 192 | <p>This command may help you debug inconsistency between project models and expected SQL schema.</p> |
193 | 193 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup schema <span class="nb">export</span> <span class="o">[</span>OPTIONS<span class="o">]</span> |
194 | 194 | </pre></div> |
195 | 195 | </div> |
196 | 196 | </section> |
197 | 197 | <section id="dipdup-schema-init"> |
198 | | -<h3>init<a class="headerlink" href="#dipdup-schema-init" title="Permalink to this headline">¶</a></h3> |
| 198 | +<h3>init<a class="headerlink" href="#dipdup-schema-init" title="Permalink to this heading">¶</a></h3> |
199 | 199 | <p>Prepare a database for running DipDip.</p> |
200 | 200 | <p>This command creates tables based on your models, then executes <cite>sql/on_reindex</cite> to finish preparation - the same things DipDup does when run on a clean database.</p> |
201 | 201 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup schema init <span class="o">[</span>OPTIONS<span class="o">]</span> |
202 | 202 | </pre></div> |
203 | 203 | </div> |
204 | 204 | </section> |
205 | 205 | <section id="dipdup-schema-wipe"> |
206 | | -<h3>wipe<a class="headerlink" href="#dipdup-schema-wipe" title="Permalink to this headline">¶</a></h3> |
| 206 | +<h3>wipe<a class="headerlink" href="#dipdup-schema-wipe" title="Permalink to this heading">¶</a></h3> |
207 | 207 | <p>Drop all database tables, functions and views.</p> |
208 | 208 | <p>WARNING: This action is irreversible! All indexed data will be lost!</p> |
209 | 209 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup schema wipe <span class="o">[</span>OPTIONS<span class="o">]</span> |
|
225 | 225 | </section> |
226 | 226 | </section> |
227 | 227 | <section id="dipdup-status"> |
228 | | -<h2>status<a class="headerlink" href="#dipdup-status" title="Permalink to this headline">¶</a></h2> |
| 228 | +<h2>status<a class="headerlink" href="#dipdup-status" title="Permalink to this heading">¶</a></h2> |
229 | 229 | <p>Show the current status of indexes in the database.</p> |
230 | 230 | <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup status <span class="o">[</span>OPTIONS<span class="o">]</span> |
231 | 231 | </pre></div> |
|
0 commit comments