Add API guide #620
Add API guide #620
Conversation
| @@ -0,0 +1,697 @@ | |||
| # Java API Guide | |||
There was a problem hiding this comment.
Added Java API Guide for the new API.
|
|
||
| Please see [Two-phase Commit Transactions](two-phase-commit-transactions.md). | ||
|
|
||
| ## Handle Exceptions |
There was a problem hiding this comment.
Moved the A Guide on How to Handle Exceptions here.
docs/design.md
Outdated
| ### Clustering order | ||
|
|
||
| As mentioned, records in Scalar DB are sorted by the clustering-key in a partition. | ||
| You can specify the default sort orders of the clustering-key, that's called clustering orders, when you create tables. | ||
| If the clustering-key consists of multiple columns, you can specify clustering order for each column. | ||
|
|
||
| ### Secondary index | ||
|
|
||
| In Scalar DB, you can basically scan a table only using columns that are part of the primary key. | ||
| Secondary Indexes in Scalar DB solve the need for querying columns that are not part of the primary key. | ||
| You can create a secondary index on a single column on a table. | ||
| Secondary indexes are used to scan a table using a column that is not normally queryable. |
There was a problem hiding this comment.
Added clustering order thing and secondary index thing here.
brfrn169
requested review from
Torch3333 and
feeblefakie
and removed request for
Torch3333
Co-authored-by: Vincent Guilpain <vincent.guilpain@scalar-labs.com>
|
@Torch3333 Thank you for the suggestions! I fixed it based on your feedback in the latest commit. Please take a look again when you have time! |
Co-authored-by: Vincent Guilpain <vincent.guilpain@scalar-labs.com>
docs/api-guide.md
Outdated
|
|
||
| ## Administrative operations | ||
|
|
||
| This chapter explains how to execute administrative operations in Scalar DB. |
There was a problem hiding this comment.
| This chapter explains how to execute administrative operations in Scalar DB. | |
| This section explains how to execute administrative operations in Scalar DB. You can execute administrative operations programmatically as follows, but you can also execute those operations through [the Schema Loader](link). |
docs/api-guide.md
Outdated
| @@ -0,0 +1,718 @@ | |||
| # Java API Guide | |||
|
|
|||
| This guide briefly explains how to use Scalar DB Java API. | |||
There was a problem hiding this comment.
I think it's helpful to have indexes like below.
* [Administrative operations](link)
* [Transactional operations](link)
There was a problem hiding this comment.
@brfrn169 Thank you for the update. But, the link seems not working.
There was a problem hiding this comment.
@feeblefakie Sorry for that... 😞 I fixed the broken links. Please take a look again when you have time!
docs/api-guide.md
Outdated
|
|
||
| ## Transactional operations | ||
|
|
||
| This chapter explains how to execute transactional operations in Scalar DB. |
There was a problem hiding this comment.
| This chapter explains how to execute transactional operations in Scalar DB. | |
| This section explains how to execute transactional operations in Scalar DB. |
|
@feeblefakie Thank you for taking a look at this! I fixed it based on your review. Please take a look again when you have time! |
|
@feeblefakie Thank you for the suggestions! I fixed it based on your feedback. Please take a look again when you have time! |
Co-authored-by: Hiroyuki Yamada <mogwaing@gmail.com>
Since the next minor release (3.6) will have a lot of API changes (while preserving the backward compatibility), I think we should add an API guide for the new API. This PR adds it. Please take a look!