diff --git a/docs/api-guide.mdx b/docs/api-guide.mdx index 7be336f1..9e653ee1 100644 --- a/docs/api-guide.mdx +++ b/docs/api-guide.mdx @@ -18,6 +18,15 @@ The ScalarDB Java API is mainly composed of the Administrative API and Transacti This section explains how to execute administrative operations programmatically by using the Administrative API in ScalarDB. +:::warning + +When an Administrative API call writes to the underlying databases, it triggers several write operations. However, these operations are not executed atomically, meaning that if the call fails midway, you may encounter inconsistent states. To resolve this inconsistency issue, you can repair the table. For details, see the following pages: + +- [Repair a table](#repair-a-table) by using the Java API +- [Repair tables](schema-loader.mdx#repair-tables) by using ScalarDB Schema Loader + +::: + :::note Another method for executing administrative operations is to use [Schema Loader](schema-loader.mdx). diff --git a/docs/scalardb-sql/grammar.mdx b/docs/scalardb-sql/grammar.mdx index b0a19b4d..191a7317 100644 --- a/docs/scalardb-sql/grammar.mdx +++ b/docs/scalardb-sql/grammar.mdx @@ -55,6 +55,15 @@ displayed_sidebar: docsEnglish ## DDL +:::warning + +Each DDL command triggers several write operations, but these operations are not executed atomically, meaning that if the command fails midway, you may encounter inconsistent states. To resolve this inconsistency issue, you can repair the table. For details, see the following pages: + +- [Repair a table](../api-guide.mdx#repair-a-table) by using the Java API +- [Repair tables](../schema-loader.mdx#repair-tables) by using ScalarDB Schema Loader + +::: + ### CREATE NAMESPACE Before creating tables, namespaces must be created since a table belongs to one namespace.