node-manticoresearch/README.md

Simple, Light, Promise

This is a Node.js client for [ManticoreSearch](https://manticoresearch.com). 
It is written in JavaScript, does not require compiling, and is 100% MIT licensed.


```javascript
const manticoresearch = require('node-manticoresearch');

const ms = manticoresearch(); // default (localhost)
const ms = manticoresearch(9308, '100.100.100.100'); // custom

//---]>
// return { data: ..., response: ... }
```


SQL SELECT query via HTTP JSON interface:
```javascript
const raw = false; // default
const r = await ms.sql(`SELECT * FROM items`, raw);

console.log(r.data);
```
- HINT: simple SQL escape - [sqlstring](https://www.npmjs.com/package/sqlstring)


Bulk:
```javascript
const r = await ms
    .insert('items')
    .bulk([
        // switch 'insert' to 'update'
        // { id: 0, action: 'update', doc: { title: 'Hello #1' }},

        { doc: { a: 1, b: 2, title: 'Hello #1' }},
        { doc: { a: 1, b: 2, title: 'World #1' }},
        { id: 1, doc: { a: 3, b: 4, title: 'Qwerty #1' }}
    ]);

console.log(r.data?.items);
```


Search:
```javascript
const r = await ms
    .search('items')
    .pagination(1, 3) // .limit(size).offset(page * size)
    .query({ match: { title: 'world' } });

console.log(r.data?.hits);
```


Nested bool query:
```javascript
const r = await ms
    .search('items')
    .query((q) => q.and([
        q.is('a', 1),
        q.or([
            q.is('a', 1),
            q.is('b', 2)
        ]),
        q.match('title', 'world')
    ]));

console.log(r.data?.hits);

// SELECT * FROM items
// WHERE a = 1 and (a = 1 or b = 2) and MATCH('@title world')
```

Nested bool query (short):
```javascript
const r = await ms
    .search('items')
    .query(_ => _.and(
        ['a', 0],
        _.or(['a', 1], ['b', 2]),
        _.match('title', 'world')
    ));


console.log(r.data?.hits);

// SELECT * FROM items
// WHERE a = 1 and (a = 1 or b = 2) and MATCH('@title world')
```

Delete by Id:
```javascript
const r = await ms
    .delete('items')
    .call('9865535'); // number, string, bigInt

console.log(r.data);
```


Delete by Query:
```javascript
const r = await ms
    .delete('items')
    .query({ match: { title: 'hello' } });

console.log(r.data);
```

Delete all:
```javascript
const r = await ms
    .delete('items')
    .call();

console.log(r.data);
```

Insert:
```javascript
const id = 0; // auto
const r = await ms
    .insert('items')
    .call(id, { doc: { a: 4, b: 4, title: 'hi #1' }});

console.log(r.data);
```


## License

MIT