Skip to main content
Version: 3.13

Run Non-Transactional Storage Operations Through the Core Library

This guide explains how to run non-transactional storage operations through the ScalarDB core library.

Preparation

For the purpose of this guide, you will set up a database and ScalarDB by using a sample in the ScalarDB samples repository.

Clone the ScalarDB samples repository

Open Terminal, then clone the ScalarDB samples repository by running the following command:

git clone https://github.com/scalar-labs/scalardb-samples

Then, go to the directory that contains the necessary files by running the following command:

cd scalardb-samples/scalardb-sample

Set up a database

Select your database, and follow the instructions to configure it for ScalarDB.

For a list of databases that ScalarDB supports, see Databases.

Run MySQL locally

You can run MySQL in Docker Compose by using the docker-compose.yml file in the scalardb-samples/scalardb-sample directory.

To start MySQL, run the following command:

docker compose up -d mysql

Configure ScalarDB

The database.properties file in the scalardb-samples/scalardb-sample directory contains database configurations for ScalarDB. Please uncomment the properties for MySQL in the database.properties file so that the configuration looks as follows:

# For MySQL
scalar.db.storage=jdbc
scalar.db.contact_points=jdbc:mysql://localhost:3306/
scalar.db.username=root
scalar.db.password=mysql

For a comprehensive list of configurations for ScalarDB, see ScalarDB Configurations.

Configure ScalarDB to run non-transactional storage operations

To run non-transactional storage operations, you need to configure the scalar.db.transaction_manager property to single-crud-operation in the configuration file database.properties:

scalar.db.transaction_manager=single-crud-operation

Create or import a schema

ScalarDB has its own data model and schema that maps to the implementation-specific data model and schema.

Create your Java application

This section describes how to add the ScalarDB core library to your project and how to configure it to run non-transactional storage operations by using Java.

Add ScalarDB to your project

The ScalarDB library is available on the Maven Central Repository. You can add the library as a build dependency to your application by using Gradle or Maven.

Select your build tool, and follow the instructions to add the build dependency for ScalarDB to your application.

To add the build dependency for ScalarDB by using Gradle, add the following to build.gradle in your application:

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

Use the Java API

For details about the Java API, see ScalarDB Java API Guide.

note

The following limitations apply to non-transactional storage operations:

Learn more