Skip to Content
This documentation is still under construction
Installation

Installation

Rust APIPython APINode.js APICommand line interface

Prerequisites

Before installing AlphaDB, ensure you have:

  • MySQL/MariaDB or PostgreSQL
  • Rust stable, if using the Rust API or installing the CLI with Cargo
  • Python 3.8+, if using the Python API
  • Node.js 20+, if using the 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.

Install the package for your database engine from PyPI.

pip install alphadb-mysql
# or
pip install alphadb-postgres

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.

Install the package for your database engine.

npm i @w-kuipers/alphadb-mysql
# or
npm i @w-kuipers/alphadb-postgres

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

Arch Linux

AUR

yay -S alphadb-bin
paru -S alphadb-bin

Or use any other AUR helper of your choice.

Platform-Independent

Cargo

cargo install alphadb-cli

Tarball

# Get the latest version
version=$(curl -s "https://api.github.com/repos/w-kuipers/alphadb/releases" | grep -Po '"tag_name": "v\K[^"]*' | head -1)
 
# To exclude prereleases, use the command below. This will fail until a stable release is available.
# version=$(curl -s "https://api.github.com/repos/w-kuipers/alphadb/releases/latest" | grep -Po '"tag_name": "v\K[^"]*')
 
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.

Last updated on
IntroductionConnect