sqlgen

KO | EN

gitlite — search

#hacktoberfest #react #ai #llm #android #linux #docker #nodejs #windows #awesome #kubernetes #awesome-list #security #openai

(★ 18)

SQL code generator, no extra runtime cost! It's blazingly fast!!! 🚀🚀🚀

sqlgen Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# sqlgen

[![Build](https://img.shields.io/github/actions/workflow/status/si3nloong/sqlgen/test.yml?branch=main)](https://github.com/si3nloong/sqlgen/actions?query=workflow%3ATest)
[![Go Report](https://goreportcard.com/badge/github.com/si3nloong/sqlgen)](https://goreportcard.com/report/github.com/si3nloong/sqlgen)
[![Go Coverage](https://codecov.io/gh/si3nloong/sqlgen/branch/main/graph/badge.svg)](https://codecov.io/gh/si3nloong/sqlgen)
[![LICENSE](https://img.shields.io/github/license/si3nloong/sqlgen)](https://github.com/si3nloong/sqlgen/blob/main/LICENSE)

> sqlgen is not an ORM, it's a code generator instead. It parse the go struct and generate the necessary struct methods for you.

## What is sqlgen?

- **sqlgen is based on a Code first approach** — You don't require to write SQL first, but Go code instead.
- **sqlgen enables Codegen** — We generate the boring bits, so you can focus on building your app quickly.
- **sqlgen prioritizes Performance** — Most of the things will define in compile time instead of runtime.
- **sqlgen embrace Generics** — We use generics to eliminate runtime reflection costs and reduce memory allocation.
- **sqlgen eliminates Side Effects** - You will get expected results instead of side effects when mutate your models.
- **sqlgen has ZERO Dependencies** - It has no dependencies at all, it only rely on the standard library.
- **sqlgen support dynamic query** - It provide [multiple insert](/docs/ADVANCED_USAGE.md#multiple-insert), [multiple upsert](/docs/ADVANCED_USAGE.md#multiple-upsert) and [cursor-based pagination](/docs/ADVANCED_USAGE.md#pagination) which [sqlc](https://github.com/sqlc-dev/sqlc) doesn't able to provide.

## SQL driver support

| Driver     | Support |
| ---------- | :-----: |
| `mysql`    |   ✅    |
| `postgres` |   ✅    |
| `sqlite`   |   ✅    |
| `mssql`    |   ❌    |

## Quick start

1.  Install sqlgen.

```console
    go install github.com/si3nloong/sqlgen/cmd/sqlgen@main
    ```

2.  Define your [model](./docs/MODELS.md) struct.

<h5 a><strong><code>model/user.go</code></strong></h5>

```go
    package model

import "time"

type LongText string

type User struct {
        ID      int64 `sql:",auto_increment"`
        Name    string
        Age     uint8
        Address LongText
        Created time.Time
    }
    ```

3.  Generate the output files.

```bash
    # sqlgen generate <source_file>
    sqlgen generate model/user.go
    ```

4.  Generated code will be as follow.

<h5 a><strong><code>model/generated.go</code></strong></h5>

```go
    // Code generated by sqlgen. DO NOT EDIT.

package model

import (
        "database/sql/driver"
        "time"

"github.com/si3nloong/sqlgen/sequel/types"
    )

func (User) TableName() string {
        return "`user`"
    }
    func (User) Columns() []string {
        return []string{"`id`", "`name`", "`age`", "`address`", "`created`"}
    }
    func (v User) IsAutoIncr() {}
    func (v User) PK() (columnName string, pos int, value driver.Value) {
        return "`id`", 0, int64(v.ID)
    }
    func (v User) Values() []any {
        return []any{int64(v.ID), string(v.Name), int64(v.Age), string(v.Address), time.Time(v.Created)}
    }
    func (v *User) Addrs() []any {
        return []any{types.Integer(&v.ID), types.String(&v.Name), types.Integer(&v.Age), types.String(&v.Address), (*time.Time)(&v.Created)}
    }
    ```

More help to get started:

- [Getting started tutorial](/docs/GET_STARTED.md) - a comprehensive guide to help you get started
- [CLI guide](/docs/CLI.md) - the CLI commands.
- [FAQ](/docs/FAQ.md) - frequent ask questions.
- [Configuration file](/docs/CONFIGURATION.md) - configure code generation.
- [Advanced usages](/docs/ADVANCED_USAGE.md) - advanced API.

## Benchmark

As you can see, [sqlgen](https://github.com/si3nloong/sqlgen) is perform as close as Raw query, and having low memory allocations.

## Road Map

- [ ] Support Mssql

## Reporting Issues

If you think you've found a bug, or something isn't behaving the way you think it should, please raise an [issue](https://github.com/si3nloong/sqlgen/issues) on GitHub.

## Contributing

We welcome contributions, Read our [Contribution Guidelines](https://github.com/si3nloong/sqlgen/blob/main/CONTRIBUTING.md) to learn more about contributing to **sqlgen**

## Inspired By

- [You don't need orm in Go](https://medium.com/@enverbisevac/you-dont-need-orm-in-go-9216fb74cdfd)
- [gqlgen](https://github.com/99designs/gqlgen)

## License

[MIT](https://github.com/si3nloong/sqlgen/blob/main/LICENSE)

sqlgen

sqlgen Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

sqlgen

sqlgen Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README