https://github.com/rkrishn7/objection-match
A lightweight search DSL for Objection.js.
https://github.com/rkrishn7/objection-match
dsl mariadb mssql mysql objection-orm objectionjs postgresql search sqlite3
Last synced: about 1 month ago
JSON representation
A lightweight search DSL for Objection.js.
- Host: GitHub
- URL: https://github.com/rkrishn7/objection-match
- Owner: rkrishn7
- License: mit
- Created: 2020-09-20T09:38:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-27T20:09:31.000Z (over 5 years ago)
- Last Synced: 2025-10-01T04:55:20.110Z (5 months ago)
- Topics: dsl, mariadb, mssql, mysql, objection-orm, objectionjs, postgresql, search, sqlite3
- Language: TypeScript
- Homepage:
- Size: 399 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# objection-match
[](https://badge.fury.io/js/objection-match)
A lightweight search plugin built on top of [Objection.js](https://github.com/Vincit/objection.js).
**objection-match** was created for programs that wish to easily support dynamic searches. In a distributed setting, a set of constraints for a search may be defined on a client machine and sent to a server for processing. However, the task of parsing the payload, loading relations, and building a query can be cumbersome. This library provides a robust and portable query language that can be used to represent a complex search with various constraints, and from it, build an Objection query.
## Installation
```sh
# npm
npm install --save objection-match
# yarn
yarn add objection-match
```
## Grammar
The grammar can be found in [src/lib/parser/parser.pegjs](https://github.com/rkrishn7/objection-match/blob/master/src/lib/parser/parser.pegjs). It defines the structure of the query language.
Briefly, a query consists of _logical_ and _comparison_ nodes. The tables below describe the mapping from each node to their respective function.
Logical Node MappingsComparison Node Mappings
| Logical Node | Corresponding Function |
| ------------ | ---------------------- |
| match_all | AND |
| match_any | OR |
| Comparison Node | Corresponding Function |
| --------------- | ---------------------- |
| eq | = |
| neq | != |
| geq | >= |
| leq | <= |
| lt | < |
| gt | > |
| like | LIKE |
| in | IN |
Logical nodes can contain children that include both node types while comparison nodes cannot contain any children. Here's an example:
```js
match_all: {
eq: ["person.name", "Antonio"],
neq: ["shirt.color", "white"],
match_any: {
eq: ["shirt.style", "polo"],
eq: ["shirt.style", "dress"]
}
}
```
A simple, browser-compatible package that constructs this syntax will be available as well.
## Usage
The `search()` method is invoked directly on a model class. In order to support this, the plugin mixin needs to be added to any models that wish to use it. Example usage:
```tsx
import Search from 'objection-match';
class Employee extends Search({ ...plugin options })(Model) {
...
}
```
Now, you can call the `search()` method like so:
```tsx
const results = await Employee.search({
predicate: `
match_all: {
geq: ["salary", 60000],
geq: ["salary_start_date", "1986-06-26"],
in: ["first_name", "Georgi, Bob"]
}
`,
limit: 5,
fields: ['salary', 'salary_start_date'],
aliases: {
salary: 'salaries.salary',
salary_start_date: 'salaries.from_date',
},
orderBy: ['salary', 'desc'],
});
```
`search()` requires a `Search` object as its argument, which has the following properties:
| Property | Description |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| predicate `string` (required) | The search string, as described in **Grammar** |
| limit `number` | A limit on the number of results |
| fields `string[]` | Fields to select (supports aliased fields) |
| aliases `Record` | An object that contains mappings from alias name to relation name. These are to be used in `predicate` and `fields`. |
| orderBy `[string, 'desc' / 'asc']` | Used for ordering results. |
For more information on third-party plugins, check out [Objection's docs](https://vincit.github.io/objection.js/guide/plugins.html#_3rd-party-plugins). You might also be interested in the [API Reference](https://rkrishn7.github.io/objection-match/).
## Caching
**objection-match** can cache the query builder object so it doesn't have to parse and build frequently used searches. To enable caching, pass options to the mixin function when initializing the plugin on a model. The options include:
| Property | Description |
| ---------------------------------- | -------------------------- |
| enableCache `boolean` | Turns on caching |
| cacheMaxSize `number` (default 10) | Sets the size of the cache |
For more information on third-party plugins, check out [Objection's docs](https://vincit.github.io/objection.js/guide/plugins.html#_3rd-party-plugins).