From 565dad9d6aeffc2a2918bde9c4d65a2b07e98323 Mon Sep 17 00:00:00 2001 From: josh-wong Date: Wed, 21 May 2025 04:11:55 +0000 Subject: [PATCH] AUTO: Sync ScalarDB docs in English to docs site repo --- .../version-3.14/scalardb-graphql/index.mdx | 23 ++++++++++++ .../version-3.14/scalardb-sql/index.mdx | 37 +++++++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 versioned_docs/version-3.14/scalardb-graphql/index.mdx create mode 100644 versioned_docs/version-3.14/scalardb-sql/index.mdx diff --git a/versioned_docs/version-3.14/scalardb-graphql/index.mdx b/versioned_docs/version-3.14/scalardb-graphql/index.mdx new file mode 100644 index 00000000..c325ea85 --- /dev/null +++ b/versioned_docs/version-3.14/scalardb-graphql/index.mdx @@ -0,0 +1,23 @@ +--- +tags: + - Enterprise Premium +displayed_sidebar: docsEnglish +--- + +# ScalarDB GraphQL Overview + +ScalarDB GraphQL is an interface layer that allows client applications to communicate with ScalarDB Cluster by using GraphQL. It enables you to take advantage the benefits of GraphQL, such as flexible data retrieval and type safety, while benefiting from the transaction management and data access features in ScalarDB. + +By using ScalarDB GraphQL, you can create GraphQL schemas automatically based on the ScalarDB schemas, perform CRUD operations, and execute complex transactions across multiple databases. The interface simplifies backend development by providing a unified querying mechanism, making it particularly useful for modern applications expecting advanced and responsive data interactions. + +## Getting started with GraphQL in ScalarDB Cluster + +ScalarDB GraphQL is designed to be intuitive and user-friendly, enabling developers to easily create GraphQL schemas automatically based on the ScalarDB schemas and interact with the underlying databases. + +For details on how to set up ScalarDB Cluster with GraphQL support, see [Getting Started with ScalarDB Cluster GraphQL](../scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx). + +## Transactions with a two-phase commit + +ScalarDB GraphQL supports executing transactions with a two-phase commit interface. By using the two-phase commit interface, you can execute a transaction that spans multiple processes/applications (for example, microservices applications). + +For details on how to execute transactions by using the two-phase commit interface in ScalarDB GraphQL, see [How to Run Two-Phase Commit Transactions](./how-to-run-two-phase-commit-transaction.mdx). diff --git a/versioned_docs/version-3.14/scalardb-sql/index.mdx b/versioned_docs/version-3.14/scalardb-sql/index.mdx new file mode 100644 index 00000000..58ca6a94 --- /dev/null +++ b/versioned_docs/version-3.14/scalardb-sql/index.mdx @@ -0,0 +1,37 @@ +--- +tags: + - Enterprise Premium +displayed_sidebar: docsEnglish +--- + +# ScalarDB SQL Overview + +ScalarDB SQL is an SQL layer for ScalarDB Cluster. Specifically, it parses SQL and converts it to a set of ScalarDB operations. + +:::note + +ScalarDB SQL is not fully compatible with standard SQL, but it offers a large subset of the SQL language. + +::: + +## Types of SQL interfaces + +ScalarDB SQL has three types of SQL interfaces. + +### JDBC + +The JDBC interface lets you connect to ScalarDB Cluster by using the standard JDBC API. This is useful for applications that already use JDBC. + +For details on how to set up and use the JDBC interface, see the [ScalarDB JDBC Guide](./jdbc-guide.mdx). + +### SQL API + +The SQL API lets you connect to ScalarDB Cluster by using the proprietary and modern Java SQL API. This is useful for applications that do not need to rely on the JDBC interface. + +For details on how to set up and use the SQL API, see the [ScalarDB SQL API Guide](./sql-api-guide.mdx). + +### Spring Data JDBC + +The Spring Data JDBC interface lets you interact with ScalarDB Cluster via Spring Data JDBC repositories and entities. This is useful for applications that already use Spring Data or when you want to integrate ScalarDB Cluster into Spring applications. + +For details on how to set up and use the Sprign Data JDBC interface, see the [Guide of Spring Data JDBC for ScalarDB](./spring-data-guide.mdx).