Apache Ignite Documentation

GridGain Developer Hub - Apache Ignitetm

Welcome to the Apache Ignite developer hub run by GridGain. Here you'll find comprehensive guides and documentation to help you start working with Apache Ignite as quickly as possible, as well as support if you get stuck.


GridGain also provides Community Edition which is a distribution of Apache Ignite made available by GridGain. It is the fastest and easiest way to get started with Apache Ignite. The Community Edition is generally more stable than the Apache Ignite release available from the Apache Ignite website and may contain extra bug fixes and features that have not made it yet into the release on the Apache website.


Let's jump right in!


Documentation     Ask a Question     Download


Javadoc     Scaladoc     Examples

PHP Thin Client


This thin client allows your PHP applications to work with Apache Ignite clusters via Binary Client Protocol.

A thin client is a lightweight Ignite client that connects to the cluster via a standard socket connection. It does not start in JVM process (Java is not required at all), does not become a part of the cluster topology, never holds any data or used as a destination of compute grid calculations.

What it does is it simply establishes a socket connection to a standard Ignite node and performs all operations through that node.

For more information, visit:

  • Initialization and Configuration to learn how to configure and obtain references of the thin client APIs currently supported.
  • Key-Value Operations to learn which JCache APIs are supported supported.
  • SQL Queries to learn how to use SQL with the Java thin client API.
  • Binary Types to learn how to use the Ignite Binary Objects API with the PHP thin client API.
  • Security to see if the thin client has enough protection to connect to an enterprise Ignite cluster over Internet.

Quick Start


Installing from Sources

  1. Clone or download the Ignite repository to local_ignite_path
  2. Go to local_ignite_path/modules/platforms/php folder
  3. Execute composer install --no-dev command
cd local_ignite_path/modules/platforms/php
composer install --no-dev

To use the client in your application, include vendor/autoload.php file, generated by Composer, to your source code. For example:

require_once "<local_ignite_path>/vendor/autoload.php";

Running an Example

After installing PHP thin client, let's run an example using existing PHP examples that are delivered with every Ignite distribution for the sake of quick getting started.

  1. Run Apache Ignite server.
    To start a cluster node with the default configuration, open the terminal and, assuming you are in IGNITE_HOME (Ignite installation folder), just type this:
$ bin/ignite.sh
$ bin\ignite.bat
  1. In another terminal window, go to IGNITE_HOME/platforms/php/examples and run an example by calling php <example_file_name>.php, like so:
cd IGNITE_HOME/platforms/php/examples
php CachePutGetExample.php


PHP example files

PHP thin client contains fully workable examples to demonstrate the behavior of the client.

Updated about a year ago

PHP Thin Client

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.