{"id":23796927,"url":"https://github.com/harish81/laravel-duckdb","last_synced_at":"2026-03-09T19:32:04.261Z","repository":{"id":146711737,"uuid":"618257043","full_name":"harish81/laravel-duckdb","owner":"harish81","description":"DuckDB CLI wrapper to interact with duckdb databases through laravel query builder.","archived":false,"fork":false,"pushed_at":"2023-10-20T03:15:45.000Z","size":54,"stargazers_count":18,"open_issues_count":1,"forks_count":6,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-01T04:41:34.941Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/harish81.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-03-24T04:32:05.000Z","updated_at":"2024-11-30T22:02:28.000Z","dependencies_parsed_at":"2023-03-24T08:31:21.513Z","dependency_job_id":"1deb5b10-fa4b-4465-9149-9a768a7661d4","html_url":"https://github.com/harish81/laravel-duckdb","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harish81%2Flaravel-duckdb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harish81%2Flaravel-duckdb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harish81%2Flaravel-duckdb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harish81%2Flaravel-duckdb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/harish81","download_url":"https://codeload.github.com/harish81/laravel-duckdb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232121505,"owners_count":18475561,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-01T20:13:41.642Z","updated_at":"2026-03-09T19:32:04.205Z","avatar_url":"https://github.com/harish81.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DuckDB CLI wrapper to interact with duckdb databases through laravel query builder.\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/harish81/laravel-duckdb.svg?style=flat-square)](https://packagist.org/packages/harish81/laravel-duckdb)\n[![Total Downloads](https://img.shields.io/packagist/dt/harish81/laravel-duckdb.svg?style=flat-square)](https://packagist.org/packages/harish81/laravel-duckdb)\n\nhttps://github.com/duckdb/duckdb\n- Download CLI (either)\n    - https://duckdb.org/docs/installation/\n    - https://github.com/duckdb/duckdb/releases/latest\n    - run `php artisan laravel-duckdb:download-cli` (Experimental)\n    - You can also pass argument `--ver` for specific version like `php artisan laravel-duckdb:download-cli --ver=0.7.1` \n\n## Support us\n\n## Installation\n\nYou can install the package via composer:\n\n```bash\ncomposer require harish81/laravel-duckdb\n```\n\n## Usage\n\n- Connect\n```php\n'connections' =\u003e [\n    'my_duckdb' =\u003e [\n        'driver' =\u003e 'duckdb',\n        'cli_path' =\u003e env('DUCKDB_CLI_PATH', base_path('vendor/bin/duckdb')),\n        //'dbfile' =\u003e env('DUCKDB_DB_FILE', '/tmp/duck_main.db'),\n    ],\n...\n```\n\n- Examples\n```php\n# Using DB facade\nDB::connection('my_duckdb')\n    -\u003etable(base_path('genderdata.csv'))\n    -\u003ewhere('Gender', '=', 'M')\n    -\u003elimit(10)\n    -\u003eget();\n```\n```php\n# Using Raw queries\nDB::connection('my_duckdb')\n    -\u003eselect(\"select * from '\".base_path('genderdata.csv').\"' limit 5\")\n```\n\n```php\n# Using Eloquent Model\nclass GenderDataModel extends \\Harish\\LaravelDuckdb\\LaravelDuckdbModel\n{\n    protected $connection = 'my_duckdb';\n    public function __construct()\n    {\n        $this-\u003etable = base_path('genderdata.csv');\n    }\n}\n...\nGenderDataModel::where('Gender','M')-\u003efirst()\n```\n\n## Advanced Usage\nYou can install duckdb extensions too.\n\n### Query data from s3 files directly.\n\n- in `database.php`\n```php\n'connections' =\u003e [\n    'my_duckdb' =\u003e [\n        'driver' =\u003e 'duckdb',\n        'cli_path' =\u003e env('DUCKDB_CLI_PATH', base_path('vendor/bin/duckdb')),\n        'cli_timeout' =\u003e 0, //0 to disable timeout, default to 1 Minute (60s)\n        'dbfile' =\u003e env('DUCKDB_DB_FILE', storage_path('app/duckdb/duck_main.db')),\n        'pre_queries' =\u003e [\n            \"SET s3_region='\".env('AWS_DEFAULT_REGION').\"'\",\n            \"SET s3_access_key_id='\".env('AWS_ACCESS_KEY_ID').\"'\",\n            \"SET s3_secret_access_key='\".env('AWS_SECRET_ACCESS_KEY').\"'\",\n        ],\n        'extensions' =\u003e ['httpfs'],\n    ],\n    ...\n```\n\n- Query data\n```php\nDB::connection('my_duckdb')\n  -\u003eselect(\"SELECT * FROM read_csv_auto('s3://my-bucket/test-datasets/example1/us-gender-data-2022.csv') LIMIT 10\")\n```\n### Writing a migration\n```php\nreturn new class extends Migration {\n    protected $connection = 'my_duckdb';\n    public function up(): void\n    {\n        DB::connection('my_duckdb')-\u003estatement('CREATE SEQUENCE people_sequence');\n        Schema::create('people', function (Blueprint $table) {\n            $table-\u003eid()-\u003edefault(new \\Illuminate\\Database\\Query\\Expression(\"nextval('people_sequence')\"));\n            $table-\u003estring('name');\n            $table-\u003einteger('age');\n            $table-\u003einteger('rank');\n            $table-\u003etimestamps();\n        });\n    }\n\n    public function down(): void\n    {\n        Schema::dropIfExists('people');\n        DB::connection('my_duckdb')-\u003estatement('DROP SEQUENCE people_sequence');\n    }\n};\n```\n\n### Readonly Connection - A solution to concurrent query.\n- in `database.php`\n```php\n    'connections' =\u003e [\n        'my_duckdb' =\u003e [\n            'driver' =\u003e 'duckdb',\n            'cli_path' =\u003e env('DUCKDB_CLI_PATH', base_path('vendor/bin/duckdb')),\n            'cli_timeout' =\u003e 0,\n            'dbfile' =\u003e env('DUCKDB_DB_FILE', storage_path('app/duckdb/duck_main.db')),\n            'schema' =\u003e 'main',\n            'read_only' =\u003e true,\n            'pre_queries' =\u003e [\n                \"SET s3_region='\".env('AWS_DEFAULT_REGION').\"'\",\n                \"SET s3_access_key_id='\".env('AWS_ACCESS_KEY_ID').\"'\",\n                \"SET s3_secret_access_key='\".env('AWS_SECRET_ACCESS_KEY').\"'\",\n            ],\n            'extensions' =\u003e ['httpfs', 'postgres_scanner'],\n        ],\n        ...\n```\n\n\n## Testing\n\n- Generate test data\n```bash\n# Syntax: ./data-generator.sh \u003clines\u003e \u003cfile-to-save.csv\u003e\n./data-generator.sh 100 _test-data/test.csv\n./data-generator.sh 90000000 _test-data/test_big_file.csv\n```\n\n- Run Test case\n```bash\ncomposer test\n```\n\n## Limitations \u0026 FAQ\n\n-  https://duckdb.org/faq\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n## Security Vulnerabilities\n\nPlease review [our security policy](../../security/policy) on how to report security vulnerabilities.\n\n## Credits\n\n- [harish](https://github.com/harish81)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharish81%2Flaravel-duckdb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharish81%2Flaravel-duckdb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharish81%2Flaravel-duckdb/lists"}