-
Notifications
You must be signed in to change notification settings - Fork 25
sqon doc #1012
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
sqon doc #1012
Conversation
|
Consider outlining performance/functionality gain versus using simpler and more familiar postgres queries. |
| | Operator | Description | Value Type | Example | | ||
| | -------- | ------------------------------------------------ | ------------------ | ------- | | ||
| | `"in"` | Field value must match one of the listed values | Array | `"value": ["Ontario", "Quebec"]` | | ||
| | `">="` | Field value must be greater than or equal to | Scalar (number) | `"value": 1640926800000` | | ||
| | `"<="` | Field value must be less than or equal to | Scalar (number) | `"value": 1672549199999` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a good start. Arranger can support more operators than this. We should definitely make a standardized absolute list and ensure compatibility across all services that use SQONs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
great idea! let's add this for now, and amend it later
| | SQON Component | Elasticsearch Equivalent | Notes | | ||
| |----------------|-------------------------|-------| | ||
| | `"op": "and"` | `"bool": { "must": [...] }` | AND logic requires all conditions to match | | ||
| | `"op": "in"` | `"terms": { "field": [...] }` | IN operation uses Elasticsearch's `terms` query | | ||
| | `"fieldName": "data.primary_site"` | `"data.primary_site": [...]` | Field name maps directly to the index mapping | | ||
| | `"first": 20` | `"size": 20` | Pagination size parameter | | ||
| | `"offset": 0` | `"from": 0` | Pagination offset parameter | | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
prettier generally does a good job at inserting spaces in md to make tables readable even without a md render. wonder if the settings in this repo need adjustment to make sure this tool is applied here
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
Remaining Tasks:
Netlify Page Preview: https://deploy-preview-33--overturedocs.netlify.app/docs/core-software/Arranger/usage/query-processing
Linked to this docs PR: overture-stack/docs#33
Note
Lyric also uses SQON, this should be documented within the Lyric documentation when it is completed