laravel-d1 maintained by xlited
Description
Laravel integration for Cloudflare D1.
Last update
2024/08/07 15:27
(dev-main)
License
Downloads
1 052
Tags
database - php - sqlite - query - laravel - cloudflare - workers - serverless - kv - r2 - d1 - serverless-functions - serverless-framework - serverless-architecture
Cloudflare D1 bindings for Laravel
Extend your PHP/Laravel application with Cloudflare D1 bindings.
🚀 Installation
You can install the package via Composer:
composer require xlited/laravel-d1
🙌 Usage
D1 with raw PDO
Though D1 is not connectable via SQL protocols, it can be used as a PDO driver via the package connector. This proxies the query and bindings to the D1's /query endpoint in the Cloudflare API.
use XliteDev\LaravelD1\D1\D1Pdo;
use XliteDev\LaravelD1\D1\D1PdoStatement;
use XliteDev\LaravelD1\CloudflareD1Connector;
$pdo = new D1Pdo(
dsn: 'sqlite::memory:', // irrelevant
connector: new CloudflareD1Connector(
database: 'your_database_id',
token: 'your_api_token',
accountId: 'your_cf_account_id',
),
);
D1 with Laravel
In your config/database.php file, add a new connection:
'connections' => [
'd1' => [
'driver' => 'd1',
'prefix' => '',
'database' => env('CLOUDFLARE_D1_DATABASE_ID', ''),
'api' => 'https://api.cloudflare.com/client/v4',
'auth' => [
'token' => env('CLOUDFLARE_TOKEN', ''),
'account_id' => env('CLOUDFLARE_ACCOUNT_ID', ''),
],
],
]
Then in your .env file, set up your Cloudflare credentials:
CLOUDFLARE_TOKEN=
CLOUDFLARE_ACCOUNT_ID=
CLOUDFLARE_D1_DATABASE_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
The d1 driver will proxy the PDO queries to the Cloudflare D1 API to run queries.
🐛 Testing
Start the built-in Worker that simulates the Cloudflare API:
cd tests/worker
npm ci
npm run start
In a separate terminal, run the tests:
vendor/bin/phpunit
🤝 Contributing
Please see CONTRIBUTING for details.
🔒 Security
If you discover any security related issues, please email alex@renoki.org instead of using the issue tracker.