PHP Client for Apache Ignite
|
Public Member Functions | |
__construct () | |
connect (ClientConfiguration $config) | |
disconnect () | |
createCache (string $name, CacheConfiguration $cacheConfig=null) | |
getOrCreateCache (string $name, CacheConfiguration $cacheConfig=null) | |
getCache (string $name) | |
destroyCache (string $name) | |
getCacheConfiguration (string $name) | |
cacheNames () | |
setDebug (bool $value) | |
Class representing Ignite client.
Apache\Ignite\Client::__construct | ( | ) |
Public Client constructor.
Apache\Ignite\Client::cacheNames | ( | ) |
Gets existing cache names.
ClientException | if error. |
Apache\Ignite\Client::connect | ( | ClientConfiguration | $config | ) |
Connects the client.
Reconnects if the client already connected.
ClientConfiguration | $config | the client configuration. |
ClientException | if error. |
Apache\Ignite\Client::createCache | ( | string | $name, |
CacheConfiguration | $cacheConfig = null |
||
) |
Creates new cache with the provided name and optional configuration.
string | $name | cache name. |
CacheConfiguration | $cacheConfig | optional cache configuration. |
ClientException | if error. |
Apache\Ignite\Client::destroyCache | ( | string | $name | ) |
Destroys cache with the provided name.
string | $name | cache name. |
ClientException | if error. |
Apache\Ignite\Client::disconnect | ( | ) |
Disconnects the client.
Does nothing if the client already disconnected.
Apache\Ignite\Client::getCache | ( | string | $name | ) |
Gets instance of the class with interface representing the cache with the provided name. The method does not check if the cache with the provided name exists.
string | $name | cache name. |
ClientException | if error. |
Apache\Ignite\Client::getCacheConfiguration | ( | string | $name | ) |
Returns configuration of cache with the provided name.
string | $name | cache name. |
ClientException | if error. |
Apache\Ignite\Client::getOrCreateCache | ( | string | $name, |
CacheConfiguration | $cacheConfig = null |
||
) |
Gets existing cache with the provided name or creates new one with the provided name and optional configuration.
string | $name | cache name. |
CacheConfiguration | $cacheConfig | cache configuration (ignored if cache with the provided name already exists). |
ClientException | if error. |
Apache\Ignite\Client::setDebug | ( | bool | $value | ) |
Enables/disables the Ignite client's debug output (including errors logging). Disabled by default.
bool | $value | true to enable, false to disable. |