Skip to content

Commit 3b19d62

Browse files
Added analyzer documentation (#23)
1 parent 7a31444 commit 3b19d62

File tree

4 files changed

+48
-4
lines changed

4 files changed

+48
-4
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,9 @@ $client->transactions()->begin(['write' => ['users', 'teams']]);
9191
2) [User schema](docs/schema-users.md)
9292
3) [Collection schema](docs/schema-collections.md)
9393
4) [Index schema](docs/schema-indexes.md)
94-
5) [View schema](docs/schema-views.md)
95-
6) [Graph schema](docs/schema-graphs.md)
94+
5) [Graph schema](docs/schema-graphs.md)
95+
6) [View schema](docs/schema-views.md)
96+
7) [Analyzer schema](docs/schema-analyzers.md)
9697
5) [Transaction manager](docs/transaction-manager.md)
9798

9899
## Related packages

docs/schema-analyzers.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Schema manager - Analyzers
2+
You can use the schema manager to perform CRUD actions on ArangoDB analyzers.
3+
4+
## Analyzer functions
5+
The schema manager supports the following analyzer functions:
6+
7+
### createAnalyzer(array $analyzer): stdClass
8+
```
9+
$arangoClient->schema()->createAnalyzer([
10+
'name' => 'myAnalyzer',
11+
'type' => 'identity',
12+
]);
13+
```
14+
15+
### getAnalyzer(string $name): stdClass
16+
```
17+
$arangoClient->schema()->getAnalyzer('myAnalyzer');
18+
```
19+
20+
### getAnalyzers(): array
21+
```
22+
$arangoClient->schema()->getAnalyzers();
23+
```
24+
25+
### hasAnalyzer(string $name): bool
26+
```
27+
$arangoClient->schema()->hasAnalyzer('myAnalyzer');
28+
```
29+
30+
### replaceAnalyzer(string $name, array $newAnalyzer): stdClass|false
31+
This will delete the old analyzer and create a new one under the same name.
32+
```
33+
$arangoClient->schema()->replaceAnalyzer('myAnalyzer', [
34+
'name' => 'myAnalyzer',
35+
'type' => 'identity',
36+
]);
37+
```
38+
39+
### deleteAnalyzer(string $name): bool
40+
```
41+
$arangoClient->schema()->deleteAnalyzer('myAnalyzer');
42+
```
43+

docs/schema-views.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
You can use the schema manager to perform CRUD actions on ArangoSearch views.
33

44
## View functions
5-
The schema manager supports the following index functions:
5+
The schema manager supports the following view functions:
66

77
### createView(array $view): stdClass
88
```

src/Statement/Statement.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ class Statement extends Manager implements IteratorAggregate
4141
/**
4242
* Statement constructor.
4343
*
44-
* @param ?array<mixed> $bindVars
44+
* @param array<mixed>|null $bindVars
4545
* @param array<mixed> $options
4646
*/
4747
public function __construct(protected ArangoClient $arangoClient, protected string $query, protected ?array $bindVars, protected array $options = []) {}

0 commit comments

Comments
 (0)