Skip to content

Commit 34f2af7

Browse files
committed
AUTO: Sync ScalarDL docs in English to docs site repo
1 parent 8f98b25 commit 34f2af7

File tree

4 files changed

+151
-105
lines changed

4 files changed

+151
-105
lines changed

docs/getting-started-hashstore.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Then, download the tools by running the following command:
3737
```console
3838
curl -OL https://github.com/scalar-labs/scalardl/releases/download/v$VERSION/scalardl-hashstore-java-client-sdk-$VERSION.zip
3939
unzip scalardl-hashstore-java-client-sdk-$VERSION.zip
40-
mv scalardl-hashstore-java-client-sdk-$VERSION client
40+
mv scalardl-hashstore-java-client-sdk-$VERSION hashstore
4141
```
4242

4343
## Configure the client properties
@@ -73,7 +73,7 @@ Do not use the sample private key and certificate in production environments. Fo
7373
Next, you can bootstrap HashStore by running the following command:
7474

7575
```console
76-
client/bin/scalardl-hashstore bootstrap --properties client.properties
76+
hashstore/bin/scalardl-hashstore bootstrap --properties client.properties
7777
```
7878

7979
The bootstrap command internally registers identity information (a certificate or secret) and predefined contracts necessary to use HashStore.
@@ -104,7 +104,7 @@ You should get the following hash value:
104104
You can put the hash value by running the following command:
105105

106106
```console
107-
client/bin/scalardl-hashstore put-object --properties client.properties \
107+
hashstore/bin/scalardl-hashstore put-object --properties client.properties \
108108
--object-id a.txt \
109109
--hash 5c7440fb2273a247f78aadefbc511c680a84e7d44004abfaedef2b145151dab0 \
110110
--metadata '{"note": "created"}'
@@ -126,7 +126,7 @@ b97a42c87a46ffebe1439f8c1cd2f86e2f9b84dad89c8e9ebb257a19b6fdfe1c a.txt
126126
You can then update the hash value as follows:
127127

128128
```console
129-
client/bin/scalardl-hashstore put-object --properties client.properties \
129+
hashstore/bin/scalardl-hashstore put-object --properties client.properties \
130130
--object-id a.txt \
131131
--hash b97a42c87a46ffebe1439f8c1cd2f86e2f9b84dad89c8e9ebb257a19b6fdfe1c \
132132
--metadata '{"note": "updated"}'
@@ -135,7 +135,7 @@ client/bin/scalardl-hashstore put-object --properties client.properties \
135135
You can also get the latest status of the object by running the following command:
136136

137137
```console
138-
client/bin/scalardl-hashstore get-object --properties client.properties \
138+
hashstore/bin/scalardl-hashstore get-object --properties client.properties \
139139
--object-id a.txt
140140
```
141141

@@ -163,7 +163,7 @@ If you cannot get the hash value of the older version of the `a.txt` file in you
163163
:::
164164

165165
```console
166-
client/bin/scalardl-hashstore compare-object-versions --properties client.properties \
166+
hashstore/bin/scalardl-hashstore compare-object-versions --properties client.properties \
167167
--object-id a.txt \
168168
--versions '[{"version_id": "v2", "hash_value": "b97a42c87a46ffebe1439f8c1cd2f86e2f9b84dad89c8e9ebb257a19b6fdfe1c"}, {"version_id": "v1", "hash_value": "5c7440fb2273a247f78aadefbc511c680a84e7d44004abfaedef2b145151dab0"}]}'
169169
```
@@ -189,7 +189,7 @@ Alice updated this file
189189
Now the hash value of the latest version is `1f75d715648a3b4b3a33ecd7428a3e7139d9357da7d38735c23bf38618ecf9c7`. You can execute validation by running the following command:
190190

191191
```console
192-
client/bin/scalardl-hashstore compare-object-versions --properties client.properties \
192+
hashstore/bin/scalardl-hashstore compare-object-versions --properties client.properties \
193193
--object-id a.txt \
194194
--versions '[{"version_id": "v2", "hash_value": "1f75d715648a3b4b3a33ecd7428a3e7139d9357da7d38735c23bf38618ecf9c7"}, {"version_id": "v1", "hash_value": "5c7440fb2273a247f78aadefbc511c680a84e7d44004abfaedef2b145151dab0"}]}'
195195
```
@@ -220,7 +220,7 @@ For example, in object authenticity management, the `put-object` command (and th
220220
The third step above must be done in an ACID manner by executing the following command with the `--put-to-mutable` option:
221221

222222
```console
223-
client/bin/scalardl-hashstore put-object --properties client.properties \
223+
hashstore/bin/scalardl-hashstore put-object --properties client.properties \
224224
--object-id a.txt \
225225
--hash 5c7440fb2273a247f78aadefbc511c680a84e7d44004abfaedef2b145151dab0 \
226226
--put-to-mutable '{...}'
@@ -256,7 +256,7 @@ If a system cannot guarantee that an audit set has not been changed unexpectedly
256256
You can create a collection for an audit set by running the following command:
257257

258258
```console
259-
client/bin/scalardl-hashstore create-collection --properties client.properties \
259+
hashstore/bin/scalardl-hashstore create-collection --properties client.properties \
260260
--collection-id audit_set --object-ids a.txt --object-ids b.txt
261261
```
262262

@@ -265,21 +265,21 @@ The collection ID must be a unique ID that identifies the collection. You can sp
265265
You can also add objects to the collection by running the following command:
266266

267267
```console
268-
client/bin/scalardl-hashstore add-to-collection --properties client.properties \
268+
hashstore/bin/scalardl-hashstore add-to-collection --properties client.properties \
269269
--collection-id audit_set --object-ids c.txt --object-ids d.txt
270270
```
271271

272272
And you can remove objects from the collection by running the following command:
273273

274274
```console
275-
client/bin/scalardl-hashstore remove-from-collection --properties client.properties \
275+
hashstore/bin/scalardl-hashstore remove-from-collection --properties client.properties \
276276
--collection-id audit_set --object-ids a.txt
277277
```
278278

279279
You can get the latest status of the collection by running the following command:
280280

281281
```console
282-
client/bin/scalardl-hashstore get-collection --properties client.properties \
282+
hashstore/bin/scalardl-hashstore get-collection --properties client.properties \
283283
--collection-id audit_set
284284
```
285285

@@ -293,7 +293,7 @@ Result:
293293
To confirm that the audit set has not been changed unexpectedly, you can check the update history of the audit set by running the following command:
294294

295295
```console
296-
client/bin/scalardl-hashstore get-collection-history --properties client.properties \
296+
hashstore/bin/scalardl-hashstore get-collection-history --properties client.properties \
297297
--collection-id audit_set
298298
```
299299

@@ -326,7 +326,7 @@ In ScalarDL, you occasionally need to validate your data to make sure all the da
326326
You can validate an object by running the following command:
327327

328328
```console
329-
client/bin/scalardl-hashstore validate-ledger --properties client.properties \
329+
hashstore/bin/scalardl-hashstore validate-ledger --properties client.properties \
330330
--object-id a.txt
331331
```
332332

@@ -349,7 +349,7 @@ You should get a result like the following:
349349
You can validate a collection by running the following command:
350350

351351
```console
352-
client/bin/scalardl-hashstore validate-ledger --properties client.properties \
352+
hashstore/bin/scalardl-hashstore validate-ledger --properties client.properties \
353353
--collection-id audit_set
354354
```
355355

docs/getting-started-tablestore.mdx

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Then, download the tools by running the following command:
3535
```console
3636
curl -OL https://github.com/scalar-labs/scalardl/releases/download/v$VERSION/scalardl-tablestore-java-client-sdk-$VERSION.zip
3737
unzip scalardl-tablestore-java-client-sdk-$VERSION.zip
38-
mv scalardl-tablestore-java-client-sdk-$VERSION client
38+
mv scalardl-tablestore-java-client-sdk-$VERSION tablestore
3939
```
4040

4141
## Configure the client properties
@@ -71,7 +71,7 @@ Do not use the sample private key and certificate in production environments. Fo
7171
Next, you can bootstrap TableStore by running the following command:
7272

7373
```console
74-
client/bin/scalardl-tablestore bootstrap --properties client.properties
74+
tablestore/bin/scalardl-tablestore bootstrap --properties client.properties
7575
```
7676

7777
The bootstrap command internally registers identity information (a certificate or secret) and predefined contracts necessary to use TableStore.
@@ -91,11 +91,11 @@ Now you can execute SQL statements with TableStore. In this section, you'll try
9191
You can create the sample table by running the following commands:
9292

9393
```console
94-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
94+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
9595
--statement "CREATE TABLE employee (id STRING PRIMARY KEY, department STRING)"
9696
```
9797
```console
98-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
98+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
9999
--statement "CREATE TABLE department (id STRING PRIMARY KEY)"
100100
```
101101

@@ -104,7 +104,7 @@ When creating a table, you need to specify the name and the primary key. You can
104104
You can show the created tables by running the following command:
105105

106106
```console
107-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
107+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
108108
--statement "SELECT * FROM information_schema.tables"
109109
```
110110

@@ -133,26 +133,26 @@ Result:
133133
Next, insert several `employee` records by running the following commands:
134134

135135
```console
136-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
136+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
137137
--statement "INSERT INTO employee VALUES {'id': '1001', 'name': 'Alice', 'department': 'sales', 'salary': 654.3}"
138138
```
139139
```console
140-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
140+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
141141
--statement "INSERT INTO employee VALUES {'id': '1002', 'name': 'Bob', 'department': 'sales', 'salary': 543.2}"
142142
```
143143
```console
144-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
144+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
145145
--statement "INSERT INTO employee VALUES {'id': '1003', 'name': 'Carol', 'department': 'engineering', 'salary': 654.3}"
146146
```
147147

148148
Insert the corresponding `department` records as well by running the following commands:
149149

150150
```console
151-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
151+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
152152
--statement "INSERT INTO department VALUES {'id': 'sales', 'location': 'Shinjuku', 'phone': '000-1234'}"
153153
```
154154
```console
155-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
155+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
156156
--statement "INSERT INTO department VALUES {'id': 'engineering', 'location': 'Shibuya', 'phone': '000-4321'}"
157157
```
158158

@@ -161,7 +161,7 @@ client/bin/scalardl-tablestore execute-statement --properties client.properties
161161
Then, check the inserted records. You need to specify at least a primary key or index key to select records. For example, you can get an `employee` record by specifying the primary key by running the following command:
162162

163163
```console
164-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
164+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
165165
--statement "SELECT id, name, department FROM employee WHERE id = '1001'"
166166
```
167167

@@ -179,7 +179,7 @@ Result:
179179
You can also specify an index key to select records by running the following command:
180180

181181
```console
182-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
182+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
183183
--statement "SELECT id, name, department FROM employee WHERE department = 'sales'"
184184
```
185185

@@ -201,7 +201,7 @@ Result:
201201
If you want to filter records, specify additional conditions by running the following command:
202202

203203
```console
204-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
204+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
205205
--statement "SELECT id, name, department FROM employee WHERE department = 'sales' AND salary < 600"
206206
```
207207

@@ -220,7 +220,7 @@ Result:
220220
You can also join the two tables by running the following command:
221221

222222
```console
223-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
223+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
224224
--statement "SELECT * FROM employee JOIN department ON employee.department = department.id WHERE employee.department = 'engineering'"
225225
```
226226

@@ -244,7 +244,7 @@ Result:
244244
You can update the `employee` records by running the following command:
245245

246246
```console
247-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
247+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
248248
--statement "UPDATE employee SET salary = 754.3 WHERE department = 'engineering'"
249249
```
250250

@@ -255,7 +255,7 @@ Make sure to specify at least a primary key or an index key to update the record
255255
You can get the update history of a record by running the following command:
256256

257257
```console
258-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
258+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
259259
--statement "SELECT history() FROM employee WHERE id = '1003'"
260260
```
261261

@@ -285,7 +285,7 @@ Result:
285285
If you want to limit the number of versions (ages), specify the `LIMIT` clause by running the following command:
286286

287287
```console
288-
client/bin/scalardl-tablestore execute-statement --properties client.properties \
288+
tablestore/bin/scalardl-tablestore execute-statement --properties client.properties \
289289
--statement "SELECT history() FROM employee WHERE id = '1003' LIMIT 1"
290290
```
291291

@@ -311,7 +311,7 @@ In ScalarDL, you occasionally need to validate your data to make sure all the da
311311
You can validate the table schema by running the following command:
312312

313313
```console
314-
client/bin/scalardl-tablestore validate-ledger --properties client.properties \
314+
tablestore/bin/scalardl-tablestore validate-ledger --properties client.properties \
315315
--table-name employee
316316
```
317317

@@ -334,7 +334,7 @@ You should get a result like the following:
334334
You can validate the record by running the following command:
335335

336336
```console
337-
client/bin/scalardl-tablestore validate-ledger --properties client.properties \
337+
tablestore/bin/scalardl-tablestore validate-ledger --properties client.properties \
338338
--table-name employee --primary-key-column-name id --column-value '"1001"'
339339
```
340340

@@ -363,7 +363,7 @@ You should get a result like the following:
363363
You can validate the index record by running the following command:
364364

365365
```console
366-
client/bin/scalardl-tablestore validate-ledger --properties client.properties \
366+
tablestore/bin/scalardl-tablestore validate-ledger --properties client.properties \
367367
--table-name employee --index-key-column-name department --column-value '"sales"'
368368
```
369369

0 commit comments

Comments
 (0)