basedwon / index

A comprehensive indexing solution built to cater to a wide variety of indexing requirements.

Indexer

A comprehensive indexing solution built to cater to a wide variety of indexing requirements. It provides a robust API for adding, removing, updating, and finding data based on multiple types of index fields. Including an inverted-indexing of words within a text field.

Features

• Dynamic field creation for indexing
• Supports single, multi, and text-based fields
• Extensible with custom index field types
• Asynchronous API support
• Transactional batch operations
• Formatter and reducer customization

Installation

Install the package with:

npm install @plaindb/index

Usage

First, import the Indexer library.

import Indexer from '@plaindb/index'

or

const Indexer = require('@plaindb/index')

Initialize the Index

const storage = // Your storage instance
const index = new Index(storage, ['name', 'age|gender', 'description text'])

Adding an Entity

await index.add({
  id: 1,
  name: 'John',
  age: 30,
  gender: 'male',
  description: 'Software Engineer'
})

Removing an Entity

await index.remove({
  id: 1
})

Updating an Entity

await index.update(oldEntity, newEntity)

Finding Entities

You can find entities based on index fields:

const results = await index.find('age', 30)

Custom Formatter and Reducer

You can provide custom formatter and reducer functions through the opts parameter:

const index = new Index(storage, ['name'], {
  formatter: new CustomFormatter(),
  reducer: (entity) => entity.customId
})

Documentation

• API Reference

Classes

• Index: Manages multiple index fields and dispatches operations.
• IndexFactory: Creates index fields dynamically.
• IndexField: Abstract class for index fields.
• SingleIndexField: Index field for single properties.
• MultiIndexField: Index field for multi-properties.
• TextIndexField: Index field for text-based searching.

Methods

• Index.by(slug): Dynamically add an index field.
• Index.add(entity): Add an entity to the index.
• Index.remove(entity): Remove an entity from the index.
• Index.update(oldEntity, newEntity): Update an entity in the index.
• Index.find(query, ...values): Find entities based on a query.

Extending

To extend the library with a custom index field, create a class extending IndexField and register it via Registry.

Tests

In order to run the test suite, simply clone the repository and install its dependencies:

git clone https://gitlab.com/frenware/framework/plaindb/index.git
cd indexer
npm install

To run the tests:

npm test

Contributing

Thank you! Please see our contributing guidelines for details.

Donations

If you find this project useful and want to help support further development, please send us some coin. We greatly appreciate any and all contributions. Thank you!

Bitcoin (BTC):

1JUb1yNFH6wjGekRUW6Dfgyg4J4h6wKKdF

Monero (XMR):

46uV2fMZT3EWkBrGUgszJCcbqFqEvqrB4bZBJwsbx7yA8e2WBakXzJSUK8aqT4GoqERzbg4oKT2SiPeCgjzVH6VpSQ5y7KQ

License

@plaindb/index is MIT licensed.