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

PHP

Use the configured address for your client. See connection addresses and security. The examples use the SQL client address unless they explicitly select the HTTP API or ParticleDB JDBC driver.

Use PDO with the pdo_pgsql extension over the SQL client interface (port 5432): prepared statements, transactions, and Handle SQLSTATE error codes through the client error API.

Check that the extension is loaded with php -m | grep pdo_pgsql.

The example connects as postgres with the password secret, for a server started with particledb start --auth-method scram-sha-256 --pg-password secret. With the server’s default --auth-method password, add sslmode=require to the DSN; see TLS and authentication.

<?php
$pdo = new PDO('pgsql:host=localhost;port=5432;dbname=particledb', 'postgres', 'secret', [
PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
]);
$pdo->exec('CREATE TABLE users (id BIGINT PRIMARY KEY, name TEXT)');
$stmt = $pdo->prepare('INSERT INTO users (id, name) VALUES (?, ?)');
$stmt->execute([1, 'Alice']);
echo $stmt->rowCount() . "\n"; // 1
$stmt = $pdo->prepare('SELECT id, name FROM users WHERE id = ?');
$stmt->execute([1]);
foreach ($stmt->fetchAll(PDO::FETCH_ASSOC) as $row) {
echo $row['id'] . ' ' . $row['name'] . "\n";
}
$pdo->beginTransaction();
$pdo->prepare('UPDATE users SET name = ? WHERE id = ?')->execute(['Bob', 1]);
$pdo->commit(); // or rollBack()
echo $pdo->query('SELECT name FROM users WHERE id = 1')->fetchColumn() . "\n"; // Bob
try {
$pdo->exec('SELECT * FROM missing_table');
} catch (PDOException $e) {
echo $e->getCode() . "\n"; // 42P01
}

Output:

1
1 Alice
Bob
42P01

Key-value operations and vector search are SQL, so you run them through PDO like any other statement, for example $pdo->prepare('SELECT KV_GET(?)'). See Vector Search.