Installation
You can install Lyra using npm, yarn, pnpm:
npm i @nearform/lyra
yarn add @nearform/lyra
pnpm add @nearform/lyra
Usage
Lyra is quite simple to use. The first thing to do is to create a new database instance and set an indexing schema:
import { Lyra } from '@nearform/lyra';
const db = new Lyra({
schema: {
author: 'string',
quote: 'string'
}
});
Lyra will only index string properties, but will allow you to set and store additional data if needed.
Once the db instance is created, you can start adding some documents:
await db.insert({
quote: 'It is during our darkest moments that we must focus to see the light.',
author: 'Aristotle'
});
await db.insert({
quote: 'If you really look closely, most overnight successes took a long time.',
author: 'Steve Jobs'
});
await db.insert({
quote: 'If you are not willing to risk the usual, you will have to settle for the ordinary.',
author: 'Jim Rohn'
});
await db.insert({
quote: 'You miss 100% of the shots you don\'t take',
author: 'Wayne Gretzky - Michael Scott'
});
After the data has been inserted, you can finally start to query the database.
const searchResult = await db.search({
term: 'if',
properties: '*'
});
In the case above, you will be searching for all the documents containing the word if, looking up in every schema property (AKA index):
{
elapsed: '99μs',
hits: [
{
id: 'ckAOPGTA5qLXx0MgNr1Zy',
quote: 'If you really look closely, most overnight successes took a long time.',
author: 'Steve Jobs'
},
{
id: 'fyl-_1veP78IO-wszP86Z',
quote: 'If you are not willing to risk the usual, you will have to settle for the ordinary.',
author: 'Jim Rohn'
}
],
count: 2
}
You can also restrict the lookup to a specific property:
const searchResult = await db.search({
term: 'Michael',
properties: ['author']
});
Result:
{
elapsed: '111μs',
hits: [
{
id: 'L1tpqQxc0c2djrSN2a6TJ',
quote: "You miss 100% of the shots you don't take",
author: 'Wayne Gretzky - Michael Scott'
}
],
count: 1
}
If needed, you can also delete a given document by using the delete method:
await db.delete('L1tpqQxc0c2djrSN2a6TJ');
License
Lyra is licensed under the Apache 2.0 license.
![[new language support] Apply a PR for chinese language support](https://avatars.githubusercontent.com/u/50233205?v=4)
65 Dec 28, 2022
41 Dec 23, 2022
215 Dec 30, 2022
7 Jun 2, 2022
5 Jul 15, 2022
4 Jun 6, 2022
89 Jan 2, 2023
5 Sep 13, 2022
208 Jan 5, 2023
3 Jun 22, 2022
1 Nov 10, 2022
9 Oct 12, 2022
4 Jun 16, 2022
8 Oct 18, 2022
18 Aug 15, 2022
6 Dec 26, 2022
3 Nov 16, 2022
21 Sep 28, 2022
5 Aug 12, 2022