Hosterra/flux-querybuilder
Hosterra/flux-querybuilder
1
0
Fork 0
Code Issues Pull requests Releases 2 Packages Activity

Improve getting started docs

Browse source 
Signed-off-by: davidarendsen <davidarendsen@hey.com>
This commit is contained in:
davidarendsen 2022-12-28 16:29:37 +00:00
commit 1e8070fc61
2 changed files with 4 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -10,7 +10,7 @@ composer require arendsen/fluxquerybuilder
``` ```
## Documentation ## Documentation
The documentation of this project is available in the [doc folder](docs/00-index.md). The documentation of this project is available in the [docs folder](docs/00-index.md).
## Testing ## Testing

7
docs/01-getting-started.md
View file

@ -7,14 +7,13 @@ Install the package with composer:
composer require arendsen/fluxquerybuilder composer require arendsen/fluxquerybuilder
``` ```
The most basic Flux query can be made with the following code. It has filters for fields and tags.
```php ```php
<?php <?php
use Arendsen\FluxQueryBuilder\QueryBuilder; use Arendsen\FluxQueryBuilder\QueryBuilder;
use Arendsen\FluxQueryBuilder\Expression\KeyFilter; use Arendsen\FluxQueryBuilder\Expression\KeyFilter;
use Arendsen\FluxQueryBuilder\Expression\Map;
use Arendsen\FluxQueryBuilder\Expression\Selection;
$queryBuilder = new QueryBuilder(); $queryBuilder = new QueryBuilder();
$queryBuilder->fromBucket('test_bucket') $queryBuilder->fromBucket('test_bucket')
@ -25,7 +24,7 @@ $queryBuilder->fromBucket('test_bucket')
KeyFilter::setEqualTo('_field', 'username') KeyFilter::setEqualTo('_field', 'username')
->orEqualTo('_field', 'email') ->orEqualTo('_field', 'email')
) )
->limit(50); ->limit(50, 100);
echo $queryBuilder->build(); echo $queryBuilder->build();
``` ```
@ -42,5 +41,5 @@ from(bucket: "test_bucket")
|> filter(fn: (r) => |> filter(fn: (r) =>
r._field == "username" or r._field == "email" r._field == "username" or r._field == "email"
) )
|> limit(n: 50, offset: 0) |> limit(n: 50, offset: 100)
``` ```