README

SawitDB is a unique database solution stored in .sawit binary files.

The system features a custom Paged Heap File architecture similar to SQLite, using fixed-size 4KB pages to ensure efficient memory usage. What differentiates SawitDB is its unique Agricultural Query Language (AQL), which replaces standard SQL keywords with Indonesian farming terminology.

Now availability on Packagist!

🚨 Emergency: Aceh Flood Relief Please support our brothers and sisters in Aceh.

Organized by Human Initiative Aceh

Features

• Paged Architecture: Data is stored in 4096-byte binary pages.
• Object Caching (New): Implements Page-Level Object Caching for high-speed reads (bypassing JSON parse for hot pages).
• Hash Joins (New): Optimized JOIN operations (O(M+N)) for massive performance gains on relations.
• Persistent Indexes (New): Indexes are now automatically persisted in _indexes system table and restored on load.
• Query Cache (New): LRU Cache for parsed queries to reduce CPU overhead.
• Zero Bureaucracy: Built with standard PHP. No massive vendor dependencies.
• Network Support: Client-Server architecture using PHP Streams.

Philosophy

Filosofi (ID)

SawitDB dibangun dengan semangat "Kemandirian Data". Kami percaya database yang handal tidak butuh Infrastruktur Langit yang harganya triliunan tapi sering down. Berbeda dengan proyek negara yang mahal di budget tapi murah di kualitas, SawitDB menggunakan arsitektur Single File (.sawit) yang hemat biaya. Backup cukup copy-paste, tidak perlu sewa vendor konsultan asing. Fitur fsync kami menjamin data tertulis di disk, karena bagi kami, integritas data adalah harga mati.

Philosophy (EN)

SawitDB is built with the spirit of "Data Sovereignty". We believe a reliable database doesn't need "Sky Infrastructure" that costs trillions yet goes down often. Unlike state projects that are expensive in budget but cheap in quality, SawitDB uses a cost-effective Single File (.sawit) architecture. Backup is just copy-paste.

Installation

Install via Composer:

composer require wowoengine/sawitdb-php

Framework Support

Vanilla PHP & CodeIgniter 4

SawitDB acts as a standard PSR-4 library. You can use the WowoEngine directly or connect via the Client.

use SawitDB\Engine\WowoEngine;
$db = new WowoEngine(__DIR__ . '/plantation.sawit');

Laravel Integration

SawitDB includes a ServiceProvider and Facade for seamless Laravel integration.

1. Install via Composer: composer require wowoengine/sawitdb-php
2. Configuration: Publish the config or add to config/database.php.

// config/database.php
'connections' => [
    'sawit' => [
        'database' => env('SAWIT_DB_DATABASE', database_path('plantation.sawit')),
    ],
],

1. Usage:

use SawitDB;

// In Controller
public function index() {
    SawitDB::query("LAHAN users");
    SawitDB::query("TANAM KE users (name) BIBIT ('Budi')");
    return SawitDB::query("PANEN * DARI users");
}

Quick Start (Network Edition)

1. Start the Server

php bin/sawit-server.php

The server will start on 0.0.0.0:7878 by default.

2. Connect with Client (CLI)

php cli/remote.php sawitdb://localhost:7878/my_plantation

Usage (Embedded)

You can use the WowoEngine directly in your PHP applications.

use SawitDB\Engine\WowoEngine;

$db = new WowoEngine(__DIR__ . '/plantation.sawit');

// Generic SQL
$db->query("CREATE TABLE users");
$db->query("INSERT INTO users (id, name) VALUES (1, 'Budi')");

// AQL
$db->query("LAHAN trees");
$db->query("TANAM KE trees (id, type) BIBIT (1, 'Dura')");

// Join
$rows = $db->query("SELECT * FROM trees JOIN users ON trees.id = users.id");
print_r($rows);

Architecture Details

• Modular Codebase: Engine logic separated into src/ components.
• Page 0 (Master Page): Contains header and Table Directory.
• Data & Indexes: Stored in 4KB atomic pages.
• WowoEngine: Core engine orchestrating Pager, Index, and Query Parser.

Full Feature Comparison

Supported Operators Table

License

MIT License