PHPackages                             clusterpoint/php-client-api-v4 - 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. clusterpoint/php-client-api-v4

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

clusterpoint/php-client-api-v4
==============================

4.0.28(9y ago)22.5k↓50%42MITPHPPHP >=5.4

Since Feb 18Pushed 9y ago5 watchersCompare

[ Source](https://github.com/clusterpoint/php-client-api-v4)[ Packagist](https://packagist.org/packages/clusterpoint/php-client-api-v4)[ Docs](https://www.clusterpoint.com/)[ RSS](/packages/clusterpoint-php-client-api-v4/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (1)Versions (29)Used By (2)

Clusterpoint 4.x PHP Client API
===============================

[](#clusterpoint-4x-php-client-api)

[![License](https://camo.githubusercontent.com/ea0bbe388bf018fb21bf19851e4153628fbdcb25c855bb2d522a94b0672a6480/68747470733a2f2f706f7365722e707567782e6f72672f636c7573746572706f696e742f7068702d636c69656e742d6170692d76342f6c6963656e7365)](https://packagist.org/packages/clusterpoint/php-client-api-v4)[![Total Downloads](https://camo.githubusercontent.com/dead1044d361ed65e1b2074dec043feae07377c8fd818aca554eda6cf1eca672/68747470733a2f2f706f7365722e707567782e6f72672f636c7573746572706f696e742f7068702d636c69656e742d6170692d76342f646f776e6c6f616473)](https://packagist.org/packages/clusterpoint/php-client-api-v4)[![Latest Stable Version](https://camo.githubusercontent.com/59263a10db2fdbba584a1e303e1002ca0f139cb9d9c3763ef04381a272fe2e49/68747470733a2f2f706f7365722e707567782e6f72672f636c7573746572706f696e742f7068702d636c69656e742d6170692d76342f762f737461626c65)](https://packagist.org/packages/clusterpoint/php-client-api-v4)[![Latest Unstable Version](https://camo.githubusercontent.com/9197aa862dcf4fe6b483664d8357ac940e2d284377a5dedc41315cdad82347fb/68747470733a2f2f706f7365722e707567782e6f72672f636c7573746572706f696e742f7068702d636c69656e742d6170692d76342f762f756e737461626c65)](https://packagist.org/packages/clusterpoint/php-client-api-v4)

Clusterpoint is a NoSQL document database known for its innovative Cloud-based distributed architecture, fast processing speed, and a flexible "pay as you use" pricing model. The database also features a developer-friendly API suitable for many popular modern programming languages, including PHP -- the specific API which is the focus of this document. Its full support for ACID-compliant transactions is a rarity among NoSQL databases, making the product useful for situations where data integrity is a must.

The recently introduced fourth edition of Clusterpoint added a unique JavaScript/SQL query language with computational capabilities,, allowing you to create powerful queries to store, retrieve, and transform data. The PHP API is flexible enough to allow you to use either interface methods or raw JS/SQL queries to accomplish your database tasks. The decision to use either approach ultimately depends on programmer preference and the individual development scenario.

Clusterpoint 4.x PHP Client API
-------------------------------

[](#clusterpoint-4x-php-client-api-1)

- [Official Documentation](#documentation)
- [Requirements](#requirements)
- [Getting Started](#start)
- [Quick Example](#usage)
- [Bugs and Vulnerabilities](#bugs)
- [License](#license)

Official Documentation
----------------------

[](#official-documentation)

Documentation for the API can be found on the [Clusterpoint website](https://www.clusterpoint.com/docs/api/4/php/389).

Requirements
------------

[](#requirements)

```
PHP >= 5.4.0
cURL PHP Extension
Composer

```

Getting Started
---------------

[](#getting-started)

1. **Sign up for Clusterpoint** – Before you begin, you need to sign up for a Clusterpoint account and retrieve your [Clusterpoint credentials](https://clusterpoint.com/docs/4.0/21/cloud-account-setup).
2. **Minimum requirements** – To run the PHP Client API, your system will need to meet the [minimum requirements](#requirements), including having \*\*PHP >= 5.4.0 compiled with the cURL extension and cURL 4.0.2+.
3. **Install the API** – [Composer](https://getcomposer.org/) is the right way to install the PHP Client API.
    `composer require clusterpoint/php-client-api-v4`
4. **Publish config file** - this is optional step, you can pass access points during workflow, but this might make your development process easier.
    `php -r "copy('vendor/clusterpoint/php-client-api-v4/src/config.example', 'clusterpoint.php');"`
5. **Access** – You can pass the credentials inside on `Clusterpoint\Client` class construction, or use **clusterpoint.php** inside your project root folder, to manage your access points.

Quick Example
-------------

[](#quick-example)

```