Skip to main content

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.

Metadata

Release files for nl2sql-adapter-sdk 0.4.1

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.4.1
File Size Uploaded
nl2sql_adapter_sdk-0.4.1.tar.gz 5.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nl2sql-adapter-sdk 0.4.1
File Interpreter ABI Platform
nl2sql_adapter_sdk-0.4.1-py3-none-any.whl Python 3 none any Details

Total release size: 12.4 kB

Release files / nl2sql_adapter_sdk-0.4.1.tar.gz

Download URL nl2sql_adapter_sdk-0.4.1.tar.gz
Size 5.7 kB
Tags Source
SHA-256 checksum
How to use checksums
334dbe8a9773d5c1900910bb9f4deda09bfd5e9a22cf40402d6d668334e84f64
BLAKE2b-256 checksum
How to use checksums
0b0d3fc935f9a9118e2d1ba1612ad5397c5e276591b49ef37da9add6b1b9b534
Upload date
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.4.1-py3-none-any.whl

Download URL nl2sql_adapter_sdk-0.4.1-py3-none-any.whl
Size 6.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
984e81e65df4af9fae577817347e27181d1c6e8f20d102657f79eb69857fce8e
BLAKE2b-256 checksum
How to use checksums
4115daea2cfdf591c6ff3f3aa15d2f21ba2ef85c4ccbd0da34fa9cacd5743bbc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

0.4.1 This release

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page