Skip to content

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[v1.8.2] - 2025-08-04

Added

  • Deployment automation script (deploy-docs-container.sh) with dynamic CLI flags to specify Docker image name, container name, and port mapping for flexible documentation site deployment.
  • Dockerfile improvements for the documentation site, including symlink dereferencing and cleaning steps to prevent build errors and ensure reliable image builds.
  • Updated documentation package listing, converting it into a Markdown table with icon images and checkbox indicators for guides availability, enhancing visual clarity and usability.

[v1.8.0] - 2025-08-02

Added

  • Modularization of db package as a standalone Go module: github.com/entiqon/db.
  • Updated import paths from github.com/entiqon/entiqon/... to github.com/entiqon/db/....
  • Added initial test coverage and CI integration for db module.
  • Future modules like core will be added modularly following this pattern.
  • Icon and documentation support for:
    • Category 1: Entiqon Sharicon (orange shared folder)
    • Category 2: Entiqon Corecon (green gear)
    • Category 3: Entiqon Datacon (green DB cylinder)
    • Category 4: Entiqon Commicon (teal antenna)
    • Category 5: Entiqon Toolicon (red wrench & hammer)

Note: This is a breaking change; downstream users must update import paths accordingly.

Codename: Atlas

[v1.7.0] - 2025-06-09

  • refactor(token): rename HasError → IsErrored(), SetErrorWith → SetError()
  • feat(token): add GetError(), SetError(), IsErrored() (Errorable contract)
  • feat(token): introduce Kind enum and Kindable interface
  • feat(token): add SetKind(), GetKind() to BaseToken
  • chore(token): update BaseToken.String() to use Kindable & Errorable
  • docs: add base_token.md and update token.md to document new contracts
  • test: add tests for Errorable and Kindable methods (nil-safe coverage)

Codename: Forge

[v1.6.0] - 2025-05-25

Added

  • Support for aliasable SQL expressions with optional table qualification
  • Introduces reusable token abstraction for handling elements like table.column AS alias
  • Provides helper methods: Raw(), String(), WithTable(), IsValid(), etc.

Notes

This version enables standardized handling of SQL identifiers across the builder, including aliases and table scoping. It's the first practical application of the previously introduced AliasableToken.

Codename: Keystone

Changelog

[v1.5.0] – 2025-05-24

✨ Features

  • StageToken: Standardized clause tagging for error validation
  • Public Dialect API: Enables custom dialect implementations
  • Enhanced builder error tagging with StageToken

🛠️ Refactors

  • Normalized ParamBinder and Condition to use injected Dialect
  • All builders updated to unified token/dialect handling strategy
  • Centralized placeholder resolution across WHERE, SET, VALUES

✅ Test Coverage

  • builder: 94.4%
  • driver: 100.0%
  • core/builder: 95.5%
  • bind, test packages: 100%
  • error/token: >75%

📄 Docs

  • Updated all builder guides
  • Documented new dialect interface and StageToken strategy

[v1.4.0] - 2025-05-22

✨ Added

  • NewCondition: semantic-aware condition constructor with support for:
    • Inline and placeholder syntax (e.g., "status = active", "status = ?" + value)
    • Type inference (int, bool, float64, string)
    • Operator support: =, !=, <>, <, >, <=, >=, IN, NOT IN, BETWEEN, LIKE, NOT LIKE
  • ParamBinder: unified argument binding for dialects (?, $N, :field)
  • condition_helpers.go: includes InferLiteralType, ParsePlaceholderPattern, AllSameType, and ContainsUnboundPlaceholder

🧱 Builders Implemented

  • SelectBuilder
  • InsertBuilder
  • UpdateBuilder
  • DeleteBuilder
  • UpsertBuilder (with ON CONFLICT, DO UPDATE, and DO NOTHING)

✅ Validation

  • All builders enforce:
    • Table presence
    • Column count/value alignment
    • Alias rejection in INSERT/UPSERT
    • Invalid or unsupported condition rejection via AddStageError(...)
  • UpsertBuilder supports RETURNING only if the dialect allows it (SupportsReturning())

🧪 Test Coverage

  • Achieved 100% coverage on:
    • select.go, insert.go, update.go, delete.go, upsert.go
    • condition_renderer.go, condition_helpers.go, param_binder.go

[v1.3.0] - 2025-05-19

✨ Added

  • update_builder.md: merged and normalized UpdateBuilder documentation
  • Introduced Dialect Guide with version-tagged interfaces and test philosophy
  • Added Principles & Best Practices section to README.md
  • Linked all finalized builder docs under docs/developer/builder/
  • Version tags added to all builder docs (Since v1.2.0)
  • Explicit Method Reference and Clause Ordering sections added to guides

🧪 Coverage

  • Achieved 100.0% test coverage across all:
    • Builder methods
    • Token resolvers
    • Dialect interfaces (base, postgres, resolver)
  • Deprecated methods (e.g., WithDialect(...)) remain tested until removal
  • All helper methods, even unused, are now covered and documented

🧠 Philosophy

  • Injected sarcastic validation quote into dialect guide:

    “Even if necessary, tests will be tested.”

  • All docs and builders adhere to strict validation, quoting, and fluent chaining principles

[v1.2.0] - 2025-05-18

📚 Documentation

  • Moved all builder documentation into /docs/builder/
  • Added centralized /docs/index.md with badges, overview, and links
  • Integrated GitHub Pages deployment via Actions
  • Updated README to offload examples and link each builder spec

🛠 Builders

  • Finalized UpsertBuilder with clause-order enforcement
  • Added BuildInsertOnly() to InsertBuilder for better delegation
  • 100% test coverage including all validation branches and dialect fallback
  • Strict enforcement of alias rules in UpdateBuilder and UpsertBuilder

⚙️ CI/CD

  • Introduced docs.yml GitHub Action to auto-deploy docs on push to main
  • Pages deploy pipeline ensures live site reflects every change

Entiqon is now fully documented and auto-published, with hardened query building and consistent structure across all SQL operations.

[v1.1.0] - 2025-05-17

✨ Added

  • Introduced dialect-aware escaping via WithDialect(...) in all builders

  • Implemented PostgresEngine with support for:

    • Escaping table and column identifiers
    • Escaping conflict and returning fields in UPSERT
    • Exposed Dialect Engine interface for future extensibility

🔧 Refactored

  • Unified condition handling via token.Condition with Set, IsValid, AppendCondition
  • Applied shared NewCondition(...) constructor across all builders
  • Updated Select, Insert, Update, Delete, and Upsert to support dialect injection
  • Improved UpsertBuilder to delegate properly and inject dialect into InsertBuilder

📘 Documentation

  • Updated README with:

    • Dialect usage example
    • New “Dialect Support” section
    • Go module version badge

Entiqon now provides a consistent, safe foundation for dialect-specific SQL generation — ready for PostgreSQL, and future engines.

[v1.0.0] - 2025-05-16

Added

  • SelectBuilder upgraded to support argument binding and structured condition handling
  • Consistent Build() (string, []any, error) signature across all builders
  • Enhanced `ConditionToken