Skip to content

Commit 580d6fb

Browse files
Added database selection and transactions.
feat: added database selection for the client. feat: added transactions docs: updated docs and added descriptions of the new features
1 parent ae385dd commit 580d6fb

21 files changed

+975
-107
lines changed

README.md

+30-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ArangoDB PHP client
1+
# ArangoClient - ArangoDB PHP client
22

33
Low level PHP client for ArangoDB. Supports PHP versions 7.4 & ^8.0
44

@@ -60,16 +60,37 @@ foreach ($statement as $document) {
6060

6161
## Managers
6262
You have access to several managers that allow you to perform specific tasks on your ArangoDB instance(s).
63+
Their functions can be called on the manager.
64+
65+
### Admin manager
66+
The admin manager manages administrative functions and information retrieval for the server/cluster.
67+
```
68+
$client->admin()->version();
69+
```
70+
71+
### Schema manager
72+
The schema manager manages all schema related operations.
73+
```
74+
$client->schema()->createDatabase('new_db');
75+
```
76+
77+
### Transaction manager
78+
The transaction manager takes care of all transactions.
79+
```
80+
$client->transactions()->begin(['write' => ['users', 'teams']]);
81+
```
6382

6483
## Documentation
65-
1) [ArangoDB PHP Client](docs/arangodb-client.md)
66-
2) [Statements](docs/statements.md)
67-
3) [Database schema](docs/schema-databases.md)
68-
4) [User schema](docs/schema-users.md)
69-
5) [Collection schema](docs/schema-collections.md)
70-
6) [Index schema](docs/schema-indexes.md)
71-
7) [View schema](docs/schema-views.md)
72-
8) [Admin manager](docs/admin-manager.md)
84+
1) [ArangoDB PHP client](docs/arangodb-client.md)
85+
2) [AQL query statements](docs/statements.md)
86+
3) [Admin manager](docs/admin-manager.md)
87+
4) Schema manager
88+
1) [Database schema](docs/schema-databases.md)
89+
2) [User schema](docs/schema-users.md)
90+
3) [Collection schema](docs/schema-collections.md)
91+
4) [Index schema](docs/schema-indexes.md)
92+
5) [View schema](docs/schema-views.md)
93+
5) [Transaction manager](docs/transaction-manager.md)
7394

7495
## Related packages
7596
[AQL query builder](https://github.com/LaravelFreelancerNL/fluentaql)

composer.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@
2626
"phpstan/phpstan": "^0.12.82",
2727
"phpmd/phpmd": "^2.9",
2828
"vimeo/psalm": "^4.6",
29-
"squizlabs/php_codesniffer": "^3.5"
29+
"squizlabs/php_codesniffer": "^3.5",
30+
"mockery/mockery": "^1.4"
3031
},
3132
"autoload": {
3233
"psr-4": {

0 commit comments

Comments
 (0)