PHPackages                             vasatiani/laravel-athena - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database &amp; ORM](/categories/database)
4. /
5. vasatiani/laravel-athena

ActiveLibrary[Database &amp; ORM](/categories/database)

vasatiani/laravel-athena
========================

Laravel Athena query builder integration with Eloquent support and Redis-safe concurrency.

023PHP

Since Nov 14Pushed 2mo ago1 watchersCompare

[ Source](https://github.com/vaasatiani/laravel-athena-connector)[ Packagist](https://packagist.org/packages/vasatiani/laravel-athena)[ RSS](/packages/vasatiani-laravel-athena/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (3)Used By (0)

Laravel Athena Query Builder
============================

[](#laravel-athena-query-builder)

A modern, clean, and scalable integration of AWS Athena with Laravel's Query Builder and Eloquent ORM.
Built with full support for Laravel 10–12, Redis-based concurrency limits, Octane/Swoole compatibility, and Athena-specific query and schema grammar.

---

🚀 Features
----------

[](#-features)

- ✅ Eloquent &amp; Query Builder support
- ✅ Safe concurrency control (Athena allows max 20 concurrent queries)
- ✅ S3 query result management
- ✅ Redis lock support (Octane/Swoole-friendly)
- ✅ Schema-aware DDL generation (CREATE TABLE)
- ✅ Custom grammar for `BETWEENLIMIT`, Athena-safe `LIMIT/OFFSET`
- ✅ Fully configurable via `config/athena.php`

---

📦 Installation
--------------

[](#-installation)

```
composer require vasatiani/laravel-athena
```

Then publish the config file:

```
php artisan vendor:publish --tag=config
```

---

🛠 Configuration
---------------

[](#-configuration)

> Located in `config/athena.php`

```
return [
    'credentials' => [
        'key'    => env('AWS_ATHENA_KEY', ''),
        'secret' => env('AWS_ATHENA_SECRET', ''),
    ],
    'region'        => env('AWS_ATHENA_REGION', 'eu-central-1'),
    'version'       => 'latest',
    'database'      => env('ATHENA_DB', ''),
    'prefix'        => env('ATHENA_TABLE_PREFIX', ''),
    'bucket'        => env('S3_ATHENA_BUCKET', ''),
    'outputfolder'  => env('ATHENA_OUTPUT_FOLDER', 'athena-output'),

    's3output'      => 's3://' . env('S3_BUCKET', '') . '/' . env('ATHENA_OUTPUT_FOLDER', 'athena-output'),

    // Concurrency control
    'lock_key'      => env('ATHENA_LOCK_KEY', 'athena:query:concurrency'),
    'lock_timeout'  => env('ATHENA_LOCK_TIMEOUT', 10),
    'lock_wait'     => env('ATHENA_LOCK_WAIT', 5),

    // Schema creation options
    'stored_as' => 'PARQUET',
    'table_properties' => [
        'has_encrypted_data' => 'false',
        'classification'     => 'json',
    ],
];
```

Make sure your `.env` contains:

```
AWS_ATHENA_KEY=your-key
AWS_ATHENA_SECRET=your-secret
AWS_ATHENA_REGION=eu-central-1
S3_ATHENA_BUCKET=your-bucket
ATHENA_DB=your_database
ATHENA_OUTPUT_FOLDER=athena-output
```

---

🧩 Usage
-------

[](#-usage)

### 🏗 Defining a Model

[](#-defining-a-model)

```
namespace App\Models;

use Vasatiani\Athena\Model;

class AthenaEvent extends Model
{
    protected $table = 'events';
}
```

---

### 📋 Running Queries

[](#-running-queries)

```
use App\Models\AthenaEvent;

$events = AthenaEvent::where('event_type', 'login')->get();

$events = AthenaEvent::query()
    ->whereDateBetween('created_at', '2024-01-01', '2024-01-31')
    ->get();

$events = AthenaEvent::whereRegex('event_name', '^checkout_.*')->get();
```

---

### 🔐 Automatic Query Caching

[](#-automatic-query-caching)

Queries are hashed and stored in the `athena_query_hashes` table.

> If the table is missing, the system will fallback gracefully.

Migration:

```
Schema::create('athena_query_hashes', function (Blueprint $table) {
    $table->string('query_hash')->primary();
    $table->string('aws_return_id');
    $table->timestamps();
});
```

---

### 💥 Custom Query Builder Helpers

[](#-custom-query-builder-helpers)

```
AthenaEvent::whereNotEmpty('email')->get();
AthenaEvent::selectIfEmpty(['id', 'name'])->get();
AthenaEvent::whereJsonHasKey('payload', 'device_id')->get();
```

---

🧱 Schema Support (Optional)
---------------------------

[](#-schema-support-optional)

```
Schema::connection('athena')->create('events', function (Blueprint $table) {
    $table->string('event_type');
    $table->timestamp('created_at');
});
```

This generates:

```
CREATE EXTERNAL TABLE events (
  event_type string,
  created_at timestamp
)
STORED AS PARQUET
LOCATION 's3://your-bucket/athena-output'
TBLPROPERTIES ('has_encrypted_data'='false','classification'='json')
```

---

⚠️ Athena LIMIT &amp; OFFSET Handling
-------------------------------------

[](#️-athena-limit--offset-handling)

Internally converted to `ROW_NUMBER()` queries via special syntax `BETWEENLIMIT`.

---

✅ Redis Lock Integration
------------------------

[](#-redis-lock-integration)

Uses Laravel's `Cache::lock()` to prevent exceeding Athena’s concurrency limits.

---

🧪 Testing
---------

[](#-testing)

```
DB::connection('athena')->select("SELECT count(*) as total FROM users");
```

---

📘 License
---------

[](#-license)

MIT © [Vakho Asatiani](mailto:vaasatiani@gmail.com)

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance56

Moderate activity, may be stable

Popularity6

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity16

Early-stage or recently created project

 Bus Factor1

Top contributor holds 94.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/ffdf15c6918d3354f6b1cf01ba1d7568b4bc106a68a528fba42c54cf1960d6a9?d=identicon)[vaasatiani](/maintainers/vaasatiani)

---

Top Contributors

[![vaasatiani](https://avatars.githubusercontent.com/u/92818261?v=4)](https://github.com/vaasatiani "vaasatiani (17 commits)")[![claude](https://avatars.githubusercontent.com/u/81847?v=4)](https://github.com/claude "claude (1 commits)")

### Embed Badge

![Health badge](/badges/vasatiani-laravel-athena/health.svg)

```
[![Health](https://phpackages.com/badges/vasatiani-laravel-athena/health.svg)](https://phpackages.com/packages/vasatiani-laravel-athena)
```

###  Alternatives

[doctrine/orm

Object-Relational-Mapper for PHP

10.2k285.3M6.2k](/packages/doctrine-orm)[jdorn/sql-formatter

a PHP SQL highlighting library

3.9k115.1M102](/packages/jdorn-sql-formatter)[illuminate/database

The Illuminate Database package.

2.8k52.4M9.4k](/packages/illuminate-database)[mongodb/mongodb

MongoDB driver library

1.6k64.0M546](/packages/mongodb-mongodb)[ramsey/uuid-doctrine

Use ramsey/uuid as a Doctrine field type.

90340.3M211](/packages/ramsey-uuid-doctrine)[reliese/laravel

Reliese Components for Laravel Framework code generation.

1.7k3.4M16](/packages/reliese-laravel)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
