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.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.4.0
File Size Uploaded
nl2sql_adapter_sdk-0.4.0.tar.gz 5.8 kB Details

Built distribution (wheel)

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

Total release size: 12.4 kB

Release files / nl2sql_adapter_sdk-0.4.0.tar.gz

Download URL nl2sql_adapter_sdk-0.4.0.tar.gz
Size 5.8 kB
Tags Source
SHA-256 checksum
How to use checksums
3d9e4543c256f36f89e0fec5f384e26f394a4efb952db783380c9ea1a9b876ff
BLAKE2b-256 checksum
How to use checksums
34d470aeec547b6c5d0fd694d492ac356247c102b08ec87b56d1dbdae6e4dfbe
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.0-py3-none-any.whl

Download URL nl2sql_adapter_sdk-0.4.0-py3-none-any.whl
Size 6.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bf32a0da8d5783bc585ce58edaf9e0c51b8c4efea7194eae63770d3e32b0f3cd
BLAKE2b-256 checksum
How to use checksums
314a9c0d1991a068f7ebf4ed34693b20141a5ce4e196448a5ac338afd9ddd089
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

This release

0.4.0 This release

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