Bendera Baris Perintah
Bendera Baris Perintah
subql (cli)
--help
> subql --help
PERINTAH
build Bangun kode proyek SubQuery ini
codegen Hasilkan skema untuk simpul graf
help menampilkan bantuan untuk subql
init Inisialisasi proyek subquery perancah
migrate Migrasikan Manifest proyek SubQuery v0.0.1 ke v0.2.0
publish Unggah proyek SubQuery ini ke IPFS
validate Memeriksa folder atau repo github adalah proyek subquery yang validate
build
Perintah ini menggunakan webpack untuk menghasilkan bundel proyek subquery.
| Pilihan | Deskripsi | | ------------------ | ------------------------------------------------------- | ----------- | ---- | ----------------------- | | -l, --location | folder lokal proyek subquery (jika belum ada di folder) | | -o, --output | tentukan folder keluaran build mis. membangun-folder | | --mode=(production | prod | development | dev) | [ default: production ] |
Dengan
subql buildAnda dapat menentukan titik masuk tambahan di bidang ekspor meskipun itu akan selalu dibangunindex.tssecara otomatis.Anda harus memiliki @subql/cli v0.19.0 atau lebih tinggi untuk menggunakan bidang ekspor.
Setiap bidang
eksporharus dipetakan ke tipe string (mis."entry": "./src/file.ts"), jika tidak, akan diabaikan dari build.
subql-node
--help
Ini menunjukkan opsi bantuan.
> 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. akan
secara paksa mengatur level log ke debug
[boolean] [default: false]
--profiler Tampilkan informasi profiler ke output konsol
[boolean] [default: false]
--subscription Aktifkan langganan [boolean] [default: false]
--network-endpoint Titik akhir jaringan Blockchain untuk terhubung [string]
--output-fmt Cetak log sebagai json atau teks biasa
[string] [pilihan: "json", "berwarna"]
--log-level Tentukan level log yang akan dicetak. 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. Dinonaktifkan oleh Default. [number]
--version
Ini menampilkan versi saat ini.
> 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. Perhatikan bahwa tanda ini juga akan menghapus semua data yang diindeks. 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
Gunakan tanda ini untuk memulai proyek SubQuery.
subql-node -f . // ATAU
subql-node --subquery .
--subquery-name (usang)
Bendera ini memungkinkan Anda untuk memberikan nama untuk proyek Anda yang bertindak seolah-olah itu membuat turunan dari proyek Anda. Setelah memberikan nama baru, skema database baru dibuat dan sinkronisasi blok dimulai dari nol. Tidak digunakan lagi karena --db-schema
subql-node -f . --subquery-name=test2
-c, --config
Semua berbagai konfigurasi ini dapat ditempatkan ke dalam file .yml atau .json dan kemudian dirujuk dengan flag config.
Contoh file subquery_config.yml:
subquery: . // Mandatory. Ini adalah jalur lokal proyek. Titik di sini berarti direktori lokal saat ini.
subqueryName: hello // Pilihan nama
batchSize: 55 // Pilihan config
Tempatkan file ini di direktori yang sama dengan proyek. Kemudian di direktori proyek saat ini, jalankan:
> subql-node -c ./subquery_config.yml
--local (usang)
Bendera ini terutama digunakan untuk tujuan debugging di mana ia membuat tabel starter_entity default dalam skema "postgres" default.
subql-node -f . --local
Perhatikan bahwa setelah Anda menggunakan bendera ini, menghapusnya tidak berarti bahwa itu akan mengarah ke database lain. Untuk menunjuk kembali ke database lain, Anda harus membuat database BARU dan mengubah pengaturan env ke database baru ini. Dengan kata lain, "ekspor DB_DATABASE=<new_db_here>".
--db-schema
Bendera ini memungkinkan Anda untuk memberikan nama untuk skema database proyek. Setelah memberikan nama baru, skema database baru dibuat dengan nama yang dikonfigurasi dan pengindeksan blok dimulai.
subql-node -f . --db-schema=test2
--berlangganan
Ini akan membuat pemicu notifikasi pada entitas, ini juga merupakan prasyarat untuk mengaktifkan fitur berlangganan di layanan kueri.
--unsafe
Proyek SubQuery biasanya dijalankan dalam kotak pasir javascript untuk keamanan guna membatasi cakupan akses yang dimiliki proyek ke sistem Anda. Kotak pasir membatasi impor javascript yang tersedia ke modul berikut:
["assert", "buffer", "crypto", "util", "path"];
Meskipun ini meningkatkan keamanan, kami memahami bahwa ini membatasi fungsionalitas SubQuery Anda yang tersedia. Perintah --unsafe mengimpor semua modul javascript default yang sangat meningkatkan fungsionalitas kotak pasir dengan pengorbanan keamanan yang menurun.
Perhatikan bahwa perintah --unsafe akan mencegah proyek Anda dijalankan di Jaringan SubQuery, dan Anda harus menghubungi bagian dukungan jika Anda ingin perintah ini dijalankan dengan proyek Anda di SubQuery's Managed Service.
--batch-size
Bendera ini memungkinkan Anda untuk mengatur ukuran batch di baris perintah. Jika ukuran batch juga diatur dalam file konfigurasi, ini akan menjadi preseden.
> 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
Skala ukuran batch pengambilan blok dengan penggunaan memori.
--timeout
Setel batas waktu khusus untuk kotak pasir javascript untuk menjalankan fungsi pemetaan di atas satu blok sebelum fungsi pemetaan blok mengeluarkan pengecualian batas waktu.
--debug
Ini mengeluarkan informasi debug ke keluaran konsol dan secara paksa menyetel level log ke 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
Ini menunjukkan informasi 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
Bendera ini memungkinkan pengguna untuk mengganti konfigurasi titik akhir jaringan dari file manifes.
subql-node -f . --network-endpoint="wss://polkadot.api.onfinality.io/public-ws"
Perhatikan bahwa ini juga harus diatur dalam file manifes, jika tidak, Anda akan mendapatkan:
GALAT Buat proyek Subquery dari jalur yang diberikan gagal! Kesalahan: gagal mengurai project.yaml.
Sebuah instance dari ProjectManifestImpl telah gagal validasi:
- jaringan properti telah gagal dalam batasan berikut: isObject
- properti network.network telah gagal dalam batasan berikut: nestedValidation
--output-fmt
Ada dua format keluaran terminal yang berbeda. JSON atau berwarna. Berwarna adalah default dan berisi teks berwarna.
> 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
Ada 7 pilihan yang bisa dipilih. “fatal”, “error”, “warn”, “info”, “debug”, “trace”, “silent”. Contoh di bawah ini menunjukkan diam. Tidak ada yang akan dicetak di terminal sehingga satu-satunya cara untuk mengetahui apakah node berfungsi atau tidak adalah dengan menanyakan database untuk jumlah baris (pilih count(*) dari subquery_1.starter_entities) atau kueri ketinggian blok.
> 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. Silakan gunakan properti detail.
(node:24686) [PINODEP007] Warning: bindings.level is deprecated, use options.level option instead
--timestamp-field
Secara default ini benar. ketika disetel ke false dengan:
> subql-node -f . –timestamp-field=false
Ini menghapus kolom create_at dan updated_at di tabel starter_entities.
-d, --network-dictionary
Ini memungkinkan Anda untuk menentukan titik akhir kamus yang merupakan layanan gratis yang disediakan dan dihosting di: https://explorer.subquery.network/ (mencari kamus) dan menyajikan titik akhir API: https //api.subquery.network/sq/subquery/dictionary-polkadot.
Biasanya ini akan diatur dalam file manifes Anda, tetapi di bawah ini menunjukkan contoh penggunaannya sebagai argumen di baris perintah.
subql-node -f . -d "https://api.subquery.network/sq/subquery/dictionary-polkadot"
Baca selengkapnya tentang cara kerja Kamus SubQuery.
-p, --port
Port yang diikat oleh layanan pengindeksan subquery. Secara default ini diatur ke 3000.
--disable-historical
Menonaktifkan pelacakan status historis otomatis, lihat Pelacakan Status Historis. Secara default ini diatur ke 3000.
-w, --workers
Ini akan memindahkan pengambilan dan pemrosesan blok ke dalam worker. Secara default, fitur ini disabled. Anda bisa mengaktifkannya dengan flag --workers=<number>. Perhatikan bahwa jumlah core CPU yang tersedia sangat membatasi penggunaan thread pekerja. Jadi, ketika menggunakan flag --workers=<number>, selalu tentukan jumlah pekerja. Tanpa flag yang disediakan, semuanya akan berjalan dalam thread yang sama.
Tip Tip Ini bisa meningkatkan performa hingga 4 kali lipat. Cobalah dan beri tahu kami tanggapan Anda!
Saat ini, ini masih dalam tahap percobaan awal, tetapi kami berencana untuk mengaktifkannya secara default. :::
Catatan
Fitur ini tersedia untuk Substrate dan Cosmos, dan akan segera diintegrasikan untuk Avalanche.
subql-query
--help
Ini menunjukkan opsi bantuan.
Pilihan:
--help Tampilkan bantuan [boolean]
--version Tampilkan nomor versi [boolean]
-n, --name Nama proyek [string] [required]]
--playground Aktifkan taman bermain graphql [boolean]
--subscription Aktifkan subscription [boolean] [default: false]
--output-fmt Mencetak log sebagai json atau teks biasa
[string] [pilihan: "json", "colored"] [default: "colored"]
--log-level Tentukan level log yang akan dicetak.
[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 yang memungkinkan kueri mengakses metadata pengindeks [string]
--unsafe Nonaktifkan batasan pada kedalaman kueri dan jumlah yang diizinkan yang dikembalikan
catatan kueri [boolean]
-p, --port Port yang akan diikat oleh layanan [number]
--version
Ini menampilkan versi saat ini.
> subql-query --version
0.7.0
-n, --name
Bendera ini digunakan untuk memulai layanan kueri. Jika flag --subquery-name tidak disediakan saat menjalankan pengindeks, nama di sini akan merujuk ke nama proyek default. Jika --subquery-name disetel, maka nama di sini harus sesuai dengan yang disetel.
> subql-node -f . // --subquery-name tidak diatur
> subql-query -n subql-helloworld --playground // nama default ke nama direktori proyek
> subql-node -f . --subquery-name=hiworld // --subquery-name set
> subql-query -n hiworld --playground // namanya menunjuk ke proyek subql-helloworld tetapi dengan nama hiworld
--playground
Bendera ini mengaktifkan taman bermain graphql sehingga harus selalu disertakan secara default untuk digunakan apa pun.
--output-fmt
Lihat --output-fmt.
--log-level
Lihat --log-level.
--log-path
Aktifkan logging file dengan menyediakan jalur ke file untuk login ke.
--log-rotate
Aktifkan rotasi log file dengan opsi interval rotasi 1d, maksimal 7 file dan dengan ukuran file maksimal 1GB.
--indexer
Tetapkan url khusus untuk lokasi titik akhir pengindeks, layanan kueri menggunakan titik akhir ini untuk kesehatan pengindeks, metadata, dan status kesiapan.
--subscription
Tanda ini mengaktifkan GraphQL Langganan, untuk mengaktifkan fitur ini memerlukan subql-node juga mengaktifkan --langganan.
--unsafe
Layanan kueri memiliki batas 100 entitas untuk kueri graphql tak terbatas. Bendera tidak aman menghapus batas ini yang dapat menyebabkan masalah kinerja pada layanan kueri. Sebagai gantinya, disarankan agar kueri diberi halaman.
Bendera ini memungkinkan fungsi agregasi tertentu termasuk jumlah, maks, rata-rata, dan lainnya. Baca selengkapnya tentang fitur ini di sini.
Ini dinonaktifkan secara default karena batas entitas.
Juga, perhatikan bahwa perintah --unsafe akan mencegah proyek Anda dijalankan di Jaringan SubQuery, dan Anda harus menghubungi dukungan jika Anda ingin perintah ini dijalankan dengan proyek Anda di layanan terkelola SubQuery.
--port
Port yang diikat oleh layanan kueri subkueri. Secara default ini diatur ke 3000