|
5 | 5 |
|
6 | 6 | # ScalarDB SQL API Guide |
7 | 7 |
|
| 8 | +import JavadocLink from '/src/theme/JavadocLink.js'; |
| 9 | + |
8 | 10 | This guide describes how to use ScalarDB SQL API. |
9 | 11 |
|
10 | 12 | ## Add ScalarDB SQL API to your project |
@@ -109,8 +111,7 @@ Statement statement = StatementBuilder.<factory method>...; |
109 | 111 | ResultSet resultSet = sqlSession.execute(statement); |
110 | 112 | ``` |
111 | 113 |
|
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). |
114 | 115 |
|
115 | 116 | ### Handle ResultSet objects |
116 | 117 |
|
@@ -141,7 +142,7 @@ If you want to get the metadata of the `ResultSet` object, you can use the `getC |
141 | 142 | ColumnDefinitions columnDefinitions = resultSet.getColumnDefinitions(); |
142 | 143 | ``` |
143 | 144 |
|
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. |
145 | 146 |
|
146 | 147 | ### Handle Record objects |
147 | 148 |
|
@@ -191,7 +192,7 @@ boolean isNullGottenByName = record.isNull("<column name>"); |
191 | 192 | boolean isNullGottenByIndex = record.isNull(<column index>); |
192 | 193 | ``` |
193 | 194 |
|
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. |
195 | 196 |
|
196 | 197 | ### Prepared Statements |
197 | 198 |
|
@@ -236,7 +237,7 @@ preparedStatement2 |
236 | 237 | .execute(); |
237 | 238 | ``` |
238 | 239 |
|
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. |
240 | 241 |
|
241 | 242 | ## Execute transactions |
242 | 243 |
|
@@ -350,7 +351,7 @@ You can get metadata with the `SqlSession.getMetadata()` method as follows: |
350 | 351 | Metadata metadata = sqlSession.getMetadata(); |
351 | 352 | ``` |
352 | 353 |
|
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. |
354 | 355 |
|
355 | 356 | ## References |
356 | 357 |
|
|
0 commit comments