Skip to content

Commit cad0c1f

Browse files
github-actions[bot]josh-wong
github-actions[bot]
and
josh-wong
authored
AUTO: Docs repo sync - ScalarDL (#1065)
* AUTO: Sync ScalarDL docs in Japanese to docs site repo * Add HashStore and TableStore command reference docs --------- Co-authored-by: josh-wong <[email protected]> Co-authored-by: Josh Wong <[email protected]>
1 parent be8fbf0 commit cad0c1f

File tree

5 files changed

+143
-101
lines changed

5 files changed

+143
-101
lines changed

‎i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/getting-started-hashstore.mdx‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ VERSION=$(grep SCALARDL_VERSION .env | awk -F= '{print $2}')
4040
```console
4141
curl -OL https://github.com/scalar-labs/scalardl/releases/download/v$VERSION/scalardl-hashstore-java-client-sdk-$VERSION.zip
4242
unzip scalardl-hashstore-java-client-sdk-$VERSION.zip
43-
mv scalardl-hashstore-java-client-sdk-$VERSION client
43+
mv scalardl-hashstore-java-client-sdk-$VERSION hashstore
4444
```
4545

4646
## クライアントプロパティの設定
@@ -76,7 +76,7 @@ EOF
7676
次に、以下のコマンドを実行して HashStore をブートストラップできます:
7777

7878
```console
79-
client/bin/scalardl-hashstore bootstrap --properties client.properties
79+
hashstore/bin/scalardl-hashstore bootstrap --properties client.properties
8080
```
8181

8282
ブートストラップコマンドは、内部的にアイデンティティ情報 (証明書またはシークレット) と HashStore を使用するために必要な事前定義されたコントラクトを登録します。
@@ -107,7 +107,7 @@ sha256sum a.txt
107107
以下のコマンドを実行して、ハッシュ値を格納できます:
108108

109109
```console
110-
client/bin/scalardl-hashstore put-object --properties client.properties \
110+
hashstore/bin/scalardl-hashstore put-object --properties client.properties \
111111
--object-id a.txt \
112112
--hash 5c7440fb2273a247f78aadefbc511c680a84e7d44004abfaedef2b145151dab0 \
113113
--metadata '{"note": "created"}'
@@ -129,7 +129,7 @@ b97a42c87a46ffebe1439f8c1cd2f86e2f9b84dad89c8e9ebb257a19b6fdfe1c a.txt
129129
次に、以下のようにハッシュ値を更新できます:
130130

131131
```console
132-
client/bin/scalardl-hashstore put-object --properties client.properties \
132+
hashstore/bin/scalardl-hashstore put-object --properties client.properties \
133133
--object-id a.txt \
134134
--hash b97a42c87a46ffebe1439f8c1cd2f86e2f9b84dad89c8e9ebb257a19b6fdfe1c \
135135
--metadata '{"note": "updated"}'
@@ -138,7 +138,7 @@ client/bin/scalardl-hashstore put-object --properties client.properties \
138138
以下のコマンドを実行して、オブジェクトの最新ステータスを取得することもできます:
139139

140140
```console
141-
client/bin/scalardl-hashstore get-object --properties client.properties \
141+
hashstore/bin/scalardl-hashstore get-object --properties client.properties \
142142
--object-id a.txt
143143
```
144144

@@ -166,7 +166,7 @@ Result:
166166
:::
167167

168168
```console
169-
client/bin/scalardl-hashstore compare-object-versions --properties client.properties \
169+
hashstore/bin/scalardl-hashstore compare-object-versions --properties client.properties \
170170
--object-id a.txt \
171171
--versions '[{"version_id": "v2", "hash_value": "b97a42c87a46ffebe1439f8c1cd2f86e2f9b84dad89c8e9ebb257a19b6fdfe1c"}, {"version_id": "v1", "hash_value": "5c7440fb2273a247f78aadefbc511c680a84e7d44004abfaedef2b145151dab0"}]}'
172172
```
@@ -192,7 +192,7 @@ Alice updated this file
192192
最新バージョンのハッシュ値は `1f75d715648a3b4b3a33ecd7428a3e7139d9357da7d38735c23bf38618ecf9c7` になります。以下のコマンドを実行して検証を実行できます:
193193

194194
```console
195-
client/bin/scalardl-hashstore compare-object-versions --properties client.properties \
195+
hashstore/bin/scalardl-hashstore compare-object-versions --properties client.properties \
196196
--object-id a.txt \
197197
--versions '[{"version_id": "v2", "hash_value": "1f75d715648a3b4b3a33ecd7428a3e7139d9357da7d38735c23bf38618ecf9c7"}, {"version_id": "v1", "hash_value": "5c7440fb2273a247f78aadefbc511c680a84e7d44004abfaedef2b145151dab0"}]}'
198198
```
@@ -223,7 +223,7 @@ ScalarDL はデータ (「アセット」と呼ばれる) を改ざん検知可
223223
上記の3番目の手順は、`--put-to-mutable` オプションを使用して以下のコマンドを実行することで ACID 方式で実行する必要があります:
224224

225225
```console
226-
client/bin/scalardl-hashstore put-object --properties client.properties \
226+
hashstore/bin/scalardl-hashstore put-object --properties client.properties \
227227
--object-id a.txt \
228228
--hash 5c7440fb2273a247f78aadefbc511c680a84e7d44004abfaedef2b145151dab0 \
229229
--put-to-mutable '{...}'
@@ -259,7 +259,7 @@ client/bin/scalardl-hashstore put-object --properties client.properties \
259259
以下のコマンドを実行して、監査セット用のコレクションを作成できます:
260260

261261
```console
262-
client/bin/scalardl-hashstore create-collection --properties client.properties \
262+
hashstore/bin/scalardl-hashstore create-collection --properties client.properties \
263263
--collection-id audit_set --object-ids a.txt --object-ids b.txt
264264
```
265265

@@ -268,21 +268,21 @@ client/bin/scalardl-hashstore create-collection --properties client.properties \
268268
以下のコマンドを実行して、コレクションにオブジェクトを追加することもできます:
269269

270270
```console
271-
client/bin/scalardl-hashstore add-to-collection --properties client.properties \
271+
hashstore/bin/scalardl-hashstore add-to-collection --properties client.properties \
272272
--collection-id audit_set --object-ids c.txt --object-ids d.txt
273273
```
274274

275275
また、以下のコマンドを実行して、コレクションからオブジェクトを削除できます:
276276

277277
```console
278-
client/bin/scalardl-hashstore remove-from-collection --properties client.properties \
278+
hashstore/bin/scalardl-hashstore remove-from-collection --properties client.properties \
279279
--collection-id audit_set --object-ids a.txt
280280
```
281281

282282
以下のコマンドを実行して、コレクションの最新ステータスを取得できます:
283283

284284
```console
285-
client/bin/scalardl-hashstore get-collection --properties client.properties \
285+
hashstore/bin/scalardl-hashstore get-collection --properties client.properties \
286286
--collection-id audit_set
287287
```
288288

@@ -296,7 +296,7 @@ Result:
296296
監査セットが予期せず変更されていないことを確認するには、以下のコマンドを実行して監査セットの更新履歴を確認できます:
297297

298298
```console
299-
client/bin/scalardl-hashstore get-collection-history --properties client.properties \
299+
hashstore/bin/scalardl-hashstore get-collection-history --properties client.properties \
300300
--collection-id audit_set
301301
```
302302

@@ -329,7 +329,7 @@ ScalarDL では、すべてのデータが有効な状態にあることを確
329329
以下のコマンドを実行して、オブジェクトを検証できます:
330330

331331
```console
332-
client/bin/scalardl-hashstore validate-ledger --properties client.properties \
332+
hashstore/bin/scalardl-hashstore validate-ledger --properties client.properties \
333333
--object-id a.txt
334334
```
335335

@@ -352,7 +352,7 @@ client/bin/scalardl-hashstore validate-ledger --properties client.properties \
352352
以下のコマンドを実行して、コレクションを検証できます:
353353

354354
```console
355-
client/bin/scalardl-hashstore validate-ledger --properties client.properties \
355+
hashstore/bin/scalardl-hashstore validate-ledger --properties client.properties \
356356
--collection-id audit_set
357357
```
358358

‎i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/getting-started-tablestore.mdx‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ VERSION=$(grep SCALARDL_VERSION .env | awk -F= '{print $2}')
3838
```console
3939
curl -OL https://github.com/scalar-labs/scalardl/releases/download/v$VERSION/scalardl-tablestore-java-client-sdk-$VERSION.zip
4040
unzip scalardl-tablestore-java-client-sdk-$VERSION.zip
41-
mv scalardl-tablestore-java-client-sdk-$VERSION client
41+
mv scalardl-tablestore-java-client-sdk-$VERSION tablestore
4242
```
4343

4444
## クライアントプロパティの設定
@@ -74,7 +74,7 @@ EOF
7474
次に、以下のコマンドを実行して TableStore をブートストラップできます:
7575

7676
```console
77-
client/bin/scalardl-tablestore bootstrap --properties client.properties
77+
tablestore/bin/scalardl-tablestore bootstrap --properties client.properties
7878
```
7979

8080
ブートストラップコマンドは、内部的にアイデンティティ情報 (証明書またはシークレット) と TableStore を使用するために必要な事前定義されたコントラクトを登録します。
@@ -94,11 +94,11 @@ client/bin/scalardl-tablestore bootstrap --properties client.properties
9494
以下のコマンドを実行して、サンプルテーブルを作成できます:
9595

9696
```console
97-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
97+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
9898
--statement "CREATE TABLE employee (id STRING PRIMARY KEY, department STRING)"
9999
```
100100
```console
101-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
101+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
102102
--statement "CREATE TABLE department (id STRING PRIMARY KEY)"
103103
```
104104

@@ -107,7 +107,7 @@ client/bin/scalardl-tablestore execute-statement --properties client.properties
107107
以下のコマンドを実行して、作成されたテーブルを表示できます:
108108

109109
```console
110-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
110+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
111111
--statement "SELECT * FROM information_schema.tables"
112112
```
113113

@@ -136,26 +136,26 @@ Result:
136136
次に、以下のコマンドを実行して、複数の `employee` レコードを挿入します:
137137

138138
```console
139-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
139+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
140140
--statement "INSERT INTO employee VALUES {'id': '1001', 'name': 'Alice', 'department': 'sales', 'salary': 654.3}"
141141
```
142142
```console
143-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
143+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
144144
--statement "INSERT INTO employee VALUES {'id': '1002', 'name': 'Bob', 'department': 'sales', 'salary': 543.2}"
145145
```
146146
```console
147-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
147+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
148148
--statement "INSERT INTO employee VALUES {'id': '1003', 'name': 'Carol', 'department': 'engineering', 'salary': 654.3}"
149149
```
150150

151151
また、以下のコマンドを実行して、対応する `department` レコードも挿入します:
152152

153153
```console
154-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
154+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
155155
--statement "INSERT INTO department VALUES {'id': 'sales', 'location': 'Shinjuku', 'phone': '000-1234'}"
156156
```
157157
```console
158-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
158+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
159159
--statement "INSERT INTO department VALUES {'id': 'engineering', 'location': 'Shibuya', 'phone': '000-4321'}"
160160
```
161161

@@ -164,7 +164,7 @@ client/bin/scalardl-tablestore execute-statement --properties client.properties
164164
次に、挿入されたレコードを確認します。レコードを選択するには、少なくともプライマリキーまたはインデックスキーを指定する必要があります。例えば、以下のコマンドを実行して、プライマリキーを指定して `employee` レコードを取得できます:
165165

166166
```console
167-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
167+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
168168
--statement "SELECT id, name, department FROM employee WHERE id = '1001'"
169169
```
170170

@@ -182,7 +182,7 @@ Result:
182182
以下のコマンドを実行して、インデックスキーを指定してレコードを選択することもできます:
183183

184184
```console
185-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
185+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
186186
--statement "SELECT id, name, department FROM employee WHERE department = 'sales'"
187187
```
188188

@@ -204,7 +204,7 @@ Result:
204204
レコードをフィルタリングしたい場合は、以下のコマンドを実行して追加の条件を指定します:
205205

206206
```console
207-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
207+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
208208
--statement "SELECT id, name, department FROM employee WHERE department = 'sales' AND salary < 600"
209209
```
210210

@@ -223,7 +223,7 @@ Result:
223223
以下のコマンドを実行して、2つのテーブルを結合することもできます:
224224

225225
```console
226-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
226+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
227227
--statement "SELECT * FROM employee JOIN department ON employee.department = department.id WHERE employee.department = 'engineering'"
228228
```
229229

@@ -247,7 +247,7 @@ Result:
247247
以下のコマンドを実行して、`employee` レコードを更新できます:
248248

249249
```console
250-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
250+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
251251
--statement "UPDATE employee SET salary = 754.3 WHERE department = 'engineering'"
252252
```
253253

@@ -258,7 +258,7 @@ client/bin/scalardl-tablestore execute-statement --properties client.properties
258258
以下のコマンドを実行して、レコードの更新履歴を取得できます:
259259

260260
```console
261-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
261+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
262262
--statement "SELECT history() FROM employee WHERE id = '1003'"
263263
```
264264

@@ -288,7 +288,7 @@ Result:
288288
バージョン数 (age) を制限したい場合は、以下のコマンドを実行して `LIMIT` 句を指定します:
289289

290290
```console
291-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
291+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
292292
--statement "SELECT history() FROM employee WHERE id = '1003' LIMIT 1"
293293
```
294294

@@ -314,7 +314,7 @@ ScalarDL では、すべてのデータが有効な状態にあることを確
314314
以下のコマンドを実行して、テーブルスキーマを検証できます:
315315

316316
```console
317-
client/bin/scalardl-tablestore validate-ledger --properties client.properties \
317+
tablestore/bin/scalardl-tablestore validate-ledger --properties client.properties \
318318
--table-name employee
319319
```
320320

@@ -337,7 +337,7 @@ client/bin/scalardl-tablestore validate-ledger --properties client.properties \
337337
以下のコマンドを実行して、レコードを検証できます:
338338

339339
```console
340-
client/bin/scalardl-tablestore validate-ledger --properties client.properties \
340+
tablestore/bin/scalardl-tablestore validate-ledger --properties client.properties \
341341
--table-name employee --primary-key-column-name id --column-value '"1001"'
342342
```
343343

@@ -366,7 +366,7 @@ client/bin/scalardl-tablestore validate-ledger --properties client.properties \
366366
以下のコマンドを実行して、インデックスレコードを検証できます:
367367

368368
```console
369-
client/bin/scalardl-tablestore validate-ledger --properties client.properties \
369+
tablestore/bin/scalardl-tablestore validate-ledger --properties client.properties \
370370
--table-name employee --index-key-column-name department --column-value '"sales"'
371371
```
372372

‎i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/how-to-run-applications-with-auditor.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import DbSpecificSteps from '/src/components/ja-jp/_getting-started-auditor-db-s
1414

1515
<TranslationBanner />
1616

17-
このガイドでは、ScalarDL Ledger と Auditor を介して ScalarDL アプリケーションを実行する方法について説明します。このドキュメントでは、すでに [ScalarDL Ledger をはじめよう](getting-started.mdx)チュートリアルを試し、[Java で ScalarDL アプリケーションを書く](how-to-write-applications.mdx)ガイドを参考にして Client SDK を使用して ScalarDL を統合したアプリケーションを作成したことを前提としています。
17+
このガイドでは、ScalarDL Ledger と Auditor を介して ScalarDL アプリケーションを実行する方法について説明します。このドキュメントでは、すでに[クイックスタート](quickstart-overview.mdx)チュートリアルのいずれかを試し、[アプリケーションを書く](develop-write-an-application-overview.mdx)ガイドを参考にしてクライアント SDK を使用して ScalarDL を統合したアプリケーションを作成したことを前提としています。
1818

1919
## ScalarDL Auditor とは何ですか？
2020

0 commit comments

Comments
 (0)