Installation Guide

Installation Guide

This guide walks you through the process of installing Stoolap on different platforms and environments.

Prerequisites

• Rust 1.70 or later (with Cargo)
• Git (for installation from source)
• Basic familiarity with command line tools

Installation Methods

Method 1: Using Cargo (Recommended)

The easiest way to install Stoolap is via Cargo:

cargo install stoolap

This command downloads the source code, compiles it, and installs the binary into your ~/.cargo/bin directory.

Method 2: Add as Dependency

To use Stoolap as a library in your Rust project:

[dependencies]
stoolap = "0.1"

Method 3: Building from Source

If you need the latest features or want to make modifications:

# Clone the repository
git clone https://github.com/stoolap/stoolap.git

# Navigate to the directory
cd stoolap

# Build in release mode
cargo build --release

# The binary will be at ./target/release/stoolap

Platform-Specific Instructions

macOS

On macOS, after building from source:

# Optionally move to a directory in your PATH
sudo cp ./target/release/stoolap /usr/local/bin/

Linux

For Linux users, after building the binary:

# Optionally move to a directory in your PATH
sudo cp ./target/release/stoolap /usr/local/bin/

Windows

On Windows:

1. Build from source as described above
2. The binary will be at .\target\release\stoolap.exe
3. Place the executable in a suitable location, such as C:\Program Files\Stoolap
4. Add the directory to your PATH through System Properties > Advanced > Environment Variables

Using Stoolap as a Library

To use Stoolap in your Rust application:

[dependencies]
stoolap = "0.1"

Then use it in your code:

use stoolap::Database;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create in-memory database
    let db = Database::open("memory://")?;

    // Create a table
    db.execute("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)", ())?;

    // Insert data with parameters
    db.execute("INSERT INTO users VALUES ($1, $2)", (1, "Alice"))?;

    // Query data
    for row in db.query("SELECT * FROM users", ())? {
        let row = row?;
        let id: i64 = row.get("id")?;
        let name: String = row.get("name")?;
        println!("User {}: {}", id, name);
    }

    Ok(())
}

See the API Reference for complete documentation of the Stoolap API.

Verifying Installation

To verify that Stoolap CLI was installed correctly:

stoolap --version

This should display the version number of your Stoolap installation.

Next Steps

After installing Stoolap, you can:

• Follow the Quick Start Tutorial to create your first database using the CLI
• Learn about Connection Strings to configure your database
• Check the API Reference for using Stoolap in your Rust applications
• Check the SQL Commands reference for working with data

Troubleshooting

If you encounter issues during installation:

• Ensure Rust is installed: rustc --version (should be 1.70+)
• Ensure Cargo is available: cargo --version
• For permission issues on Linux/macOS, use sudo as needed

If problems persist, please open an issue on GitHub with details about your environment and the error you’re experiencing.