Skip to content

Commit

Permalink
AUTO: Sync ScalarDL docs in English to docs site repo
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-wong committed Feb 20, 2025
1 parent 1f43845 commit b0b147a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
7 changes: 4 additions & 3 deletions versioned_docs/version-3.9/compatibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Versions are expressed as `x.y.z`, where `x` represents the major version, `y` r
## ScalarDL compatibility with client SDKs

| ScalarDL Ledger/Auditor version | ScalarDL Java Client SDK version |
| :------------------------------ | :------------------------------- |
| 3.9 | 3.0 - 3.9 |
| 3.8 | 3.0 - 3.8 |
|:--------------------------------|:---------------------------------|
| 3.10 | 3.8 - 3.10 |
| 3.9 | 3.8 - 3.9 |
| 3.8 | 3.8 |

:::note

Expand Down
17 changes: 15 additions & 2 deletions versioned_docs/version-3.9/scalardl-benchmarks/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,19 @@ Then, go to the directory that contains the benchmarking files by running the fo
cd scalardl-benchmarks
```

### Change the client SDK version

Check the `build.gradle` file to see if the ScalarDL Java Client SDK version is a supported version for the target ScalarDL Ledger and Auditor, based on [ScalarDL compatibility with client SDKs](../compatibility.mdx). If it is not supported, change `<VERSION>` in the following part of the `build.gradle` file to a version like `X.Y.Z` (for example, `3.9.4`).

```gradle
dependencies {
implementation group: 'com.google.inject', name: 'guice', version: '5.0.1'
implementation group: 'com.scalar-labs', name: 'kelpie', version: '1.2.3'
implementation group: 'com.scalar-labs', name: 'scalardl-java-client-sdk', version: '<VERSION>'
implementation group: 'io.github.resilience4j', name: 'resilience4j-retry', version: '1.3.1'
}
```

### Build the tools

To build the benchmarking tools, run the following command:
Expand Down Expand Up @@ -149,9 +162,9 @@ Select a benchmark, and follow the instructions to run the benchmark.
In addition, the following options are available:

- `--only-pre`. Only registers certificates and contracts and loads the data.
- `--only-process`. Only runs the benchmark.
- `--except-pre` Runs a job without registering certificates and contracts and loading the data.
- `--except-process`. Runs a job without running the benchmark.

You can run the benchmark several times by using the `--except-pre` option after the initialization is done by using the `--only-pre` option.

## Common parameters

Expand Down

0 comments on commit b0b147a

Please sign in to comment.