https://github.com/foo123/advanced-search
transform any search box / search term query into an advanced multi-field search with custom search operators (PHP, Node/XPCOM/JS, Python)
https://github.com/foo123/advanced-search
search-query searchbox
Last synced: 3 months ago
JSON representation
transform any search box / search term query into an advanced multi-field search with custom search operators (PHP, Node/XPCOM/JS, Python)
- Host: GitHub
- URL: https://github.com/foo123/advanced-search
- Owner: foo123
- Created: 2016-05-24T10:47:53.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-05-29T13:31:12.000Z (about 9 years ago)
- Last Synced: 2025-01-22T19:48:43.736Z (5 months ago)
- Topics: search-query, searchbox
- Language: JavaScript
- Homepage: https://foo123.github.io/
- Size: 10.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# advanced-search
Transform any search box / search term query into an advanced multi-field search with custom search operators (PHP, Node/XPCOM/JS, Python)
**What it does**
This enables out-of-the-box search boxes (actualy the search term query) to **textualy** encode complex (customizable) search queries, including `AND`/`OR` operators, `greater-than`, `less-than`, `like`, reference multiple different `search fields` and so on.. Similar to advanced search queries in search engines. **Note**, this **does not include a GUI for that** (although, one, can indeed use a GUI to build the complex search query), only the functionality to interpret the search term as complex query and get the parsed parts to be used then to do the actual query. The advantage is that one can use this to leverage **ANY** search form/search term to be able to encode a complex query without additional GUI or anything else extraneous and extravagant.
**Example** (see `test/` folder)
```javascript
var AdvancedSearch = require('../src/js/AdvancedSearch.js');
function echo( s )
{
console.log( "object" === typeof s ? JSON.stringify(s, null, 4) : s );
}
echo("AdvancedSearch.VERSION = " + AdvancedSearch.VERSION);
echo(['term',AdvancedSearch().query('term')]);
echo(['~"term term2"',AdvancedSearch().query('~"term term2"')]);
echo(['field=term',AdvancedSearch().query('field=term')]);
echo(['field>=term field<=term2',AdvancedSearch().query('field>=term field<=term2')]);
echo(['field>=term field<=term2, field2~term3',AdvancedSearch().query('field>=term field<=term2, field2~term3')]);
echo(['field>="term term2" field<=term2, field2~"field2~term3", "field2~term3"',AdvancedSearch().query('field>="term term2" field<=term2, field2~"field2~term3", "field2~term3"')]);
```
**output**
```text
AdvancedSearch.VERSION = 0.2.0
[
"term",
[
[
{
"field": null,
"op": null,
"term": "term"
}
]
]
]
[
"~\"term term2\"",
[
[
{
"field": null,
"op": "~",
"term": "term term2"
}
]
]
]
[
"field=term",
[
[
{
"field": "field",
"op": "=",
"term": "term"
}
]
]
]
[
"field>=term field<=term2",
[
[
{
"field": "field",
"op": ">=",
"term": "term"
},
{
"field": "field",
"op": "<=",
"term": "term2"
}
]
]
]
[
"field>=term field<=term2, field2~term3",
[
[
{
"field": "field",
"op": ">=",
"term": "term"
},
{
"field": "field",
"op": "<=",
"term": "term2"
}
],
[
{
"field": "field2",
"op": "~",
"term": "term3"
}
]
]
]
[
"field>=\"term term2\" field<=term2, field2~\"field2~term3\", \"field2~term3\"",
[
[
{
"field": "field",
"op": ">=",
"term": "term term2"
},
{
"field": "field",
"op": "<=",
"term": "term2"
}
],
[
{
"field": "field2",
"op": "~",
"term": "field2~term3"
}
],
[
{
"field": null,
"op": null,
"term": "field2~term3"
}
]
]
]
```
The output consists of a tree representing the complex query, where the first level
represents `OR` clauses and the second level `AND` clauses (inside each `OR` clause) including operators (default `null` interpret as you like) and specific search `field` references (see above example to get an idea).
One could then contruct an actual query out of this (note how the original GUI of the application did not change at all, it was simply leveraged in functionality) like the following:
```javascript
var sql = "SELECT field1,field2,field3 FROM table";
var query = AdvancedSearch().query(GET['search']);
var OR = [];
for(var i=0; i