ParadeDB JavaScript Client Library

ParadeDB is an Elasticsearch alternative built on Postgres. We're modernizing the features of Elasticsearch's product suite, starting with real-time search and analytics.

Test successfully with

• Paradedb v0.11
• Paradedb v0.12
• Paradedb v0.13
• Paradedb v0.14
• Paradedb v0.15 (Query Builder not supported)

Packages

Package	Version
paradedb-js
@mwcp/paradedb

Installation

1npm i paradedb 
2// OR
3npm i @mwcp/paradedb

Usage

Index

• Initialize ParadeDb instance

  1import { ParadeDb, type DbConnectionConfig } from 'paradedb'
  2
  3const connection: DbConnectionConfig  = {
  4  host: process.env['PARADEDB_HOST'] ? process.env['PARADEDB_HOST'] : 'localhost',
  5  port: process.env['PARADEDB_PORT'] ? +process.env['PARADEDB_PORT'] : 5432,
  6  database: process.env['PARADEDB_DB'] ? process.env['PARADEDB_DB'] : 'postgres',
  7  user: process.env['PARADEDB_USER'] ? process.env['PARADEDB_USER'] : 'postgres',
  8  password: process.env['PARADEDB_PASSWORD'] ? process.env['PARADEDB_PASSWORD'] : 'password',
  9}
  10
  11const pdb = new ParadeDb('master', { connection })

• Create an Index

  1const options: CreateBm25Options = {
  2  indexName: 'search_idx',
  3  tableName: 'mock_items',
  4  keyField: 'id',
  5}
  6await pdb.index.createBm25(options)

  More examples

• Drop an Index

  1const options: DropBm25Options = {
  2  indexName: 'search_idx',
  3}
  4await pdb.index.dropBm25(options)

• Index Schema

  1const rows: IndexSchemaDto[] = await idx.schema({ indexName: 'search_idx' })
  2assert(rows.length, 'Not found')

• Index Size

  1const size: bigint = await idx.size({ indexName: 'search_idx' })
  2// 0n means not found

Full Text Search

• Syntax of knex query builder
• FTS Examples

Basic Usage:

1const pdb = new ParadeDb('test', dbConfig)
2const rows = await pdb.search<MockItemsDo>('mock_items')
3  .whereRaw(`description @@@ :k1`, { k1: 'keyboard' })
4  .orderBy('id', 'desc')
5  .limit(limit)

Midway.js Component

Configuration

Update project src/configuration.ts

1import { Configuration } from '@midwayjs/core'
2import * as pdb from '@mwcp/paradedb'
3
4@Configuration({
5  imports: [ pdb ],
6  importConfigs: [join(__dirname, 'config')],
7})
8export class ContainerConfiguration implements ILifeCycle {
9}

Usage

Example

License

MIT

Languages

• English
• 中文