Skip to content

Commit 3e1d905

Browse files
AUTO: Sync ScalarDB docs in English to docs site repo (#905)
Co-authored-by: josh-wong <[email protected]>
1 parent 39b3130 commit 3e1d905

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

docs/requirements.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The following Java Development Kits (JDKs) are verified and supported.
2929

3030
### .NET
3131

32-
ScalarDB is provided as a gRPC server called ScalarDB Cluster, which also has a [.NET client SDK](scalardb-cluster-dotnet-client-sdk/overview.mdx) that wraps the .NET client generated from the proto file.
32+
ScalarDB is provided as a gRPC server called ScalarDB Cluster, which also has a [.NET client SDK](scalardb-cluster-dotnet-client-sdk/index.mdx) that wraps the .NET client generated from the proto file.
3333

3434
The following .NET versions are verified and supported:
3535

docs/scalardb-cluster/run-non-transactional-storage-operations-through-scalardb-cluster.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ You can use the primary key or the secondary key in your Azure Cosmos DB account
216216
</TabItem>
217217
</Tabs>
218218

219-
For a comprehensive list of configurations for ScalarDB, see [ScalarDB Configurations](configurations.mdx).
219+
For a comprehensive list of configurations for ScalarDB, see [ScalarDB Configurations](../configurations.mdx).
220220

221221
## Set up ScalarDB Cluster in standalone mode
222222

docs/scalardb-cluster/run-non-transactional-storage-operations-through-sql-interface.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ You can use the primary key or the secondary key in your Azure Cosmos DB account
215215
</TabItem>
216216
</Tabs>
217217

218-
For a comprehensive list of configurations for ScalarDB, see [ScalarDB Configurations](configurations.mdx).
218+
For a comprehensive list of configurations for ScalarDB, see [ScalarDB Configurations](../configurations.mdx).
219219

220220
## Set up ScalarDB Cluster in standalone mode
221221

docs/scalardb-sql/grammar.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,7 @@ The `SELECT` command retrieves records from the database. ScalarDB SQL creates a
584584
3. If you specify the indexed column value with the `equal to` (`=`) operator in the `WHERE` clause without the `ORDER BY` clause, the `SELECT` command will use an index `Scan` operation.
585585
4. For other cases, the `SELECT` command will be converted to a cross-partition `Scan` operation.
586586

587-
You need to enable the cross-partition scan option and the cross-partition scan with filtering and ordering options if you want to flexibly retrieve records across partitions with arbitrary conditions and orderings. Currently, the ordering option is available only for JDBC databases. For details about configurations, see [Cross-partition scan configurations](../configurations.mdx#cross-partition-scan-configurations) and [ScalarDB SQL Configurations](./configurations.mdx).
587+
You need to enable the cross-partition scan option and the cross-partition scan with filtering and ordering options if you want to flexibly retrieve records across partitions with arbitrary conditions and orderings. Currently, the ordering option is available only for JDBC databases. For details about configurations, see [Cross-partition scan configurations](../configurations.mdx#cross-partition-scan-configurations) and [ScalarDB Cluster SQL configurations](../scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx#scalardb-cluster-sql-client-configurations).
588588

589589
:::warning
590590

@@ -1211,7 +1211,7 @@ UpsertStatement statement4 = StatementBuilder.upsertInto("ns", "tbl")
12111211

12121212
The `UPDATE` command updates existing records in the database. You can specify any conditions in the `WHERE` clause to filter records. However, specifying a primary key uniquely as much as possible is recommended to avoid the cross-partition operation since it might cause performance and consistency issues, especially in non-JDBC databases. Because ScalarDB SQL creates an execution plan for an `UPDATE` command that uses a `Get` or `Scan` operation to identify the target records, the same rule is applied for the selection of records. To understand what kinds of `WHERE` clauses cause cross-partition operations and to avoid such operations, see [SELECT](#select).
12131213

1214-
You need to enable the cross-partition scan option if you want to update all records across partitions without specifying the `WHERE` clause. You also need to enable the cross-partition scan with filtering option if you want to flexibly update records across partitions with arbitrary conditions in the `WHERE` clause. For details about configurations, see [Cross-partition scan configurations](../configurations.mdx#cross-partition-scan-configurations) and [ScalarDB SQL Configurations](./configurations.mdx).
1214+
You need to enable the cross-partition scan option if you want to update all records across partitions without specifying the `WHERE` clause. You also need to enable the cross-partition scan with filtering option if you want to flexibly update records across partitions with arbitrary conditions in the `WHERE` clause. For details about configurations, see [Cross-partition scan configurations](../configurations.mdx#cross-partition-scan-configurations) and [ScalarDB Cluster SQL configurations](../scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx#scalardb-cluster-sql-client-configurations).
12151215

12161216
:::warning
12171217

@@ -1439,7 +1439,7 @@ UpdateStatement statement9 =
14391439

14401440
The `DELETE` command deletes records in the database. You can specify any conditions in the `WHERE` clause to filter records. However, specifying a primary key uniquely is recommended as much as possible to avoid the cross-partition operation since it might cause performance and consistency issues, especially in non-JDBC databases. Because ScalarDB SQL creates an execution plan for a `DELETE` command that uses a `Get` or `Scan` operation to identify the target records, the same rule is applied for the selection of records. To understand what kinds of `WHERE` clauses cause cross-partition operations and to avoid such operations, see [SELECT](#select).
14411441

1442-
You need to enable the cross-partition scan option if you want to delete all records across partitions without specifying the `WHERE` clause. You also need to enable the cross-partition scan with filtering option if you want to flexibly delete records across partitions with arbitrary conditions in the `WHERE` clause. For details about configurations, see [Cross-partition scan configurations](../configurations.mdx#cross-partition-scan-configurations) and [ScalarDB SQL Configurations](./configurations.mdx).
1442+
You need to enable the cross-partition scan option if you want to delete all records across partitions without specifying the `WHERE` clause. You also need to enable the cross-partition scan with filtering option if you want to flexibly delete records across partitions with arbitrary conditions in the `WHERE` clause. For details about configurations, see [Cross-partition scan configurations](../configurations.mdx#cross-partition-scan-configurations) and [ScalarDB Cluster SQL configurations](../scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx#scalardb-cluster-sql-client-configurations).
14431443

14441444
:::warning
14451445

docs/schema-loader-import.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ The following is a sample schema for importing tables. For the sample schema fil
7878
}
7979
```
8080

81-
The import table schema consists of a namespace name, a table name, and a `transaction` field. The `transaction` field indicates whether the table will be imported for transactions or not. If you set the `transaction` field to `true` or don't specify the `transaction` field, this tool creates a table with transaction metadata if needed. If you set the `transaction` field to `false`, this tool imports a table without adding transaction metadata (that is, for a table using the [Storage API](storage-abstraction.mdx)).
81+
The import table schema consists of a namespace name, a table name, and a `transaction` field. The `transaction` field indicates whether the table will be imported for transactions or not. If you set the `transaction` field to `true` or don't specify the `transaction` field, this tool creates a table with transaction metadata if needed. If you set the `transaction` field to `false`, this tool imports a table without adding transaction metadata (that is, for a table using the [Storage API](run-non-transactional-storage-operations-through-primitive-crud-interface.mdx)).
8282

8383
## Data-type mapping from JDBC databases to ScalarDB
8484

docs/schema-loader.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,7 @@ The schema has table definitions that include `columns`, `partition-key`, `clust
463463
- The `secondary-index` field defines which columns are indexed.
464464
- The `transaction` field indicates whether the table is for transactions or not.
465465
- If you set the `transaction` field to `true` or don't specify the `transaction` field, this tool creates a table with transaction metadata if needed.
466-
- If you set the `transaction` field to `false`, this tool creates a table without any transaction metadata (that is, for a table with [Storage API](storage-abstraction.mdx)).
466+
- If you set the `transaction` field to `false`, this tool creates a table without any transaction metadata (that is, for a table with [Storage API](run-non-transactional-storage-operations-through-primitive-crud-interface.mdx)).
467467

468468
You can also specify database or storage-specific options in the table definition as follows:
469469

0 commit comments

Comments
 (0)