Skip to main content

A pip package to generate SQL/Mongo queries from natural language using an LLM API

Project description

querybuilder-llm

A simple pip package that lets you generate SQL or MongoDB queries from natural language using your deployed LLM API.
Schema is passed in, and the LLM figures out the correct query.
All responses are wrapped with a success flag for safety.


Installation

pip install querybuilder-llm

Usage

from querybuilder_llm.client import build_query

# Example schema
schema = {
    "users": ["id", "name", "email", "age"]
}

result = build_query(schema, "Find all gmail users", "postgresql")

if result["success"]:
    print("SQL Query:", result["response"])
else:
    print("Error:", result["error"])

# --- Mongo Example ---
result = build_query(schema, "Find users older than 30", "mongodb")

if result["success"]:
    print("Mongo Query:", result["response"])
else:
    print("Error:", result["error"])

Response Format

{
  "success": True/False,
  "response": str | dict | None,
  "error": str | None
}

success: Whether query generation was successful

response: SQL string or MongoDB JSON dict (if success)

error: Error details if failed

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

querybuilder_llm-0.1.2.tar.gz (2.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

querybuilder_llm-0.1.2-py3-none-any.whl (2.7 kB view details)

Uploaded Python 3

File details

Details for the file querybuilder_llm-0.1.2.tar.gz.

File metadata

  • Download URL: querybuilder_llm-0.1.2.tar.gz
  • Upload date:
  • Size: 2.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for querybuilder_llm-0.1.2.tar.gz
Algorithm Hash digest
SHA256 928d7bc806c383ac266887b4bc68e1fef439372778027aacc05c1b8909402480
MD5 da001184244c206f178049f1adb40266
BLAKE2b-256 b5a41074d24545ccc509e6cc59d4b3f8d6ae152a39f26042ff3bad9e777f3a84

See more details on using hashes here.

File details

Details for the file querybuilder_llm-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for querybuilder_llm-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b8ac4b016d29b4de40406ce512c5e8c01c7c05b992703fee8036eb8d7f26ed01
MD5 0b1b73e99c710b13802c85b3771d1a6e
BLAKE2b-256 2db76e5d7a55614d64dbbcfe95bc8919a224123dcaec56f098928f303fdfc5e1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page