You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: versioned_docs/version-3.13/api-guide.mdx
+4-3
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,7 @@ displayed_sidebar: docsEnglish
8
8
9
9
# ScalarDB Java API Guide
10
10
11
+
importJavadocLinkfrom'/src/theme/JavadocLink.js';
11
12
importTabsfrom'@theme/Tabs';
12
13
importTabItemfrom'@theme/TabItem';
13
14
@@ -540,7 +541,7 @@ In the `where()` condition method chain, the conditions must be an AND-wise junc
540
541
541
542
:::
542
543
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 <JavadocLinkpackageName="scalardb"path="com/scalar/db/api"className="ConditionBuilder" /> and <JavadocLinkpackageName="scalardb"path="com/scalar/db/api"className="ConditionSetBuilder" /> pages in the Javadoc.
544
545
545
546
###### Handle `Result` objects
546
547
@@ -581,7 +582,7 @@ And if you need to check if a value of a column is null, you can use the `isNull
581
582
boolean isNull = result.isNull("<COLUMN_NAME>");
582
583
```
583
584
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 <JavadocLinkpackageName="scalardb"path="com/scalar/db/api"className="Result" /> page in the Javadoc.
585
586
586
587
###### Execute `Get` by using a secondary index
587
588
@@ -676,7 +677,7 @@ In the `where()` condition method chain, the conditions must be an AND-wise junc
676
677
677
678
:::
678
679
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 <JavadocLinkpackageName="scalardb"path="com/scalar/db/api"className="ConditionBuilder" /> and <JavadocLinkpackageName="scalardb"path="com/scalar/db/api"className="ConditionSetBuilder" /> pages in the Javadoc.
Copy file name to clipboardExpand all lines: versioned_docs/version-3.13/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx
+3-2
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,8 @@ displayed_sidebar: docsEnglish
6
6
7
7
# Getting Started with ScalarDB Cluster GraphQL
8
8
9
+
importJavadocLinkfrom'/src/theme/JavadocLink.js';
10
+
9
11
This tutorial describes how to use ScalarDB Cluster GraphQL.
10
12
11
13
## Prerequisites
@@ -186,8 +188,7 @@ You should get the following result in the right pane:
186
188
187
189
### Mappings between GraphQL API and ScalarDB Java API
188
190
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 <JavadocLinkpackageName="scalardb"path="com/scalar/db/api"className="DistributedTransaction" /> interface.
191
192
192
193
Assuming you have an `account` table in a namespace, the following queries and mutations will be generated:
Copy file name to clipboardExpand all lines: versioned_docs/version-3.13/scalardb-graphql/getting-started-with-scalardb-graphql.mdx
+3-1
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# Getting Started with ScalarDB GraphQL
2
2
3
+
importJavadocLinkfrom'/src/theme/JavadocLink.js';
4
+
3
5
ScalarDB GraphQL is an interface layer that allows client applications to communicate with a [ScalarDB](https://github.com/scalar-labs/scalardb) database with GraphQL.
4
6
5
7
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.
125
127
126
128
## Mappings between GraphQL API and ScalarDB Java API
127
129
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 <JavadocLinkpackageName="scalardb"path="com/scalar/db/api"className="DistributedTransaction" /> interface.
129
131
130
132
Assuming you have an `account` table in a namespace, the following queries and mutations will be generated.
`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 <JavadocLinkpackageName="scalardb-sql"path="com/scalar/db/sql/statement/builder"className="StatementBuilder" /> page in the Javadoc and [ScalarDB SQL Grammar](grammar.mdx).
115
116
116
117
### Handle ResultSet objects
117
118
@@ -142,7 +143,7 @@ If you want to get the metadata of the `ResultSet` object, you can use the `getC
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 <JavadocLinkpackageName="scalardb-sql"path="com/scalar/db/sql"className="ColumnDefinition" /> page in the Javadoc.
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 <JavadocLinkpackageName="scalardb-sql"path="com/scalar/db/sql"className="Record" /> page of the Javadoc.
196
197
197
198
### Prepared Statements
198
199
@@ -237,7 +238,7 @@ preparedStatement2
237
238
.execute();
238
239
```
239
240
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 <JavadocLinkpackageName="scalardb-sql"path="com/scalar/db/sql"className="PreparedStatement" /> page of the Javadoc.
241
242
242
243
## Execute transactions
243
244
@@ -351,7 +352,7 @@ You can get metadata with the `SqlSession.getMetadata()` method as follows:
351
352
Metadata metadata = sqlSession.getMetadata();
352
353
```
353
354
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 <JavadocLinkpackageName="scalardb-sql"path="com/scalar/db/sql/metadata"className="Metadata" /> page of the Javadoc.
0 commit comments