Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 2.89 KB

README.md

File metadata and controls

67 lines (46 loc) · 2.89 KB
Raw

ScalarDB

ScalarDB is a cross-database HTAP engine. It achieves ACID transactions and real-time analytics across diverse databases to simplify the complexity of managing multiple databases.

Install

The library is available on maven central repository. You can install it in your application using your build tool such as Gradle and Maven.

To add a dependency on ScalarDB using Gradle, use the following:

dependencies {
    implementation 'com.scalar-labs:scalardb:3.14.0'
}

To add a dependency using Maven:

<dependency>
  <groupId>com.scalar-labs</groupId>
  <artifactId>scalardb</artifactId>
  <version>3.14.0</version>
</dependency>

Docs

See our User Documentation.

Contributing

This library is mainly maintained by the Scalar Engineering Team, but of course we appreciate any help.

  • For asking questions, finding answers and helping other users, please go to stackoverflow and use scalardb tag.
  • For filing bugs, suggesting improvements, or requesting new features, help us out by opening an issue.

Here are the contributors we are especially thankful for:

Pre-commit hook

This project uses pre-commit to automate code format and so on as much as possible. If you're interested in the development of ScalarDB, please install pre-commit and the git hook script as follows.

$ ls -a .pre-commit-config.yaml
.pre-commit-config.yaml
$ pre-commit install

The code formatter is automatically executed when committing files. A commit will fail and be formatted by the formatter when any invalid code format is detected. Try to commit the change again.

Exception and log message guidelines

All the exception and log messages in this project are consistent with the following guidelines:

  • The first character is capitalized.
  • The message does not end with a punctuation mark.

When contributing to this project, please follow these guidelines.

License

ScalarDB is dual-licensed under both the Apache 2.0 License (found in the LICENSE file in the root directory) and a commercial license. You may select, at your option, one of the above-listed licenses. The commercial license includes several enterprise-grade features such as ScalarDB Cluster, management tools, and declarative query interfaces like GraphQL and SQL interfaces. For more information about the commercial license, please contact us.