Add description about placeholders of database.properties #1498
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kota2and3kan
requested review from
komamitsu,
brfrn169,
feeblefakie and
Torch3333
and removed request for
a team
komamitsu
approved these changes
Feb 15, 2024
docs/configurations.md
Outdated
| @@ -186,6 +186,10 @@ The following are additional configurations available for ScalarDB: | |||
| | `scalar.db.default_namespace_name` | The given namespace name will be used by operations that do not already specify a namespace. | | | |||
| | `scalar.db.system_namespace_name` | The given namespace name will be used by ScalarDB internally. | `scalardb` | | |||
|
|
|||
| ## Use placeholders | |||
|
|
|||
| You can use placeholders in the values, and they are replaced with environment variables (${env:<ENVIRONMENT_VARIABLE_NAME>}) or system properties (${sys:<SYSTEM_PROPERTY_NAME>}). You can also specify default values in placeholders like ${sys:<SYSTEM_PROPERTY_NAME>:-<DEFAULT_VALUE>}. | |||
There was a problem hiding this comment.
environment variables (${env:<ENVIRONMENT_VARIABLE_NAME>})
How about syntax-highlighting it as follows?
environment variables (`${env:<ENVIRONMENT_VARIABLE_NAME>}`)There was a problem hiding this comment.
Ah, I see. Looks good!
I will apply it. Thank you for your suggestion!
josh-wong
requested changes
Feb 15, 2024
Co-authored-by: Josh Wong <joshua.wong@scalar-labs.com>
josh-wong
approved these changes
Feb 15, 2024
Co-authored-by: Josh Wong <joshua.wong@scalar-labs.com>
brfrn169
reviewed
Feb 16, 2024
docs/configurations.md
Outdated
| @@ -258,3 +262,14 @@ scalar.db.contact_points=indirect:<SCALARDB_CLUSTER_CONTACT_POINT> | |||
| ``` | |||
|
|
|||
| For details about client configurations, see the ScalarDB Cluster [client configurations (redirects to the Enterprise docs site)](https://scalardb.scalar-labs.com/docs/latest/scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api/#client-configurations). | |||
|
|
|||
| ### Configuration example #3 - Placeholder usage | |||
There was a problem hiding this comment.
I think we can move this example into the ## Placeholder usage part. I think this Configuration example section is more like for the actual/real settings. So if this example is only for the placeholder usage, I think we can put it in the ## Placeholder usage part. What do you think?
There was a problem hiding this comment.
I see. Indeed, this example does not include the actual configuration (minimum configuration) to access the backend DB or ScalarDB Cluster.
I agree with you. I will move this example into the ## Placeholder usage section. Thank you!
There was a problem hiding this comment.
I updated it in 910c269.
feeblefakie
pushed a commit
that referenced
this pull request
Feb 16, 2024
Co-authored-by: Josh Wong <joshua.wong@scalar-labs.com> Co-authored-by: Toshihiro Suzuki <brfrn169@gmail.com>
feeblefakie
pushed a commit
that referenced
this pull request
Feb 16, 2024
Co-authored-by: Josh Wong <joshua.wong@scalar-labs.com> Co-authored-by: Toshihiro Suzuki <brfrn169@gmail.com>
feeblefakie
pushed a commit
that referenced
this pull request
Feb 16, 2024
Co-authored-by: Josh Wong <joshua.wong@scalar-labs.com> Co-authored-by: Toshihiro Suzuki <brfrn169@gmail.com>
feeblefakie
pushed a commit
that referenced
this pull request
Feb 16, 2024
Co-authored-by: Josh Wong <joshua.wong@scalar-labs.com> Co-authored-by: Toshihiro Suzuki <brfrn169@gmail.com>
feeblefakie
pushed a commit
that referenced
this pull request
Feb 16, 2024
Co-authored-by: Josh Wong <joshua.wong@scalar-labs.com> Co-authored-by: Toshihiro Suzuki <brfrn169@gmail.com>
This was referenced Feb 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the description about placeholders in the database.properties file.
We added placeholder support in the database.properties file in PR #770.
There is a Javadoc, which describes this feature, but there is no description in Scalar Docs site.
So, I added the description of the placeholder feature in the document.
Please take a look!
Related issues and/or PRs
Changes made
docs/configurations.md.Checklist
Additional notes (optional)
N/A
Release notes
N/A