Skip to content

Latest commit

 

History

History
executable file
·
97 lines (59 loc) · 4.16 KB

README.md

File metadata and controls

executable file
·
97 lines (59 loc) · 4.16 KB

MariaDB Columnstore Docker Image

This is a fork of mariadb-columnstore-docker maintained by Vettabase. The aim of this fork is to keep an updated version of MariaDB Community edition with Columnstore and the S3 engine for use by the community and production installations.

The official MariaDB docker currently does not support Columnstore of the S3 engine, an issue is already open to get this resolved.

Another ticket has been raised to update the current Columnstore image, but we feel like it is not suitable for container deployment or orchestration.

Some usage examples are documented below, and in the examples/ directory.

Summary

MariaDB ColumnStore is a columnar storage engine that utilizes a massively parallel distributed data architecture. It was built by porting InfiniDB to MariaDB and has been released under the GPL license.

MariaDB ColumnStore is designed for big data scaling to process petabytes of data, linear scalability and exceptional performance with real-time response to analytical queries. It leverages the I/O benefits of columnar storage, compression, just-in-time projection, and horizontal and vertical partitioning to deliver tremendous performance when analyzing large data sets.

Requirements

  • A container runtime such as Docker or Podman.
  • A shared volume mount for all servers when using a multi-node setup, or access to S3/S3-Compatible.

Usage Examples

To start the container from the Dockerfile:

docker run -d -e MARIADB_RANDOM_ROOT_PASSOWRD --name mcs vettadock/mariadb-columnstore

To start using mariadb CLI client:

docker exec -ti mcs mariadb

To run a query in a non-interactive fashion from the host:

docker exec -ti mcs mariadb -e "SHOW SCHEMAS;"

To take a logical backup and write it into a file outside of the container:

docker exec -ti mcs mariadb-dump --all-databases --single-transaction > backup.sql

Single node with persistent storage

docker run -d -P 3307:3306 -v path/to/data:/var/lib/mysql vettadock/mariadb-columnstore-docker

Single node with S3

docker run -d -e S3_X -e S3_Y -e S3_Z vettadock/mariadb-columnstore-docker

Multi-Node with CMAPI

cd examples
docker compose up -d

Using S3 and MinIO

docker run -d minio/minio
docker run -d -e S3_X -e S3_Y -e S3_Z vettadock/mariadb-columnstore-docker

Environment Variables

  • USE_S3_STORAGE, set to non-empty value to configure MariaDB Columnstore for use with S3.
  • S3_BUCKET, the name of the bucket to use.
  • S3_REGION, the S3 region name.
  • S3_ACCESS_KEY, your AWS Access Key.
  • S3_SECRET_KEY, your AWS Secret Key.
  • S3_HOSTNAME, set a custom hostname from the default of s3.amazonaws.com, also sets endpoint in columnstore Storage Manager. Required when using services such as MinIO.
  • S3_PORT, the S3 port number, the default is 0
  • S3_USE_HTTP, set to non-empty value. Requiered for services such as MinIO.
  • CROSS_ENGINE_USERNAME, Set a custom username for Cross Engine Join support in Columnstore. The default username is cross_engine_joiner.
  • CROSS_ENGINE_PASSWORD, Set a custom password for Cross Engine Join support in Columnstore. The default password is randomised using pwgen.

TO DO:

  • Show how to use a Docker network
  • Show how to expose ports
  • Add recipes for Podman
  • Inherit AWS credentials from user environment
  • Make AWS credentials optoinally mountable

Maintainers and Credits

This is a Vettabase project.

This project was originally developed and is currently maintained by Richard Bensley richard.bensley@vettabase.com.

Anyone who makes a relevant contribution to this project will be kudoed here, unless they ask not to be mentioned.

Copyright and License

Copyright © Vettabase 2024

This project is distributed under the terms of the GPL, version 3.

If you haven't received a copy of the license, please find it here: https://www.gnu.org/licenses/gpl-3.0.txt