diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/getting-started-hashstore.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/getting-started-hashstore.mdx index 5713dcb5..f6193b31 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/getting-started-hashstore.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/getting-started-hashstore.mdx @@ -40,7 +40,7 @@ VERSION=$(grep SCALARDL_VERSION .env | awk -F= '{print $2}') ```console curl -OL https://github.com/scalar-labs/scalardl/releases/download/v$VERSION/scalardl-hashstore-java-client-sdk-$VERSION.zip unzip scalardl-hashstore-java-client-sdk-$VERSION.zip -mv scalardl-hashstore-java-client-sdk-$VERSION client +mv scalardl-hashstore-java-client-sdk-$VERSION hashstore ``` ## クライアントプロパティの設定 @@ -76,7 +76,7 @@ EOF 次に、以下のコマンドを実行して HashStore をブートストラップできます: ```console -client/bin/scalardl-hashstore bootstrap --properties client.properties +hashstore/bin/scalardl-hashstore bootstrap --properties client.properties ``` ブートストラップコマンドは、内部的にアイデンティティ情報 (証明書またはシークレット) と HashStore を使用するために必要な事前定義されたコントラクトを登録します。 @@ -107,7 +107,7 @@ sha256sum a.txt 以下のコマンドを実行して、ハッシュ値を格納できます: ```console -client/bin/scalardl-hashstore put-object --properties client.properties \ +hashstore/bin/scalardl-hashstore put-object --properties client.properties \ --object-id a.txt \ --hash 5c7440fb2273a247f78aadefbc511c680a84e7d44004abfaedef2b145151dab0 \ --metadata '{"note": "created"}' @@ -129,7 +129,7 @@ b97a42c87a46ffebe1439f8c1cd2f86e2f9b84dad89c8e9ebb257a19b6fdfe1c a.txt 次に、以下のようにハッシュ値を更新できます: ```console -client/bin/scalardl-hashstore put-object --properties client.properties \ +hashstore/bin/scalardl-hashstore put-object --properties client.properties \ --object-id a.txt \ --hash b97a42c87a46ffebe1439f8c1cd2f86e2f9b84dad89c8e9ebb257a19b6fdfe1c \ --metadata '{"note": "updated"}' @@ -138,7 +138,7 @@ client/bin/scalardl-hashstore put-object --properties client.properties \ 以下のコマンドを実行して、オブジェクトの最新ステータスを取得することもできます: ```console -client/bin/scalardl-hashstore get-object --properties client.properties \ +hashstore/bin/scalardl-hashstore get-object --properties client.properties \ --object-id a.txt ``` @@ -166,7 +166,7 @@ Result: ::: ```console -client/bin/scalardl-hashstore compare-object-versions --properties client.properties \ +hashstore/bin/scalardl-hashstore compare-object-versions --properties client.properties \ --object-id a.txt \ --versions '[{"version_id": "v2", "hash_value": "b97a42c87a46ffebe1439f8c1cd2f86e2f9b84dad89c8e9ebb257a19b6fdfe1c"}, {"version_id": "v1", "hash_value": "5c7440fb2273a247f78aadefbc511c680a84e7d44004abfaedef2b145151dab0"}]}' ``` @@ -192,7 +192,7 @@ Alice updated this file 最新バージョンのハッシュ値は `1f75d715648a3b4b3a33ecd7428a3e7139d9357da7d38735c23bf38618ecf9c7` になります。以下のコマンドを実行して検証を実行できます: ```console -client/bin/scalardl-hashstore compare-object-versions --properties client.properties \ +hashstore/bin/scalardl-hashstore compare-object-versions --properties client.properties \ --object-id a.txt \ --versions '[{"version_id": "v2", "hash_value": "1f75d715648a3b4b3a33ecd7428a3e7139d9357da7d38735c23bf38618ecf9c7"}, {"version_id": "v1", "hash_value": "5c7440fb2273a247f78aadefbc511c680a84e7d44004abfaedef2b145151dab0"}]}' ``` @@ -223,7 +223,7 @@ ScalarDL はデータ (「アセット」と呼ばれる) を改ざん検知可 上記の3番目の手順は、`--put-to-mutable` オプションを使用して以下のコマンドを実行することで ACID 方式で実行する必要があります: ```console -client/bin/scalardl-hashstore put-object --properties client.properties \ +hashstore/bin/scalardl-hashstore put-object --properties client.properties \ --object-id a.txt \ --hash 5c7440fb2273a247f78aadefbc511c680a84e7d44004abfaedef2b145151dab0 \ --put-to-mutable '{...}' @@ -259,7 +259,7 @@ client/bin/scalardl-hashstore put-object --properties client.properties \ 以下のコマンドを実行して、監査セット用のコレクションを作成できます: ```console -client/bin/scalardl-hashstore create-collection --properties client.properties \ +hashstore/bin/scalardl-hashstore create-collection --properties client.properties \ --collection-id audit_set --object-ids a.txt --object-ids b.txt ``` @@ -268,21 +268,21 @@ client/bin/scalardl-hashstore create-collection --properties client.properties \ 以下のコマンドを実行して、コレクションにオブジェクトを追加することもできます: ```console -client/bin/scalardl-hashstore add-to-collection --properties client.properties \ +hashstore/bin/scalardl-hashstore add-to-collection --properties client.properties \ --collection-id audit_set --object-ids c.txt --object-ids d.txt ``` また、以下のコマンドを実行して、コレクションからオブジェクトを削除できます: ```console -client/bin/scalardl-hashstore remove-from-collection --properties client.properties \ +hashstore/bin/scalardl-hashstore remove-from-collection --properties client.properties \ --collection-id audit_set --object-ids a.txt ``` 以下のコマンドを実行して、コレクションの最新ステータスを取得できます: ```console -client/bin/scalardl-hashstore get-collection --properties client.properties \ +hashstore/bin/scalardl-hashstore get-collection --properties client.properties \ --collection-id audit_set ``` @@ -296,7 +296,7 @@ Result: 監査セットが予期せず変更されていないことを確認するには、以下のコマンドを実行して監査セットの更新履歴を確認できます: ```console -client/bin/scalardl-hashstore get-collection-history --properties client.properties \ +hashstore/bin/scalardl-hashstore get-collection-history --properties client.properties \ --collection-id audit_set ``` @@ -329,7 +329,7 @@ ScalarDL では、すべてのデータが有効な状態にあることを確 以下のコマンドを実行して、オブジェクトを検証できます: ```console -client/bin/scalardl-hashstore validate-ledger --properties client.properties \ +hashstore/bin/scalardl-hashstore validate-ledger --properties client.properties \ --object-id a.txt ``` @@ -352,7 +352,7 @@ client/bin/scalardl-hashstore validate-ledger --properties client.properties \ 以下のコマンドを実行して、コレクションを検証できます: ```console -client/bin/scalardl-hashstore validate-ledger --properties client.properties \ +hashstore/bin/scalardl-hashstore validate-ledger --properties client.properties \ --collection-id audit_set ``` diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/getting-started-tablestore.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/getting-started-tablestore.mdx index 0f2252ac..420414e0 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/getting-started-tablestore.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/getting-started-tablestore.mdx @@ -38,7 +38,7 @@ VERSION=$(grep SCALARDL_VERSION .env | awk -F= '{print $2}') ```console curl -OL https://github.com/scalar-labs/scalardl/releases/download/v$VERSION/scalardl-tablestore-java-client-sdk-$VERSION.zip unzip scalardl-tablestore-java-client-sdk-$VERSION.zip -mv scalardl-tablestore-java-client-sdk-$VERSION client +mv scalardl-tablestore-java-client-sdk-$VERSION tablestore ``` ## クライアントプロパティの設定 @@ -74,7 +74,7 @@ EOF 次に、以下のコマンドを実行して TableStore をブートストラップできます: ```console -client/bin/scalardl-tablestore bootstrap --properties client.properties +tablestore/bin/scalardl-tablestore bootstrap --properties client.properties ``` ブートストラップコマンドは、内部的にアイデンティティ情報 (証明書またはシークレット) と TableStore を使用するために必要な事前定義されたコントラクトを登録します。 @@ -94,11 +94,11 @@ client/bin/scalardl-tablestore bootstrap --properties client.properties 以下のコマンドを実行して、サンプルテーブルを作成できます: ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "CREATE TABLE employee (id STRING PRIMARY KEY, department STRING)" ``` ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "CREATE TABLE department (id STRING PRIMARY KEY)" ``` @@ -107,7 +107,7 @@ client/bin/scalardl-tablestore execute-statement --properties client.properties 以下のコマンドを実行して、作成されたテーブルを表示できます: ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "SELECT * FROM information_schema.tables" ``` @@ -136,26 +136,26 @@ Result: 次に、以下のコマンドを実行して、複数の `employee` レコードを挿入します: ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "INSERT INTO employee VALUES {'id': '1001', 'name': 'Alice', 'department': 'sales', 'salary': 654.3}" ``` ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "INSERT INTO employee VALUES {'id': '1002', 'name': 'Bob', 'department': 'sales', 'salary': 543.2}" ``` ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "INSERT INTO employee VALUES {'id': '1003', 'name': 'Carol', 'department': 'engineering', 'salary': 654.3}" ``` また、以下のコマンドを実行して、対応する `department` レコードも挿入します: ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "INSERT INTO department VALUES {'id': 'sales', 'location': 'Shinjuku', 'phone': '000-1234'}" ``` ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "INSERT INTO department VALUES {'id': 'engineering', 'location': 'Shibuya', 'phone': '000-4321'}" ``` @@ -164,7 +164,7 @@ client/bin/scalardl-tablestore execute-statement --properties client.properties 次に、挿入されたレコードを確認します。レコードを選択するには、少なくともプライマリキーまたはインデックスキーを指定する必要があります。例えば、以下のコマンドを実行して、プライマリキーを指定して `employee` レコードを取得できます: ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "SELECT id, name, department FROM employee WHERE id = '1001'" ``` @@ -182,7 +182,7 @@ Result: 以下のコマンドを実行して、インデックスキーを指定してレコードを選択することもできます: ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "SELECT id, name, department FROM employee WHERE department = 'sales'" ``` @@ -204,7 +204,7 @@ Result: レコードをフィルタリングしたい場合は、以下のコマンドを実行して追加の条件を指定します: ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "SELECT id, name, department FROM employee WHERE department = 'sales' AND salary < 600" ``` @@ -223,7 +223,7 @@ Result: 以下のコマンドを実行して、2つのテーブルを結合することもできます: ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "SELECT * FROM employee JOIN department ON employee.department = department.id WHERE employee.department = 'engineering'" ``` @@ -247,7 +247,7 @@ Result: 以下のコマンドを実行して、`employee` レコードを更新できます: ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "UPDATE employee SET salary = 754.3 WHERE department = 'engineering'" ``` @@ -258,7 +258,7 @@ client/bin/scalardl-tablestore execute-statement --properties client.properties 以下のコマンドを実行して、レコードの更新履歴を取得できます: ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "SELECT history() FROM employee WHERE id = '1003'" ``` @@ -288,7 +288,7 @@ Result: バージョン数 (age) を制限したい場合は、以下のコマンドを実行して `LIMIT` 句を指定します: ```console -client/bin/scalardl-tablestore execute-statement --properties client.properties \ +tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \ --statement "SELECT history() FROM employee WHERE id = '1003' LIMIT 1" ``` @@ -314,7 +314,7 @@ ScalarDL では、すべてのデータが有効な状態にあることを確 以下のコマンドを実行して、テーブルスキーマを検証できます: ```console -client/bin/scalardl-tablestore validate-ledger --properties client.properties \ +tablestore/bin/scalardl-tablestore validate-ledger --properties client.properties \ --table-name employee ``` @@ -337,7 +337,7 @@ client/bin/scalardl-tablestore validate-ledger --properties client.properties \ 以下のコマンドを実行して、レコードを検証できます: ```console -client/bin/scalardl-tablestore validate-ledger --properties client.properties \ +tablestore/bin/scalardl-tablestore validate-ledger --properties client.properties \ --table-name employee --primary-key-column-name id --column-value '"1001"' ``` @@ -366,7 +366,7 @@ client/bin/scalardl-tablestore validate-ledger --properties client.properties \ 以下のコマンドを実行して、インデックスレコードを検証できます: ```console -client/bin/scalardl-tablestore validate-ledger --properties client.properties \ +tablestore/bin/scalardl-tablestore validate-ledger --properties client.properties \ --table-name employee --index-key-column-name department --column-value '"sales"' ``` diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/how-to-run-applications-with-auditor.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/how-to-run-applications-with-auditor.mdx index da66a4de..c747c9ee 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/how-to-run-applications-with-auditor.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/how-to-run-applications-with-auditor.mdx @@ -14,7 +14,7 @@ import DbSpecificSteps from '/src/components/ja-jp/_getting-started-auditor-db-s -このガイドでは、ScalarDL Ledger と Auditor を介して ScalarDL アプリケーションを実行する方法について説明します。このドキュメントでは、すでに [ScalarDL Ledger をはじめよう](getting-started.mdx)チュートリアルを試し、[Java で ScalarDL アプリケーションを書く](how-to-write-applications.mdx)ガイドを参考にして Client SDK を使用して ScalarDL を統合したアプリケーションを作成したことを前提としています。 +このガイドでは、ScalarDL Ledger と Auditor を介して ScalarDL アプリケーションを実行する方法について説明します。このドキュメントでは、すでに[クイックスタート](quickstart-overview.mdx)チュートリアルのいずれかを試し、[アプリケーションを書く](develop-write-an-application-overview.mdx)ガイドを参考にしてクライアント SDK を使用して ScalarDL を統合したアプリケーションを作成したことを前提としています。 ## ScalarDL Auditor とは何ですか？ diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/how-to-run-applications.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/how-to-run-applications.mdx index d9660afe..f224cd84 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/how-to-run-applications.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/how-to-run-applications.mdx @@ -7,137 +7,179 @@ displayed_sidebar: docsJapanese # ScalarDL Ledger を介して ScalarDL アプリケーションを実行する +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; import JavadocLink from "/src/theme/JavadocLink.js"; import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このガイドでは、ScalarDL Ledger を介して ScalarDL アプリケーションを実行する方法を説明します。このドキュメントは、すでに [ScalarDL Ledger をはじめよう](getting-started.mdx)チュートリアルを試し、[Java で ScalarDL アプリケーションを書く](how-to-write-applications.mdx)ガイドを参考にして Client SDK を使った ScalarDL アプリケーションを作成済みであることを前提としています。 +このガイドでは、ScalarDL Ledger を介して ScalarDL アプリケーションを実行する方法を説明します。このドキュメントは、すでに[クイックスタート](quickstart-overview.mdx)チュートリアルのいずれかを試し、[アプリケーションを書く](develop-write-an-application-overview.mdx)ガイドを参考にしてクライアント SDK を使用して ScalarDL を統合したアプリケーションを作成済みであることを前提としています。 -## 設定する +## 設定を決定する -Ledger および Ledger と通信するクライアントの設定を行う必要があります。 +Ledger を介して ScalarDL アプリケーションを実行する前に、まず Ledger および Ledger と相互作用するクライアントを設定する必要があります。 -以下の重要なオプションを決定し、設定してください。 +以下に説明するとおり、設定する必要がある重要なオプションと決定事項がいくつかあります。 -### Auditor を無効化にする +### Auditor を無効化する -Ledger のみでアプリケーションを実行する場合は Auditor を無効化する必要があります。Auditor の無効化は、クライアントと Ledger の設定で以下のように行います。 +Ledger のみを介してアプリケーションを実行するため、Auditor を無効化する必要があります。Auditor の無効化は、以下のようにクライアントと Ledger の設定で行う必要があります。 -- クライアントの設定で `scalar.dl.client.auditor.enabled` を `false` に設定します。 (デフォルト値が `false` のため、省略可能です) -- Ledger の設定で `scalar.dl.ledger.auditor.enabled` を `false` に設定します。 (デフォルト値が `false` のため、省略可能です) +- クライアントの設定で `scalar.dl.client.auditor.enabled` を `false` に設定します。（`false` がデフォルト値のため、このプロパティを省略することもできます。） +- Ledger の設定で `scalar.dl.ledger.auditor.enabled` を `false` に設定します。（`false` がデフォルト値のため、このプロパティを省略することもできます。） :::note -`scalardl-samples` 環境を利用している場合は、対応するストレージの `ledger.properties` ファイルを参照してください。 +`scalardl-samples` 環境を使用している場合は、対応するストレージの `ledger.properties` ファイルを参照してください。 ::: -設定の詳細は以下を参照してください。 +設定の詳細については、以下を参照してください： -- [クライアントの設定](configurations.mdx#クライアントの設定) -- [Ledger の設定](configurations.mdx#ledger-の設定) +- [クライアントの設定](configurations.mdx#client-configurations) +- [Ledger の設定](configurations.mdx#ledger-configurations) ### 認証方式を決定する -クライアントの認証方式として、電子署名または HMAC のいずれかを選択する必要があります。電子署名方式は認証に加えて否認防止も提供しますが遅く、HMAC 方式は認証のみですが高速です。 +クライアントの認証方式として、電子署名または HMAC のいずれかを選択する必要があります。簡単に比較すると、電子署名方式は認証に加えて否認防止も提供しますが低速であり、HMAC 方式は認証のみを提供しますが高速です。 -認証方法は以下のように設定できます。クライアントと Ledger の両方で同じ方法 (`digital-signature` または `hmac`) を設定する必要があります。 +認証方式は以下のように設定できます。クライアントと Ledger の両方で同じ方式（`digital-signature` または `hmac`）を設定する必要があります。 -- クライアントの設定で `scalar.dl.client.authentication.method` を `digital-signature` または `hmac` に設定します。 -- Ledger の設定で `scalar.dl.ledger.authentication.method` を `digital-signature` または `hmac` に設定します。 +- クライアントの設定で、`scalar.dl.client.authentication.method` を `digital-signature` または `hmac`（選択した方式に応じて）に設定します。 +- Ledger の設定で、`scalar.dl.ledger.authentication.method` を `digital-signature` または `hmac`（選択した方式に応じて）に設定します。 -また、秘密情報の準備も必要です。電子署名方式の場合は証明書と秘密鍵、HMAC 方式の場合はシークレットキーを用意してください。ScalarDL の認証について詳しくは [ScalarDL 認証ガイド](./authentication.mdx)を参照してください。 +また、秘密情報を準備する必要があります。電子署名方式を使用する場合は証明書と秘密鍵を準備する必要があります。HMAC 方式を使用する場合は、シークレットキーを準備する必要があります。ScalarDL の認証についてより詳しくは、[ScalarDL 認証ガイド](./authentication.mdx)をご覧ください。 -設定の詳細は以下を参照してください。 +設定の詳細については、以下を参照してください： -- [クライアントの設定](configurations.mdx#クライアントの設定) -- [Ledger の設定](configurations.mdx#ledger-の設定) +- [クライアントの設定](configurations.mdx#client-configurations) +- [Ledger の設定](configurations.mdx#ledger-configurations) -### データベース設定を決定する +### データベースの設定 -Ledger は ScalarDB を利用してデータベースを操作します。ScalarDB がサポートする様々なデータベース上で ScalarDL を実行できます。アプリケーション要件に応じて利用するデータベースを決定し、いくつかの ScalarDB パラメータを設定してください。 +Ledger は ScalarDB を使用してデータベースとやり取りするため、ScalarDB がサポートするさまざまなデータベース上で ScalarDL を実行できます。そのため、アプリケーションの要件に基づいて ScalarDB がサポートするデータベースを決定し、いくつかの ScalarDB パラメータを設定する必要があります。 ScalarDB パラメータの詳細については、[ScalarDB の設定](https://scalardb.scalar-labs.com/ja-jp/docs/latest/configurations/)も参照してください。 -#### 下位のデータベース +#### 基盤データベース -使用するデータベースの設定方法: +使用するデータベースは以下のように設定できます： -- Ledger の設定で `scalar.db.storage`, `scalar.db.contact_points`, `scalar.db.username`, `scalar.db.password` を利用するデータベースに合わせて設定します。 +- Ledger の設定で、使用するデータベースに基づいて `scalar.db.storage`、`scalar.db.contact_points`、`scalar.db.username`、および `scalar.db.password` を適切な値に設定します。 -ScalarDB を介して ScalarDL でサポートされるデータベースとそのバージョンについては、[要件](requirements.mdx#データベース)を参照してください。 +ScalarDB を介して ScalarDL でサポートされるデータベースとそのバージョンについては、[要件](requirements.mdx#databases)を参照してください。 :::warning -アプリケーションが Function 機能を介してテーブルを読み書きし、そのテーブルが ScalarDB アプリケーションからも直接アクセスされる場合は、ここで選択したデータベースを適切に設定する必要があります。具体的には、一貫性を保証するために、ScalarDL アプリケーションと ScalarDB アプリケーションの両方が同じ Coordinator テーブルを参照する必要があります。 +Function 機能を介してアプリケーションがテーブルの読み書きを行い、そのテーブルが ScalarDB アプリケーションからも直接アクセスされる場合は、ここで選択したデータベースを適切に設定する必要があります。具体的には、一貫性を保証するために、ScalarDL アプリケーションと ScalarDB アプリケーションの両方が同じ Coordinator テーブルを参照する必要があります。 ::: #### 分離レベル -Ledger は ScalarDB の [Consensus Commit](https://scalardb.scalar-labs.com/ja-jp/docs/latest/consensus-commit/) トランザクションマネージャを利用してトランザクションを管理します。トランザクションマネージャは、トランザクションの分離性を保証し、整合性・正確性を担保します。 +Ledger は、トランザクションを管理するために ScalarDB の [Consensus Commit](https://scalardb.scalar-labs.com/ja-jp/docs/latest/consensus-commit/) トランザクションマネージャに依存しています。トランザクションマネージャは、トランザクションの整合性と正確性を保証するために重要な、トランザクションの分離プロパティを保証する責任があります。 -Ledger の分離レベルは以下のように設定できます。どの分離レベルを使うべきかわからない場合は、`SERIALIZABLE` を使用してください。 +Ledger の分離レベルは以下のように設定できます。どの分離レベルを使用するかわからない場合は、`SERIALIZABLE` を使用してください。 -- Ledger の設定で `scalar.db.consensus_commit.isolation_level` に希望する分離レベルを設定します。デフォルト値は `SNAPSHOT` です。 +- Ledger の設定で、`scalar.db.consensus_commit.isolation_level` を選択した分離レベルに設定します。デフォルト値は `SNAPSHOT` です。 #### 制限事項 -ScalarDL は ScalarDB を活用していますが、以下の ScalarDB 機能は ScalarDL の一貫性保証メカニズムと互換性がありません。 +ScalarDL は ScalarDB を活用していますが、以下の ScalarDB 機能は ScalarDL の整合性保証メカニズムと互換性がありません： -- [Coordinator テーブルのグループコミット](https://scalardb.scalar-labs.com/ja-jp/docs/latest/api-guide#coordinator-テーブルのグループコミット) (`scalar.db.consensus_commit.coordinator.group_commit.enabled` は `false` である必要があります) -- [パフォーマンス関連の設定](https://scalardb.scalar-labs.com/ja-jp/docs/latest/configurations#パフォーマンス関連の設定)における Coordinator テーブルへの書き込み省略最適化 (`scalar.db.consensus_commit.coordinator.write_omission_on_read_only.enabled` は `false` である必要があります) +- [Coordinator テーブルのグループコミット](https://scalardb.scalar-labs.com/ja-jp/docs/latest/api-guide/#group-commit-for-the-coordinator-table)（`scalar.db.consensus_commit.coordinator.group_commit.enabled` は `false` である必要があります。） +- [パフォーマンス関連の設定](https://scalardb.scalar-labs.com/ja-jp/docs/latest/configurations#performance-related-configurations)における Coordinator 書き込み省略最適化（`scalar.db.consensus_commit.coordinator.write_omission_on_read_only.enabled` は `false` である必要があります。） ### その他の設定を決定する -クライアントと Ledger には TLS や gRPC などの設定を追加で設定可能です。詳細は以下を参照してください。 +クライアントと Ledger には、TLS や gRPC 設定などの他の設定も適用できます。設定の詳細については、以下を参照してください： -- [クライアントの設定](configurations.mdx#クライアントの設定) -- [Ledger の設定](configurations.mdx#ledger-の設定) +- [クライアントの設定](configurations.mdx#client-configurations) +- [Ledger の設定](configurations.mdx#ledger-configurations) ## Ledger を起動する -Ledger とクライアントの設定後、Ledger を起動します。 +Ledger とクライアントを設定した後、Ledger を起動する必要があります。 -Docker Compose を使ったローカルでの Ledger 起動方法は [データベースを選択して ScalarDL を起動します](getting-started.mdx#データベースを選択して-scalardl-を起動します)を参照してください。ローカルまたはクラウドベースの Kubernetes 環境での起動方法は [ローカル Kubernetes 環境に ScalarDL をデプロイする](deploy-local-environment-overview.mdx)または[クラウドベースの Kubernetes 環境に ScalarDL をデプロイする](deploy-managed-kubernetes-environment-overview.mdx)を参照してください。 +Docker Compose を使用して Ledger をローカルで起動する方法の詳細については、[お好みのデータベースで ScalarDL を起動する](getting-started.mdx#start-up-scalardl-with-your-preferred-database)を参照してください。ローカルまたはクラウドベースの Kubernetes 環境で Ledger を起動する方法については、それぞれ [ローカル Kubernetes 環境に ScalarDL をデプロイする](deploy-local-environment-overview.mdx)または[クラウドベース Kubernetes 環境に ScalarDL をデプロイする](deploy-managed-kubernetes-environment-overview.mdx)を参照してください。 -## Client SDK をダウンロードする +## HashStore、TableStore、または Ledger 抽象化のクライアントを設定する -ScalarDL コマンドを実行する場合は Client SDK をダウンロードしてください。手順は [Client SDK のダウンロード](getting-started.mdx#client-sdk-をダウンロードする)を参照してください。 +アプリケーションが基づく抽象化（具体的には、HashStore、TableStore、または Ledger）に応じて、設定手順が異なります。抽象化を選択して、手順に従ってください。 -## クライアントから証明書またはシークレットキーを登録する + -電子署名認証方式の場合、以下のコマンドで証明書を Ledger に登録できます。詳細は [ScalarDL クライアントコマンドリファレンス](scalardl-command-reference.mdx#register-cert)を参照してください。 + -```shell -scalardl register-cert --properties +

HashStore クライアントをブートストラップする

+ +アプリケーションで `HashStoreClientService` を作成する際、クライアント証明書またはシークレットキーと HashStore を使用するために必要なコントラクトが、`ClientConfig` の設定に基づいて自動的に登録されます。したがって、HashStore クライアントを手動でブートストラップする必要はありません。テスト目的などで手動で実行したい場合は、[Client SDK をダウンロードする](getting-started-hashstore.mdx#download-the-client-sdk)に従って HashStore Client SDK をダウンロードし、以下のコマンドを実行してください。 + +```console +scalardl-hashstore bootstrap --properties ``` -HMAC 認証方式の場合、以下のコマンドでシークレットキーを Ledger に登録できます。詳細は [ScalarDL クライアントコマンドリファレンス](scalardl-command-reference.mdx#register-secret)を参照してください。 + + + + +

TableStore クライアントをブートストラップする

+ +アプリケーションで `TableStoreClientService` を作成する際、クライアント証明書またはシークレットキーと TableStore を使用するために必要なコントラクトが、`ClientConfig` の設定に基づいて自動的に登録されます。したがって、TableStore クライアントを手動でブートストラップする必要はありません。テスト目的などで手動で実行したい場合は、[Client SDK をダウンロードする](getting-started-tablestore.mdx#download-the-client-sdk)に従って TableStore Client SDK をダウンロードし、以下のコマンドを実行してください。 -```shell -scalardl register-secret --properties +```console +scalardl-tablestore bootstrap --properties ``` -また、 を利用して [ScalarDL Java Client SDK](how-to-write-applications.mdx#scalardl-client-sdk-を使用する) から証明書や秘密鍵の登録も可能です。 + -## クライアントからコントラクトやファンクションを登録する + -以下のコマンドでコントラクトを Ledger に登録できます。詳細は [ScalarDL クライアントコマンドリファレンス](scalardl-command-reference.mdx#register-contract)を参照してください。 +

クライアントコマンドをダウンロードする

+ +Ledger クライアントを設定する際には、Client SDK に含まれるクライアントコマンドを実行する必要があります。Client SDK を取得するには、[Client SDK をダウンロードする](getting-started.mdx#download-the-client-sdk)を参照してください。 + +

Ledger クライアントをブートストラップする

+ +以下の `bootstrap` コマンドを実行して、クライアント ID とシステムコントラクトを登録します： + +```console +scalardl bootstrap --properties +``` -```shell +ブートストラップコマンドは、[認証方式を決定する](#認証方式を決定する)で行った認証設定に基づいて、クライアント証明書またはシークレットキーを登録します。 + +[ScalarDL Java Client SDK](how-to-write-applications.mdx#use-the-scalardl-client-sdk) の を使用してブートストラップすることもできます。 + +

コントラクトと関数を登録する

+ +`register-contract` コマンドを使用してコントラクトを登録できます。 + +```console scalardl register-contract --properties --contract-id --contract-binary-name --contract-class-file ``` -ファンクションは以下のコマンドで Ledger に登録できます。詳細は [ScalarDL クライアントコマンドリファレンス](scalardl-command-reference.mdx#register-function)を参照してください。 +`register-function` コマンドを使用して関数を登録できます。 -```shell +```console scalardl register-function --properties --function-id --function-binary-name --function-class-file ``` -また、 を利用して [ScalarDL Java Client SDK](how-to-write-applications.mdx#scalardl-client-sdk-を使用する) からコントラクトやファンクションの登録も可能です。 +[ScalarDL Java Client SDK](how-to-write-applications.mdx#use-the-scalardl-client-sdk) の を使用してコントラクトと関数を登録することもできます。 + + + + ## アプリケーションを実行する -クライアントからコントラクトやファンクションの登録が完了したら、ScalarDL アプリケーションを実行できます。 +必要な ID とコントラクトを登録したので、ScalarDL を統合したアプリケーションを実行できます。 + +## 参照 + +各コマンドの詳細については、以下のコマンドリファレンスを参照してください： + +- [ScalarDL Client コマンドリファレンス](scalardl-command-reference.mdx) +- [ScalarDL HashStore コマンドリファレンス](scalardl-hashstore-command-reference.mdx) +- [ScalarDL TableStore コマンドリファレンス](scalardl-tablestore-command-reference.mdx) \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index bd2c81ca..de64e5b7 100644 --- a/sidebars.js +++ b/sidebars.js @@ -866,16 +866,16 @@ const sidebars = { id: 'scalardl-command-reference', label: 'クライアントコマンドリファレンス', }, - // { - // type: 'doc', - // id: 'scalardl-hashstore-command-reference', - // label: 'Hashstore コマンドリファレンス', - // }, - // { - // type: 'doc', - // id: 'scalardl-tablestore-command-reference', - // label: 'TableStore コマンドリファレンス', - // }, + { + type: 'doc', + id: 'scalardl-hashstore-command-reference', + label: 'Hashstore コマンドリファレンス', + }, + { + type: 'doc', + id: 'scalardl-tablestore-command-reference', + label: 'TableStore コマンドリファレンス', + }, { type: 'doc', id: 'schema-loader',