laravel-freelancer-nl / arangodb-php-client
Low level PHP client for ArangoDB
Fund package maintenance!
LaravelFreelancerNL
Installs: 9 982
Dependents: 1
Suggesters: 0
Security: 0
Stars: 11
Watchers: 5
Forks: 0
Open Issues: 3
Requires
- php: ^8.1
- ext-curl: *
- ext-json: *
- guzzlehttp/guzzle: ^7.3
- halaxa/json-machine: ^1.0
- spatie/data-transfer-object: ^3.9
- spatie/ray: ^1.41
Requires (Dev)
- laravel/pint: ^1.2.1
- mockery/mockery: ^1.4
- phpmd/phpmd: ^2.9
- phpstan/phpstan: ^1.0
- phpunit/phpunit: ^9.5
- rector/rector: ^0.14.8
- scrutinizer/ocular: ^1.8
This package is auto-updated.
Last update: 2024-10-08 11:21:18 UTC
README
Low level PHP client for ArangoDB. Supports PHP ^8.0.
This client is a conduit to ArangoDB and back, so it doesn't make any presumptions on the returned data itself. JSON objects are decoded to POPO's. You can cast those to what you need in your ODM or project.
Install
composer require laravel-freelancer-nl/arangodb-php-client
Quickstart
Create a new client
$client = new ArangoClient($config);
Create a collection
Use the schemaManager to create a new collection.
$client->schema()->createCollection('users');
Get documents from the collection
$statement = $client->prepare('FOR user in Users RETURN user');
$statement->execute();
$users = $statement->fetchAll();
As there are no users yet in the above example this will yield an empty result. Note that this client does not have any preconceptions about the data structure and thus everything is returned as raw arrays.
config
The connector has a default configuration for a local ArangoDB instance at it's default port (8529).
AQL statements
To run AQL queries you prepare a query, execute it and fetch the results. Much like PHP's PDO extension.
$statement = $client->prepare('FOR user in users RETURN user');
$statement->execute();
$users = $statement->fetchAll();
Alternatively you can traverse over the statement itself to get the results one at a time.
$statement = $client->prepare('FOR user in users RETURN user');
$statement->execute();
foreach ($statement as $document) {
//
}
Managers
You have access to several managers that allow you to perform specific tasks on your ArangoDB instance(s). Their functions can be called on the manager.
Admin manager
The admin manager manages administrative functions and information retrieval for the server/cluster.
$client->admin()->version();
Monitor manager
The monitor manager manages monitoring functions the server/cluster.
$client->monitor()->getMetrics();
Schema manager
The schema manager manages all schema related operations.
$client->schema()->createDatabase('new_db');
Transaction manager
The transaction manager takes care of all transactions.
$client->transactions()->begin(['write' => ['users', 'teams']]);
Documentation
- ArangoDB PHP client
- AQL query statements
- Admin manager
- Monitor manager 5Schema manager