https://github.com/beameryedge/querycraft-to-elasticsearch

Converts a QueryCraft Filter Builder object into an Elasticsearch query
https://github.com/beameryedge/querycraft-to-elasticsearch

elasticsearch querycraft querycraft-filter-builder

Last synced: 5 months ago
JSON representation

Converts a QueryCraft Filter Builder object into an Elasticsearch query

• Host: GitHub
• URL: https://github.com/beameryedge/querycraft-to-elasticsearch
• Owner: BeameryEdge
• License: mit
• Created: 2017-12-05T11:36:56.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-05T16:57:41.000Z (10 months ago)
• Last Synced: 2025-01-04T05:20:59.844Z (6 months ago)
• Topics: elasticsearch, querycraft, querycraft-filter-builder
• Language: TypeScript
• Size: 81.1 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# QueryCraft-To-Elasticsearch

Converts a [QueryCraft](https://github.com/BeameryHQ/QueryCraft) Filter Builder object into the body of an Elasticsearch query.

[![NPM](https://nodei.co/npm/querycraft-to-elasticsearch.png)](https://npmjs.org/package/querycraft-to-elasticsearch)

[![npm version](https://badge.fury.io/js/querycraft-to-elasticsearch.svg)](https://badge.fury.io/js/querycraft-to-elasticsearch)

[![CircleCI](https://circleci.com/gh/BeameryHQ/QueryCraft-To-Elasticsearch.svg?style=shield)](https://circleci.com/gh/BeameryHQ/QueryCraft-To-Elasticsearch)

[![codecov](https://codecov.io/gh/BeameryHQ/QueryCraft-To-Elasticsearch/branch/master/graph/badge.svg)](https://codecov.io/gh/BeameryHQ/QueryCraft-To-Elasticsearch)

[![David deps](https://david-dm.org/BeameryHQ/QueryCraft-To-Elasticsearch.svg)](https://david-dm.org/BeameryHQ/QueryCraft-To-Elasticsearch)

[![Known Vulnerabilities](https://snyk.io/test/github/beameryhq/querycraft-to-elasticsearch/badge.svg)](https://snyk.io/test/github/beameryhq/querycraft-to-elasticsearch)

## Installation

```sh

npm install --save 'querycraft-to-elasticsearch'

```

## Examples

Suppose we have a collection of data that satisfies the interface

```ts

interface Contact {

    id: string

    'list': { id: string }[]

    firstName: string

    lastName: string

    email: string

    createdAt: Date

    customFields: { id: string, value: number }[]

    assignedTo?: string

}

```

If we want a query the describes the logic:-

```

    first 50 items where

        fistName is bob

        lastName is doyle OR is not set

        assignedTo is anything

        list has an item where id is item1

    sorted (in ascending order) by the value property of the customField where id is custom1

    created less than 5 days ago

```

We can build build it as easily as:-

```ts

import { FilterBuilder, eq, lt, neq, any, find, where } from 'querycraft'

import toElastic from 'querycraft-to-elasticsearch'

import { Client } from 'elasticsearch'

const client = new Client({ host: 'http://localhost:9200/'})

        

async function getContacts(filter: FilterBuilder){

    const result = await client.search({

        explain: true,

        index: testIndexName,

        body: toElastic(filter, fieldIdMapFn)

    })

    return  result.hits.hits.map(prop('_source')) as Contact[]

    // -> filtered list of contacts

}

const filter = new FilterBuilder()

.where('firstName', eq('bob'))

.where('list', find(where('id', eq('item1'))))

.where('lastName', any([

    eq('doyle'),

    eq(null)

]))

.where('createdAt', lt({ daysAgo: 5 }))

.where('assignedTo', neq(null))

.setSortFieldId('customFields', 'custom1', 'value')

.setSortDirection('ASC')

.setLimit(50)

getContacts(filter)

.then(console.log)

// -> filtered list of contacts

```