drivers

package

v0.55.0 Latest Latest Go to latest Published: Sep 10, 2026 License: MIT Imports: 0 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/neilotoole/sq

Links

Open Source Insights

README ¶

sq drivers

This directory holds the concrete sq driver implementations: one package per datasource type (Postgres, MySQL, CSV, JSON, etc.). In sq parlance, a "driver" implements a datasource type.

The full developer documentation lives under docs/:

Driver development guide: docs/DRIVERS.md, covering how to add and maintain a driver: package structure, type mapping, the driver ship checklist, test handles, and the SQL vs document driver split.
Architecture: docs/ARCHITECTURE.md shows how drivers fit into the overall sq architecture.
User docs: sq.io drivers section.

Some drivers carry their own README with maintainer notes (implementation quirks, upstream-driver workarounds), e.g. clickhouse/README.md.

Documentation ¶

Overview ¶

Package drivers is the parent package of the concrete sq driver implementations.

Source Files ¶

View all Source files

doc.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
clickhouse Package clickhouse implements the sq driver for ClickHouse, a column-oriented OLAP database management system.	Package clickhouse implements the sq driver for ClickHouse, a column-oriented OLAP database management system.
csv Package csv implements the sq driver for CSV/TSV et al.	Package csv implements the sq driver for CSV/TSV et al.
duckdb Package duckdb implements the sq driver for DuckDB.	Package duckdb implements the sq driver for DuckDB.
internal/portsakila Package portsakila translates the SQLite sakila SQL files into a form that DuckDB can ingest.	Package portsakila translates the SQLite sakila SQL files into a form that DuckDB can ingest.
internal/portsakila/cmd/portsakila command Command portsakila ports SQLite sakila SQL files to DuckDB-compatible form and builds all testdata fixtures.	Command portsakila ports SQLite sakila SQL files to DuckDB-compatible form and builds all testdata fixtures.
json Package json implements the sq driver for JSON.	Package json implements the sq driver for JSON.
mysql
oracle Package oracle implements the sq driver for Oracle Database.	Package oracle implements the sq driver for Oracle Database.
orshared Package orshared holds Oracle error translation shared by database/sql wire drivers (e.g.	Package orshared holds Oracle error translation shared by database/sql wire drivers (e.g.
postgres Package postgres implements the sq driver for postgres.	Package postgres implements the sq driver for postgres.
rqlite Package rqlite implements the sq driver for rqlite, the distributed SQLite-based database (see https://rqlite.io).	Package rqlite implements the sq driver for rqlite, the distributed SQLite-based database (see https://rqlite.io).
sqlite3 Package sqlite3 implements the sq driver for SQLite.	Package sqlite3 implements the sq driver for SQLite.
sqlparser Package sqlparser contains SQL parsing functionality for SQLite.	Package sqlparser contains SQL parsing functionality for SQLite.
sqlparser/sqlite
sqlserver Package sqlserver implements the sq driver for SQL Server.	Package sqlserver implements the sq driver for SQL Server.
userdriver Package userdriver implements the "user-driver" functionality that allows users to define source driver types declaratively.	Package userdriver implements the "user-driver" functionality that allows users to define source driver types declaratively.
xmlud Package xmlud provides user driver XML import functionality.	Package xmlud provides user driver XML import functionality.
xlsx Package xlsx implements the sq driver for Microsoft Excel.	Package xlsx implements the sq driver for Microsoft Excel.
internal/genxlsx command Command genxlsx regenerates the Sakila XLSX test fixtures from the canonical SQLite fixture (drivers/sqlite3/testdata/sakila.db), so they carry the same faithful data (restored accents, real phone numbers, original 2006 timestamps) as the rest of the Sakila fixtures.	Command genxlsx regenerates the Sakila XLSX test fixtures from the canonical SQLite fixture (drivers/sqlite3/testdata/sakila.db), so they carry the same faithful data (restored accents, real phone numbers, original 2006 timestamps) as the rest of the Sakila fixtures.