README

Eloquent models for Indonesian administrative regions — no database required.

Powered by Sushi, Terloquent ID lets you query provinces, regencies/cities, districts, and villages instantly — without any migrations or seeders.

✨ Features

• 🇮🇩 Ready-to-use Indonesian administrative data: Province, Regency, District, Village
• ⚡ Works like standard Eloquent models (where, first, whereLike, etc.)
• 🧠 No migrations or seeding required
• 🗃️ Auto-cached via Sushi for fast performance
• 📦 Uses external CSV data from sensasi-delight/id-administrative-divisions

🚀 Installation

composer require terloquent/id

Requires the pdo_sqlite PHP extension.

Start using it right away:

use TerloquentID\Regency;

$regency = Regency::whereLike('name', '%Samarinda%')->firstOrFail();

No setup. No migrations. No database.

🧩 Data Source

The administrative data is sourced from the open dataset repository: 👉 sensasi-delight/id-administrative-divisions

This repository provides CSV files representing Indonesia’s full administrative hierarchy:

Province → Regency → District → Village

It may also include additional metadata such as:

• Official region codes (Kemendagri / BPS)
• Coordinates (latitude, longitude)
• Postal codes
• Other optional attributes

Users cannot modify the data at runtime. To suggest updates or corrections, please open a pull request to sensasi-delight/id-administrative-divisions.

⚙️ Under the Hood

• Built on Sushi, which loads CSV data into an in-memory SQLite cache.
• Relationships mirror the Indonesian hierarchy: Province → Regency → District → Village

🛠️ Artisan Commands

TerloquentID provides a few handy Artisan commands to help you manage local administrative data:

👥 Perfect For

• Laravel developers building Indonesia-focused applications
• Address forms, location filters, or dashboards
• Projects that need regional data without managing a database

❤️ Acknowledgements

• Caleb Porzio — Sushi
• All contributors to sensasi-delight/id-administrative-divisions

Made with ❤️ by 🍕 sensasi-delight