docs / drivers

On this page

Drivers

Official drivers speak the native NSQL v1 protocol. Do not put keys or passwords in a URL. TLS 1.3 is required off loopback.

RuntimePathOpen
Go`drivers/go`nextsql.Open(nextsql.Config{…})
Node.js 18+`drivers/node`connect({ address, user, password, tls })
Bun`drivers/bun`same shape as Node
Deno`drivers/deno`import { connect } from "./mod.ts"
PHP 8.1+`drivers/php`NextSQL\Client::connect([…])
Python 3.10+`drivers/python`nextsql.connect(nextsql.Config(…))
Ruby 3.0+`drivers/ruby`NextSQL.connect(NextSQL::Config.new(…))

Shared TypeScript types: `drivers/js/types.d.ts`.

Common API

exec (materialize), query (stream rows), prepare / execute, cancel, close. A connection is single-flight: a second query while rows are open returns conflict.

Address is host:port only. Values containing ://, key=, or password= are rejected.

When nextsqld is started with --require-client-key, the first authenticated client supplies the 32-byte root over TLS. See TLS and client keys.

Language guides

Engine note: `docs/protocol.md`.

0.1.0-dev · GitHub