Skip to content

Commit 308f203

Browse files
AUTO: Sync ScalarDB docs in English to docs site repo (#1107)
Co-authored-by: josh-wong <[email protected]>
1 parent b2a2b09 commit 308f203

File tree

4 files changed

+16
-11
lines changed

4 files changed

+16
-11
lines changed

versioned_docs/version-3.12/api-guide.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ tags:
77

88
# ScalarDB Java API Guide
99

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

@@ -530,7 +531,7 @@ And if you need to check if a value of a column is null, you can use the `isNull
530531
boolean isNull = result.isNull("<COLUMN_NAME>");
531532
```
532533

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

535536
##### Execute `Get` by using a secondary index
536537

@@ -715,7 +716,7 @@ In the `where()` condition method chain, the conditions must be an and-wise junc
715716

716717
:::
717718

718-
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.
719+
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.
719720

720721
#### `Put` operation
721722

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ tags:
55

66
# Getting Started with ScalarDB Cluster GraphQL
77

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

1012
## Prerequisites
@@ -185,8 +187,7 @@ You should get the following result in the right pane:
185187

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

188-
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 specified namespaces.
189-
These operations are designed to match the ScalarDB APIs defined in the [`DistributedTransaction`](https://javadoc.io/doc/com.scalar-labs/scalardb/latest/com/scalar/db/api/DistributedTransaction.html) interface.
190+
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.
190191

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

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

Lines changed: 3 additions & 1 deletion
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 specified namespaces. These operations are designed to match the ScalarDB APIs defined in the [`DistributedTransaction`](https://javadoc.io/doc/com.scalar-labs/scalardb/latest/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.12/scalardb-sql/sql-api-guide.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ tags:
55

66
# ScalarDB SQL API Guide
77

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

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

112-
`Statement` objects can be built by `StatementBuilder` that has factory methods for corresponding SQLs.
113-
Please see [the Javadoc of `StatementBuilder`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.12.5/com/scalar/db/sql/statement/builder/StatementBuilder.html) and [ScalarDB SQL Grammar](grammar.mdx) for more details.
114+
`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).
114115

115116
### Handle ResultSet objects
116117

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

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

146147
### Handle Record objects
147148

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

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

196197
### Prepared Statements
197198

@@ -236,7 +237,7 @@ preparedStatement2
236237
.execute();
237238
```
238239

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

241242
## Execute transactions
242243

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

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

355356
## References
356357

0 commit comments

Comments
 (0)