Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/felixdotgo/querybox/llms.txt

Use this file to discover all available pages before exploring further.

QueryBox supports PostgreSQL databases through a native driver plugin. Connect to local or remote PostgreSQL servers with flexible SSL/TLS configuration.

​
Connection Configuration

Configure your PostgreSQL connection using individual parameters:
​
host
string
required
PostgreSQL server hostname or IP addressDefault: localhost
​
port
number
PostgreSQL server portDefault: 5432
​
user
string
Database usernameDefault: postgres
​
password
string
Database password
​
database
string
Database name to connect to
​
tls
string
SSL/TLS mode for secure connectionsOptions: disable, require, verify-ca, verify-fullDefault: disable
​
params
string
Additional connection parametersExample: connect_timeout=5&application_name=myapp

​
SSL/TLS Modes

PostgreSQL supports multiple SSL modes for different security requirements:
  • disable: No SSL encryption (default)
  • require: SSL encryption required, no certificate verification
  • verify-ca: SSL encryption with CA certificate verification
  • verify-full: SSL encryption with full certificate verification including hostname
When using verify-ca or verify-full, QueryBox automatically uses embedded root certificates for verification.

​
Connection String Examples

​
Local Development

host=localhost port=5432 user=postgres password=secret dbname=mydb sslmode=disable

​
Remote Server with SSL

host=db.example.com port=5432 user=app_user password=pass dbname=production sslmode=require

​
URL Format

postgres://user:password@localhost:5432/mydb?sslmode=disable

​
With Connection Timeout

host=localhost port=5432 user=postgres dbname=mydb sslmode=disable connect_timeout=10

​
Supported Features

SQL Queries

Execute SELECT, INSERT, UPDATE, DELETE statements

Query Explanation

Analyze query execution plans with EXPLAIN

Schema Browser

Browse databases, schemas, tables, and views

DDL Operations

Create and drop databases, schemas, and tables

​
Capabilities

  • Query Execution: Run arbitrary SQL queries and view results
  • Explain Query: Prefix queries with EXPLAIN to analyze execution plans
  • Connection Tree: Navigate database → schema → table hierarchy
  • Schema Support: Full support for PostgreSQL schemas (excludes system schemas)
  • Table & View Detection: Automatically identifies tables, views, materialized views, and foreign tables
  • DDL Actions: Create/drop databases and tables with visual tools
  • SSL/TLS Support: Multiple SSL modes with embedded root certificate validation

​
Database Structure

The PostgreSQL plugin displays a hierarchical tree:
  1. Server (connection root)
  2. Databases (current database shown)
  3. Schemas (excludes pg_catalog, information_schema, and other system schemas)
  4. Tables/Views (includes regular tables, views, materialized views, partitioned tables, and foreign tables)

​
Notes

A default connection timeout of 5 seconds is automatically applied if not specified.
If SSL is disabled on the server and you attempt to connect with sslmode=require, you’ll receive a helpful error message suggesting to use sslmode=disable.
When the database name is omitted in the connection, you can browse all schemas in the current database.

​
Plugin Information

  • Version: 0.1.0
  • License: PostgreSQL
  • Author: PostgreSQL Global Development Group
  • Tags: sql, relational

Build docs developers (and LLMs) love

Get started for freeTalk to us