dipdup¶
Manage and run DipDup indexers.
Documentation: https://docs.dipdup.io
Issues: https://github.com/dipdup-io/dipdup/issues
dipdup [OPTIONS] COMMAND [ARGS]...
Options
- --version¶
Show the version and exit.
- -c, --config <PATH>¶
A path to DipDup project config (default: dipdup.yml).
- -e, --env-file <PATH>¶
A path to .env file containing KEY=value strings.
config¶
Commands to manage DipDup configuration.
dipdup config [OPTIONS] COMMAND [ARGS]...
env¶
Dump environment variables used in DipDup config.
If variable is not set, default value will be used.
dipdup config env [OPTIONS]
Options
- -f, --file <file>¶
Output to file instead of stdout.
export¶
Print config after resolving all links and, optionally, templates.
WARNING: Avoid sharing output with 3rd-parties when –unsafe flag set - it may contain secrets!
dipdup config export [OPTIONS]
Options
- --unsafe¶
Resolve environment variables or use default values from config.
- --full¶
Resolve index templates.
hasura¶
Commands related to Hasura integration.
dipdup hasura [OPTIONS] COMMAND [ARGS]...
configure¶
Configure Hasura GraphQL Engine to use with DipDup.
dipdup hasura configure [OPTIONS]
Options
- --force¶
Proceed even if Hasura is already configured.
init¶
Generate project tree, callbacks and types.
This command is idempotent, meaning it won’t overwrite previously generated files unless asked explicitly.
dipdup init [OPTIONS]
Options
- --overwrite-types¶
Regenerate existing types.
- --keep-schemas¶
Do not remove JSONSchemas after generating types.
install¶
Install DipDup for the current user.
dipdup install [OPTIONS]
Options
- -q, --quiet¶
Use default values for all prompts.
- -f, --force¶
Force reinstall.
- -r, --ref <ref>¶
Install DipDup from a specific git ref.
- -p, --path <path>¶
Install DipDup from a local path.
migrate¶
Migrate project to the new spec version.
If you’re getting MigrationRequiredError after updating DipDup, this command will fix imports and type annotations to match the current spec_version. Review and commit changes after running it.
dipdup migrate [OPTIONS]
new¶
Create a new project interactively.
dipdup new [OPTIONS]
Options
- -q, --quiet¶
Use default values for all prompts.
- -f, --force¶
Overwrite existing files.
- -r, --replay <replay>¶
Replay a previously saved state.
run¶
Run indexer.
Execution can be gracefully interrupted with Ctrl+C or SIGINT signal.
dipdup run [OPTIONS]
schema¶
Commands to manage database schema.
dipdup schema [OPTIONS] COMMAND [ARGS]...
approve¶
Continue to use existing schema after reindexing was triggered.
dipdup schema approve [OPTIONS]
export¶
Print SQL schema including scripts from sql/on_reindex.
This command may help you debug inconsistency between project models and expected SQL schema.
dipdup schema export [OPTIONS]
init¶
Prepare a database for running DipDip.
This command creates tables based on your models, then executes sql/on_reindex to finish preparation - the same things DipDup does when run on a clean database.
dipdup schema init [OPTIONS]
wipe¶
Drop all database tables, functions and views.
WARNING: This action is irreversible! All indexed data will be lost!
dipdup schema wipe [OPTIONS]
Options
- --immune¶
Drop immune tables too.
- --force¶
Skip confirmation prompt.
status¶
Show the current status of indexes in the database.
dipdup status [OPTIONS]
uninstall¶
Uninstall DipDup for the current user.
dipdup uninstall [OPTIONS]
Options
- -q, --quiet¶
Use default values for all prompts.
update¶
Update DipDup for the current user.
dipdup update [OPTIONS]
Options
- -q, --quiet¶
Use default values for all prompts.
- -f, --force¶
Force reinstall.