Metadata-Version: 2.1
Name: forgeql
Version: 4.0.0
Summary: The Multi-Table Omni-Channel Database built on B+ Trees.
Author: Bharath
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# ForgeQL (v0.2.0)

**The Multi-Table Omni-Channel Database built natively on B+ Trees.**

ForgeQL is an embedded, offline-first, high-performance database written entirely in Java. It features a built-in React dashboard for visual management and zero external runtime dependencies.

## Quickstart

Run the database server instantly from your terminal:

```bash
pip install forgeql
forgeql
```

Or connect directly in Python:

```python
from forgeql import ForgeQL

db = ForgeQL(host="http://localhost:8080", token="admin-secret-key")

# Simple SDK Methods
db.insert("users", 101, {"name": "Satoshi Nakamoto"})
user = db.get("users", 101)

# Forge Query Syntax (FQL)
results = db.fql("FIND users WHERE role = ADMIN")
```

## Core Features
- **B+ Tree Storage Engine**: Disk-based storage with O(log n) lookups.
- **Forge Query Syntax (FQL)**: Lightweight human-readable string query language (`GET`, `FIND`, `INSERT`, `UPDATE`, `DELETE`, `INDEX`).
- **Visual Dashboard**: Integrated React UI served directly from the backend.
- **Role-Based Access Control (RBAC)**: Native `ADMIN` and `READ_ONLY` authorization.
- **Write-Ahead Logging (WAL)**: ACID durability and automated crash recovery.
- **Vector Search (HNSW)**: Cosine Similarity and K-Nearest Neighbors for AI embeddings.

## Engine Architecture
ForgeQL operates offline. Running the CLI command boots a Spring Boot server on port `8080`, exposing the REST API and Forge Studio dashboard simultaneously.
