Skip to content
ParticleDB
Release candidateParticleDB 1.1.19-rc.17 is not yet GA or ready for production data.Release status →

Choose your client

Choose the client that fits your application. Connection setup, authentication and type handling depend on the client; SQL syntax is documented separately.

ParticleDB SDKs for Python, TypeScript and Node.js, Java, Go and Rust are published under the MIT license and use the native client protocol on the database port, 7173. They need server 1.1.19-rc.13 or later. Other languages use published third-party PostgreSQL clients. See release and client availability for versions and licenses.

Language Install
Python pip install particledb
TypeScript and Node.js npm install @particledb/sdk
Java and JDBC ai.particledb:particledb-jdbc:1.0.12, ai.particledb:particledb-java-sdk:1.1.3
Go go get github.com/particledb-ai/particledb-go@v0.2.2
Rust cargo add particledb-sdk
Language Client path Guide
Python ParticleDB SDK or psycopg Python
TypeScript and Node.js ParticleDB SDK or node-postgres TypeScript and Node.js
Java and JDBC ParticleDB JDBC or pgjdbc Java and JDBC
Go ParticleDB SDK or pgx Go
Rust ParticleDB SDK or tokio-postgres Rust
C# and .NET Npgsql C# and .NET
C libpq C
C++ libpqxx C++
Ruby pg Ruby
PHP PDO PHP
Swift PostgresNIO Swift
Dart postgres Dart
Elixir Postgrex Elixir
Kotlin JDBC Kotlin
Clojure next.jdbc Clojure
Browser applications your application backend Browser applications

Use connection addresses to select the correct endpoint. The HTTP API defaults to port 7173; SQL clients default to port 5432.

The ParticleDB SDKs and the ParticleDB JDBC driver use the native client protocol on the database port, 7173. The JDBC driver has different feature support from pgjdbc; follow the Java guide when choosing between them.

  • Use bound parameters for user-supplied values.
  • Keep each transaction on one connection.
  • Roll back failed transactions before reusing a connection.
  • Configure connection and statement timeouts.
  • Keep database credentials in your backend, outside browser bundles.

Check the package version, TLS support and runtime requirements on the language page. Test the combination of client and server versions your application will deploy. See limits for behavior that differs from other databases.

Documentation home · Troubleshooting