命令行标志

SubQuery Team大约 10 分钟

命令行标志

subql (cli)

--help

> subql --help

COMMANDS
  build     Build this SubQuery project code
  codegen   Generate schemas for graph node
  help      display help for subql
  init      Initialize a scaffold subquery project
  migrate   Migrate Subquery project manifest v0.0.1 to v0.2.0
  publish   Upload this SubQuery project to IPFS
  validate  Check a folder or github repo is a validate subquery project

构建...

此命令使用 webpack 生成 subquery 项目的捆绑包。

| 选项 | 描述 | | ------------------ | --------------------------------------------- | ----------- | ---- | ---------------------- | | -l, --location | subquery 项目的本地文件夹(如果没有在文件夹中) | | -o, --output | 指定构建的输出文件夹，例如：build-folder | | --mode=(production | prod | development | dev) | [ 默认︰ production ] |

用subql build命令，您可以在 exports 字段中指定额外的入口点，尽管它总是会自动构建 index.ts
您需要有 @subql/cli v0.19.0 或更高版本才能使用 exports 字段。
任何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. Disabled by default.     [number]

--version

这将显示当前版本。

> 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/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

-f, --subquery

使用此标志启动 SubQuery 项目。

subql-node -f . // 或者
subql-node --subquery .

--subquery-name (已废弃)

如果您新建了一个项目的实例，这个命令行将允许您为这个项目提供一个新名称。在提供一个新名称后，将创建一个新的数据库模式，并从零区块开始进行区块同步。已弃用，取而代之的是 --db-schema

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

-c, --config

所有这些不同的配置都可以放置到 .yml 或 .json 文件中，然后用 config 参数进行引用。

示例 subquery_config.yml 文件：

subquery: . // Mandatory. This is the local path of the project. The period here means the current local directory.
subqueryName: hello // Optional name
batchSize: 55 // Optional config

将此文件放在与项目相同的目录中。然后在当前项目目录中，运行：

> subql-node -c ./subquery_config.yml

--local (已废弃)

这个标志主要用于调试，在默认的“postgres”模式中创建默认 starter_entity 表。

subql-node -f . --local

请注意，一旦您使用此命令行，删除它并不意味着它会指向另一个数据库。要重新指向另一个数据库，您将需要创建一个新的数据库，并将环境设置更改为这个新数据库。换言之，“export DB_DATABASE=<new_db_here>".

--db-schema

此标志允许您为项目数据库方案提供一个名称。提供新名称后，将使用配置的名称创建新的数据库模式，并开始块索引。

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

--subscription

这将在实体上创建一个通知触发器，这也是在查询服务中启用订阅功能的先决条件。

--unsafe

SubQuery 项目通常在 javascript sandbox 中运行，以保证安全，限制项目对您系统的访问范围。沙盒将可用的 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 Serviceopen in 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

--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;

--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

--network-endpoint

此命令行允许用户从清单文件覆盖网络端点配置。

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

请注意，这也必须在清单文件中设置，否则您将会得到：

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

--output-fmt

有两种不同的终端输出格式。 JSON 或者 colored。 colored 是默认的，包含着 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

--log-level

有七个选项可供选择： “fatal”, “error”, “warn”, “info”, “debug”, “trace”, “silent”. 下面的示例显示 silent。终端中不会打印任何内容，所以，判断节点工作与否的唯一方法是查询数据库中的行数（从 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. Please use the detail property.
(node:24686) [PINODEP007] Warning: bindings.level is deprecated, use options.level option instead

--timestamp-field

默认情况下是正确的。当设置成 false 时：

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

这将删除在 starter_entities 表中的 created_at 和 updated_at 列

-d, --network-dictionary

这允许您指定一个字典端点，这是一个免费的服务，其在 https://explorer.subquery etwork/open in new window (搜索字典) 上提供和托管。并提供了一个 API 端口： https://api.subquery.network/sq/sq/subquery/dictiony-polkadot.

通常，这将在您的清单文件中设置，但在下面显示一个在命令行中使用它作为参数的例子。

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

阅读更多关于 SubQuery 字典的工作原理

-p, --port

Subquery 索引服务绑定到的端口。默认设置为 3000.

--disable-history

禁用自动状态跟踪，查看历史状态跟踪。默认情况下为 false。

-w, --workers

这将把块提取和处理移动到一个工作者。默认情况下，此功能是 已禁用。您可以使用 --workers=<number> 标志启用它。请注意，可用的 CPU 核心数严格限制了工人线程的使用。因此，当使用 --workers=<number> 标志时，总是指定工人的数量。如果没有提供标记，所有东西都将在同一线程中运行。

提示它可以提高性能最多 4 次。试试一下，让我们知道你的反馈！

目前它处于早期试验阶段，但我们计划默认启用它。 :::

::: 信息注释此功能可用于 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] [choices: "fatal", "error", "warn", "info", "debug", "trace",
                                                     "silent"] [default: "info"]
      --log-path    Path to create log file e.g ./src/name.log          [string]
      --log-rotate  Rotate log files in directory specified by log-path
                                                      [boolean] [default: false]
      --indexer     Url that allows query to access indexer metadata    [string]
      --unsafe      Disable limits on query depth and allowable number returned
                    query records                                      [boolean]
  -p, --port        The port the service will bind to                   [number

--version

这将显示当前版本。

> subql-query --version
0.7.0

-n, --name

该标志用于启动查询服务。如果在运行索引器时未提供 --subquery-name 标志，则此处的名称将引用默认项目名称。如果设置了 --subquery-name，那么这里的名称应该与设置的匹配。

> subql-node -f . // --subquery-name not set

> subql-query -n subql-helloworld  --playground // the name defaults to the project directory name

> subql-node -f . --subquery-name=hiworld // --subquery-name set

> subql-query -n hiworld --playground  // the name points to the subql-helloworld project but with the name of hiworld

--playground

这个标识符启用了 graphql playground，所以在默认情况下，应该始终包含有任何用途。

--output-fmt

查看 --output-fmt.

--log-level

查看 --loglevel.

--log-path

通过提供要记录到的文件的路径来启用文件记录。

--log-rotate

使用 1d 轮换间隔选项启用文件日志轮换，最多 7 个文件，最大文件大小为 1GB。

--indexer

为索引器端点的位置设置自定义 url，查询服务将这些端点用于索引器运行状况、元数据和就绪状态。

--subscription

此标志启用 GraphQL 订阅, 以启用此功能需要 subql-node 也启用 --subscription.

--unsafe

查询服务的无界 graphql 查询限制为 100 个实体。 unsafe 标志删除了此限制，这可能会导致查询服务出现性能问题。建议改为分页open in new window查询。

此标志启用某些聚合函数，包括 sum、max、avg 等。在此处了解有关此功能的更多信息。

由于实体限制，它们默认被禁用。

**请注意，--unsafe 命令将阻止您的项目在 SubQuery 网络中运行，如果您希望此命令与您的项目一起在

SubQuery 的托管服务中运行。

--port

Subquery 索引服务绑定到的端口。默认设置为 3000

命令行标志

# 命令行标志

# subql (cli)

# --help

# 构建...

# subql-node

# --help

# --version

# reindex

# force-clean

# -f, --subquery

# --subquery-name (已废弃)

# -c, --config

# --local (已废弃)

# --db-schema

# --subscription

# --unsafe

# --batch-size

# --scale-batch-size

# --timeout

# --debug

# --profiler

# --network-endpoint

# --output-fmt

# --log-level

# --timestamp-field

# -d, --network-dictionary

# -p, --port

# --disable-history

# -w, --workers

# subql-query

# --help

# --version

# -n, --name

# --playground

# --output-fmt

# --log-level

# --log-path

# --log-rotate

# --indexer

# --subscription

# --unsafe

# --port

命令行标志

subql (cli)

--help

构建...

subql-node

--help

--version

reindex

force-clean

-f, --subquery

--subquery-name (已废弃)

-c, --config

--local (已废弃)

--db-schema

--subscription

--unsafe

--batch-size

--scale-batch-size

--timeout

--debug

--profiler

--network-endpoint

--output-fmt

--log-level

--timestamp-field

-d, --network-dictionary

-p, --port

--disable-history

-w, --workers

subql-query

--help

--version

-n, --name

--playground

--output-fmt

--log-level

--log-path

--log-rotate

--indexer

--subscription

--unsafe

--port