nl2sql-adapter-sdk

The contracts a database adapter for the nl2sql engine implements. It depends on pydantic and the standard library only, so an adapter built against it inherits nothing else.

DatasourceAdapterProtocol: capabilities(), connect(), fetch_schema_snapshot(), execute(request) and get_dialect(), which returns a sqlglot dialect name such as postgres or tsql.
AdapterRequest, ResultFrame and ResultError: what the engine sends an adapter and what it gets back.
SchemaSnapshot and the table, column and foreign-key contracts an adapter describes its schema with.

An adapter is published as an nl2sql.adapters entry point, and the engine finds it there; it never imports an adapter by name.

pip install nl2sql-adapter-sdk

Writing an adapter: Adapter development. Try the engine without installing anything: https://nl2sql.codewithnk.com.

Development Status
- 3 - Alpha
Intended Audience
- Developers
Operating System
- OS Independent
Programming Language
Topic
- Database
- Software Development :: Libraries

Metadata

Development Status
- 3 - Alpha
Intended Audience
- Developers
Operating System
- OS Independent
Programming Language
Topic
- Database
- Software Development :: Libraries

Release files for nl2sql-adapter-sdk 0.2.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nl2sql-adapter-sdk 0.2.4
File	Size	Uploaded
nl2sql_adapter_sdk-0.2.4.tar.gz	5.1 kB	Oct 12, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for nl2sql-adapter-sdk 0.2.4
File	Interpreter	ABI	Platform	Reset
nl2sql_adapter_sdk-0.2.4-py3-none-any.whl 6.0 kB Oct 12, 2026	Python 3	none	any	Details

Total release size: 11.1 kB

Release files / nl2sql_adapter_sdk-0.2.4.tar.gz

Download URL	nl2sql_adapter_sdk-0.2.4.tar.gz
Size	5.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`e1a208fee75a51ad6543bb5883a38b3c39681cbb93f4c22dfa3ddaf94dcad545`
BLAKE2b-256 checksum How to use checksums	`1447e44aa0e53029671ebfefb54fe758df08c4879f4fa4bdc0b79725f48bdd68`
Upload date	Oct 12, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Release files / nl2sql_adapter_sdk-0.2.4-py3-none-any.whl

Download URL	nl2sql_adapter_sdk-0.2.4-py3-none-any.whl
Size	6.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`679e98a6c6d470094584e4debc443cbfac5c7825aa73b9bf5e6f7805b01c3621`
BLAKE2b-256 checksum How to use checksums	`94dd5582ddaff7610605bd0ea439e9cfe5aee83c8fab1cdf57f473e479830d3b`
Upload date	Oct 12, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`