-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,27 @@ | ||
# Tigris NoQL generation tool | ||
|
||
This tool looks up for the Tigris API calls in the source code and | ||
generates query filters and update mutations for the filter and update | ||
functions passed as parameters to the Tigris APIs. | ||
|
||
# Install | ||
|
||
```shell | ||
go install github.com/tigrisdata/tigrisgen@latest | ||
``` | ||
|
||
# Setup | ||
|
||
Include the following line in one of the files in the package | ||
which contains Tigris API calls: | ||
|
||
```shell | ||
//go:generate tigrisgen | ||
``` | ||
|
||
Now, when building you project, before calling `go build` you need to run `go generate ./...` to | ||
generate query filters and update mutations. | ||
|
||
# License | ||
|
||
This software is licensed under the [Apache 2.0](LICENSE). |