https://github.com/plotlabs/esgetfamily-node
Get parent and children documents from Elasticsearch using a single query.
https://github.com/plotlabs/esgetfamily-node
elasticsearch nodejs npm-package
Last synced: 12 months ago
JSON representation
Get parent and children documents from Elasticsearch using a single query.
- Host: GitHub
- URL: https://github.com/plotlabs/esgetfamily-node
- Owner: plotlabs
- License: mit
- Created: 2018-04-25T08:29:54.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-28T08:29:36.000Z (almost 8 years ago)
- Last Synced: 2025-04-10T12:56:13.233Z (12 months ago)
- Topics: elasticsearch, nodejs, npm-package
- Language: JavaScript
- Homepage: https://www.plotlabs.io
- Size: 25.4 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Elasticsearch: Get Family - Node.js
[](https://github.com/plotlabs/esgetfamily-node/blob/master/LICENSE.txt) [](https://travis-ci.org/plotlabs/esgetfamily-node) [](https://www.codefactor.io/repository/github/plotlabs/esgetfamily-node) [](https://www.plotlabs.io/) [](https://www.npmjs.com/package/esgetfamily)
The following library helps you get a unified result with parents having result of children in a **single result** with scroll and custom query.
# Installation
```console
npm install esgetfamily --save
npm install esgetfamily
```
## Using in node.js
```js
var esgetfamily = require('esgetfamily');
esgetfamily(
'http://localhost:9200',
{
index: 'es-getfamilytest',
parent_type: 'parent',
child_type: 'child'
},
[
{
_index: 'es-getfamilytest',
_type: 'parent',
_id: '1',
_score: 1,
_source: {
id: 1,
no_employee: 23,
company: 'Plotlabs'
}
}
],
[
{
match: {
employee_name: 'employee 1'
}
}
],
function(error, result) {
// Do something here.
}
);
```
## Arguments
The function takes following arguments and in the following order
```js
esgetfamily(
< URL >,
< connection parameters>,
< data >,
< filter >,
function(error, result){
// Do something here.
}
);
```
* **URL**: Mention the URL of either localhost or remote server
* **connection parameters**: The argument has three parts `{ index: "name of the index", parent_type: "name of the parent type", children_type: "name of the children type" }`
* **data**: pass any data array of parent object/objects. '\_id' in each object is essential for it to parse it's child
* **filter**: you can pass any valid query object for eg. `[{match: { "employee_name":"employee 1" }}]`
* **callback**: simple callback function with error as first argument
## Result
The result are in the form:
```json
[
{
"_index": "es-getfamilytest",
"_type": "parent",
"_id": "1",
"_score": 1,
"_source": { "id": 1, "no_employee": 23, "company": "Plotlabs" },
"children": [
{
"_index": "es-getfamilytest",
"_type": "child",
"_id": "1",
"_score": 1,
"_routing": "1",
"_parent": "1",
"_source": { "id": 1, "name": "employee1" }
}
]
}
]
```