Skip to content

README.md

Latest commit

 

History

History
72 lines (54 loc) · 2.25 KB

README.md

File metadata and controls

72 lines (54 loc) · 2.25 KB

Zeko-SQL-Builder

Interactive CLI reference and helper tool for the Zeko SQL Builder Kotlin DSL library with query examples, WHERE clause builder, and dependency snippets.

Zeko SQL Builder CLI

An interactive command-line reference and helper tool for the Zeko SQL Builder Kotlin library. Explore the DSL syntax, generate query examples, build WHERE clauses interactively, and get Maven/Gradle dependency snippets.

Features

  • Quick Start — Get up and running with Zeko SQL Builder in seconds
  • Query Examples — SELECT, INSERT, UPDATE, DELETE with real DSL code and SQL output
  • DSL Reference — Complete reference of all query construction methods
  • WHERE Clause Builder — Interactive tool that generates Kotlin DSL from your parameters
  • JOINs Reference — All JOIN types with usage examples
  • Aggregations — Full list of aggregation functions with custom extension examples
  • Dependency Snippets — Ready-to-paste Maven and Gradle dependency blocks

Requirements

  • Python 3.8+

Installation

pip install -r requirements.txt

Usage

python main.py

Menu Options

Option Description
1 Quick Start guide
2 Query Examples (SELECT, INSERT, UPDATE, DELETE)
3 DSL Reference (methods, conditions, modifiers)
4 WHERE Clause Builder (interactive)
5 JOINs Reference
6 Aggregations
7 Dependency Snippets (Maven / Gradle)
8 About
0 Exit

About Zeko SQL Builder

Zeko SQL Builder is a lightweight, high-performance SQL library for Kotlin:

  • No configuration files, XML, YAML, or annotations
  • Clean DSL for building type-safe SQL queries
  • Minimal overhead — primarily string operations
  • Supports HikariCP, Jasync SQL, and Vert.x JDBC
  • Extensible with custom operators and SQL functions

Project Structure

.
├── main.py            # Entry point and TUI menu
├── reference.py       # DSL reference content and examples
├── query_builder.py   # Interactive WHERE clause builder
├── config.py          # User preferences
├── utils/             # Environment utilities
├── requirements.txt   # Python dependencies
└── README.md

License

MIT