PHPackages                             intermaterium/duckeh - 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. intermaterium/duckeh

ActivePhp-ext

intermaterium/duckeh
====================

PHP extension for DuckDB

0.2.0(1mo ago)05↑2900%MITCPHP >=8.1CI failing

Since Mar 27Pushed 1mo agoCompare

[ Source](https://github.com/chrisBirmingham/duckeh)[ Packagist](https://packagist.org/packages/intermaterium/duckeh)[ RSS](/packages/intermaterium-duckeh/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (3)Used By (0)

Duckeh - DuckDB for PHP
=======================

[](#duckeh---duckdb-for-php)

A PHP extension for the [DuckDB](https://duckdb.org/) API

This is a fork of [Daniel Hernández Marín](https://github.com/dhernandez) original work found [here](https://github.com/satur-io/duckdb)

Caution

This project is in an early development stage and there are probably a tonne of bugs. Nevertheless, any contribution will be welcome.

Prerequisites
-------------

[](#prerequisites)

- libduckdb 1.5.0 and above
- PHP 8.1 and above

Installation (PIE)
------------------

[](#installation-pie)

You can install this extension using [PIE](https://github.com/php/pie):

```
pie install intermaterium/duckeh
```

Installation (Build from source)
--------------------------------

[](#installation-build-from-source)

You can also use the old phpize method to install the extension

```
git clone --recursive --depth=1 https://github.com/chrisBirmingham/duckeh.git
cd duckeh
phpize
./configure
make
make install
```

Configuration
-------------

[](#configuration)

Then enable the extension, add this to your PHP INI file

```
extension=duckdb
```

Usage
-----

[](#usage)

### Creation

[](#creation)

A new in-memory database can be created like so:

```
$db = new \DuckDB\DuckDB();
```

You can attach to a store by specifying a path like so.

```
$db = new \DuckDB\DuckDB(__DIR__ '/Star_Trek-Season_1.csv');
```

A `ConnectionException` is thrown if the class fails to initialise.

### Running Queries

[](#running-queries)

#### Simple

[](#simple)

You can run queries via the `query` method:

```
$db = new \DuckDB\DuckDB();
$res = $db->query('SELECT * FROM duck');
```

The query method returns a `Result` class or throws a `QueryException` if the query fails.

#### Prepared Statements

[](#prepared-statements)

Prepared statements are created via the `prepare` method:

```
$db = new \DuckDB\DuckDB();

# Named (`$1`, `$quack`) and unnamed (`?`) parameters are supported.
$stmt = $db->prepare('SELECT * FROM duck where quack = $1');

# Bind a variable to the parameter
$stmt->bindParam(1, "honk");

# Execute the prepared statement
$res = $stmt->execute();
```

On success, a `Result` class is returned otherwise a `QueryException` is thrown if the query fails. If a bound parameter doesn't exist or the value provided to the bound parameter isn't a scalar value, an `InvalidArgumentException` is thrown

### Results

[](#results)

The result class supports two forms for getting the queried data, the higher level fetch method and lower level chunk method

#### Fetch methods

[](#fetch-methods)

These methods closely map to the pdo statement methods of the same name. The `fetch` method will keep on returning data until it reaches the end of the returned data where it will return false. The `fetchAll` method will collect all the data and return it as one big array.

Both methods return each row as an associative array with the column name as the key and the values are mapped directly to PHP types.

```
$db = new \DuckDB\DuckDB(__DIR__ . '/Star_Trek-Season_1.csv');
$res = $db->query('SELECT episode_num FROM "Star_Trek-Season_1" limit 10');

while ($row = $res->fetch()) {
    echo $row['episode_num'] . "\n" ;
}

$db = new \DuckDB\DuckDB(__DIR__ . '/Star_Trek-Season_1.csv');
$res = $db->query('SELECT episode_num FROM "Star_Trek-Season_1" limit 10')->fetchAll();

foreach ($res as $row) {
    echo $row['episode_num'] . "\n" ;
}
```

### Chunk method

[](#chunk-method)

This extension also supports duckdb's lower level chunk and vector datatypes. Chunks represent a horizontal slice of
the resulting query, and they hold a number of vectors. You can retrieve a chunk via the `fetchChunk`method, this method will keep on returning chunks until all data is exhausted. You can then process a chunk like so:

```
$duckDB = new \DuckDB\DuckDB();

$result = $duckDB->query("SELECT 'quack' as mycolumn1, 'quick' as mycolumn2;");

# Get how many columns the response has
$columns = $result->columnCount();

# Keep on getting data until we've exhausted the input
while ($dataChunk = $result->fetchChunk()) {
    # Get how many rows are inside the chunk
    $rows = $dataChunk->getSize();

    # Loop over all the rows in the chunk
    for ($j = 0; $j < $rows; $j++) {

        for ($i = 0; $i < $columns; $i++) {
            # Get the vector for the column
            $vector = $dataChunk->getVector($i);

            # Get the value of the column for row $j
            $data = $vector->getData($j);
            var_dump($data);
        }
    }
}
```

### Appender

[](#appender)

This extension provides an interface to the Appender feature provided by duckdb. The duckdb Appender is best suited for fast data loading opposed to inserting multiple rows via an INSERT query.

You can create an appender via the `append` method:

```
$db = new \DuckDB\DuckDB();
$appender = $db->append('table');
```

You can then insert a row `appendRow` method:

```
$appender->appendRow([1, 'Duck']);

$db->query('SELECT * FROM people')->print();

for ($i = 2; $i appendRow([$i, 'Duck' . $i]);
}
```

Rows aren't automatically appended to the table. You can explicitly flush the rows to the table via the `flush` method, otherwise the rows will either be flushed when an internal buffer is filled up or when the appender is cleaned up via the garbage collector.

If you want to clear the appended rows, you can call the `clear` method.

Caution

Care should be taken when inserting rows into the appender. Should an exception be thrown because of type mismatches, the appender can be left in an incomplete state. In such a situation, it's best that you call the clear method

###  Health Score

35

—

LowBetter than 79% of packages

Maintenance90

Actively maintained with recent releases

Popularity5

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity33

Early-stage or recently created project

 Bus Factor1

Top contributor holds 64.5% 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.

###  Release Activity

Cadence

Every ~1 days

Total

2

Last Release

46d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/605c5ba17b9ede3481247c152615eae793b42714b4c5a6d40c2afa0e341f97ca?d=identicon)[intermaterium](/maintainers/intermaterium)

---

Top Contributors

[![dhernandez](https://avatars.githubusercontent.com/u/1096670?v=4)](https://github.com/dhernandez "dhernandez (60 commits)")[![chrisBirmingham](https://avatars.githubusercontent.com/u/6173078?v=4)](https://github.com/chrisBirmingham "chrisBirmingham (33 commits)")

### Embed Badge

![Health badge](/badges/intermaterium-duckeh/health.svg)

```
[![Health](https://phpackages.com/badges/intermaterium-duckeh/health.svg)](https://phpackages.com/packages/intermaterium-duckeh)
```

PHPackages © 2026

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