Update Cosmos DB name in supported DB docs #813
Conversation
kota2and3kan
requested review from
komamitsu,
brfrn169,
feeblefakie and
Torch3333
|
@kota2and3kan I think we can make the same change for all the documents in |
|
@brfrn169 |
| ## Cosmos DB setup | ||
| You also need to set up a Cosmos DB account to get started with ScalarDB on Cosmos DB. | ||
| ## Cosmos DB for NoSQL setup | ||
| You also need to set up a Cosmos DB for NoSQL account to get started with ScalarDB on Cosmos DB for NoSQL. | ||
|
|
||
| This section explains how to set up [Azure Cosmos DB](https://docs.microsoft.com/en-us/azure/cosmos-db/introduction) with Azure portal. | ||
| 1. Select **Azure Cosmos DB** service from the services on Azure portal. |
There was a problem hiding this comment.
I noticed that these steps are a bit different from the current steps.
I think it is better to add official document links to reduce the maintenance cost of this document.
So, I will update these steps in another PR.
There was a problem hiding this comment.
I updated these steps in PR #814.
| @@ -78,7 +78,7 @@ Create/Delete schemas in the storage defined in the config file | |||
| --ru=<ru> Base resource unit (supported in DynamoDB, Cosmos DB) | |||
| ``` | |||
|
|
|||
| For Cosmos DB (Deprecated. Please use the command using a config file instead): | |||
| For Cosmos DB for NoSQL (Deprecated. Please use the command using a config file instead): | |||
| ```console | |||
| Usage: java -jar scalardb-schema-loader-<version>.jar --cosmos [-D] | |||
There was a problem hiding this comment.
I don't update this part since these descriptions are defined in the source code of Schema Loader.
| @@ -146,7 +146,7 @@ admin.addNewColumnToTable("ns", "tbl", "c6", DataType.INT) | |||
|
|
|||
| This should be executed with significant consideration as the execution time may vary greatly | |||
| depending on the underlying storage. Please plan accordingly especially if the database runs in production: | |||
| - For Cosmos and Dynamo DB: this operation is almost instantaneous as the table | |||
| - For Cosmos DB for NoSQL and DynamoDB: this operation is almost instantaneous as the table | |||
There was a problem hiding this comment.
I think Dynamo DB is just a typo. DynamoDB (no white space) is the correct name.
| @@ -291,7 +291,7 @@ admin.addNewColumnToTable("ns", "tbl", "c6", DataType.INT) | |||
|
|
|||
| This should be executed with significant consideration as the execution time may vary greatly | |||
| depending on the underlying storage. Please plan accordingly especially if the database runs in production: | |||
| - For Cosmos and Dynamo DB: this operation is almost instantaneous as the table | |||
| - For Cosmos DB for NoSQL and DynamoDB: this operation is almost instantaneous as the table | |||
There was a problem hiding this comment.
I think Dynamo DB is just a typo. DynamoDB (no white space) is the correct name.
|
I updated the Cosmos DB name from |
This PR updates the Cosmos DB name from
Cosmos DBtoCosmos DB for NoSQLin the supported DB document since the official name was changed.https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/
Please take a look!
Also, I want to discuss whether we should update this name in the documents other than the supported DB document.
There are some documents that state
Cosmos DB. So, if we should update them toCosmos DB for NoSQL, I will do it in this PR.What do you think?