Флаги командной строки
Флаги командной строки
subql (cli)
- помощь
> subql --help
КОМАНДЫ
build Построить код проекта SubQuery
codegen Генерировать схемы для узла графа
help Вывести справку для subql
init Инициализировать проект Subquery на основе эшафота
migrate Мигрировать манифест проекта Subquery с v0.0.1 на v0.2.0
publish Загрузите этот проект Subquery в IPFS
validate Проверить папку или репозиторий github на наличие проекта Subquery validate
создать
Эта команда использует webpack для генерации пакета проекта subquery.
| Параметры | Описание | | ------------------ | ---------------------------------------------------------- | ----------- | ---- | ----------------------- | | -l, --location | локальная папка проекта subquery (если ее еще нет в папке) | | -o, --output | указать выходную папку сборки, например, build-folder | | --mode=(production | prod | development | dev) | [ default: production ] |
В
subql buildвы можете указать дополнительные точки входа в поле exports, хотя он всегда будет строитьindex.tsавтоматически.Для использования поля exports необходимо иметь @subql/cli версии 0.19.0 или выше.
Любое поле
exportsдолжно соответствовать строковому типу (например,"entry": "./src/file.ts"), иначе оно будет проигнорировано при сборке.
subql-node
- помощь
Здесь отображаются параметры справки.
> subql-node --help
Commands:
run force-clean Clean the database dropping project schemas and tables. Once
the command is executed, the application would exit upon
completion.
run reindex Reindex to specified block height. Historical must be enabled
for the targeted project (--disable-historical=false). Once
the command is executed, the application would exit upon
completion.
Options:
--help Show help [boolean]
--version Show version number [boolean]
-f, --subquery Local path of the subquery project [string]
--subquery-name Name of the subquery project [deprecated] [string]
-c, --config Specify configuration file [string]
--local Use local mode [deprecated] [boolean]
--db-schema Db schema name of the project [string]
--unsafe Allows usage of any built-in module within the
sandbox [boolean][default: false]
--batch-size Batch size of blocks to fetch in one round [number]
--scale-batch-size scale batch size based on memory usage
[boolean] [default: false]
--timeout Timeout for indexer sandbox to execute the mapping
functions [number]
--debug Show debug information to console output. will
forcefully set log level to debug
[boolean] [default: false]
--profiler Show profiler information to console output
[boolean] [default: false]
--subscription Enable subscription [boolean] [default: false]
--network-endpoint Blockchain network endpoint to connect [string]
--output-fmt Print log as json or plain text
[string] [choices: "json", "colored"]
--log-level Specify log level to print. Ignored when --debug is
used
[string] [choices: "fatal", "error", "warn", "info", "debug", "trace",
"silent"]
--migrate Migrate db schema (for management tables only)
[boolean] [default: false]
--timestamp-field Enable/disable created_at and updated_at in schema
[boolean] [default: false]
-d, --network-dictionary Specify the dictionary api for this network [string]
-m, --mmr-path Local path of the merkle mountain range (.mmr) file
[string]
--proof-of-index Enable/disable proof of index
[boolean] [default: false]
-p, --port The port the service will bind to [number]
--disable-historical Disable storing historical state entities
[boolean] [default: true]
-w, --workers Number of worker threads to use for fetching and
processing blocks. Отключено по умолчанию. [number]
--версия
Здесь отображается текущая версия.
> subql-node --version
0.19.1
reindex
In order to use this command, you require `@subql/node:v1.10.0`/`@subql/node-YOURNETWORK:v1.10.0` or above. :::
When using reindex command, historical must be enabled for the targeted project (--disable-historical=false). After starting the project, it would print out a log stating if historical is enabled or not.
Further information on Automated Historical State Tracking
Use --targetHeight=<blockNumber> with reindex to remove indexed data and reindex from specified block height.
-f or --subquery flag must be passed in, to set path of the targeted project.
If the targetHeight is less than the declared starting height, it will execute the --force-clean command.
subql-node -f /example/subql-project reindex --targetHeight=30
Note
Once the command is executed and the state has been rolled back the the specified height, the application will exit. You can then start up the indexer to proceed again from this height.
force-clean
- In order to use this command you need to have
@subql/nodev1.10.0 or above.
This command forces the project schemas and tables to be regenerated. It is helpful to use when iteratively developing graphql schemas in order to ensure a clean state when starting a project. Обратите внимание, что этот флаг также сотрет все индексированные данные. This will also drop all related schema and tables of the project.
-f, --subquery flag must be passed in, to set path of the targeted project.
Note Similar to `reindex` command, the application would exit upon completion. :::
subql-node -f /example/subql-project force-clean
-f, --subquery
Используйте этот флаг для запуска проекта SubQuery.
subql-node -f . // или
subql-node --subquery .
--subquery-имя (устаревшее)
Этот флаг позволяет задать имя для вашего проекта, которое действует так, как будто создает экземпляр вашего проекта. При указании нового имени создается новая схема базы данных, и синхронизация блоков начинается с нуля. Утратил силу в пользу --db-schema
subql-node -f . --subquery-name=test2
-c, --конфигурация
Все эти различные конфигурации можно поместить в файл .yml или .json, а затем сослаться на него с помощью флага config.
Пример файла subquery_config.yml:
subquery: . // Обязательно. Это локальный путь проекта. Точка здесь означает текущий локальный каталог.
subqueryName: hello // Необязательное имя
batchSize: 55 // Необязательная конфигурация
Поместите этот файл в тот же каталог, что и проект. Затем в текущем каталоге проекта запустите:
> subql-node -c ./subquery_config.yml
--локальный (устаревший)
Этот флаг используется в основном для отладочных целей, где он создает таблицу starter_entity по умолчанию в схеме "postgres" по умолчанию.
subql-node -f . --local
Обратите внимание, что если вы используете этот флаг, его удаление не означает, что он будет указывать на другую базу данных. Для перенаправления на другую базу данных вам придется создать НОВУЮ базу данных и изменить настройки env на эту новую базу данных. Другими словами, "export DB_DATABASE=<new_db_here>".
--db-схема
Этот флаг позволяет задать имя для схемы базы данных проекта. При указании нового имени создается новая схема базы данных с настроенным именем и начинается блочное индексирование.
subql-node -f . --db-schema=test2
--подписка
Это создаст триггер уведомления на сущность, что также является необходимым условием для включения функции подписки в службе запросов.
- небезопасно
Проекты SubQuery обычно запускаются в песочнице javascript для безопасности, чтобы ограничить объем доступа проекта к вашей системе. Песочница ограничивает доступный импорт javascript следующими модулями:
["assert", "buffer", "crypto", "util", "path"];
Хотя это повышает безопасность, мы понимаем, что это ограничивает доступную функциональность вашего SubQuery. Команда --unsafe импортирует все модули javascript по умолчанию, что значительно увеличивает функциональность песочницы, но при этом снижает безопасность.
Note that the --unsafe command will prevent your project from being run in the SubQuery Network, and you must contact support if you want this command to be run with your project in SubQuery's Managed Service.
--размер партии
Этот флаг позволяет задать размер партии в командной строке. Если размер партии также задан в конфигурационном файле, он имеет приоритет.
> subql-node -f . --batch-size=20
2021-08-09T23:24:43.775Z <fetch> INFO fetch block [6601,6620], total 20 blocks
2021-08-09T23:24:45.606Z <fetch> INFO fetch block [6621,6640], total 20 blocks
2021-08-09T23:24:47.415Z <fetch> INFO fetch block [6641,6660], total 20 blocks
2021-08-09T23:24:49.235Z <fetch> INFO fetch block [6661,6680], total 20 blocks
--масштабируемый размер партии
Масштабируйте размер пакета выборки блоков в зависимости от использования памяти.
--тайм-аут
Установите пользовательский таймаут для javascript-песочницы для выполнения функций отображения над блоком до того, как функция отображения блока выбросит исключение по таймауту.
отладка
Это выводит отладочную информацию на консольный вывод и принудительно устанавливает уровень журнала на отладочный.
> subql-node -f . --debug
2021-08-10T11:45:39.471Z <db> DEBUG Executing (1b0d0c23-d7c7-4adb-a703-e4e5c414e035): INSERT INTO "subquery_1"."starter_entities" ("id","block_height","created_at","updated_at") VALUES ($1,$2,$3,$4) ON CONFLICT ("id") DO UPDATE SET "id"=EXCLUDED."id","block_height"=EXCLUDED."block_height","updated_at"=EXCLUDED."updated_at" RETURNING "id","block_height","created_at","updated_at";
2021-08-10T11:45:39.472Z <db> DEBUG Executing (default): UPDATE "subqueries" SET "next_block_height"=$1,"updated_at"=$2 WHERE "id" = $3
2021-08-10T11:45:39.472Z <db> DEBUG Executing (1b0d0c23-d7c7-4adb-a703-e4e5c414e035): COMMIT;
профиль
Здесь отображается информация о профилировщике.
subql-node -f . --local --profiler
2021-08-10T10:57:07.234Z <profiler> INFO FetchService, fetchMeta, 3876 ms
2021-08-10T10:57:08.095Z <profiler> INFO FetchService, fetchMeta, 774 ms
2021-08-10T10:57:10.361Z <profiler> INFO SubstrateUtil, fetchBlocksBatches, 2265 ms
2021-08-10T10:57:10.361Z <fetch> INFO fetch block [3801,3900], total 100 blocks
--Сетевая конечная точка
Этот флаг позволяет пользователям переопределять конфигурацию конечной точки сети из файла манифеста.
subql-node -f . --network-endpoint="wss://polkadot.api.onfinality.io/public-ws"
Обратите внимание, что это также должно быть установлено в файле манифеста, иначе вы получите:
ERROR Создать проект Subquery по заданному пути не удалось! Ошибка: не удалось разобрать project.yaml.
Экземпляр ProjectManifestImpl не прошел проверку:
- свойство network не выполнило следующие ограничения: isObject
- свойство network.network не прошло следующие ограничения: nestedValidation
--Вывод
Существует два различных формата вывода терминала. JSON или цвет. Colored (Цветной) используется по умолчанию и содержит цветной текст.
> subql-node -f . --output-fmt=json
{"level":"info","timestamp":"2021-08-10T11:58:18.087Z","pid":24714,"hostname":"P.local","category":"fetch","message":"fetch block [10501,10600], total 100 blocks"}
> subql-node -f . --output-fmt=colored
2021-08-10T11:57:41.480Z <subql-node> INFO node started
(node:24707) [PINODEP007] Warning: bindings.level is deprecated, use options.level option instead
2021-08-10T11:57:48.981Z <fetch> INFO fetch block [10201,10300], total 100 blocks
2021-08-10T11:57:51.862Z <fetch> INFO fetch block [10301,10400], total 100 blocks
--уровень лога
На выбор предлагается 7 вариантов. “fatal”, “error”, “warn”, “info”, “debug”, “trace”, “silent”. В приведенном ниже примере ничего не показывается. В терминале ничего не будет выведено, поэтому единственный способ узнать, работает узел или нет, - это запросить в базе данных количество строк (select count(*) from subquery_1.starter_entities) или запросить высоту блока.
> subql-node -f . --log-level=silent
(node:24686) [PINODEP007] Предупреждение: bindings.level устарел, вместо него используйте опцию options.level
(Используйте `node --trace-warnings ...`, чтобы показать, где было создано предупреждение)
(node:24686) [PINODEP007] Warning: bindings.level is deprecated, use options.level option instead
(node:24686) [PINODEP007] Warning: bindings.level is deprecated, use options.level option instead
(node:24686) [PINODEP007] Warning: bindings.level is deprecated, use options.level option instead
(node:24686) [PINODEP007] Warning: bindings.level is deprecated, use options.level option instead
(node:24686) [PINODEP007] Warning: bindings.level is deprecated, use options.level option instead
(node:24686) [PINODEP007] Warning: bindings.level is deprecated, use options.level option instead
(node:24686) [PINODEP007] Warning: bindings.level is deprecated, use options.level option instead
(node:24686) [PINODEP007] Warning: bindings.level is deprecated, use options.level option instead
(node:24686) [DEP0152] DeprecationWarning: Пользовательские аксессоры PerformanceEntry устарели. Пожалуйста, используйте свойство детализации.
(node:24686) [PINODEP007] Предупреждение: bindings.level устарел, вместо него используйте опцию options.level
--поле временной метки
По умолчанию это значение истина. если установлено значение ложь:
> subql-node -f . –timestamp-field=false
Это удаляет столбцы created_at и updated_at в таблице starter_entities.
-d, --сетевой словарь
Это позволяет вам указать конечную точку словаря, который является бесплатной услугой, предоставляемой и размещаемой в SubQuery's Project Explorer (поиск словаря) и представляет конечную точку API: https://api.subquery.network/sq/subquery/dictionary-polkadot.
Обычно этот параметр задается в файле манифеста, но ниже показан пример использования его в качестве аргумента в командной строке.
subql-node -f . -d "https://api.subquery.network/sq/subquery/dictionary-polkadot"
Подробнее о том, как работает словарь SubQuery .
-p, --порт
Порт, к которому привязывается служба индексирования подзапросов. По умолчанию установлено значение 3000.
--disable-historical
Отключает автоматическое отслеживание исторических состояний, см. Historic State Tracking. По умолчанию установлено значение false.
-w, --workers
Это позволит перевести добычу блока и обработку данных в рабочее состояние. По умолчанию эта функция будет выглядеть как disabled. Вы можете активировать это с помощью флага --workers=<number>. Обращаем ваше внимание, что количество доступных ядер процессора строго ограничивает использование рабочих потоков. Итак, при использовании флага --workers=<number> всегда задавайте количество работников. Без указания флага все будет выполняться в одном потоке.
Это позволит увеличить производительность в 4 раза. Попробуйте и оставьте нам обратную связь!
На данный момент он находится на ранней стадии эксперимента, но мы планируем включить его по умолчанию. :::
:::Примечание Эта функция доступна для Substrate и Cosmos и вскоре будет интегрирована в Avalanche.
subql-query
- помощь
Здесь отображаются параметры справки.
Options:
--help Show help [boolean]
--version Show version number [boolean]
-n, --name Project name [string] [required]
--playground Enable graphql playground [boolean]
--subscription Enable subscription [boolean] [default: false]
--output-fmt Print log as json or plain text
[string] [choices: "json", "colored"] [default: "colored"]
--log-level Specify log level to print.
[string] [варианты: "fatal", "error", "warn", "info", "debug", "trace",
"silent"] [по умолчанию: "info"]
--log-path Путь для создания файла журнала, например ./src/name.log [string]
--log-rotate Вращать файлы журнала в каталоге, указанном log-path
[boolean] [по умолчанию: false]
--indexer Url, позволяющий запросу получить доступ к метаданным индексатора [string]
--unsafe Отключить ограничения на глубину запроса и допустимое количество возвращаемых
query records [boolean]
-p, --port Порт, к которому будет привязан сервис [число]
--версия
Здесь отображается текущая версия.
> subql-query --version
0.7.0
-n, --имя
Этот флаг используется для запуска службы запросов. Если флаг --subquery-name не указан при запуске индексатора, имя здесь будет ссылаться на имя проекта по умолчанию. Если задано --subquery-name, то имя здесь должно соответствовать заданному.
> subql-node -f . // --subquery-name not set
> subql-query -n subql-helloworld --playground // имя по умолчанию соответствует имени каталога проекта
> subql-node -f . --subquery-name=hiworld // --subquery-name set
> subql-query -n hiworld --playground // имя указывает на проект subql-helloworld, но с именем hiworld
игровая площадка
Этот флаг включает игровую площадку graphql, поэтому он всегда должен быть включен по умолчанию, чтобы быть полезным.
--Вывод
Смотрите --output-fmt.
--уровень лога
Смотрите --loglevel.
--log-path
Включите ведение журнала файлов, указав путь к файлу, в который будет вестись журнал.
--log-поворот
Включите ротацию журналов с параметрами интервала ротации 1d, максимум 7 файлов и с максимальным размером файла 1GB.
--индексатор
Установите пользовательский url для расположения конечных точек индексатора, служба запросов использует эти конечные точки для определения состояния здоровья индексатора, метаданных и статуса готовности.
--подписка
Этот флаг включает GraphQL Subscriptions, для включения этой функции требуется subql-node также включить --subscription.
- небезопасно
Служба запросов имеет ограничение в 100 сущностей для неограниченных запросов graphql. Флаг unsafe снимает это ограничение, что может вызвать проблемы с производительностью службы запросов. Вместо этого рекомендуется, чтобы запросы были пагинированными.
Этот флаг позволяет использовать некоторые функции агрегирования, включая sum, max, avg и другие. Подробнее об этой функции здесь.
По умолчанию они отключены из-за лимита сущностей.
Обратите внимание, что команда --unsafe не позволит запустить ваш проект в сети SubQuery, и вы должны обратиться в службу поддержки, если хотите, чтобы эта команда была запущена с вашим проектом в SubQuery's Managed Services.
--порт
Порт, к которому привязывается служба запросов Subquery. По умолчанию установлено значение 3000