localstack-paradedb 0.1.0

LocalStack Extension: ParadeDB on LocalStack

ParadeDB on LocalStack

This repo contains a LocalStack Extension that facilitates developing ParadeDB-based applications locally.

ParadeDB is an Elasticsearch alternative built on Postgres. It provides full-text search with BM25 scoring, hybrid search combining semantic and keyword search, and real-time analytics capabilities.

After installing the extension, a ParadeDB server instance will become available and can be accessed using standard PostgreSQL clients.

Connection Details

Once the extension is running, you can connect to ParadeDB using any PostgreSQL client with the following default credentials:

• Host: localhost (or the Docker host if running in a container)
• Port: 5432 (mapped from the container)
• Database: mydatabase
• Username: myuser
• Password: mypassword

Example connection using psql:

psql -h localhost -p 5432 -U myuser -d mydatabase

Example connection using Python:

import psycopg2

conn = psycopg2.connect(
    host="localhost",
    port=5432,
    database="mydatabase",
    user="myuser",
    password="mypassword"
)

ParadeDB Features

ParadeDB includes the pg_search extension, for both search and analytics workloads.

Example of BM25 scoring, from the excellent quickstart guide:

CALL paradedb.create_bm25_test_table(
  schema_name => 'public',
  table_name => 'mock_items'
);

CREATE INDEX search_idx ON mock_items
USING bm25 (id, description, category, rating, in_stock, created_at, metadata, weight_range)
WITH (key_field='id');

SELECT description, pdb.score(id)
FROM mock_items
WHERE description ||| 'running shoes' AND rating > 2
ORDER BY score DESC
LIMIT 5;

Configuration

The following environment variables can be passed to the LocalStack container to configure the extension:

• PARADEDB_POSTGRES_USER: PostgreSQL username (default: myuser)
• PARADEDB_POSTGRES_PASSWORD: PostgreSQL password (default: mypassword)
• PARADEDB_POSTGRES_DB: Default database name (default: mydatabase)

Prerequisites

• Docker
• LocalStack Pro (free trial available)
• localstack CLI
• make

Install from GitHub repository

This extension can be installed directly from this Github repo via:

localstack extensions install "git+https://github.com/localstack/localstack-extensions.git#egg=localstack-paradedb&subdirectory=paradedb"

Install local development version

Please refer to the docs here for instructions on how to start the extension in developer mode.

Change Log

• 0.1.0: Initial version of the extension

License

The code in this repo is available under the Apache 2.0 license.