From 0b69be37a2e449f1a569e6552cc764db3506a234 Mon Sep 17 00:00:00 2001 From: josh-wong Date: Thu, 28 Nov 2024 09:45:44 +0000 Subject: [PATCH] AUTO: Sync ScalarDL docs in English to docs site repo --- docs/compatibility.mdx | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/compatibility.mdx b/docs/compatibility.mdx index df2e8d9c..5ada4d75 100644 --- a/docs/compatibility.mdx +++ b/docs/compatibility.mdx @@ -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.