From 5eefb86ae81d66d9b6160d582ea18dbce311324b Mon Sep 17 00:00:00 2001 From: bgodlin <37313677+bgodlin@users.noreply.github.com> Date: Thu, 7 Mar 2024 08:20:40 +0100 Subject: [PATCH] csv export docker reference (#485) * csv export docker reference * Update docs/run_publish/references.md --------- Co-authored-by: James Bayly --- docs/run_publish/references.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/run_publish/references.md b/docs/run_publish/references.md index 5d7d4d83a6a..520ed50195e 100644 --- a/docs/run_publish/references.md +++ b/docs/run_publish/references.md @@ -93,6 +93,20 @@ Data Mutations: subql-node --csv-out-dir=/csv-dir/ -f subql-project.ts ``` +::: tip Note +When running your project using Docker, it is important to consider your current volume mounts. If you initiated your project using a template, it is likely that you already have Docker volumes mounted, typically defined in a `docker-compose.yaml` file as follows: + +``` +- ./:/app +``` + +To enable the export to function properly with `csv-dir` as the target folder, follow these steps: + +1. Create an empty folder named `csv-dir` in the root directory of your project. +2. Specify `app` in the path of the parameter, so that the complete parameter appears as follows: `- --csv-out-dir=/app/csv-dir` + +::: + ### --db-schema **String** - This flag allows you to provide a name for the project database schema. Upon providing a new name, a new database schema is created with the configured name and block indexing starts.