---

What is ScalarDB?

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

To learn more, see ScalarDB Overview.

Quickstart

1. Start running transactions.
   • Get started with ScalarDB Core: To set up a basic application by using Java, see Getting Started with ScalarDB.
   • Get started with ScalarDB Cluster (for enterprise customers): To set up a basic application that uses ScalarDB Cluster through the Java API, see Getting Started with ScalarDB Cluster.
2. To set up and run various samples instances, see the list of ScalarDB sample applications.
3. Learn about the configurations for ScalarDB Core and the configurations for ScalarDB Cluster.
4. Learn about ScalarDB and its features:
   • ScalarDB design
   • User authentication/authorization (for enterprise customers)
   • Attribute-based access control (for enterprise customers)
   • Vector search (for enterprise customers)
   • For a comprehensive list of features, see ScalarDB Features.

For additional documentation, visit ScalarDB Documentation.

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.19.1'
}

To add a dependency using Maven:

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

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.

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

See the LICENSE file and the licenses directory.