Quickstart

Get ParticleDB running locally and execute your first queries in under 5 minutes.

1. Start ParticleDB

   docker run -d --name particledb \
     -p 5432:5432 \
     -p 8080:8080 \
     particledb/particledb

2. Connect

   Use any PostgreSQL client:

   psql -h localhost -p 5432

   Or connect from your application:

   TypeScript

   import { ParticleDB } from '@particledb/sdk';
   const db = new ParticleDB({ host: 'localhost', port: 5432 });

   Python

   from particledb import ParticleDB
   db = ParticleDB(host="localhost", port=5432)

   Go

   import "github.com/particledb/particledb-go"
   db, err := particledb.Connect("localhost:5432")

   Rust

   use particledb::Client;
   let client = Client::connect("host=localhost port=5432").await?;

   Java

   import io.particledb.ParticleDB;
   ParticleDB db = ParticleDB.connect("jdbc:particledb://localhost:5432");

3. Create a table

   CREATE TABLE products (
       id         BIGINT PRIMARY KEY,
       name       VARCHAR NOT NULL,
       price      DOUBLE PRECISION,
       embedding  VECTOR(384),
       created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
   );

4. Insert data

   INSERT INTO products (id, name, price) VALUES
       (1, 'Wireless Mouse', 29.99),
       (2, 'Mechanical Keyboard', 89.99),
       (3, 'USB-C Hub', 49.99),
       (4, '4K Monitor', 399.99);

5. Query

   -- Analytical query
   SELECT name, price FROM products WHERE price > 50 ORDER BY price DESC;
   
   -- Aggregation
   SELECT COUNT(*), AVG(price), MAX(price) FROM products;

6. Transactions

   BEGIN;
   UPDATE products SET price = price * 0.9 WHERE price > 100;
   SELECT name, price FROM products WHERE price > 50;
   COMMIT;

Next Steps

• SQL Reference — Full SQL dialect documentation
• Vector Search — Semantic similarity queries
• SDKs — Client libraries for 8 languages
• Benchmarks — See how ParticleDB performs
• Architecture — How it works under the hood