From 8a3366ffa00f1e8629d39240c871b9787c62e8fc Mon Sep 17 00:00:00 2001 From: Matteo Brusamolin Date: Thu, 7 Sep 2017 18:24:04 +0200 Subject: [PATCH 1/3] New select via HTTP POST to let user make queries with a lot of parameters --- lib/client.js | 74 +++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 72 insertions(+), 2 deletions(-) diff --git a/lib/client.js b/lib/client.js index 879b63b..f7744b3 100644 --- a/lib/client.js +++ b/lib/client.js @@ -66,7 +66,7 @@ Client.prototype._makeHostUrl = function(protocol, host, port) { }; /** - * Request get + * Request data (using http get method) * * @param {String} path - target path * @param {Object|String} query - query @@ -119,6 +119,60 @@ Client.prototype._requestGet = function(path, query, finalCallback) { } }; +/** + * Request data (using http post method) + * + * @param {String} path - target path + * @param {Object|String} query - query + * @param {Function} finalCallback - (err, result) + * + * @returns {undefined|Promise} - When there's no callback function it returns a PromiseŰ + */ +Client.prototype._requestGetUsingHttpPost = function(path, query, finalCallback) { + var params, options, requestUrl; + + if (query instanceof Query) { + params = query.toString(); + } else if (_.isString(query)) { + params = query; + } else { + params = 'q=*:*'; + } + requestUrl = this._makeHostUrl(this.options.protocol, this.options.host, this.options.port); + requestUrl += '/' + [this.options.rootPath, this.options.core, path].join('/'); + + logger.debug('[_requestGetUsingHttpPost] requestUrl: ', requestUrl, ' params: ', params); + + options = { + method: 'POST', + body: params, + headers: { + 'accept' : 'application/json; charset=utf-8', + 'content-type' : 'application/x-www-form-urlencoded; charset=utf-8' + } + }; + var result = fetch(requestUrl, options) + .then(function(res) { + if (res.status !== 200) { + logger.error(res); + throw new Error('Solr server error: ' + res.status); + } else { + return res.json(); + } + }); + if (typeof finalCallback === 'function') { + result + .then(function(json) { + finalCallback(null,json); + }) + .catch(function (err) { + finalCallback(err.message); + }); + } else { + return result; + } +}; + /** * Request post * @@ -188,7 +242,7 @@ Client.prototype.query = function() { }; /** - * Search + * Search (using HTTP get method) * * @param {Object|String} query * @param {Function} finalCallback - (err, result) @@ -202,6 +256,22 @@ Client.prototype.search = function(query, finalCallback) { return this._requestGet(this.SEARCH_PATH, query); } }; +/** + * Search (using HTTP post method) + * + * @param {Object|String} query + * @param {Function} finalCallback - (err, result) + * + * @returns {Undefined|Promise} + */ +Client.prototype.searchUsingHttpPost = function(query, finalCallback) { + if (typeof finalCallback === 'function') { + this._requestGetUsingHttpPost(this.SEARCH_PATH, query, finalCallback); + } else { + return this._requestGetUsingHttpPost(this.SEARCH_PATH, query); + } +}; + /** * Terms * From e1bae12499de2cae601c29e198bdeac5f247a0c8 Mon Sep 17 00:00:00 2001 From: Matteo Brusamolin <> Date: Wed, 5 Dec 2018 14:48:32 +0100 Subject: [PATCH 2/3] OS Change --- .bithoundrc | 8 +- .gitignore | 82 +- .travis.yml | 20 +- HISTORY.md | 132 +- LICENSE | 42 +- README.md | 382 +- docs/gen/Client.html | 5554 +++--- docs/gen/Query.html | 14462 +++++++-------- docs/gen/classes.list.html | 596 +- .../fonts/glyphicons-halflings-regular.svg | 574 +- docs/gen/global.html | 824 +- docs/gen/index.html | 456 +- docs/gen/quicksearch.html | 62 +- docs/gen/scripts/docstrap.lib.js | 20 +- docs/gen/scripts/fulltext-search-ui.js | 178 +- docs/gen/scripts/fulltext-search.js | 70 +- docs/gen/scripts/lunr.min.js | 10 +- .../scripts/prettify/Apache-License-2.0.txt | 404 +- docs/gen/scripts/prettify/jquery.min.js | 10 +- docs/gen/scripts/prettify/lang-css.js | 40 +- docs/gen/scripts/prettify/prettify.js | 990 +- docs/gen/scripts/sunlight.js | 2312 +-- docs/gen/scripts/toc.js | 406 +- docs/gen/styles/darkstrap.css | 1920 +- docs/gen/styles/prettify-tomorrow.css | 264 +- docs/gen/styles/site.cerulean.css | 14016 +++++++------- docs/gen/styles/site.cosmo.css | 14122 +++++++------- docs/gen/styles/site.cyborg.css | 14096 +++++++------- docs/gen/styles/site.darkly.css | 14342 +++++++-------- docs/gen/styles/site.darkstrap.css | 11276 ++++++------ docs/gen/styles/site.dibs-bootstrap.css | 11798 ++++++------ docs/gen/styles/site.flatly.css | 14294 +++++++-------- docs/gen/styles/site.journal.css | 13946 +++++++------- docs/gen/styles/site.lumen.css | 14596 +++++++-------- docs/gen/styles/site.paper.css | 15246 ++++++++-------- docs/gen/styles/site.readable.css | 13994 +++++++------- docs/gen/styles/site.sandstone.css | 14070 +++++++------- docs/gen/styles/site.simplex.css | 14046 +++++++------- docs/gen/styles/site.slate.css | 14686 +++++++-------- docs/gen/styles/site.spacelab.css | 14110 +++++++------- docs/gen/styles/site.superhero.css | 14262 +++++++-------- docs/gen/styles/site.united.css | 13790 +++++++------- docs/gen/styles/site.yeti.css | 14390 +++++++-------- docs/gen/styles/sunlight.dark.css | 688 +- docs/gen/styles/sunlight.default.css | 686 +- gulpfile.js | 72 +- index.js | 10 +- lib/client.js | 924 +- lib/query.js | 1666 +- package.json | 92 +- test/client-test.js | 1720 +- test/query-test.js | 1978 +- 52 files changed, 144367 insertions(+), 144367 deletions(-) diff --git a/.bithoundrc b/.bithoundrc index be645df..f0edff7 100644 --- a/.bithoundrc +++ b/.bithoundrc @@ -1,5 +1,5 @@ -{ - "ignore": [ - "docs/**" - ] +{ + "ignore": [ + "docs/**" + ] } \ No newline at end of file diff --git a/.gitignore b/.gitignore index 3b280b0..27b553d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,42 +1,42 @@ -# Logs -logs -*.log -npm-debug.log* - -# Runtime data -pids -*.pid -*.seed - -# Directory for instrumented libs generated by jscoverage/JSCover -lib-cov - -# Coverage directory used by tools like istanbul -coverage - -# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) -.grunt - -# node-waf configuration -.lock-wscript - -# Compiled binary addons (http://nodejs.org/api/addons.html) -build/Release - -# Dependency directory -node_modules - -# Optional npm cache directory -.npm - -# Optional REPL history -.node_repl_history - -# idea files -.idea - -# coverage files -coverage - -# Mac +# Logs +logs +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directory +node_modules + +# Optional npm cache directory +.npm + +# Optional REPL history +.node_repl_history + +# idea files +.idea + +# coverage files +coverage + +# Mac .DS_Store \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index 3b1ba38..fdc411d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,10 +1,10 @@ -language: node_js -node_js: - - "0.12.4" -before_install: - - npm install -g gulp -install: - - npm install -script: gulp -after_success: - - bash <(curl -s https://codecov.io/bash) +language: node_js +node_js: + - "0.12.4" +before_install: + - npm install -g gulp +install: + - npm install +script: gulp +after_success: + - bash <(curl -s https://codecov.io/bash) diff --git a/HISTORY.md b/HISTORY.md index 301a189..3a27774 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,66 +1,66 @@ -### 0.0.5 - * Support search, terms, update, delete - -### 0.1.0 - * Support spell - * Support commit - * Support ping - * Support mlt - -### 0.1.1 - * Support facet - * Fix #23 (When query is object, make invalid url.) - -### 0.1.2 - * Fix #25 (requestPost url bug) - * Support group - * Support hl - -### 0.1.3 - * Fix #30 ("&wt=json" don't need when query is String.) - -### 1.0.0 - * Fix #33 (Fix comments) - * Update #34 (Add error exception) - * Support #35 (wt) - * Update #38 (Add test case) - * Update #40 (Update client.js) - -### 1.0.1 - * Add docs - * Add docs generator (gulp doc) - -### 1.0.2 - * Support set debug level (#45) - -### 1.0.3 - * Support #47 - -### 1.0.4 - * Fix #49 - -### 1.0.5 - * Support #50 - -### 1.0.6 - * Support #51 - -### 1.0.7 - * Support #53 - -### 1.0.8 - * Support #55 - -### 1.0.9 - * Fix #56 - -### 1.0.10 - * Fix #58 - -### 1.0.11 - * Fix client - -### 1.0.12 - -### 1.0.13 - * Adds support for spatial params +### 0.0.5 + * Support search, terms, update, delete + +### 0.1.0 + * Support spell + * Support commit + * Support ping + * Support mlt + +### 0.1.1 + * Support facet + * Fix #23 (When query is object, make invalid url.) + +### 0.1.2 + * Fix #25 (requestPost url bug) + * Support group + * Support hl + +### 0.1.3 + * Fix #30 ("&wt=json" don't need when query is String.) + +### 1.0.0 + * Fix #33 (Fix comments) + * Update #34 (Add error exception) + * Support #35 (wt) + * Update #38 (Add test case) + * Update #40 (Update client.js) + +### 1.0.1 + * Add docs + * Add docs generator (gulp doc) + +### 1.0.2 + * Support set debug level (#45) + +### 1.0.3 + * Support #47 + +### 1.0.4 + * Fix #49 + +### 1.0.5 + * Support #50 + +### 1.0.6 + * Support #51 + +### 1.0.7 + * Support #53 + +### 1.0.8 + * Support #55 + +### 1.0.9 + * Fix #56 + +### 1.0.10 + * Fix #58 + +### 1.0.11 + * Fix client + +### 1.0.12 + +### 1.0.13 + * Adds support for spatial params diff --git a/LICENSE b/LICENSE index e8b5574..6958724 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,21 @@ -The MIT License (MIT) - -Copyright (c) 2016 Donghyun Go - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +The MIT License (MIT) + +Copyright (c) 2016 Donghyun Go + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 8927ebd..0a032eb 100644 --- a/README.md +++ b/README.md @@ -1,191 +1,191 @@ -# solr-node - -Simple Solr Node Client Project - -[![NPM](https://nodei.co/npm/solr-node.png?downloads=true&stars=true)](https://nodei.co/npm/solr-node/) - -[![codecov](https://codecov.io/gh/godong9/solr-node/branch/master/graph/badge.svg)](https://codecov.io/gh/godong9/solr-node) -[![bitHound Dependencies](https://www.bithound.io/github/godong9/solr-node/badges/dependencies.svg)](https://www.bithound.io/github/godong9/solr-node/master/dependencies/npm) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) - - -## Install - -``` -npm install solr-node -``` - -## Usage -- Client: http://godong9.github.io/solr-node/docs/Client.html -- Query: http://godong9.github.io/solr-node/docs/Query.html - -### Create Client - -```js -// Require module -var SolrNode = require('solr-node'); - -// Create client -var client = new SolrNode({ - host: '127.0.0.1', - port: '8983', - core: 'test', - protocol: 'http' -}); - -// Set Debug Level -var client = new SolrNode({ - host: '127.0.0.1', - port: '8983', - core: 'test', - protocol: 'http', - debugLevel: 'ERROR' // log4js debug level paramter -}); -``` - -### Search - -Search can be executed with a simple text query or an object query. - -#### Text - -Text queries are similar to what one would find on the SOLR Core UI, EX: - -From the URL: `http://localhost:8080/solr/products/select?q=*%3A*&wt=json` - -The Query would be: - -``` -*:*&wt=json -``` - -NOTE: url decoded ':' from `%3A`. - -#### Object - -Object based queries can be simple or complex using chaining. Each method of the Query object returns an instance of itself. - -Examples: - -Simple: - -``` -client.query().q({text:'test', title:'test'}); -``` - -Complex and chained: - -``` -client.query() - .q({text:'test', title:'test'}) - .addParams({ - wt: 'json', - indent: true - }) - .start(1) - .rows(1) -; -``` - -### Query Examples - -```js -// Create query -var strQuery = client.query().q('text:test'); -var objQuery = client.query().q({text:'test', title:'test'}); -var myStrQuery = 'q=text:test&wt=json'; - -// Search documents using strQuery -solrClient.search(strQuery, function (err, result) { - if (err) { - console.log(err); - return; - } - console.log('Response:', result.response); -}); - -// Search documents using objQuery -solrClient.search(objQuery, function (err, result) { - if (err) { - console.log(err); - return; - } - console.log('Response:', result.response); -}); - -// Search documents using myStrQuery -solrClient.search(myStrQuery, function (err, result) { - if (err) { - console.log(err); - return; - } - console.log('Response:', result.response); -}); - -``` - -### Update - -```js -// JSON Data -var data = { - text: 'test', - title: 'test' -}; - -// Update document to Solr server -client.update(data, function(err, result) { - if (err) { - console.log(err); - return; - } - console.log('Response:', result.responseHeader); -}); - -``` - -### Delete - -```js -// Delete Query -var strQuery = 'id:testid' -var objQuery = {id:'testid'} - -// Delete document using strQuery -client.delete(strQuery, function(err, result) { - if (err) { - console.log(err); - return; - } - console.log('Response:', result.responseHeader); -}); - -// Delete document using objQuery -client.delete(objQuery, function(err, result) { - if (err) { - console.log(err); - return; - } - console.log('Response:', result.responseHeader); -}); - -``` - -### Promise support - -Skip the callback to get a promise back. ie: -```js -var result = solrClient.search(query) - .then(function(result) { - console.log('Response:', result.response); - }) - .catch(function(err) { - console.error(err); - }); -``` - -## Test & Coverage & Docs - -``` -gulp -``` +# solr-node + +Simple Solr Node Client Project + +[![NPM](https://nodei.co/npm/solr-node.png?downloads=true&stars=true)](https://nodei.co/npm/solr-node/) + +[![codecov](https://codecov.io/gh/godong9/solr-node/branch/master/graph/badge.svg)](https://codecov.io/gh/godong9/solr-node) +[![bitHound Dependencies](https://www.bithound.io/github/godong9/solr-node/badges/dependencies.svg)](https://www.bithound.io/github/godong9/solr-node/master/dependencies/npm) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + + +## Install + +``` +npm install solr-node +``` + +## Usage +- Client: http://godong9.github.io/solr-node/docs/Client.html +- Query: http://godong9.github.io/solr-node/docs/Query.html + +### Create Client + +```js +// Require module +var SolrNode = require('solr-node'); + +// Create client +var client = new SolrNode({ + host: '127.0.0.1', + port: '8983', + core: 'test', + protocol: 'http' +}); + +// Set Debug Level +var client = new SolrNode({ + host: '127.0.0.1', + port: '8983', + core: 'test', + protocol: 'http', + debugLevel: 'ERROR' // log4js debug level paramter +}); +``` + +### Search + +Search can be executed with a simple text query or an object query. + +#### Text + +Text queries are similar to what one would find on the SOLR Core UI, EX: + +From the URL: `http://localhost:8080/solr/products/select?q=*%3A*&wt=json` + +The Query would be: + +``` +*:*&wt=json +``` + +NOTE: url decoded ':' from `%3A`. + +#### Object + +Object based queries can be simple or complex using chaining. Each method of the Query object returns an instance of itself. + +Examples: + +Simple: + +``` +client.query().q({text:'test', title:'test'}); +``` + +Complex and chained: + +``` +client.query() + .q({text:'test', title:'test'}) + .addParams({ + wt: 'json', + indent: true + }) + .start(1) + .rows(1) +; +``` + +### Query Examples + +```js +// Create query +var strQuery = client.query().q('text:test'); +var objQuery = client.query().q({text:'test', title:'test'}); +var myStrQuery = 'q=text:test&wt=json'; + +// Search documents using strQuery +solrClient.search(strQuery, function (err, result) { + if (err) { + console.log(err); + return; + } + console.log('Response:', result.response); +}); + +// Search documents using objQuery +solrClient.search(objQuery, function (err, result) { + if (err) { + console.log(err); + return; + } + console.log('Response:', result.response); +}); + +// Search documents using myStrQuery +solrClient.search(myStrQuery, function (err, result) { + if (err) { + console.log(err); + return; + } + console.log('Response:', result.response); +}); + +``` + +### Update + +```js +// JSON Data +var data = { + text: 'test', + title: 'test' +}; + +// Update document to Solr server +client.update(data, function(err, result) { + if (err) { + console.log(err); + return; + } + console.log('Response:', result.responseHeader); +}); + +``` + +### Delete + +```js +// Delete Query +var strQuery = 'id:testid' +var objQuery = {id:'testid'} + +// Delete document using strQuery +client.delete(strQuery, function(err, result) { + if (err) { + console.log(err); + return; + } + console.log('Response:', result.responseHeader); +}); + +// Delete document using objQuery +client.delete(objQuery, function(err, result) { + if (err) { + console.log(err); + return; + } + console.log('Response:', result.responseHeader); +}); + +``` + +### Promise support + +Skip the callback to get a promise back. ie: +```js +var result = solrClient.search(query) + .then(function(result) { + console.log('Response:', result.response); + }) + .catch(function(err) { + console.error(err); + }); +``` + +## Test & Coverage & Docs + +``` +gulp +``` diff --git a/docs/gen/Client.html b/docs/gen/Client.html index 4ff03d2..6035b37 100644 --- a/docs/gen/Client.html +++ b/docs/gen/Client.html @@ -1,2778 +1,2778 @@ - - - - - - - Documentation Class: Client - - - - - - - - - - -
-
-
- Documentation - -
- - -
-
- - -
-
- - -
- -
- - -

Class: Client

-
- -
- -

- Client -

- - -
- - -
-
- - -
-
-

new Client(options)

- - -
-
- - -
-

Solr Node Client

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
options - - -Object - - - - - -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDescription
host - - -String - - - - - - - <optional>
- - - - - -

host address of Solr server

port - - -Number -| - -String - - - - - - - <optional>
- - - - - -

port number of Solr server

core - - -String - - - - - - - <optional>
- - - - - -

client core name

rootPath - - -String - - - - - - - <optional>
- - - - - -

solr root path

protocol - - -String - - - - - - - <optional>
- - - - - -

request protocol ('http'|'https')

debugLevel - - -String - - - - - - - <optional>
- - - - - -

log4js debug level ('ALL'|'DEBUG'|'INFO'|'ERROR'|...)

- -
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - -

Methods

- -
- -
-
-

_requestGet(path, query, finalCallback)

- - -
-
- - -
-

Request get

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
path - - -String - - - - -

target path

query - - -Object -| - -String - - - - -

query

finalCallback - - -function - - - - -

(err, result)

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - -
-
    -
  • When there's no callback function it returns a PromiseŰ
    • -
-
- - - -
-
- Type -
-
- -undefined -| - -Promise - - - -
-
- - - - - -
- - - -
-
-

_requestPost(path, data, urlOptions, finalCallback)

- - -
-
- - -
-

Request post

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
path - - -String - - - - -

target path

data - - -Object - - - - -

json data

urlOptions - - -Object -| - -String - - - - -

url options

finalCallback - - -function - - - - -

(err, result)

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - -
-
    -
  • When there's no callback function it returns a PromiseŰ
    • -
-
- - - -
-
- Type -
-
- -undefined -| - -Promise - - - -
-
- - - - - -
- - - -
-
-

commit(finalCallback)

- - -
-
- - -
-

Commit

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
finalCallback - - -function - - - - -

(err, result)

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Undefined -| - -Promise - - - -
-
- - - - - -
- - - -
-
-

delete(query [, options], finalCallback)

- - -
-
- - -
-

Delete

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDescription
query - - -String -| - -Object - - - - - - - - - - -

query

options - - -Object -| - -function - - - - - - - <optional>
- - - - - -

delete options

finalCallback - - -function - - - - - - - - - - -

(err, result)

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Undefined -| - -Promise - - - -
-
- - - - - -
- - - -
-
-

mlt(query, finalCallback)

- - -
-
- - -
-

Mlt

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
query - - -Object -| - -String - - - - -
finalCallback - - -function - - - - -

(err, result)

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Undefined -| - -Promise - - - -
-
- - - - - -
- - - -
-
-

ping(finalCallback)

- - -
-
- - -
-

Ping

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
finalCallback - - -function - - - - -

(err, result)

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Undefined -| - -Promise - - - -
-
- - - - - -
- - - -
-
-

query()

- - -
-
- - -
-

Make Query instance and return

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Object - - - -
-
- - - - - -
- - - -
-
- - - -
-
- - -
-

Search

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
query - - -Object -| - -String - - - - -
finalCallback - - -function - - - - -

(err, result)

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Undefined -| - -Promise - - - -
-
- - - - - -
- - - -
-
-

softCommit(finalCallback)

- - -
-
- - -
-

SoftCommit

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
finalCallback - - -function - - - - -

(err, result)

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Undefined -| - -Promise - - - -
-
- - - - - -
- - - -
-
-

spell(query, finalCallback)

- - -
-
- - -
-

Spell

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
query - - -Object -| - -String - - - - -
finalCallback - - -function - - - - -

(err, result)

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Undefined -| - -Promise - - - -
-
- - - - - -
- - - -
-
-

terms(query, finalCallback)

- - -
-
- - -
-

Terms

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
query - - -Object -| - -String - - - - -
finalCallback - - -function - - - - -

(err, result)

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Undefined -| - -Promise - - - -
-
- - - - - -
- - - -
-
-

update(data [, options], finalCallback)

- - -
-
- - -
-

Update

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDescription
data - - -Object - - - - - - - - - - -

json data

options - - -Object -| - -function - - - - - - - <optional>
- - - - - -

update options

finalCallback - - -function - - - - - - - - - - -

(err, result)

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Undefined -| - -Promise - - - -
-
- - - - - -
- -
- - - - - -
- -
- - - - -
-
- -
- - -
- -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + Documentation Class: Client + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: Client

+
+ +
+ +

+ Client +

+ + +
+ + +
+
+ + +
+
+

new Client(options)

+ + +
+
+ + +
+

Solr Node Client

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
host + + +String + + + + + + + <optional>
+ + + + + +

host address of Solr server

port + + +Number +| + +String + + + + + + + <optional>
+ + + + + +

port number of Solr server

core + + +String + + + + + + + <optional>
+ + + + + +

client core name

rootPath + + +String + + + + + + + <optional>
+ + + + + +

solr root path

protocol + + +String + + + + + + + <optional>
+ + + + + +

request protocol ('http'|'https')

debugLevel + + +String + + + + + + + <optional>
+ + + + + +

log4js debug level ('ALL'|'DEBUG'|'INFO'|'ERROR'|...)

+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

_requestGet(path, query, finalCallback)

+ + +
+
+ + +
+

Request get

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
path + + +String + + + + +

target path

query + + +Object +| + +String + + + + +

query

finalCallback + + +function + + + + +

(err, result)

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • When there's no callback function it returns a PromiseŰ
    • +
+
+ + + +
+
+ Type +
+
+ +undefined +| + +Promise + + + +
+
+ + + + + +
+ + + +
+
+

_requestPost(path, data, urlOptions, finalCallback)

+ + +
+
+ + +
+

Request post

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
path + + +String + + + + +

target path

data + + +Object + + + + +

json data

urlOptions + + +Object +| + +String + + + + +

url options

finalCallback + + +function + + + + +

(err, result)

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • When there's no callback function it returns a PromiseŰ
    • +
+
+ + + +
+
+ Type +
+
+ +undefined +| + +Promise + + + +
+
+ + + + + +
+ + + +
+
+

commit(finalCallback)

+ + +
+
+ + +
+

Commit

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
finalCallback + + +function + + + + +

(err, result)

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Undefined +| + +Promise + + + +
+
+ + + + + +
+ + + +
+
+

delete(query [, options], finalCallback)

+ + +
+
+ + +
+

Delete

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
query + + +String +| + +Object + + + + + + + + + + +

query

options + + +Object +| + +function + + + + + + + <optional>
+ + + + + +

delete options

finalCallback + + +function + + + + + + + + + + +

(err, result)

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Undefined +| + +Promise + + + +
+
+ + + + + +
+ + + +
+
+

mlt(query, finalCallback)

+ + +
+
+ + +
+

Mlt

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
query + + +Object +| + +String + + + + +
finalCallback + + +function + + + + +

(err, result)

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Undefined +| + +Promise + + + +
+
+ + + + + +
+ + + +
+
+

ping(finalCallback)

+ + +
+
+ + +
+

Ping

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
finalCallback + + +function + + + + +

(err, result)

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Undefined +| + +Promise + + + +
+
+ + + + + +
+ + + +
+
+

query()

+ + +
+
+ + +
+

Make Query instance and return

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Object + + + +
+
+ + + + + +
+ + + +
+
+ + + +
+
+ + +
+

Search

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
query + + +Object +| + +String + + + + +
finalCallback + + +function + + + + +

(err, result)

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Undefined +| + +Promise + + + +
+
+ + + + + +
+ + + +
+
+

softCommit(finalCallback)

+ + +
+
+ + +
+

SoftCommit

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
finalCallback + + +function + + + + +

(err, result)

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Undefined +| + +Promise + + + +
+
+ + + + + +
+ + + +
+
+

spell(query, finalCallback)

+ + +
+
+ + +
+

Spell

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
query + + +Object +| + +String + + + + +
finalCallback + + +function + + + + +

(err, result)

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Undefined +| + +Promise + + + +
+
+ + + + + +
+ + + +
+
+

terms(query, finalCallback)

+ + +
+
+ + +
+

Terms

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
query + + +Object +| + +String + + + + +
finalCallback + + +function + + + + +

(err, result)

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Undefined +| + +Promise + + + +
+
+ + + + + +
+ + + +
+
+

update(data [, options], finalCallback)

+ + +
+
+ + +
+

Update

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
data + + +Object + + + + + + + + + + +

json data

options + + +Object +| + +function + + + + + + + <optional>
+ + + + + +

update options

finalCallback + + +function + + + + + + + + + + +

(err, result)

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Undefined +| + +Promise + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/gen/Query.html b/docs/gen/Query.html index 54ca3e3..c6babf2 100644 --- a/docs/gen/Query.html +++ b/docs/gen/Query.html @@ -1,7232 +1,7232 @@ - - - - - - - Documentation Class: Query - - - - - - - - - - -
-
-
- Documentation - -
- - -
-
- - -
-
- - -
- -
- - -

Class: Query

-
- -
- -

- Query -

- - -
- - -
-
- - -
-
-

new Query()

- - -
-
- - -
-

Solr Query

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - -

Methods

- -
- -
-
-

addParams(params)

- - -
-
- - -
-

Add params

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -Array.<Object> - - - - - -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
field - - -String - - - - -

params field

value - - -String - - - - -

params value

- -
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

df(params)

- - -
-
- - -
-

Set the default query field.

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -String - - - - -

default field for search

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

dismax()

- - -
-
- - -
-

Set DisMax query parser

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

edismax()

- - -
-
- - -
-

Set eDisMax query parser

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

facetQuery(params)

- - -
-
- - -
-

Set facet query params

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -Object -| - -String - - - - -

facet object or facet string

-
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDefaultDescription
on - - -Boolean - - - - - - - <optional>
- - - - - - 		- - true - -

Turn on or off facet

query - - -String - - - - - - - <optional>
- - - - - - 		- -

Specifies a Lucene query to generate a facet count.

field - - -String -| - -Array - - - - - - - <optional>
- - - - - - 		- -

Identifies a field to be treated as a facet.

prefix - - -String - - - - - - - <optional>
- - - - - - 		- -

Limits the terms used for faceting to those that begin with the specified prefix.

contains - - -String - - - - - - - <optional>
- - - - - - 		- -

Limits the terms used for faceting to those that contain the specified substring.

containsIgnoreCase - - -String - - - - - - - <optional>
- - - - - - 		- -

If facet.contains is used, ignore case when searching for the specified substring.

sort - - -String - - - - - - - <optional>
- - - - - - 		- -

Controls how faceted results are sorted. (count|index)

limit - - -Number - - - - - - - <optional>
- - - - - - 		- -

Controls how many constraints should be returned for each facet.

offset - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies an offset into the facet results at which to begin displaying facets.

mincount - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies the minimum counts required for a facet field to be included in the response.

missing - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

Controls whether Solr should compute a count of all matching results which have no value for the field, in addition to the term-based constraints of a facet field.

method - - -String - - - - - - - <optional>
- - - - - - 		- -

Selects the algorithm or method Solr should use when faceting a field. (enum|fc|fcs)

- -
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

fl(params)

- - -
-
- - -
-

Set field params

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -String -| - -Array.<String> - - - - -

field name

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

fq(params)

- - -
-
- - -
-

Set filter query params

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -Object -| - -Array.<Object> - - - - -

filter options

-
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDescription
field - - -String - - - - - - - <optional>
- - - - - -

filter field

value - - -String -| - -Number - - - - - - - <optional>
- - - - - -

filter value

- -
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

groupQuery(params)

- - -
-
- - -
-

Set group query params

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -Object -| - -String - - - - -

group object or group string

-
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDefaultDescription
on - - -Boolean - - - - - - - <optional>
- - - - - - 		- - true - -

Turn on or off group

field - - -String - - - - - - - <optional>
- - - - - - 		- -

The name of the field by which to group results.

query - - -String - - - - - - - <optional>
- - - - - - 		- -

Return a single group of documents that match the given query.

limit - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies the number of results to return for each group. The default value is 1.

offset - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies an initial offset for the document list of each group.

sort - - -String - - - - - - - <optional>
- - - - - - 		- -

Specifies how Solr sorts documents within each group.

format - - -String - - - - - - - <optional>
- - - - - - 		- -

If this parameter is set to simple, the grouped documents are presented in a single flat list, and the start and rows parameters affect the numbers of documents instead of groups.

main - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple.

ngroups - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

If true, Solr includes the number of groups that have matched the query in the results. The default value is false.

truncate - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

If true, facet counts are based on the most relevant document of each group matching the query. The default value is false.

facet - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

Determines whether to compute grouped facets for the field facets specified in facet.field parameters.

cachePercent - - -Number - - - - - - - <optional>
- - - - - - 		- -

Determines whether to compute grouped facets for the field facets specified in facet.field parameters.

- -
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

hlQuery(params)

- - -
-
- - -
-

Set hl query params

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -Object -| - -String - - - - -

hl object or hl string

-
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDefaultDescription
on - - -Boolean - - - - - - - <optional>
- - - - - - 		- - true - -

Turn on or off hl

q - - -String - - - - - - - <optional>
- - - - - - 		- -

Specifies an overriding query term for highlighting

qparser - - -String - - - - - - - <optional>
- - - - - - 		- -

Specifies a qparser to use for the hl.q query.

fl - - -String -| - -Array - - - - - - - <optional>
- - - - - - 		- -

Specifies a list of fields to highlight.

snippets - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies maximum number of highlighted snippets to generate per field.

fragsize - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies the size, in characters, of fragments to consider for highlighting.

mergeContiguous - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

Instructs Solr to collapse contiguous fragments into a single fragment.

requireFieldMatch - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

If set to true, highlights terms only if they appear in the specified field.

maxAnalyzedChars - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies the number of characters into a document that Solr should look for suitable snippets.

maxMultiValuedToExamine - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies the maximum number of entries in a multi-valued field to examine before stopping.

maxMultiValuedToMatch - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies the maximum number of matches in a multi-valued field that are found before stopping.

alternateField - - -String - - - - - - - <optional>
- - - - - - 		- -

Specifies a field to be used as a backup default summary if Solr cannot generate a snippet (i.e., because no terms match).

maxAlternateFieldLength - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies the maximum number of characters of the field to return.

formatter - - -String - - - - - - - <optional>
- - - - - - 		- - simple - -

Selects a formatter for the highlighted output.

simplePre - - -String - - - - - - - <optional>
- - - - - - 		- -

Specifies the text that should appear before. ()

simplePost - - -String - - - - - - - <optional>
- - - - - - 		- -

Specifies the text that should appear after. ()

fragmenter - - -String - - - - - - - <optional>
- - - - - - 		- -

Specifies a text snippet generator for highlighted text.

usePhraseHighlighter - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

If set to true, Solr will use the Lucene SpanScorer class to highlight phrase terms only when they appear within the query phrase in the document.

highlightMultiTerm - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

If set to true, Solr will use highlight phrase terms that appear in multi-term queries.

regexSlop - - -Number - - - - - - - <optional>
- - - - - - 		- -

When using the regex fragmenter (hl.fragmenter =regex), this parameter defines the factor by which the fragmenter can stray from the ideal fragment size (given by hl.fragsize) to accommodate a regular expression.

regexPattern - - -String - - - - - - - <optional>
- - - - - - 		- -

Specifies the regular expression for fragmenting. This could be used to extract sentences.

regexMaxAnalyzedChars - - -Number - - - - - - - <optional>
- - - - - - 		- -

Instructs Solr to analyze only this many characters from a field when using the regex fragmenter (after which, the fragmenter produces fixed-sized fragments).

preserveMulti - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

If true, multi-valued fields will return all values in the order they were saved in the index. If false, only values that match the highlight request will be returned.

- -
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

mltQuery(params)

- - -
-
- - -
-

Set mlt query params

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -Object -| - -String - - - - -

mlt object or mlt string

-
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDefaultDescription
on - - -Boolean - - - - - - - <optional>
- - - - - - 		- - true - -

Turn on or off mlt

fl - - -String -| - -Array - - - - - - - <optional>
- - - - - - 		- -

Specifies the fields to use for similarity. If possible, these should have stored termVectors.

mintf - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies the Minimum Term Frequency, the frequency below which terms will be ignored in the source document.

mindf - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies the Minimum Document Frequency, the frequency at which words will be ignored which do not occur in at least this many documents.

maxdf - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies the Maximum Document Frequency, the frequency at which words will be ignored which occur in more than this many documents.

minwl - - -Number - - - - - - - <optional>
- - - - - - 		- -

Sets the minimum word length below which words will be ignored.

maxwl - - -Number - - - - - - - <optional>
- - - - - - 		- -

Sets the maximum word length above which words will be ignored.

maxqt - - -Number - - - - - - - <optional>
- - - - - - 		- -

Sets the maximum number of query terms that will be included in any generated query.

maxntp - - -Number - - - - - - - <optional>
- - - - - - 		- -

Sets the maximum number of tokens to parse in each example document field that is not stored with TermVector support.

boost - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

Specifies if the query will be boosted by the interesting term relevance. It can be either "true" or "false".

qf - - -String - - - - - - - <optional>
- - - - - - 		- -

Query fields and their boosts using the same format as that used by the DisMaxRequestHandler. These fields must also be specified in mlt.fl.

count - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies the number of similar documents to be returned for each result. The default value is 5.

matchInclude - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

Specifies whether or not the response should include the matched document. If set to false, the response will look like a normal select response.

matchOffset - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies an offset into the main query search results to locate the document on which the MoreLikeThis query should operate. By default, the query operates on the first result for the q parameter.

interestingTerms - - -String - - - - - - - <optional>
- - - - - - 		- -

Controls how the MoreLikeThis component presents the "interesting" terms (the top TF/IDF terms) for the query. ("list"|"details"|"none")

- -
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

q(params)

- - -
-
- - -
-

Set query params

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -Object -| - -String - - - - -

query object or query string

-
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDescription
str - - -String - - - - - - - <optional>
- - - - - -

native str query ( ex) '(name:test OR category:test)' )

- -
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

qop(params)

- - -
-
- - -
-

Set default query operator

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -String - - - - -

default operator('AND'|'OR')

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

rows(params)

- - -
-
- - -
-

Set rows params

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -Number - - - - -

size number

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

sort(params)

- - -
-
- - -
-

Set sort params

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -Object - - - - -

sort options

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

spatial(params)

- - -
-
- - -
-

Spatial

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -Array.<Object> - - - - - -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
pt - - -String - - - - -

params pt

sfield - - -String - - - - -

params sfield

d - - -String - - - - -

params d

- -
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

spellcheckQuery(params)

- - -
-
- - -
-

Set spellcheck query params

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -Object -| - -String - - - - -

spell object or spell string

-
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDefaultDescription
on - - -Boolean - - - - - - - <optional>
- - - - - - 		- - true - -

Turn on or off spell

q - - -String - - - - - - - <optional>
- - - - - - 		- -

Selects the query to be spellchecked.

build - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

Instructs Solr to build a dictionary for use in spellchecking.

collate - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

Causes Solr to build a new query based on the best suggestion for each term in the submitted query.

maxCollations - - -Number - - - - - - - <optional>
- - - - - - 		- -

This parameter specifies the maximum number of collations to return.

maxCollationTries - - -Number - - - - - - - <optional>
- - - - - - 		- -

This parameter specifies the number of collation possibilities for Solr to try before giving up.

maxCollationEvaluations - - -Number - - - - - - - <optional>
- - - - - - 		- -

This parameter specifies the maximum number of word correction combinations to rank and evaluate prior to deciding which collation candidates to test against the index.

collateExtendedResults - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

If true, returns an expanded response detailing the collations found. If s pellcheck.collate is false, this parameter will be ignored.

collateMaxCollectDocs - - -Number - - - - - - - <optional>
- - - - - - 		- -

The maximum number of documents to collect when testing potential Collations

count - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies the maximum number of spelling suggestions to be returned.

dictionary - - -String - - - - - - - <optional>
- - - - - - 		- -

Specifies the dictionary that should be used for spellchecking.

extendedResults - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

Causes Solr to return additional information about spellcheck results, such as the frequency of each original term in the index (origFreq) as well as the frequency of each suggestion in the index (frequency).

onlyMorePopular - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

Limits spellcheck responses to queries that are more popular than the original query.

maxResultsForSuggest - - -Number - - - - - - - <optional>
- - - - - - 		- -

The maximum number of hits the request can return in order to both generate spelling suggestions and set the "correctlySpelled" element to "false".

alternativeTermCount - - -Number - - - - - - - <optional>
- - - - - - 		- -

The count of suggestions to return for each query term existing in the index and/or dictionary.

reload - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

Reloads the spellchecker.

accuracy - - -Number - - - - - - - <optional>
- - - - - - 		- -

Specifies an accuracy value to help decide whether a result is worthwhile. The value is a float between 0 and 1.

- -
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

start(params)

- - -
-
- - -
-

Set start params

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -Number - - - - -

offset number

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

termsQuery(params)

- - -
-
- - -
-

Set terms query params

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -Object -| - -String - - - - -

terms object or terms string

-
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDefaultDescription
on - - -Boolean - - - - - - - <optional>
- - - - - - 		- - true - -

Turn on or off terms

fl - - -String - - - - - - - - - - - - -

The name of the field to get the terms from.

lower - - -String - - - - - - - <optional>
- - - - - - 		- -

The term to start at. If not specified, the empty string is used, meaning start at the beginning of the field.

lowerIncl - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

The term to start at. Include the lower bound term in the result set. Default is true.

mincount - - -Number - - - - - - - <optional>
- - - - - - 		- -

The minimum doc frequency to return in order to be included.

maxcount - - -Number - - - - - - - <optional>
- - - - - - 		- -

The maximum doc frequency.

prefix - - -String - - - - - - - <optional>
- - - - - - 		- -

Restrict matches to terms that start with the prefix.

regex - - -String - - - - - - - <optional>
- - - - - - 		- -

Restrict matches to terms that match the regular expression.

regexFlag - - -String - - - - - - - <optional>
- - - - - - 		- -

Flags to be used when evaluating the regular expression defined in the "terms.regex" parameter.(case_insensitive|comments|multiline|literal|dotall|unicode_case|canon_eq|unix_lines)

limit - - -Number - - - - - - - <optional>
- - - - - - 		- -

The maximum number of terms to return.

upper - - -String - - - - - - - <optional>
- - - - - - 		- -

The term to stop at. Either upper or terms.limit must be set.

upperIncl - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

Include the upper bound term in the result set. Default is false.

raw - - -Boolean - - - - - - - <optional>
- - - - - - 		- -

If true, return the raw characters of the indexed term, regardless of if it is human readable.

sort - - -String - - - - - - - <optional>
- - - - - - 		- -

If count, sorts the terms by the term frequency (highest count first). If index, returns the terms in index order.(count|index)

- -
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- - - -
-
-

toString()

- - -
-
- - -
-

Make query to string

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -String - - - -
-
- - - - - -
- - - -
-
-

wt(params)

- - -
-
- - -
-

Set the response type.

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
params - - -String - - - - -

response type (json|xml)

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Query - - - -
-
- - - - - -
- -
- - - - - -
- -
- - - - -
-
- -
- - -
- -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + Documentation Class: Query + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: Query

+
+ +
+ +

+ Query +

+ + +
+ + +
+
+ + +
+
+

new Query()

+ + +
+
+ + +
+

Solr Query

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

addParams(params)

+ + +
+
+ + +
+

Add params

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Array.<Object> + + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
field + + +String + + + + +

params field

value + + +String + + + + +

params value

+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

df(params)

+ + +
+
+ + +
+

Set the default query field.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +String + + + + +

default field for search

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

dismax()

+ + +
+
+ + +
+

Set DisMax query parser

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

edismax()

+ + +
+
+ + +
+

Set eDisMax query parser

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

facetQuery(params)

+ + +
+
+ + +
+

Set facet query params

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Object +| + +String + + + + +

facet object or facet string

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
on + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ + true + +

Turn on or off facet

query + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Specifies a Lucene query to generate a facet count.

field + + +String +| + +Array + + + + + + + <optional>
+ + + + + + 		+ +

Identifies a field to be treated as a facet.

prefix + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Limits the terms used for faceting to those that begin with the specified prefix.

contains + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Limits the terms used for faceting to those that contain the specified substring.

containsIgnoreCase + + +String + + + + + + + <optional>
+ + + + + + 		+ +

If facet.contains is used, ignore case when searching for the specified substring.

sort + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Controls how faceted results are sorted. (count|index)

limit + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Controls how many constraints should be returned for each facet.

offset + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies an offset into the facet results at which to begin displaying facets.

mincount + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the minimum counts required for a facet field to be included in the response.

missing + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

Controls whether Solr should compute a count of all matching results which have no value for the field, in addition to the term-based constraints of a facet field.

method + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Selects the algorithm or method Solr should use when faceting a field. (enum|fc|fcs)

+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

fl(params)

+ + +
+
+ + +
+

Set field params

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +String +| + +Array.<String> + + + + +

field name

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

fq(params)

+ + +
+
+ + +
+

Set filter query params

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Object +| + +Array.<Object> + + + + +

filter options

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
field + + +String + + + + + + + <optional>
+ + + + + +

filter field

value + + +String +| + +Number + + + + + + + <optional>
+ + + + + +

filter value

+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

groupQuery(params)

+ + +
+
+ + +
+

Set group query params

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Object +| + +String + + + + +

group object or group string

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
on + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ + true + +

Turn on or off group

field + + +String + + + + + + + <optional>
+ + + + + + 		+ +

The name of the field by which to group results.

query + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Return a single group of documents that match the given query.

limit + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the number of results to return for each group. The default value is 1.

offset + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies an initial offset for the document list of each group.

sort + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Specifies how Solr sorts documents within each group.

format + + +String + + + + + + + <optional>
+ + + + + + 		+ +

If this parameter is set to simple, the grouped documents are presented in a single flat list, and the start and rows parameters affect the numbers of documents instead of groups.

main + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple.

ngroups + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

If true, Solr includes the number of groups that have matched the query in the results. The default value is false.

truncate + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

If true, facet counts are based on the most relevant document of each group matching the query. The default value is false.

facet + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

Determines whether to compute grouped facets for the field facets specified in facet.field parameters.

cachePercent + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Determines whether to compute grouped facets for the field facets specified in facet.field parameters.

+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

hlQuery(params)

+ + +
+
+ + +
+

Set hl query params

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Object +| + +String + + + + +

hl object or hl string

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
on + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ + true + +

Turn on or off hl

q + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Specifies an overriding query term for highlighting

qparser + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Specifies a qparser to use for the hl.q query.

fl + + +String +| + +Array + + + + + + + <optional>
+ + + + + + 		+ +

Specifies a list of fields to highlight.

snippets + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies maximum number of highlighted snippets to generate per field.

fragsize + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the size, in characters, of fragments to consider for highlighting.

mergeContiguous + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

Instructs Solr to collapse contiguous fragments into a single fragment.

requireFieldMatch + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

If set to true, highlights terms only if they appear in the specified field.

maxAnalyzedChars + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the number of characters into a document that Solr should look for suitable snippets.

maxMultiValuedToExamine + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the maximum number of entries in a multi-valued field to examine before stopping.

maxMultiValuedToMatch + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the maximum number of matches in a multi-valued field that are found before stopping.

alternateField + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Specifies a field to be used as a backup default summary if Solr cannot generate a snippet (i.e., because no terms match).

maxAlternateFieldLength + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the maximum number of characters of the field to return.

formatter + + +String + + + + + + + <optional>
+ + + + + + 		+ + simple + +

Selects a formatter for the highlighted output.

simplePre + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the text that should appear before. ()

simplePost + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the text that should appear after. ()

fragmenter + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Specifies a text snippet generator for highlighted text.

usePhraseHighlighter + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

If set to true, Solr will use the Lucene SpanScorer class to highlight phrase terms only when they appear within the query phrase in the document.

highlightMultiTerm + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

If set to true, Solr will use highlight phrase terms that appear in multi-term queries.

regexSlop + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

When using the regex fragmenter (hl.fragmenter =regex), this parameter defines the factor by which the fragmenter can stray from the ideal fragment size (given by hl.fragsize) to accommodate a regular expression.

regexPattern + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the regular expression for fragmenting. This could be used to extract sentences.

regexMaxAnalyzedChars + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Instructs Solr to analyze only this many characters from a field when using the regex fragmenter (after which, the fragmenter produces fixed-sized fragments).

preserveMulti + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

If true, multi-valued fields will return all values in the order they were saved in the index. If false, only values that match the highlight request will be returned.

+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

mltQuery(params)

+ + +
+
+ + +
+

Set mlt query params

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Object +| + +String + + + + +

mlt object or mlt string

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
on + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ + true + +

Turn on or off mlt

fl + + +String +| + +Array + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the fields to use for similarity. If possible, these should have stored termVectors.

mintf + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the Minimum Term Frequency, the frequency below which terms will be ignored in the source document.

mindf + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the Minimum Document Frequency, the frequency at which words will be ignored which do not occur in at least this many documents.

maxdf + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the Maximum Document Frequency, the frequency at which words will be ignored which occur in more than this many documents.

minwl + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Sets the minimum word length below which words will be ignored.

maxwl + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Sets the maximum word length above which words will be ignored.

maxqt + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Sets the maximum number of query terms that will be included in any generated query.

maxntp + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Sets the maximum number of tokens to parse in each example document field that is not stored with TermVector support.

boost + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

Specifies if the query will be boosted by the interesting term relevance. It can be either "true" or "false".

qf + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Query fields and their boosts using the same format as that used by the DisMaxRequestHandler. These fields must also be specified in mlt.fl.

count + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the number of similar documents to be returned for each result. The default value is 5.

matchInclude + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

Specifies whether or not the response should include the matched document. If set to false, the response will look like a normal select response.

matchOffset + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies an offset into the main query search results to locate the document on which the MoreLikeThis query should operate. By default, the query operates on the first result for the q parameter.

interestingTerms + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Controls how the MoreLikeThis component presents the "interesting" terms (the top TF/IDF terms) for the query. ("list"|"details"|"none")

+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

q(params)

+ + +
+
+ + +
+

Set query params

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Object +| + +String + + + + +

query object or query string

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
str + + +String + + + + + + + <optional>
+ + + + + +

native str query ( ex) '(name:test OR category:test)' )

+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

qop(params)

+ + +
+
+ + +
+

Set default query operator

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +String + + + + +

default operator('AND'|'OR')

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

rows(params)

+ + +
+
+ + +
+

Set rows params

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Number + + + + +

size number

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

sort(params)

+ + +
+
+ + +
+

Set sort params

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Object + + + + +

sort options

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

spatial(params)

+ + +
+
+ + +
+

Spatial

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Array.<Object> + + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
pt + + +String + + + + +

params pt

sfield + + +String + + + + +

params sfield

d + + +String + + + + +

params d

+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

spellcheckQuery(params)

+ + +
+
+ + +
+

Set spellcheck query params

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Object +| + +String + + + + +

spell object or spell string

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
on + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ + true + +

Turn on or off spell

q + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Selects the query to be spellchecked.

build + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

Instructs Solr to build a dictionary for use in spellchecking.

collate + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

Causes Solr to build a new query based on the best suggestion for each term in the submitted query.

maxCollations + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

This parameter specifies the maximum number of collations to return.

maxCollationTries + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

This parameter specifies the number of collation possibilities for Solr to try before giving up.

maxCollationEvaluations + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

This parameter specifies the maximum number of word correction combinations to rank and evaluate prior to deciding which collation candidates to test against the index.

collateExtendedResults + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

If true, returns an expanded response detailing the collations found. If s pellcheck.collate is false, this parameter will be ignored.

collateMaxCollectDocs + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

The maximum number of documents to collect when testing potential Collations

count + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the maximum number of spelling suggestions to be returned.

dictionary + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Specifies the dictionary that should be used for spellchecking.

extendedResults + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

Causes Solr to return additional information about spellcheck results, such as the frequency of each original term in the index (origFreq) as well as the frequency of each suggestion in the index (frequency).

onlyMorePopular + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

Limits spellcheck responses to queries that are more popular than the original query.

maxResultsForSuggest + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

The maximum number of hits the request can return in order to both generate spelling suggestions and set the "correctlySpelled" element to "false".

alternativeTermCount + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

The count of suggestions to return for each query term existing in the index and/or dictionary.

reload + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

Reloads the spellchecker.

accuracy + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

Specifies an accuracy value to help decide whether a result is worthwhile. The value is a float between 0 and 1.

+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

start(params)

+ + +
+
+ + +
+

Set start params

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Number + + + + +

offset number

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

termsQuery(params)

+ + +
+
+ + +
+

Set terms query params

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Object +| + +String + + + + +

terms object or terms string

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
on + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ + true + +

Turn on or off terms

fl + + +String + + + + + + + + + + + + +

The name of the field to get the terms from.

lower + + +String + + + + + + + <optional>
+ + + + + + 		+ +

The term to start at. If not specified, the empty string is used, meaning start at the beginning of the field.

lowerIncl + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

The term to start at. Include the lower bound term in the result set. Default is true.

mincount + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

The minimum doc frequency to return in order to be included.

maxcount + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

The maximum doc frequency.

prefix + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Restrict matches to terms that start with the prefix.

regex + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Restrict matches to terms that match the regular expression.

regexFlag + + +String + + + + + + + <optional>
+ + + + + + 		+ +

Flags to be used when evaluating the regular expression defined in the "terms.regex" parameter.(case_insensitive|comments|multiline|literal|dotall|unicode_case|canon_eq|unix_lines)

limit + + +Number + + + + + + + <optional>
+ + + + + + 		+ +

The maximum number of terms to return.

upper + + +String + + + + + + + <optional>
+ + + + + + 		+ +

The term to stop at. Either upper or terms.limit must be set.

upperIncl + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

Include the upper bound term in the result set. Default is false.

raw + + +Boolean + + + + + + + <optional>
+ + + + + + 		+ +

If true, return the raw characters of the indexed term, regardless of if it is human readable.

sort + + +String + + + + + + + <optional>
+ + + + + + 		+ +

If count, sorts the terms by the term frequency (highest count first). If index, returns the terms in index order.(count|index)

+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ + + +
+
+

toString()

+ + +
+
+ + +
+

Make query to string

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +String + + + +
+
+ + + + + +
+ + + +
+
+

wt(params)

+ + +
+
+ + +
+

Set the response type.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +String + + + + +

response type (json|xml)

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Query + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/gen/classes.list.html b/docs/gen/classes.list.html index de35d95..1822a1c 100644 --- a/docs/gen/classes.list.html +++ b/docs/gen/classes.list.html @@ -1,299 +1,299 @@ - - - - - - - Documentation Classes - - - - - - - - - - -
-
-
- Documentation - -
- - -
-
- - -
-
- - -
- -
- - -

Classes

-
- -
- -

- -

- - -
- - -
-
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -

Classes

- -
-
Client
-
- -
Query
-
-
- - - - - - - - - - - - - -
- -
- - - - -
-
- -
- - -
- -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + Documentation Classes + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Classes

+
+ +
+ +

+ +

+ + +
+ + +
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +

Classes

+ +
+
Client
+
+ +
Query
+
+
+ + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/gen/fonts/glyphicons-halflings-regular.svg b/docs/gen/fonts/glyphicons-halflings-regular.svg index 94fb549..8376c0f 100644 --- a/docs/gen/fonts/glyphicons-halflings-regular.svg +++ b/docs/gen/fonts/glyphicons-halflings-regular.svg @@ -1,288 +1,288 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/gen/global.html b/docs/gen/global.html index a0b39cb..19afbde 100644 --- a/docs/gen/global.html +++ b/docs/gen/global.html @@ -1,413 +1,413 @@ - - - - - - - Documentation Global - - - - - - - - - - -
-
-
- Documentation - -
- - -
-
- - -
-
- - -
- -
- - -

Global

-
- -
- -

- -

- - -
- - -
-
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - - - - - - - -

Members

- -
- -
-
-

_

- - -
-
- -
-

Require modules

-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - -
-
-

_

- - -
-
- -
-

Require modules

-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- -
- - - - - - - -
- -
- - - - -
-
- -
- - -
- -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + Documentation Global + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Global

+
+ +
+ +

+ +

+ + +
+ + +
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + +

Members

+ +
+ +
+
+

_

+ + +
+
+ +
+

Require modules

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

_

+ + +
+
+ +
+

Require modules

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
+ + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/gen/index.html b/docs/gen/index.html index 75fc4be..1a9ce8e 100644 --- a/docs/gen/index.html +++ b/docs/gen/index.html @@ -1,229 +1,229 @@ - - - - - - - Documentation Index - - - - - - - - - - -
-
-
- Documentation - -
- - -
-
- - -
-
- - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
- - -
- -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + Documentation Index + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/gen/quicksearch.html b/docs/gen/quicksearch.html index 2d8934f..5f7f0b8 100644 --- a/docs/gen/quicksearch.html +++ b/docs/gen/quicksearch.html @@ -1,31 +1,31 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + diff --git a/docs/gen/scripts/docstrap.lib.js b/docs/gen/scripts/docstrap.lib.js index 09d9272..ad2900a 100644 --- a/docs/gen/scripts/docstrap.lib.js +++ b/docs/gen/scripts/docstrap.lib.js @@ -1,11 +1,11 @@ -if(!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){function c(a){var b="length"in a&&a.length,c=_.type(a);return"function"!==c&&!_.isWindow(a)&&(!(1!==a.nodeType||!b)||("array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a))}function d(a,b,c){if(_.isFunction(b))return _.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return _.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(ha.test(b))return _.filter(b,a,c);b=_.filter(b,a)}return _.grep(a,function(a){return U.call(b,a)>=0!==c})}function e(a,b){for(;(a=a[b])&&1!==a.nodeType;);return a}function f(a){var b=oa[a]={};return _.each(a.match(na)||[],function(a,c){b[c]=!0}),b}function g(){Z.removeEventListener("DOMContentLoaded",g,!1),a.removeEventListener("load",g,!1),_.ready()}function h(){Object.defineProperty(this.cache={},0,{get:function(){return{}}}),this.expando=_.expando+h.uid++}function i(a,b,c){var d;if(void 0===c&&1===a.nodeType)if(d="data-"+b.replace(ua,"-$1").toLowerCase(),c=a.getAttribute(d),"string"==typeof c){try{c="true"===c||"false"!==c&&("null"===c?null:+c+""===c?+c:ta.test(c)?_.parseJSON(c):c)}catch(a){}sa.set(a,b,c)}else c=void 0;return c}function j(){return!0}function k(){return!1}function l(){try{return Z.activeElement}catch(a){}}function m(a,b){return _.nodeName(a,"table")&&_.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function n(a){return a.type=(null!==a.getAttribute("type"))+"/"+a.type,a}function o(a){var b=Ka.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function p(a,b){for(var c=0,d=a.length;d>c;c++)ra.set(a[c],"globalEval",!b||ra.get(b[c],"globalEval"))}function q(a,b){var c,d,e,f,g,h,i,j;if(1===b.nodeType){if(ra.hasData(a)&&(f=ra.access(a),g=ra.set(b,f),j=f.events)){delete g.handle,g.events={};for(e in j)for(c=0,d=j[e].length;d>c;c++)_.event.add(b,e,j[e][c])}sa.hasData(a)&&(h=sa.access(a),i=_.extend({},h),sa.set(b,i))}}function r(a,b){var c=a.getElementsByTagName?a.getElementsByTagName(b||"*"):a.querySelectorAll?a.querySelectorAll(b||"*"):[];return void 0===b||b&&_.nodeName(a,b)?_.merge([a],c):c}function s(a,b){var c=b.nodeName.toLowerCase();"input"===c&&ya.test(a.type)?b.checked=a.checked:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}function t(b,c){var d,e=_(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:_.css(e[0],"display");return e.detach(),f}function u(a){var b=Z,c=Oa[a];return c||(c=t(a,b),"none"!==c&&c||(Na=(Na||_("