Skip to content
ParticleDB

Quickstart

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

  1. Start ParticleDB

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

  2. Connect

    Use psql or any PostgreSQL client:

    Terminal window
    psql -h localhost -p 5432 -U particledb -d particledb

    Or hit the HTTP API directly:

    Terminal window
    curl -X POST http://localhost:8080/v1/sql \
      -H "Content-Type: application/json" \
      -d '{"sql":"SELECT 1 AS ok"}'

  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

Section titled “Next Steps”