ScalarDL クライアントコマンドリファレンス
このページは英語版のページが機械翻訳されたものです。英語版との間に矛盾または不一致がある場合は、英語版を正としてください。
このページでは、ScalarDL コンポーネントと対話するためのクライアントコマンドである scalardl を紹介します。
コマンドの概要
- クライアントをブートストラップする
bootstrap: ID 情報とシステムコントラクトを登録してクライアントをブートストラップします。
- ID 情報を登録する
register-cert: 指定された証明書を登録します。register-secret: 指定されたシークレットを登録します。
- ビジネスロジックを登録する
register-contract: 指定されたコントラクトを登録します。register-contracts: 指定されたコントラクトを登録します。register-function: 指定されたファンクションを登録します。register-functions: 指定されたファンクションを登録します。
- 登録されたビジネスロジックを実行して一覧表示する
execute-contract: 指定されたコントラクトを実行します。list-contracts: 登録されたコントラクトを一覧表示します。
- 名前空間を管理する
create-namespace: 名前空間を作成します。list-namespaces: 名前空間を一覧表示します。drop-namespace: 名前空間を削除します。
- トランザクション状態を管理します
purge-state: ScalarDL が保持する残留トランザクション状態をパージします。
- 台帳を検証します
validate-ledger: 台帳内の指定されたアセットを検証します。
- 汎用コントラクト向けにコマンドを実行します
generic-contracts: 汎用コントラクトベースの構成でコマンドを実行します。
bootstrap
ID 情報とシステムコントラクトを登録してクライアントをブートストラップします。このコマンドは以下を実行します。
- プロパティファイルで設定された認証方式に基づいて、証明書またはシークレットを登録します。
- Auditor が有効な場合、
ValidateLedgerコントラクトを登録します。
ID 情報またはコントラクトがすでに登録されている場合は、登録をスキップしてエラーなしで続行します。
オプション
| オプション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
共通ユーティリティオプションも利用できます。
例
scalardl bootstrap --properties client.properties
register-cert
指定された証明書を登録します。
オプション
| オプション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
--namespace | 証明書が登録される名前空間。 |
--entity-id | 証明書のエンティティID。 |
--cert-path | PEM形式の証明書ファイルへ のパス。 |
--cert-version | 証明書のバージョン (デフォルト: 1)。 |
--namespace が指定されている場合、--entity-id と --cert-path も必要です。--namespace が指定されていない場合は、プロパティファイルの認証情報が使用されます。
共通ユーティリティオプションも利用できます。
例
プロパティファイルの認証情報を使用して証明書を登録する。
scalardl register-cert --properties client.properties
指定された名前空間に証明書を登録する。
scalardl register-cert --properties admin.properties --namespace tenant_a --entity-id foo --cert-path ./fixture/client.pem
register-secret
指定されたシークレットを登録します。
オプション
| オプション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
--namespace | シークレットが登録される名前空間。 |
--entity-id | シークレットのエンティティID。 |
--secret-key | HMAC認証用のシークレットキー。 |
--secret-key-version | シークレットキーのバージョン (デフォルト: 1)。 |
--namespace が指定されている場合、--entity-id と --secret-key も必要です。--namespace が指定されていない場合は、プロパティファイルの認証情報が使用されます。
共通ユーティリティオプション も利用できます。
例
プロパティファイルの認証情報を使用してシークレットを登録する。
scalardl register-secret --properties client.properties
指定された名前空間にシークレットを登録する。
scalardl register-secret --properties admin.properties --namespace tenant_a --entity-id foo --secret-key some_secret
register-contract
指定されたコントラクトを登録します。
オプション
| オプション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
--contract-binary-name | 登録するコントラクトのバイナリ名。 |
--contract-class-file | 登録するコントラクトクラスファイル。 |
--contract-id | 登録するコントラクトの ID。 |
--contract-properties | シリアル化された形式のコントラクトプロパティ。 |
--deserialization-format | コントラクトプロパティの逆シリアル化形式。有効な値: JSON または STRING (デフォルト: JSON) |
共通ユーティリティオプションも利用できます。
例
scalardl register-contract --properties client.properties --contract-id StateUpdater --contract-binary-name com.org1.contract.StateUpdater --contract-class-file build/classes/java/main/com/org1/contract/StateUpdater.class
register-contracts
指定されたコントラクトを登録します。
オプション
| オプション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
--contracts-file | TOML 形式で登録するコントラクトを含むファイル。 |
共通ユーティリティオプションも利用できます。
例
scalardl register-contracts --properties client.properties --contracts-file /path/to/contracts-file
コントラクトファイルの例は次のとおりです。
[[contracts]]
contract-id = "StateUpdater"
contract-binary-name = "com.org1.contract.StateUpdater"
contract-class-file = "build/classes/java/main/com/org1/contract/StateUpdater.class"
[[contracts]]
contract-id = "StateReader"
contract-binary-name = "com.org1.contract.StateReader"
contract-class-file = "build/classes/java/main/com/org1/contract/StateReader.class"
register-function
指定されたファンクションを登録します。
オプション
| オプション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
--function-binary-name | 登録するファンクションのバイナリ名。 |
--function-class-file | 登録するファンクションクラスファイル。 |
--function-id | 登録するファンクションの ID。 |
共通ユーティリティオプションも利用できます。
例
scalardl register-function --properties client.properties --function-id test-function --function-binary-name com.example.function.TestFunction --function-class-file /path/to/TestFunction.class
register-functions
指定された機能を登録します。
オプション
| オプション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
--functions-file | TOML 形式で登録するファンクションを含むファイル。 |
共通ユーティリティオプションも利用できます。
例
scalardl register-functions --properties client.properties --functions-file /path/to/functions-file
ファンクションファイルの例は次のとおりです。
[[functions]]
function-id = "TestFunction1"
function-binary-name = "com.org1.function.TestFunction1"
function-class-file = "build/classes/java/main/com/org1/function/TestFunction1.class"
[[functions]]
function-id = "TestFunction2"
function-binary-name = "com.org1.function.TestFunction2"
function-class-file = "build/classes/java/main/com/org1/function/TestFunction2.class"
execute-contract
指定されたコントラクトを実行します。
オプション
| オプション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
--contract-argument | シリアル化された形式で実行するコントラクトの引数。 |
--contract-id | 実行するコントラクトの ID。 |
--deserialization-format | コントラクトおよびファンクションの引数のデシリアル化形式。有効な値: JSON または STRING (デフォルト: JSON) |
--function-id | 実行するファンクションの ID。 |
共通ユーティリティオプションも利用できます。
例
ファンクションなしでコントラクトを実行します。
scalardl execute-contract --properties client.properties --contract-id StateUpdater --contract-argument '{"asset_id":"some_asset", "state":3}'
ファンクションを使用してコントラクトを実行します。
scalardl execute-contract --properties client.properties --contract-id TestContract --contract-argument '{...}' --function-id TestFunction --function-argument '{...}'
list-contracts
登録されたコントラクトを一覧表示します。
オプション
| オプション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
--contract-id | 表示するコントラクトの ID。 |
共通ユーティリティオプションも利用できます。
例
指定されたエンティティによって登録されたすべてのコントラクトを一覧表示します。
scalardl list-contracts --properties client.properties
指定されたコントラクトのみを表示します。
scalardl list-contracts --properties client.properties --contract-id StateUpdater
create-namespace
名前空間機能は現在パブリックプレビュー中です。この機能と関連ドキュメントは変更される可能性があります。
名前空間を作成します。名前空間名は英字で始まり、英数字とアンダースコアのみを含むことができます (パターン: [a-zA-Z][a-zA-Z0-9_]*)。デフォルトの名前空間である default は予約されており、作成または削除することはできません。
オプション
| オプション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
--namespace | 作成する名前空間の名前。 |
共通ユーティリティオプションも利用可能です。
例
scalardl create-namespace --properties client.properties --namespace my_namespace
list-namespaces
名前空間機能は現在パブリックプレビュー中です。この機能と関連ドキュメントは変更される可能性があります。
名前空間を一覧表示します。
オプション
| オプション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
--pattern | 名前空間をフィルタリングするパターン（部分一致）。 |
共通ユーティリティオプションも利用可能です。
例
すべての名前空間を一覧表示します。
scalardl list-namespaces --properties client.properties
指定されたパターンにマッチする名前空間を一覧表示します。
scalardl list-namespaces --properties client.properties --pattern my_
drop-namespace
名前空間機能は現在パブリックプレビュー中です。この機能と関連ドキュメントは変更される可能性があります。
名前空間を削除します。このコマンドは、確認のために名前空間名を入力する必要があります。
オプション
| オ プション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
--namespace | 削除する名前空間の名前。 |
共通ユーティリティオプションも利用可能です。
例
scalardl drop-namespace --properties client.properties --namespace my_namespace
purge-state
ScalarDL が完了したトランザクションについて保持している残留トランザクション状態 (Coordinator state レコードと request proof) をパージします。このコマンドは、Auditor が有効で、かつ Ledger と Auditor の両方でトランザクション状態のパージが有効 (scalar.dl.ledger.transaction_state_purge.enabled と scalar.dl.auditor.transaction_state_purge.enabled が true) になっている場合にのみ利用できます。詳細については、残留トランザクション状態のパージを参照してください。
デフォルトでは、このコマンドはパージ前に確認を求めます。確認プロンプトをスキップするには (たとえば非対話環境で実行する場合)、--force オプションを使用します。
オプション
| オプション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
-f, --force | 確認を求めずに残留トランザクション状態をパージします。 |
共通ユーティリティオプションも利用できます。
例
残留トランザクション状態をパージします。実行前に確認を求められます。
scalardl purge-state --properties client.properties
確認プロンプトなしで残留トランザクション状態をパージします。
scalardl purge-state --properties client.properties --force
このコマンドは、対象となったトランザクション、パージされたトランザクション、およびスキップされたトランザクションの数のサマリーを返します。
{
"status_code": "OK",
"output": {
"total_targets": 5,
"purged": 4,
"skipped": 1
}
}
validate-ledger
元帳内の指定されたアセットを検証します。
オプション
| オプション | 説明 |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
--namespace | アセットの名前空間。指定されていない場合は、プロパティファイルのscalar.dl.client.context.namespace値が使用されます。それも設定されていない場合は、default名前空間が使用されます。 |
--asset-id | アセットの ID またはアセットの ID と経過時間。形式: 'ASSET_ID' (検証するアセットの ID)、または 'ASSET_ID,START_AGE,END_AGE' (検証するアセットの ID と経過時間)。 |
共通ユーティリティオプションも利用できます。
例
すべての世代を対象にアセットを検証します。
scalardl validate-ledger --properties client.properties --asset-id 'some_asset'
アセットを 0 から 10 までの世代のみ検証します。
scalardl validate-ledger --properties client.properties --asset-id 'some_asset,0,10'
generic-contracts
汎用コントラクトは ScalarDL 3.10 で導入されましたが、ScalarDL 3.12 でリリースされた HashStore は、汎用コントラクトをラップしたより高次の抽象化を提供します。ほとんどのユースケースでは、汎用コントラクトを直接使用するよりも、HashStore を使用する方がシンプルで効率的です。詳細については、ScalarDL の最新版の ScalarDL HashStore をはじめようをご参照ください。
汎用コントラクトベースの構成向けにコマンドを実行します。これは、scalardl コマンドのサブコマンドとほぼ同じです。唯一の違いは、validate-ledger サブコマンドで、生のアセット ID ではなく、汎用コントラクトで用いられるオブジェクト ID でアセットを指定できることです。他のサブコマンドについては、次のサブコマンドセクションの対応する各コマンドを参照してください。
scalardl-gc トップレベルコマンドまたは gc サブコマンドを generic-contracts サブコマンドのエイリアスとして使用することもできます。
サブコマンド
| サブコマンド | 説明 |
|---|---|
register-cert | 指定された証明書を登録します。 |
register-secret | 指定されたシークレットを登録します。 |
register-contract | 指定されたコントラクトを登録します。 |
register-contracts | 指定された複数のコントラクトを登録します。 |
register-function | 指定されたファンクションを登録します。 |
register-functions | 指定された複数のファンクションを登録します。 |
execute-contract | 指定されたコントラクトを実行します。 |
list-contracts | 登録されたコントラクトを一覧表示します。 |
validate-ledger | 台帳内の指定されたアセットを検証します。 |
validate-ledger for generic contracts
台帳内の指定されたアセットを検証します。
汎用コントラクトは、オブジェクトまたはコレクションを表すアセットレコードに専用のアセット ID を内部的に割り当てます。アセット ID は、アセットタイプのプレ フィックスとキーで構成されます。たとえば、オブジェクトのプレフィックス o_ とオブジェクト ID です。validate-ledger コマンドを実行すると、このような生のアセット ID が表示されます。
Options
| Option | Description |
|---|---|
--config, --properties | プロパティ形式の設定ファイル。 |
--object-id | object.Put コントラクトで作成されたオブジェクトの ID。 |
--collection-id | collection.Create コントラクトで作成されたコレクションの ID。 |
--start-age | アセットの検証開始世代 (オプショナル). |
--end-age | アセットの検証終了世代 (オプショナル). |
共通ユーティリティオプションも利用できます。
サブコマンドの使用例
指定された証明書を登録します。使用可能なオプションについては、register-certを参照してください。
scalardl generic-contracts register-cert --properties client.properties
指定されたシークレットを登録します。使用可能なオプションについては、register-secretを参照してください。
scalardl generic-contracts register-secret --properties client.properties
指定されたコントラクトを登録します。使用可能なオプションについては、register-contractを参照してください。
scalardl generic-contracts register-contract --properties client.properties --contract-id object.Put --contract-binary-name com.scalar.dl.genericcontracts.object.Put --contract-class-file /path/to/Put.class
指定された複数のコントラクトを登録します。使用可能なオプションについては、register-contractsを参照してください。
scalardl generic-contracts register-contracts --properties client.properties --contracts-file /path/to/contracts-file
指定されたファンクションを登録します。使用可能なオプションについては、register-functionを参照してください。
scalardl generic-contracts register-function --properties client.properties --function-id object.PutToMutableDatabase --function-binary-name com.scalar.dl.genericcontracts.object.PutToMutableDatabase --function-class-file /path/to/PutToMutableDatabase.class
指定された複数のファンクショ ンを登録します。使用可能なオプションについては、register-functionsを参照してください。
scalardl generic-contracts register-functions --properties client.properties --functions-file /path/to/functions-file
指定されたコントラクトを実行します。使用可能なオプションについては、execute-contractを参照してください。
scalardl generic-contracts execute-contract --properties client.properties --contract-id object.Put --contract-argument '{"object_id": "a.txt", "hash_value": "b97a42c87a46ffebe1439f8c1cd2f86e2f9b84dad89c8e9ebb257a19b6fdfe1c", "metadata": {"note": "updated"}}'
登録済みのコントラクトを一覧表示します。使用可能なオプションについては、list-contractsを参照してください。
scalardl generic-contracts list-contracts --properties client.properties
すべての世代のオブジェクトを検証します。
scalardl generic-contracts validate-ledger --properties client.properties --object-id 'a.txt'
世代 0 から 10 までのオブジェクトのみを検証します。
scalardl generic-contracts validate-ledger --properties client.properties --object-id 'a.txt' --start-age 0 --end-age 10
すべての世代のコレクションを検証します。
scalardl generic-contracts validate-ledger --properties client.properties --collection-id 'audit_set'
scalardl generic-contracts のエイリアスとして、トップレベルコマンド scalardl-gc を使用します。
scalardl-gc validate-ledger --properties client.properties --object-id 'a.txt'
scalardl generic-contracts のエイリアスとして、サブコマンド scalardl gc を使用します。
scalardl gc validate-ledger --properties client.properties --object-id 'a.txt'
共通ユーティリティオプション
上記のすべてのコマンドで次のオプションを使用できます。
| オプション | 説明 |
|---|---|
-g, --use-gateway | ゲートウェイを使用するためのオプション。 |
-h, --help | コマンドのヘルプメッセージを表示します。 |
--stacktrace | Java スタックトレースを stderr ストリームに出力します。 |