🛠️ This documentation is still under construction
Installation

Installation

Rust APIPython APINode.js APICommand line interface

Prerequisites

Before installing AlphaDB, ensure you have:

  • MySQL/MariaDB (version 5.7 or higher)
  • Rust (for Rust API and CLI)
  • Python 3.7+ (for Python API)
  • Node.js 14+ (for Node.js API)

Rust API

The Rust API provides the most complete and performant implementation of AlphaDB.

cargo add alphadb

Features

  • Full access to all AlphaDB functionality
  • Type-safe API
  • High performance
  • Native Rust integration

Python API

The Python API offers a simple and intuitive interface for Python developers.

pip install alphadb

Note that pip refers to the Python 3 package manager. In an environment where Python 2 is also present the correct command may be pip3.

Features

  • Easy-to-use Python interface
  • Full feature parity with core implementation
  • Async support

Node.js API

The Node.js API provides a familiar interface for JavaScript/TypeScript developers.

npm i @w-kuipers/alphadb

Features

  • Promise-based API
  • TypeScript support
  • Full feature parity
  • Easy integration with Node.js applications

Command line interface

The CLI provides a convenient way to manage your databases from the command line.

MacOS

Homebrew

brew tap w-kuipers/alphadb
brew install alphadb

Platform-Independent

Cargo

cargo install alphadb-cli

Tarball

# Get the latest version
# version=$(curl -s "https://api.github.com/repos/w-kuipers/alphadb/releases/latest" | grep -Po '"tag_name": "v\K[^"]*')
 
# For beta releases, use:
version="v1.0.0-beta.36"
 
curl -Lo alphadb-cli_${version}_Linux_x86_64.tar.gz "https://github.com/w-kuipers/alphadb/releases/download/${version}/alphadb-cli_${version}_Linux-x86_64.tar.gz"
 
tar xf alphadb-cli_${version}_Linux_x86_64.tar.gz alphadb
sudo install alphadb /usr/local/bin
rm alphadb alphadb-cli_${version}_Linux_x86_64.tar.gz

CLI Features

  • Database version management
  • Schema verification
  • Migration application
  • Configuration management

Next Steps

After installation, you'll want to:

  1. Configure your database connection
  2. Create your first schema definition
  3. Set up version control for your database

Check out our usage guides for detailed instructions on getting started with AlphaDB.

IntroductionConnect