Skip to content

Commit

Permalink
Merge pull request #5 from triadev/update_readme
Browse files Browse the repository at this point in the history
Updated the readme
  • Loading branch information
triadev committed Jan 8, 2019
2 parents aa8dc1b + 9f950f2 commit 3c4c538
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ This will create a file ```config/laravel-elasticsearch-dsl.php```.

## Metrics
Metrics are generated with the package: [LaravelPrometheusExporter](https://github.com/triadev/LaravelPrometheusExporter)
<br />
Detailed configuration options are documented in the readme of the package.

The following metrics are generated as long as ```metrics.enabled = true```:
Expand All @@ -72,10 +73,10 @@ The following metrics are generated as long as ```metrics.enabled = true```:

## Usage

Dieses Paket bietet eine DSL für Elasticsearch. Als Einstiegspunkt für jede Query/Aggregation steht eine Facade zur Verfügung.
This package offers a dsl for elasticsearch. The entry point for each query / aggregation is a facade.
>Triadev\Es\Dsl\Facade\ElasticDsl;
Jede Query/Aggregation gibt ein Object zurück, welches das Suchergebnis und Aggregation beinhaltet.
Each query / aggregation returns an object containing the search result and aggregation.
>Triadev\Es\Dsl\Model\SearchResult
```php
int: time needed to execute the query
Expand All @@ -98,7 +99,7 @@ $result->aggregation();
```

### Bool
Bei jeder Abfrage, die auf Bool basiert, kann der Bool-Status verändert werden.
For every query that is based on bool, the bool status can be changed.
>Default bool state: must
```php
ElasticDsl::search()->termLevel()
Expand All @@ -114,7 +115,7 @@ ElasticDsl::search()->termLevel()
```

#### Nested bool query
Eine verschachtelte Query wird über ```bool(\Closure $closure)``` realisiert.
A nested query is realized with ```bool(\Closure $closure)```.
```php
ElasticDsl::search()
->termLevel()
Expand Down

0 comments on commit 3c4c538

Please sign in to comment.