Download the PHP package tbolner/monetdb-php without Composer

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.

Table of contents

• MonetDB-PHP
• Table of contents
• Installation with Composer (PHP 8.x)
• Usage without installation
• Installation for PHP 7.2 or above.
• Examples
  • Example 1: Simple query
  • Example 2: Get execution stats
  • Example 3: Parameterized query with prepared statement
  • Example 4: Using escaping
  • Example 5: Renaming fields and using column info
  • Example 6: Query the first record only
  • Example 7: Transactions
  • Example 8: Importing data the fastest way
  • Example 9: Using multiple connections
• API Reference
  • Connection Class
  • Response Class
  • StatusRecord Class
  • ColumnInfo Class
• Development setup through the Docker image
• Running the integration tests
• IDE setup

Installation with Composer (PHP 8.x)

This library is available on Packagist at:

• https://packagist.org/packages/tbolner/monetdb-php

First install Composer, then execute the following in your project's directory:

Usage without installation

You don't need to use Composer in your project. You can just copy all files in the 'src' folder, and include them in your project through the include.php file, which was created just for this purpose.

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):

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

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)

Installation for PHP 7.2 or above.

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

Examples

Example projects:

• Data modification
• Web query
• Japanese test

Example 1: Simple query

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

Example 2: Get execution stats

Example 3: Parameterized query with prepared statement

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

Always pass the null values as null, and not as a string.

Example 4: Using escaping

Example 5: Renaming fields and using column info

Example 6: Query the first record only

Example 7: Transactions

Or:

Example 8: Importing data the fastest way

Example 9: Using multiple connections

API Reference

Connection Class

Class for encapsulating a connection to a MonetDB server.

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 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 Class

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

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

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

The output should be similar to:

IDE setup

• IDE: Visual Studio Code
• Plugins:
  • PHP Intelephense (Ben Mewburn)
  • PHP DocBlocker (Neil Brayfield)
  • Remote-SSH (Microsoft)
  • Markdown All in One (Yu Zhang)
• Plugins for the Monet-Explorer project:
  • C/C++ IntelliSense, debugging, and code browsing. (Microsoft)
  • Doxygen Documentation Generator (Christoph Schlosser)