db_sql_generator

package module
v1.0.0-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 22, 2026 License: MIT Imports: 4 Imported by: 2

README

Compogo DB SQL Generator

SQL-генератор для фреймворка Compogo.

На основе goqu предоставляет:

  • Генерацию SQL-запросов для различных СУБД (MySQL, PostgreSQL, SQLite)
  • Типобезопасное построение запросов
  • Автоматический выбор диалекта по драйверу БД
  • Плагинную систему диалектов

Установка

go get github.com/Compogo/db-sql-generator

Быстрый старт

package main

import (
    "github.com/Compogo/compogo"
    "github.com/Compogo/db-sql-generator"
	"github.com/doug-martin/goqu"
)

func main() {
    app := compogo.NewApp("myapp",
        compogo.WithComponents(&db_sql_generator.Component),
    )

    app.AddComponents(&compogo.Component{
        Name: "user_repository",
        Init: compogo.StepFunc(func(container compogo.Container) error {
            return container.Invoke(func(gen *goqu.DialectWrapper) error {
                // Генерация SELECT
                sql, args, _ := gen.From("users").Where(goqu.C("age").Gt(18)).ToSQL()
                // SELECT * FROM users WHERE age > 18

                // Генерация INSERT
                sql, args, _ := gen.Insert("users").Rows(goqu.Record{
                    "name": "John",
                    "age":  30,
                }).ToSQL()
                // INSERT INTO users (name, age) VALUES ('John', 30)

                return nil
            })
        }),
    })

    if err := app.Serve(); err != nil {
        panic(err)
    }
}

Регистрация диалектов

import "github.com/Compogo/db-sql-generator"

func init() {
    db_sql_generator.Registration("mysql", "mysql")
}

Зависимости

  • Compogo — основной фреймворк
  • goqu — SQL-генератор

Лицензия

MIT License

Copyright (c) 2026 Compogo

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Component = compogo.Component{
	Init: compogo.StepFunc(func(container compogo.Container) error {
		return container.Provides(
			NewConfig,
			NewGenerator,
		)
	}),
	Configuration: compogo.StepFunc(func(container compogo.Container) error {
		return container.Invoke(Configuration)
	}),
}

Component — компонент SQL-генератора для Compogo. Регистрирует конфигурацию и генератор в DI-контейнере.

Пример подключения:

app.AddComponents(&db_sql_generator.Component)

var gen *goqu.DialectWrapper
container.Invoke(func(g *goqu.DialectWrapper) { gen = g })

// Генерация запроса
query, args, _ := gen.From("users").Where(goqu.C("id").Eq(1)).ToSQL()
rows, err := client.Query(query, args...)

Functions

func NewGenerator

func NewGenerator(config *Config, logger compogo.Logger) (*goqu.DialectWrapper, error)

NewGenerator создаёт новый SQL-генератор для указанного драйвера. Использует goqu.Dialect для генерации SQL-запросов в нужном диалекте.

Пример использования:

var gen *goqu.DialectWrapper
container.Invoke(func(g *goqu.DialectWrapper) { gen = g })

// Генерация SELECT
sql, args, _ := gen.From("users").Where(goqu.C("age").Gt(18)).ToSQL()
// SELECT * FROM users WHERE age > 18

// Генерация INSERT
sql, args, _ := gen.Insert("users").Rows(goqu.Record{"name": "John", "age": 30}).ToSQL()
// INSERT INTO users (name, age) VALUES ('John', 30)

// Генерация UPDATE
sql, args, _ := gen.Update("users").Set(goqu.Record{"age": 31}).Where(goqu.C("id").Eq(1)).ToSQL()
// UPDATE users SET age = 31 WHERE id = 1

func Registration

func Registration(driverName string, alias string)

Registration регистрирует соответствие между драйвером БД и диалектом goqu. Должна вызываться в init() каждого пакета драйвера.

Пример регистрации MySQL-драйвера:

func init() {
    db_sql_generator.Registration("mysql", "mysql")
}

Пример регистрации PostgreSQL-драйвера:

func init() {
    db_sql_generator.Registration("postgres", "postgres")
}

Types

type Config

type Config struct {
	Driver string
}

Config содержит конфигурацию SQL-генератора.

func Configuration

func Configuration(config *Config) *Config

Configuration загружает конфигурацию из Configurator. Если Driver не задан и зарегистрирован только один драйвер, используется он.

func NewConfig

func NewConfig() *Config

NewConfig создаёт новую конфигурацию.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL