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://nadeem4nk-nl2sql-demo.hf.space.

Metadata

Release files for nl2sql-adapter-sdk 0.2.0

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.0
File Size Uploaded
nl2sql_adapter_sdk-0.2.0.tar.gz 5.1 kB Details

Built distribution (wheel)

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

Total release size: 11.1 kB

Release files / nl2sql_adapter_sdk-0.2.0.tar.gz

Download URL nl2sql_adapter_sdk-0.2.0.tar.gz
Size 5.1 kB
Tags Source
SHA-256 checksum
How to use checksums
dbbf59939d4ca25307b98d768c819fa999c31c3cd135cb1c4db7f55bce51465d
BLAKE2b-256 checksum
How to use checksums
fe08aba8e190448b3829daef6fb8787775e17ad64beb9ad2853e33928cfc208b
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.2.0-py3-none-any.whl

Download URL nl2sql_adapter_sdk-0.2.0-py3-none-any.whl
Size 6.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e57dafd98371d788725430e2120b78e3de01b1c06fda12e9b4c9d319c15dc542
BLAKE2b-256 checksum
How to use checksums
cbca3fddbff7f9fb8d2feb51a028960934fc2f8a1b38181137ebbb17ed36ae32
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

0.4.1

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

This release

0.2.0 This release

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