Skip to content

Commit ac467da

Browse files
AUTO: Sync ScalarDL docs in English to docs site repo (#1075)
Co-authored-by: josh-wong <[email protected]>
1 parent aa23349 commit ac467da

File tree

1 file changed

+14
-13
lines changed
  • versioned_docs/version-3.9/scalardl-benchmarks

1 file changed

+14
-13
lines changed

versioned_docs/version-3.9/scalardl-benchmarks/README.mdx

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,8 @@ You can run the benchmark several times by using the `--except-pre` option after
168168

169169
## Common parameters
170170

171+
The following parameters are common to all workloads.
172+
171173
### `concurrency`
172174

173175
- **Description:** Number of worker threads that concurrently execute benchmark transactions against the database. This parameter controls the level of parallelism during the actual benchmark execution phase. Increasing this value simulates more concurrent client accesses and higher workload intensity.
@@ -189,65 +191,64 @@ Select a workload to see its available parameters.
189191

190192
<Tabs groupId="benchmarks" queryString>
191193
<TabItem value="SmallBank" label="SmallBank" default>
192-
### `num_accounts`
194+
<h3>`num_accounts`</h3>
193195

194196
- **Description:** Number of bank accounts to create for the benchmark workload. This parameter determines the size of the dataset and affects the working-set size.
195197
- **Default value:** `100000`
196198

197-
### `load_concurrency`
199+
<h3>`load_concurrency`</h3>
198200

199201
- **Description:** Number of parallel threads used to load initial benchmark data into the database. This parameter controls how fast the data-loading phase completes. Increasing this value can significantly reduce data-loading time for large datasets. This is separate from the `concurrency` parameter used during benchmark execution.
200202
- **Default value:** `1`
201203

202-
### `load_batch_size`
204+
<h3>`load_batch_size`</h3>
203205

204206
- **Description:** Number of accounts to insert within a single transaction during the initial data-loading phase. Larger batch sizes can improve loading performance by reducing the number of transactions, but may increase the execution time of each transaction.
205207
- **Default value:** `1`
206208
</TabItem>
207209
<TabItem value="TPC-C" label="TPC-C">
208-
### `num_warehouses`
210+
<h3>`num_warehouses`</h3>
209211

210212
- **Description:** Number of warehouses to create for the TPC-C benchmark workload. This value is the scale factor that determines the dataset size. Increasing this value creates a larger working set and enables various enterprise-scale testing.
211213
- **Default value:** `1`
212214

213-
### `rate_payment`
215+
<h3>`rate_payment`</h3>
214216

215217
- **Description:** Percentage of Payment transactions in the transaction mix, with the remainder being New-Order transactions. For example, a value of `50` means 50% of transactions will be Payment transactions and 50% will be New-Order transactions.
216218
- **Default value:** `50`
217219

218-
### `load_concurrency`
220+
<h3>`load_concurrency`</h3>
219221

220222
- **Description:** Number of parallel threads used to load initial benchmark data into the database. This parameter controls how fast the data-loading phase completes. Increasing this value can significantly reduce data-loading time, especially for larger numbers of warehouses. This is separate from the `concurrency` parameter used during benchmark execution.
221223
- **Default value:** `1`
222224
</TabItem>
223225
<TabItem value="YCSB" label="YCSB">
224-
### `record_count`
226+
<h3>`record_count`</h3>
225227

226228
- **Description:** Number of records to create for the YCSB benchmark workload. This parameter determines the size of the dataset and affects the working-set size during benchmark execution.
227229
- **Default value:** `1000`
228230

229-
### `payload_size`
231+
<h3>`payload_size`</h3>
230232

231233
- **Description:** Size of the payload data (in bytes) for each record. This parameter controls the amount of data stored per record and affects database storage, memory usage, and I/O characteristics.
232234
- **Default value:** `1000`
233235

234-
### `ops_per_tx`
236+
<h3>`ops_per_tx`</h3>
235237

236238
- **Description:** Number of read or write operations to execute within a single transaction. This parameter affects transaction size and execution time. Higher values create longer-running transactions.
237239
- **Default value:** `2`
238240

239-
### `workload`
241+
<h3>`workload`</h3>
240242

241243
- **Description:** YCSB workload type that defines the operation mix: **A** (50% reads, 50% read-modify-write operations), **C** (100% reads), or **F** (100% read-modify-write operations). Note that the workload A in this benchmark uses read-modify-write operations instead of pure blind writes because ScalarDL prohibits the blind writes. Each workload type simulates different application access patterns.
242-
243244
- **Default value:** `A`
244245

245-
### `load_concurrency`
246+
<h3>`load_concurrency`</h3>
246247

247248
- **Description:** Number of parallel threads used to load initial benchmark data into the database. This parameter controls how fast the data-loading phase completes. Increasing this value can significantly reduce data-loading time for large datasets. This is separate from the `concurrency` parameter used during benchmark execution.
248249
- **Default value:** `1`
249250

250-
### `load_batch_size`
251+
<h3>`load_batch_size`</h3>
251252

252253
- **Description:** Number of records to insert within a single transaction during the initial data-loading phase. Larger batch sizes can improve loading performance by reducing the number of transactions, but may increase the execution time of each transaction.
253254
- **Default value:** `1`

0 commit comments

Comments
 (0)