Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AUTO: Docs repo sync - ScalarDL #591

Merged
merged 1 commit into from
Nov 28, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/compatibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ Versions are expressed as `x.y.z`, where `x` represents the major version, `y` r
| 3.9 | 3.0 - 3.9 |
| 3.8 | 3.0 - 3.8 |

:::note

- You can consider the client tools ([ScalarDL Client Command](./scalardl-command-reference.mdx) and [ScalarDL Schema Loader](./schema-loader.mdx)) to be the same as the ScalarDL Java Client SDK. In other words, you can apply the same compatibility rules to client tools as the ScalarDL Java Client SDK.
- When you create a new deployment of ScalarDL, we recommend using the same version of ScalarDL Schema Loader as the version of ScalarDL.
- When you upgrade the minor or patch version of ScalarDL, basically, you don't need to update the existing schemas. In other words, basically, you don't need to re-run ScalarDL Schema Loader when you upgrade a minor or patch version of ScalarDL.
- If you use a new feature that ScalarDL provides in a new minor version, you may need to use the same or a later version of the client tools or re-create (or update) existing schemas. For details, please refer to the relevant documentation about each feature.

:::

### Version skew policy

- If the **major** versions are different between ScalarDL and the client SDK, they are **not** compatible and are **not** supported.
Expand Down