PHPackages                             tbolner/monetdb-php - 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 & ORM](/categories/database)
4. /
5. tbolner/monetdb-php

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

tbolner/monetdb-php
===================

A PHP client library for accessing MonetDB.

1.2.1(3y ago)81381[1 PRs](https://github.com/MonetDB/MonetDB-PHP/pulls)Apache-2.0C++PHP >=7.2 || >=8.0CI failing

Since Apr 10Pushed 4mo ago3 watchersCompare

[ Source](https://github.com/MonetDB/MonetDB-PHP)[ Packagist](https://packagist.org/packages/tbolner/monetdb-php)[ RSS](/packages/tbolner-monetdb-php/feed)WikiDiscussions master Synced 2w ago

READMEChangelog (10)Dependencies (1)Versions (23)Used By (0)

MonetDB-PHP
===========

[](#monetdb-php)

The official PHP client library for accessing MonetDB. For PHP 8.x and 7.2 or above (see instructions below).

Main features:

- Parameterized queries, using cached prepared statements.
- Extensively tested with Japanese characters for the UTF-8 compliance.
- Multiple, concurrent connections.
- Allows access to response stats, like execution time and affected row count, etc.
- The thrown `MonetException` exception objects contain user-friendly error messages.
- Provides information about the columns of the response data, like name, SQL type and length.

If you wish to implement your own client library either for PHP or for another language, then please read the [guide about the client-server protocol](protocol_doc/README.md).

Table of contents
=================

[](#table-of-contents)

- [MonetDB-PHP](#monetdb-php)
- [Table of contents](#table-of-contents)
- [Installation with Composer (PHP 8.x)](#installation-with-composer-php-8x)
- [Usage without installation](#usage-without-installation)
- [Installation for PHP 7.2 or above.](#installation-for-php-72-or-above)
- [Examples](#examples)
    - [Example 1: Simple query](#example-1-simple-query)
    - [Example 2: Get execution stats](#example-2-get-execution-stats)
    - [Example 3: Parameterized query with prepared statement](#example-3-parameterized-query-with-prepared-statement)
    - [Example 4: Using escaping](#example-4-using-escaping)
    - [Example 5: Renaming fields and using column info](#example-5-renaming-fields-and-using-column-info)
    - [Example 6: Query the first record only](#example-6-query-the-first-record-only)
    - [Example 7: Transactions](#example-7-transactions)
    - [Example 8: Importing data the fastest way](#example-8-importing-data-the-fastest-way)
    - [Example 9: Using multiple connections](#example-9-using-multiple-connections)
- [API Reference](#api-reference)
    - [Connection Class](#connection-class)
    - [Response Class](#response-class)
    - [StatusRecord Class](#statusrecord-class)
    - [ColumnInfo Class](#columninfo-class)
- [Development setup through the Docker image](#development-setup-through-the-docker-image)
- [Running the integration tests](#running-the-integration-tests)
- [IDE setup](#ide-setup)

Installation with Composer (PHP 8.x)
====================================

[](#installation-with-composer-php-8x)

This library is available on Packagist at:

-

First install [Composer](https://getcomposer.org/download/), then execute the following in your project's directory:

```
composer require tbolner/monetdb-php

```

Usage without installation
==========================

[](#usage-without-installation)

You don't need to use [Composer](https://getcomposer.org) in your project. You can just copy all files in the ['src' folder](https://github.com/MonetDB/MonetDB-PHP/tree/master/src), and include them in your project through the [include.php](src/include.php) file, which was created just for this purpose.

```
require_once(__DIR__."/../path/to/include.php");
```

Then either reference the classes by a combination of a `use` statement and the short class name (as it is done in the [example projects](https://github.com/MonetDB/MonetDB-PHP/tree/master/Examples)):

```
use MonetDB\Connection;

$connection = new Connection("127.0.0.1", 50000, "monetdb", "monetdb", "myDatabase");
```

Or just use the fully qualified class name (if your project doesn't use namespaces):

```
$connection = new \MonetDB\Connection("127.0.0.1", 50000, "monetdb", "monetdb", "myDatabase");
```

Please make sure that the `php-mbstring` (multi-byte string) extension is installed and enabled, and the character encoding for your project is set to UTF-8: (This is required for preventing SQL injection attacks)

```
mb_internal_encoding('UTF-8');
mb_regex_encoding('UTF-8');
```

Installation for PHP 7.2 or above.
==================================

[](#installation-for-php-72-or-above)

Only the 1.1.x versions support `PHP 7.2` or above.

```
composer require tbolner/monetdb-php:1.1.6

```

Examples
========

[](#examples)

Example projects:

- [Data modification](Examples/DataModification/)
- [Web query](Examples/WebQuery/)
- [Japanese test](Examples/JapaneseTest/)

Example 1: Simple query
-----------------------

[](#example-1-simple-query)

```
use MonetDB\Connection;

$connection = new Connection("127.0.0.1", 50000,
    "monetdb", "monetdb", "myDatabase");

$result = $connection->Query('
    select
        name, weight_kg, category, birth_date, net_worth_usd
    from
        cats
');

$columnNames = $result->GetColumnNames();

foreach($result as $record) {
    echo "Name: {$record["name"]}\n";
    echo "Weight: {$record["weight_kg"]} kg\n";
    echo "Category: {$record["category"]}\n";
    echo "Birth date: {$record["birth_date"]}\n";
    echo "Net worth: ${$record["net_worth_usd"]}\n\n";
}
```

The returned values are always in string representation except the null, which is always returned as `null`.

Example 2: Get execution stats
------------------------------

[](#example-2-get-execution-stats)

```
$result = $connection->Query(Query('
    select
        *
    from
        "cats"
    where
        "name" = ?
        and "weight_kg" > ?
    limit
        10
', [ "D'artagnan", 5.3 ]);
```

In MonetDB the placeholders of prepared statements have specific types. This library auto-converts some of the PHP types to the corresponding MonetDB types.

MonetDB typeAccepted PHP typesValue examplestimestamp`string`, `DateTime``"2020-12-20 11:14:26.123456"`date`string`, `DateTime``"2020-12-20"`boolean`boolean`, `string`, `integer``true`, `false`, `"true"`, `0`, `"0"`, `1`, `"t"`, `"f"`, `"yes"`, `"no"`, `"enabled"`, `"disabled"`Numeric values`integer`, `float`, `string``12.34`, `"12.34"` (use string for huge numbers)Character types`string``"Hello World!"`Binary`string``"0f44ba12"` (always interpreted as hexadecimal)time`string`, `DateTime``"11:28"`, `"12:28:34"`Always pass the null values as `null`, and not as a string.

Example 4: Using escaping
-------------------------

[](#example-4-using-escaping)

```
$name = $connection->Escape("D'artagnan");
$weight = floatval("5.3");

$result = $connection->Query( {$weight}
EOF
);
```

Example 5: Renaming fields and using column info
------------------------------------------------

[](#example-5-renaming-fields-and-using-column-info)

```
$result = $connection->Query('
    select
        "category",
        sys.stddev_samp("weight_kg") as "weight_stddev",
        sys.median("weight_kg") as "weight_median",
        avg("weight_kg") as "weight_mean"
    from
        "cats"
    group by
        "category"
');

echo "The columns of the response data:\n\n";

foreach($result->GetColumnInfo() as $info) {
    echo "Table/resource name: {$info->GetTableName()}\n";
    echo "Field name: {$info->GetColumnName()}\n";
    echo "Type: {$info->GetType()}\n";
    echo "Length: {$info->GetLength()}\n\n";
}

echo "Data:\n\n";

foreach($result as $record) {
    echo "{$record["category"]} : Mean: {$record["weight_mean"]} kg, "
        ."Median: {$record["weight_median"]} kg, "
        ."StdDev: {$record["weight_stddev"]} kg\n";
}
```

Example 6: Query the first record only
--------------------------------------

[](#example-6-query-the-first-record-only)

```
$record = $connection->QueryFirst('
    select
        sum("weight_kg") as "weight"
    from
        "cats"
');

echo "Sum: {$record["weight"]}\n";
```

Example 7: Transactions
-----------------------

[](#example-7-transactions)

```
$connection->Query(Query(Query("...");
$result2 = $connection2->Query("...");
$result3 = $connection3->Query("...");
```

---

API Reference
=============

[](#api-reference)

ClassSummary[Connection](#connection-class)Class for encapsulating a connection to a MonetDB server.[Response](#response-class)This class represents a response for an SQL query or for a command. In case of a 'select' query, this class can be iterated through, using a 'foreach' loop. The records are returned as associative arrays, indexed by the column names.[StatusRecord](#statusrecord-class)This class shares the information returned by MonetDB about the executed queries. Like execution time, number of rows affected, etc. Note that only specific fields are populated for specific queries, the others remain NULL.[ColumnInfo](#columninfo-class)This class contains information about the columns of a table response to a 'select' query.---

Connection Class
----------------

[](#connection-class)

*Class for encapsulating a connection to a MonetDB server.*

MethodDocumentation**\_\_construct**Create a new connection to a MonetDB database.

**@param** *string* **$host** : The host of the database. Use '127.0.0.1' if the DB is on the same machine.
**@param** *int* **$port** : The port of the database. For MonetDB this is usually 50000.
**@param** *string* **$user** : The user name.
**@param** *string* **$password** : The password of the user.
**@param** *string* **$database** : The name of the database to connect to. Don't forget to release and start it.
**@param** *string* **$saltedHashAlgo** *= "SHA1"* : Optional. The preferred hash algorithm to be used for exchanging the password. It has to be supported by both the server and PHP. This is only used for the salted hashing. Another stronger algorithm is used first (usually SHA512).
**@param** *bool* **$syncTimeZone** *= true* : If true, then tells the clients time zone offset to the server, which will convert all timestamps is case there's a difference. If false, then the timestamps will end up on the server unmodified.
**@param** *int* **$maxReplySize** *= 200* : The maximal number of tuples returned in a response. A higher value results in smaller number of memory allocations and string operations, but also in higher memory footprint.**Close**Close the connection**Query**Execute an SQL query and return its response. For 'select' queries the response can be iterated using a 'foreach' statement. You can pass an array as second parameter to execute the query as prepared statement, where the array contains the parameter values. SECURITY WARNING: For prepared statements in MonetDB, the parameter values are passed in a regular 'EXECUTE' command, using escaping. Therefore the same security considerations apply here as for using the Connection->Escape(...) method. Please read the comments for that method.

**@param** *string* **$sql**
**@param** *array* **$params** *= null* : An optional array for prepared statement parameters. If not provided (or null), then a normal query is executed instead of a prepared statement. The parameter values will be converted to the proper MonetDB type when possible. See the relevant section of README.md about parameterized queries for more details.
**@return** *Response***QueryFirst**Execute an SQL query and return only the first row as an associative array. If there is more data on the stream, then discard all. Returns null if the query has empty result. You can pass an array as second parameter to execute the query as prepared statement, where the array contains the parameter values.

**@param** *string* **$sql**
**@param** *array* **$params** *= null* : An optional array for prepared statement parameters. If not provided (or null), then a normal query is executed instead of a prepared statement. See the 'Query' method for more information about the parameter values.
**@return** *string\[\] -or- null***Command**Send a 'command' to MonetDB. Commands are used for configuring the database, for example setting the maximal response size, or for requesting unread parts of a query response ('export').

**@param** *string* **$command**
**@param** *bool* **$noResponse** *= true* : If true, then returns NULL and makes no read to the underlying socket.
**@return** *Response -or- null***Escape**Escape a string value, to be inserted into a query, inside single quotes. The following characters are escaped by this method: backslash, single quote, carriage return, line feed, tabulator, null character, CTRL+Z. As a security measure this library forces the use of multi-byte support and UTF-8 encoding, which is also used by MonetDB, avoiding the SQL-injection attacks, which play with differences between character encodings.

**@param** *string* **$value**
**@return** *string***ClearPsCache**Clears the in-memory cache of prepared statements. This is called automatically when an error is received from MonetDB, because that also purges the prepared statements and all session state in this case.**GetMaxReplySize**The maximal number of tuples returned in a response.

**@return** *int*---

Response Class
--------------

[](#response-class)

*This class represents a response for an SQL query or for a command. In case of a 'select' query, this class can be iterated through, using a 'foreach' loop. The records are returned as associative arrays, indexed by the column names.*

MethodDocumentation**Discard**Read through all of the data and discard it. Use this method when you don't want to iterate through a long query, but you would like to start a new one instead.**IsDiscarded**Returns true if this response is no longer connected to an input TCP stream.

**@return** *boolean***GetColumnNames**Returns the names of columns for the table. If you would like to have more information about the columns than just their names, then use the 'GetColumnInfo()' method.

**@return** *string\[\]***Fetch**Returns the next row as an associative array, or null if the query ended.

**@return** *array -or- null***GetStatusRecords**Returns one or more Status records that tell information about the queries executed through a single request.

**@return** *StatusRecord\[\]***GetColumnInfo**Returns an array of ColumnInfo objects that contain information about the columns of a table response to a 'select' query.

**@return** *ColumnInfo\[\]*---

StatusRecord Class
------------------

[](#statusrecord-class)

*This class shares the information returned by MonetDB about the executed queries. Like execution time, number of rows affected, etc. Note that only specific fields are populated for specific queries, the others remain NULL.*

MethodDocumentation**GetQueryType**Returns a short string which identifies the type of the query.

**@return** *string***GetDescription**Returns a user-friendly text which describes the effect of the query.

**@return** *string***GetQueryTime**The time the server spent on executing the query. In milliseconds.

**@return** *float -or- null***GetSqlOptimizerTime**SQL optimizer time in milliseconds.

**@return** *float -or- null***GetMalOptimizerTime**MAL optimizer time in milliseconds.

**@return** *float -or- null***GetAffectedRows**The number of rows updated or inserted.

**@return** *integer -or- null***GetTotalRowCount**The total number of rows in the result set. This includes those rows too, which are not in the current response.

**@return** *integer -or- null***GetAsText**Get a description of the status response in a human-readable format.

**@return** *string***GetPreparedStatementID**Get the ID of a created prepared statement. This ID can be used in an 'EXECUTE' statement, but only in the same session.

**@return** *integer -or- null***GetResultID**Returns the ID of the result set that is returned for a query. It is stored on the server for this session, and parts of it can be queried using the "export" command.

**@return** *integer -or- null***GetAutoCommitState**Available after "start transaction", "commit" or "rollback". Tells whether the current session is in auto-commit mode or not.

**@return** *boolean -or- null***GetRowCount**The number of rows (tuples) in the current response only.

**@return** *integer -or- null***GetColumnCount**Column count. If the response contains tabular data, then this tells the number of columns.

**@return** *integer -or- null***GetQueryID**Query ID. A global ID which is also used in functions such as sys.querylog\_catalog().

**@return** *integer -or- null***GetLastInsertID**The last automatically generated ID by an insert statement. (Usually auto\_increment) NULL if none.

**@return** *integer -or- null***GetExportOffset**The index (offset) of the first row in a block response. (For an "export" command.)

**@return** *integer -or- null*---

ColumnInfo Class
----------------

[](#columninfo-class)

*This class contains information about the columns of a table response to a 'select' query.*

MethodDocumentation**GetTableName**The name of the table the field belongs to, or the name of a temporary resource if the value is the result of an expression.

**@return** *string***GetColumnName**Column name.

**@return** *string***GetType**The SQL data type of the field.

**@return** *string***GetLength**A length value that can be used for deciding the width of the columns when rendering the response.

**@return** *integer*---

Development setup through the Docker image
==========================================

[](#development-setup-through-the-docker-image)

- Build the Docker image:

    ```
      docker/build.sh

    ```
- Create the Docker container with Apache listening on port 9292:

    ```
      docker/create.sh

    ```
- Login into the container as the host user or as root:

    ```
      docker/login.sh
      docker/root_login.sh

    ```
- When you don't need the MonetDB-PHP container anymore, you can get rid of it easily: (this also removes the unused images)

    ```
      docker/cleanup.sh

    ```

Running the integration tests
=============================

[](#running-the-integration-tests)

- Login into the running container with `docker/login.sh`.
- Execute the tests with:

```
vendor/bin/phpunit tests

```

The output should be similar to:

```
$ vendor/bin/phpunit tests
PHPUnit 8.5.33 by Sebastian Bergmann and contributors.

........................                                          24 / 24 (100%)

Time: 971 ms, Memory: 4.00 MB

OK (24 tests, 50 assertions)

```

IDE setup
=========

[](#ide-setup)

- IDE: Visual Studio Code
- Plugins:
    - [PHP Intelephense (Ben Mewburn)](https://marketplace.visualstudio.com/items?itemName=bmewburn.vscode-intelephense-client)
    - [PHP DocBlocker (Neil Brayfield)](https://marketplace.visualstudio.com/items?itemName=neilbrayfield.php-docblocker)
    - [Remote-SSH (Microsoft)](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
    - [Markdown All in One (Yu Zhang)](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
- Plugins for the [Monet-Explorer](protocol_doc/monet-explorer/) project:
    - [C/C++ IntelliSense, debugging, and code browsing. (Microsoft)](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)
    - [Doxygen Documentation Generator (Christoph Schlosser)](https://marketplace.visualstudio.com/items?itemName=cschlosser.doxdocgen)

###  Health Score

41

—

FairBetter than 87% of packages

Maintenance50

Moderate activity, may be stable

Popularity17

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity71

Established project with proven stability

 Bus Factor1

Top contributor holds 85.2% 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 ~60 days

Recently: every ~208 days

Total

19

Last Release

1177d ago

PHP version history (2 changes)1.0.0PHP >=7.2

1.2.0PHP >=7.2 || >=8.0

### Community

Maintainers

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

---

Top Contributors

[![bolner](https://avatars.githubusercontent.com/u/2199459?v=4)](https://github.com/bolner "bolner (121 commits)")[![MitchellWeg](https://avatars.githubusercontent.com/u/26233379?v=4)](https://github.com/MitchellWeg "MitchellWeg (17 commits)")[![njnes](https://avatars.githubusercontent.com/u/3414452?v=4)](https://github.com/njnes "njnes (2 commits)")[![joerivanruth](https://avatars.githubusercontent.com/u/13964176?v=4)](https://github.com/joerivanruth "joerivanruth (1 commits)")[![monetdb-team](https://avatars.githubusercontent.com/u/11664177?v=4)](https://github.com/monetdb-team "monetdb-team (1 commits)")

---

Tags

columnarlibrarymonetdbphpclientlibrarydata scienceMonetDBcolumnar

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/tbolner-monetdb-php/health.svg)

```
[![Health](https://phpackages.com/badges/tbolner-monetdb-php/health.svg)](https://phpackages.com/packages/tbolner-monetdb-php)
```

###  Alternatives

[rah/danpu

Zero-dependency MySQL dump library for easily exporting and importing databases

62410.3k11](/packages/rah-danpu)[eden/sqlite

Eden SQLite Search, Collection, Model ORM componen

199.2k2](/packages/eden-sqlite)[zachflower/eloquent-interactions

An implementation of the interactor pattern for Laravel.

1312.3k](/packages/zachflower-eloquent-interactions)[soosyze/queryflatfile

The Queryflatfile is PHP library for simple database not SQL

181.1k1](/packages/soosyze-queryflatfile)

PHPackages © 2026

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