Прапори командного рядка

... 2022-12-1 Приблизно 5 хв

# Прапори командного рядка

# subql (cli)

# --help

> subql --help

COMMANDS
  build     Створіть цей код проекту SubQuery
  codegen   Створення схем для вузла graph
  help      відображення довідки для subql
  init      Ініціалізуйте проект SubQuery scaffold
  migrate   Перенести маніфест проекту SubQuery v0.0.1 в v0.2.0
  publish   Завантажте цей проект SubQuery в IPFS
  validate  Перевірка папки або сховища github - це проект перевірки SubQuery
1
2
3
4
5
6
7
8
9
10

# будувати

Ця команда використовує webpack для створення пакету проєкту subquery.

Опція Описання
-l, --location локальна тека проєкту subquery (якщо вона ще не знаходиться в теці)
-o, --output вкажіть вихідну теку збірки, наприклад, build-folder
--mode=(production prod
  • За допомогою subql build ви можете вказати додаткові точки входу в поле exports, хоча він завжди буде будуватися index.Ts автоматично.

  • Для використання поля експорту у вас повинен бути @subql/cli версії 0.19.0 або вище.

  • Будь-яке поле exports має відповідати рядковому типу (наприклад, "entry": "./src/file.ts"), інакше воно буде проігноровано при складанні.

ще один приклад.

# subql-node

# --help

Тут показуватися параметри довідки.

> 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]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

# --version

При цьому показуватися поточна версія.

> subql-node --version
0.19.1
1
2

# reindex

In order to use this command, you require `@subql/node:v1.10.0`/`@subql/node-: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
1

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/node v1.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
1

# -f, --subquery

Використовуйте цей прапорець, щоб запустити проєкт SubQuery.

subql-node -f . // бо
subql-node --subquery .
1
2

# --subquery-name (засуджувати)

Цей прапорець дозволяє вказати ім'я для вашого проєкту, яке діє так, як якби він створив екземпляр вашого проєкту. Після надання нового імені створюється нова схема бази даних, і синхронізація блоків починається з нуля. Застарів на користь --db-schema

subql-node -f . --subquery-name=test2
1

# -c, --config

Всі ці різні конфігурації можуть бути поміщені в .yml yml або .json, на який потім посилаються за допомогою прапора конфігурації.

Зразок subquery_config.yml file:

subquery: . // Mandatory. Це локальний шлях проєкту. Точка тут означає поточний локальний каталог.
subqueryName: hello // Необов'язкове ім'я
batchSize: 55 // Додаткова конфігурація
1
2
3

Помістіть цей файл в той же каталог, що і проєкт. Потім в поточному каталозі проєкту запустіть:

> subql-node -c ./subquery_config.yml
1

# --local (засуджувати)

Цей прапор в основному використовується для цілей налагодження, де він створює таблицю starter_entity за замовчуванням у схемі postgres за замовчуванням.

subql-node -f . --local
1

Зверніть увагу, що як тільки ви використовуєте цей прапор, його видалення не означатиме, що він буде вказувати на іншу базу даних. Щоб вказати на іншу базу даних, вам потрібно буде створити нову базу даних та змінити налаштування env для цієї нової бази даних. Іншими словами, "export DB_DATABASE=<new_db_here>".

# --db-schema

Цей прапорець дозволяє вказати ім'я для схеми бази даних проєкту. Після надання нового імені створюється нова схема бази даних з налаштованим ім'ям і починається індексація блоків.

subql-node -f . --db-schema=test2
1

# --subscription

Це створить тригер повідомлення для об'єкта, це також є необхідною умовою для включення функції підписки в службі запитів.

# --unsafe

Проєкти SubQuery зазвичай виконуються в ізольованому середовищі javascript для забезпечення безпеки, щоб обмежити обсяг доступу проєкту до вашої системи. Ізольоване середовище обмежує доступний імпорт javascript наступними модулями:

["assert", "buffer", "crypto", "util", "path"];
1

Хоча це підвищує безпеку, ми розуміємо, що це обмежує доступну функціональність вашого 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 (opens new window).

# --batch-size

Цей прапор дозволяє встановити розмір пакета в командному рядку. Якщо розмір пакета також заданий в конфігураційному файлі, це має прецедент.

> 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
1
2
3
4
5

# --scale-batch-size

Масштабуйте розмір пакета вибірки блоків залежно від використання пам'яті.

# --timeout

Встановіть користувальницький тайм-аут для пісочниці javascript для виконання функцій зіставлення над блоком, перш ніж функція зіставлення блоків видасть виняток тайм-ауту.

# --debug

Це виводить налагоджувальну інформацію на висновок консолі й примусово встановлює рівень журналу для налагодження.

> 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;
1
2
3
4

# --profiler

Тут показуватися інформація про профілювальника.

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
1
2
3
4
5

# --network-endpoint

Цей прапорець дозволяє користувачам перевизначати конфігурацію кінцевої точки мережі з файлу маніфесту.

subql-node -f . --network-endpoint="wss://polkadot.api.onfinality.io/public-ws"
1

Зверніть увагу, що це також має бути задано у файлі маніфесту, в іншому випадку ви отримаєте:

ERROR Create Subquery project from given path failed! Error: failed to parse project.yaml.
An instance of ProjectManifestImpl has failed the validation:
 - property network has failed the following constraints: isObject
 - property network.network has failed the following constraints: nestedValidation
1
2
3
4

# --output-fmt

Існує два різних форматів виводу терміналу. JSON або кольоровий. Кольорове значення за замовчуванням і містить кольоровий текст.

> 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"}
1
2
> 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
1
2
3
4
5

# --log-level

Є 7 варіантів на вибір. “fatal”, “error”, “warn”, “info”, “debug”, “trace”, “silent”. У наведеному нижче прикладі показано мовчання. У терміналі нічого не буде надруковано, тому єдиним способом визначити, чи працює вузол чи ні, є запит на кількість рядків у базі даних (виберіть count(*) з subquery_1.starter_entities) або запитати висоту блоку.

> subql-node -f . --log-level=silent
(node:24686) [PINODEP007] Warning: bindings.level is deprecated, use options.level option instead
(Use `node --trace-warnings ...` to show where the warning was created)
(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: Custom PerformanceEntry accessors are deprecated. Будь ласка, використовуйте властивість detail.
(node:24686) [PINODEP007] Warning: bindings.level is deprecated, use options.level option instead
1
2
3
4
5
6
7
8
9
10
11
12
13

# --timestamp-field

За замовчуванням це значення дорівнює true. коли встановлено значення false за допомогою:

> subql-node -f . –timestamp-field=false
1

При цьому видаляються стовпці created_at і updated_at в таблиці starter_entities.

# -d, --network-dictionary

Це дозволяє вказати кінцеву точку словника, яка є безплатною службою, що надається та розміщується в Project Explorer (opens new window) SubQuery's (пошук за словником) і представляє кінцеву точку API: https://api.subquery.network/sq/subquery/dictionary-polkadot.

Зазвичай це значення задається у вашому файлі маніфесту, але нижче наведено приклад його використання в якості аргументу в командному рядку.

subql-node -f . -d "https://api.subquery.network/sq/subquery/dictionary-polkadot"
1

докладніше про те, як працює словник SubQuery, читайте тут.

# -p, --port

Порт, до якого прив'язується служба індексації subquery. За замовчуванням це значення дорівнює 3000.

# --disable-historical

Вимикає автоматичне відстеження історичного стану, див. розділ відстеження історичного стану. За замовчуванням для цього параметра встановлено значення false.

# -w, --workers

Це перемістить вибірку та обробку блоків у Worker. За умовчанням цю функцію ** disabled **. Ви можете ввімкнути його за допомогою позначки --workers=<number>. Зауважте, що кількість доступних ядер ЦП суворо обмежує використання робочих потоків. Отже, використовуючи прапорець --workers=<number>, завжди вказуйте кількість працівників. Якщо прапорець не надано, усе працюватиме в одному потоці.

Порада Це може збільшити продуктивність до 4 разів. Спробуйте й повідомте нам свій відгук!

На даний момент він знаходиться на ранній експериментальній стадії, але ми плануємо ввімкнути його за умовчанням. :::

:: info Примітка Ця функція доступна для Substrate і Cosmos, і незабаром буде інтегрована для Avalanche. :::

# subql-query

# --help

Тут показуватися параметри довідки.

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"] [default: "info"]
      --log-path      Шлях для створення файлу журналу e.g ./src/name.log          [string]
      --log-rotate    Поворот файлів журналу в каталозі, зазначеному log-path
                                                      [boolean] [default: false]
      --indexer       Url-адреса, що дозволяє запиту отримати доступ до метаданих індексатора    [string]
      --unsafe        Вимкніть обмеження на глибину запиту і допустиме число, що повертається
                      записи query                                      [boolean]
  -p, --port          Порт, до якого буде прив'язана служба                   [number]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# --version

При цьому показуватися поточна версія.

> subql-query --version
0.7.0
1
2

# -n, --name

Цей прапор використовується для запуску служби query. Якщо прапор -- subquery-name не вказано при запуску індексатора, ім'я тут буде посилатися на ім'я проєкту за замовчуванням. Якщо задано --subquery-name, то ім'я тут має відповідати тому, що було задано.

> subql-node -f . // --subquery-name не встановлено

> subql-query -n subql-helloworld  --playground // ім'я за замовчуванням дорівнює імені каталогу проекту
1
2
3
> subql-node -f . --subquery-name=hiworld // --subquery-name set

> subql-query -n hiworld --playground  // назва вказує на проєкт subql-helloworld, але з назвою hiworld
1
2
3

# --playground

Цей прапор включає ігровий майданчик graphql, тому вона завжди повинна бути включена за замовчуванням, щоб бути корисною.

# --output-fmt

Бачачи --output-fmt.

# --log-level

Бачачи --log-level.

# --log-path

Увімкніть ведення журналу файлів, вказавши шлях до файлу для входу в систему.

# --log-rotate

Увімкніть обертання журналу файлів з параметрами інтервалу обертання 1D, максимум 7 файлів і з максимальним розміром файлу 1 Гб.

# --indexer

Задайте користувацьку Url-адресу для розташування кінцевих точок індексів, служба запитів використовує ці кінцеві точки для визначення працездатності індексатора, метаданих і стану готовності.

# --subscription

Цей прапорець включає підписки на GraphQL, для включення цієї функції потрібно subql-node також включити --subscription.

# --unsafe

Служба запитів має обмеження в 100 об'єктів для необмежених запитів graphql. Прапор unsafe видаляє це обмеження, яке може викликати проблеми з продуктивністю служби запитів. Замість цього рекомендується, щоб запити були розбиті на сторінки (opens new window).

Цей прапор включає певні функції агрегування, включаючи sum, max, avg та інші. Докладніше про цю функцію читайте тут.

За замовчуванням вони відключені через обмеження сутності.

Зверніть увагу, що команда --unsafe запобігає запуску вашого проєкту в мережі SubQuery, і ви повинні звернутися в службу підтримки, якщо хочете, щоб ця команда виконувалася з вашим проєктом в керованих службах SubQuery's (opens new window).

# --port

Порт, до якого прив'язується служба запитів subquery. За замовчуванням це значення дорівнює 3000

Останнє оновлення: December 1, 2022 23:29