Skip to content

Commit 3a45c43

Browse files
committed
AUTO: Sync ScalarDB docs in English to docs site repo
1 parent 15debaf commit 3a45c43

File tree

4 files changed

+17
-12
lines changed

4 files changed

+17
-12
lines changed

versioned_docs/version-3.13/api-guide.mdx

+4-3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ displayed_sidebar: docsEnglish
88

99
# ScalarDB Java API Guide
1010

11+
import JavadocLink from '/src/theme/JavadocLink.js';
1112
import Tabs from '@theme/Tabs';
1213
import TabItem from '@theme/TabItem';
1314

@@ -540,7 +541,7 @@ In the `where()` condition method chain, the conditions must be an AND-wise junc
540541

541542
:::
542543

543-
For more details about available conditions and condition sets, see the `ConditionBuilder` and `ConditionSetBuilder` page in the [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/latest/index.html) of the version of ScalarDB that you're using.
544+
For more details about available conditions and condition sets, see the <JavadocLink packageName="scalardb" path="com/scalar/db/api" className="ConditionBuilder" /> and <JavadocLink packageName="scalardb" path="com/scalar/db/api" className="ConditionSetBuilder" /> pages in the Javadoc.
544545

545546
###### Handle `Result` objects
546547

@@ -581,7 +582,7 @@ And if you need to check if a value of a column is null, you can use the `isNull
581582
boolean isNull = result.isNull("<COLUMN_NAME>");
582583
```
583584

584-
For more details, see the `Result` page in the [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.2/index.html) of the version of ScalarDB that you're using.
585+
For more details, see the <JavadocLink packageName="scalardb" path="com/scalar/db/api" className="Result" /> page in the Javadoc.
585586

586587
###### Execute `Get` by using a secondary index
587588

@@ -676,7 +677,7 @@ In the `where()` condition method chain, the conditions must be an AND-wise junc
676677

677678
:::
678679

679-
For more details about available conditions and condition sets, see the `ConditionBuilder` and `ConditionSetBuilder` page in the [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/latest/index.html) of the version of ScalarDB that you're using.
680+
For more details about available conditions and condition sets, see the <JavadocLink packageName="scalardb" path="com/scalar/db/api" className="ConditionBuilder" /> and <JavadocLink packageName="scalardb" path="com/scalar/db/api" className="ConditionSetBuilder" /> pages in the Javadoc.
680681

681682
###### Execute `Scan` by using a secondary index
682683

versioned_docs/version-3.13/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx

+3-2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ displayed_sidebar: docsEnglish
66

77
# Getting Started with ScalarDB Cluster GraphQL
88

9+
import JavadocLink from '/src/theme/JavadocLink.js';
10+
911
This tutorial describes how to use ScalarDB Cluster GraphQL.
1012

1113
## Prerequisites
@@ -186,8 +188,7 @@ You should get the following result in the right pane:
186188

187189
### Mappings between GraphQL API and ScalarDB Java API
188190

189-
The automatically generated GraphQL schema defines queries, mutations, and object types for input/output to allow you to run CRUD operations for all the tables in the target namespaces.
190-
These operations are designed to match the ScalarDB APIs defined in the [`DistributedTransaction`](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.2/com/scalar/db/api/DistributedTransaction.html) interface.
191+
The automatically generated GraphQL schema defines queries, mutations, and object types for input/output to allow you to run CRUD operations for all the tables in the target namespaces. These operations are designed to match the ScalarDB APIs defined in the <JavadocLink packageName="scalardb" path="com/scalar/db/api" className="DistributedTransaction" /> interface.
191192

192193
Assuming you have an `account` table in a namespace, the following queries and mutations will be generated:
193194

versioned_docs/version-3.13/scalardb-graphql/getting-started-with-scalardb-graphql.mdx

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Getting Started with ScalarDB GraphQL
22

3+
import JavadocLink from '/src/theme/JavadocLink.js';
4+
35
ScalarDB GraphQL is an interface layer that allows client applications to communicate with a [ScalarDB](https://github.com/scalar-labs/scalardb) database with GraphQL.
46

57
In this Getting Started guide, you will run a GraphQL server on your local machine.
@@ -125,7 +127,7 @@ You should get the following result in the right pane.
125127

126128
## Mappings between GraphQL API and ScalarDB Java API
127129

128-
The automatically generated GraphQL schema defines queries, mutations, and object types for input/output to allow you to run CRUD operations for all the tables in the target namespaces. These operations are designed to match the ScalarDB APIs defined in the [`DistributedTransaction`](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.2/com/scalar/db/api/DistributedTransaction.html) interface.
130+
The automatically generated GraphQL schema defines queries, mutations, and object types for input/output to allow you to run CRUD operations for all the tables in the target namespaces. These operations are designed to match the ScalarDB APIs defined in the <JavadocLink packageName="scalardb" path="com/scalar/db/api" className="DistributedTransaction" /> interface.
129131

130132
Assuming you have an `account` table in a namespace, the following queries and mutations will be generated.
131133

versioned_docs/version-3.13/scalardb-sql/sql-api-guide.mdx

+7-6
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ displayed_sidebar: docsEnglish
66

77
# ScalarDB SQL API Guide
88

9+
import JavadocLink from '/src/theme/JavadocLink.js';
10+
911
This guide describes how to use ScalarDB SQL API.
1012

1113
## Add ScalarDB SQL API to your project
@@ -110,8 +112,7 @@ Statement statement = StatementBuilder.<factory method>...;
110112
ResultSet resultSet = sqlSession.execute(statement);
111113
```
112114

113-
`Statement` objects can be built by `StatementBuilder` that has factory methods for corresponding SQLs.
114-
Please see [the Javadoc of `StatementBuilder`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.13.2/com/scalar/db/sql/statement/builder/StatementBuilder.html) and [ScalarDB SQL Grammar](grammar.mdx) for more details.
115+
`Statement` objects can be built by `StatementBuilder` that has factory methods for corresponding SQLs. For more details, see the <JavadocLink packageName="scalardb-sql" path="com/scalar/db/sql/statement/builder" className="StatementBuilder" /> page in the Javadoc and [ScalarDB SQL Grammar](grammar.mdx).
115116

116117
### Handle ResultSet objects
117118

@@ -142,7 +143,7 @@ If you want to get the metadata of the `ResultSet` object, you can use the `getC
142143
ColumnDefinitions columnDefinitions = resultSet.getColumnDefinitions();
143144
```
144145

145-
Please see [the Javadoc of `ColumnDefinitions`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.13.2/com/scalar/db/sql/ColumnDefinition.html) for more details.
146+
For more details, see the <JavadocLink packageName="scalardb-sql" path="com/scalar/db/sql" className="ColumnDefinition" /> page in the Javadoc.
146147

147148
### Handle Record objects
148149

@@ -192,7 +193,7 @@ boolean isNullGottenByName = record.isNull("<column name>");
192193
boolean isNullGottenByIndex = record.isNull(<column index>);
193194
```
194195

195-
Please see also [the Javadoc of `Record`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.13.2/com/scalar/db/sql/Record.html) for more details.
196+
For more details, see the <JavadocLink packageName="scalardb-sql" path="com/scalar/db/sql" className="Record" /> page of the Javadoc.
196197

197198
### Prepared Statements
198199

@@ -237,7 +238,7 @@ preparedStatement2
237238
.execute();
238239
```
239240

240-
Please see also [the Javadoc of `PreparedStatement`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.13.2/com/scalar/db/sql/PreparedStatement.html) for more details.
241+
For more details, see the <JavadocLink packageName="scalardb-sql" path="com/scalar/db/sql" className="PreparedStatement" /> page of the Javadoc.
241242

242243
## Execute transactions
243244

@@ -351,7 +352,7 @@ You can get metadata with the `SqlSession.getMetadata()` method as follows:
351352
Metadata metadata = sqlSession.getMetadata();
352353
```
353354

354-
Please see [the Javadoc of `Metadata`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.13.2/com/scalar/db/sql/metadata/Metadata.html) for the details.
355+
For more details, see the <JavadocLink packageName="scalardb-sql" path="com/scalar/db/sql/metadata" className="Metadata" /> page of the Javadoc.
355356

356357
## References
357358

0 commit comments

Comments
 (0)