LeanXcale Quick Guide

LeanXcale is a distributed database built for scalability and performance. This quick guide provides an introduction to the basics. If you want to go deeper, you can read the Concepts and Architecture documentation.

1. Installation

Installing LeanXcale is very easy. You just have to copy the tgz file with the LeanXcale binaries, untar it, install a few prerequisites and you’re set to go.

The simplest installation - given you meet the prerequisites - is:

  1. Create a folder for LeanXcale:

mkdir /lxs
cd /lxs
  1. Untar your LeanXcale installation package:

tar xvfz LeanXcale-x.y.z-YYYYMMDD.tgz
  1. Setup the inventory:name: value

cp conf/inventory.simplest conf/inventory
  1. Finish installing python requirements and deploying


So now you can go and start the database, but please take a look to the Installation Guide.

2. Basic Operations

In this section you’ll learn how to use the basic operations to manage LeanXcale. Give a look to the Operations Manual to get a deeper look.

  • Start Cluster:

user@host:~/lxs$ admin/startcluster.sh
  • Stop Cluster:

# Stops everything
user@host:~/lxs$ admin/stopcluster.sh MS ZK

# Stops all the components except Zookeeper
user@host:~/lxs$ admin/stopcluster.sh
  • Check the Cluster components and its ports:

user@host:~/lxs$ admin/checkcluster.sh
  • Hot Backup:

During normal LeanXcale operation, without stopping it

user@host:~/lxs$ admin/backupcluster.sh
  • Cold Backup:

Stop LeanXcale first, before going to do backup

# First stop all the workload
user@host:~/lxs$ admin/stopcluster.sh MS ZK

# If any component didn't stop, force to kill it
user@host:~/lxs$ admin/stopcluster.sh force

user@host:~/lxs$ admin/backupcluster.sh

Take into account that backup doesn’t store transaction log files so if the system didn’t stop gracefully some information could be lost.

  • Restore:

To restore from a previous backup, there is a script but assumes you have first stopped the cluster.

After restoring files, cluster is started.

##First stop all the workload
$BASEDIR/admin> ./stopcluster.sh force
$BASEDIR/admin> ./restorecluster.sh
$BASEDIR/admin> ./checkcluster.sh

3. SQL Clients

LeanXcale provides a simple command line client called lxClient, but we recommend you use your favorite JDBC/SQL client. We provide instructions on how to install and configure the SQuirreL SQL client with LeanXcale.

3.1. Creating the schema

Using SQL DDL commands, you can use the client of your choice to create a database and build your schema.

3.2. Monitoring

LeanXcale is distributed with a Prometheus and a Grafana instance with a standard dashboard so you can have a view on how your cluster is running.

You can access the dashboard at http://{Metaserver}:3000/

Default login:

user admin

password admin

Don’t forget to change the password