59 docs tagged with "Community"
View all tagsA Guide on How to Backup and Restore Data in ScalarDL
Since ScalarDL uses ScalarDB that provides transaction capability on top of non-transactional (possibly transactional) databases non-invasively,
A Guide on How to Write a Good Contract for ScalarDL
This document sets out some guidelines for writing contracts for ScalarDL.
A Guide on How to Write Function for ScalarDL
This document sets out some guidelines for writing functions for ScalarDL.
A simple bank account application
Overview
Advanced Configurations and Operations Overview
In this sub-category, you can learn how to set advanced configurations and perform advanced operations for ScalarDL.
API endpoints
GET v1/accounts
Back Up and Restore Databases
This guide explains how to back up and restore databases that are used by ScalarDL through ScalarDB.
Deploy Overview
In this category, you can follow guides to help you become more familiar with deploying ScalarDL in local and cloud-based Kubernetes environments.
Develop Overview
In this category, you can follow guides to help you become more familiar with ScalarDL, specifically with how to write and run ScalarDL applications.
Generic Contracts and Functions Reference Guide
Although generic contracts were introduced in ScalarDL 3.10, HashStore, released in ScalarDL 3.12, provides a higher-level abstraction that wraps generic contracts. For most use cases, using HashStore is simpler and more efficient than using generic contracts directly. For details, see Get Started with ScalarDL HashStore in the latest version of ScalarDL.
Get Started with ScalarDL HashStore
ScalarDL HashStore is a high-level abstraction on top of a low-level ledger abstraction. It is specially designed for digital evidence preservation and offers two functionalities: object authenticity management and collection authenticity management. By using HashStore, you can manage hash values of objects and a collection of objects in an immutable manner without writing a contract, enabling you to develop authenticity management applications quickly and easily.
Get Started with ScalarDL Ledger
This getting started tutorial explains how to configure ScalarDL on your preferred database and illustrates the process of creating a simple application where the historical states of data are traced.
Get Started with ScalarDL TableStore
ScalarDL TableStore is a high-level abstraction on top of the low-level ledger abstraction. It offers an SQL interface instead of primitive CRUD interfaces like get and put, enabling you to build versatile, tamper-evident applications with the familiar data model and commands quickly and easily.
Getting Started with Helm Charts (Logging using Loki Stack)
This document explains how to get started with log aggregation for Scalar products on Kubernetes using Grafana Loki (with Promtail).
Getting Started with Helm Charts (Monitoring using Prometheus Operator)
This document explains how to get started with Scalar products monitoring on Kubernetes using Prometheus Operator (kube-prometheus-stack). Here, we assume that you already have a Mac or Linux environment for testing. We use Minikube in this document, but the steps we will show should work in any Kubernetes cluster.
Glossary
This glossary includes terms that are often used when using ScalarDL.
How to Get a Certificate
This document describes how to get a certificate to enroll in ScalarDL.
How to Install ScalarDL in Your Local Environment with Docker
This document shows how to set up a local environment that runs ScalarDL along with the back-end Cassandra server using Docker Compose.
How to start CA server with CFSSL
This document describes how to start CA server with CFSSL.
How to Upgrade ScalarDB
This guide explains how to upgrade to a newer version of ScalarDB.
Libraries and Tools for ScalarDL
ScalarDL provides various libraries and tools to help you build and operate scalable and reliable applications. Below are some key libraries and tools available.
Manage Overview
In this category, you can follow guides to help you manage ScalarDL.
Manage the Contract and Function Lifecycle
This document explains the lifecycle of contracts and functions in ScalarDL—from creating and registering them to updating them when bug fixes or feature additions are needed.
Model Your Data
Data modeling (or in other words, organizing your data) is the process of conceptualizing and visualizing how data will be stored and used by identifying the patterns used to access data and the types of queries to be performed within business operations.
Quickstart Overview
In this category, you can follow quickstart tutorials for how to get started with ScalarDL.
Requirements
This page describes the required tools and their versions to use ScalarDL correctly.
Run a ScalarDL Application Through ScalarDL Ledger
This guide explains how to run a ScalarDL application through ScalarDL Ledger. This document assumes that you have already tried one of the Quickstart tutorials and created your application that integrates ScalarDL by using client SDKs by referring to the Write an Application guides.
Run an Application Overview
In this sub-category, you can learn how to run an application through ScalarDL.
Run Sample Applications Overview
In this sub-category, you can learn how to run sample applications that take advantage of ScalarDL.
ScalarDL 3.12 Release Notes
This page includes a list of release notes for ScalarDL 3.12.
ScalarDL Authentication Guide
This document explains the ScalarDL authentication mechanism and how to use it properly.
ScalarDL Benchmarking Tools
This tutorial describes how to run benchmarking tools for ScalarDL. Benchmarking is helpful for evaluating how a system performs against a set of standards.
ScalarDL Client Command Reference
This page introduces scalardl, which is a client command for interacting with ScalarDL components.
ScalarDL Client Error Codes
This page provides a list of error codes in ScalarDL clients.
ScalarDL Common Error Codes
This page provides a list of error codes common across ScalarDL.
ScalarDL Compatibility Matrix
This document shows the compatibility of ScalarDL Ledger and Auditor versions among ScalarDL Java Client SDK versions and ScalarDB Cluster.
ScalarDL Configurations
This page describes the following available configurations for ScalarDL:
ScalarDL Design Document
This design document briefly explains the design and implementation of ScalarDL. For the background and objectives of ScalarDL, see ScalarDL Overview.
ScalarDL HashStore Command Reference
This page introduces scalardl-hashstore, which is a client command for interacting with ScalarDL HashStore.
ScalarDL HashStore Error Codes
This page provides a list of error codes in ScalarDL HashStore.
ScalarDL Implementation
ScalarDL is scalable and practical Byzantine fault detection middleware for transactional database systems, which achieves correctness, scalability, and database agnosticism.
ScalarDL Javadoc
- scalardl-common
ScalarDL Learning Paths
This guide provides learning paths for different roles. Depending on your role, follow the appropriate sequence of documents to gain a comprehensive understanding of ScalarDL.
ScalarDL Ledger Error Codes
This page provides a list of error codes in ScalarDL Ledger.
ScalarDL Overview
This page describes what ScalarDL is and its primary use cases.
ScalarDL Roadmap
This roadmap provides a look into the proposed future of ScalarDL. The purpose of this roadmap is to provide visibility into what changes may be coming so that you can more closely follow progress, learn about key milestones, and give feedback during development. This roadmap will be updated as new versions of ScalarDL are released.
ScalarDL Schema Loader
A Docker image that loads the database schemas of ScalarDL using Schema Tool for ScalarDB.
ScalarDL TableStore Command Reference
This page introduces scalardl-tablestore, which is a client command for interacting with ScalarDL TableStore.
ScalarDL TableStore Error Codes
This page provides a list of error codes in ScalarDL TableStore.
ScalarDL TableStore SQL Grammar
This page provides a list of commands supported in ScalarDL TableStore SQL.
Use Generic Contracts and Functions
Although generic contracts were introduced in ScalarDL 3.10, HashStore, released in ScalarDL 3.12, provides a higher-level abstraction that wraps generic contracts. For most use cases, using HashStore is simpler and more efficient than using generic contracts directly. For details, see Get Started with ScalarDL HashStore in the latest version of ScalarDL.
Use Table-Oriented Generic Contracts
Although table-oriented generic contracts were introduced in ScalarDL 3.11, TableStore, released in ScalarDL 3.12, provides a higher-level abstraction that wraps table-oriented generic contracts. For most use cases, using TableStore is simpler and more efficient than using table-oriented generic contracts directly. For details, see Get Started with ScalarDL TableStore in the latest version of ScalarDL.
Write a ScalarDL Application with Generic Contracts
Although generic contracts were introduced in ScalarDL 3.10, HashStore, released in ScalarDL 3.12, provides a higher-level abstraction that wraps generic contracts. For most use cases, using HashStore is simpler and more efficient than using generic contracts directly. For details, see Write a ScalarDL Application with the HashStore Abstraction in the latest version of ScalarDL.
Write a ScalarDL Application with the HashStore Abstraction
This document explains how to write ScalarDL applications with the HashStore abstraction. You will learn how to use ScalarDL HashStore in your applications, handle errors, and validate your data.
Write a ScalarDL Application with the Ledger Abstraction
This document explains how to write ScalarDL applications with the Ledger abstraction. You will learn how to integrate ScalarDL into your applications, handle errors, and validate your data.
Write a ScalarDL Application with the TableStore Abstraction
This document explains how to write ScalarDL applications with the TableStore abstraction. You will learn how to use ScalarDL TableStore in your applications, handle errors, and validate your data.
Write an Application Overview
In this sub-category, you can learn how to write a ScalarDL application.
Write Business Logic Overview
In this sub-category, you can learn how to write business logic for a ScalarDL application.