Go to file
lqs 8834a4fefd fix gofmt issues 2020-12-28 22:20:17 +08:00
generator fix gofmt issues 2020-12-28 22:20:17 +08:00
sqlingo-gen fix import path 2020-07-28 18:23:54 +08:00
sqlingo-gen-mysql fix import path 2020-07-28 18:21:14 +08:00
sqlingo-gen-postgres fix import path 2020-07-28 18:21:14 +08:00
sqlingo-gen-sqlite3 fix gofmt issues 2020-12-28 22:20:17 +08:00
.travis.yml add go1.15 in travis 2020-08-17 13:26:55 +08:00
LICENSE initial commit 2018-11-18 22:11:43 +08:00
README.md split sqlingo-gen 2020-07-28 18:09:30 +08:00
case.go add documents on all exported functions and interfaces 2020-07-07 17:07:14 +08:00
case_test.go add test 2019-04-30 18:51:03 +08:00
common.go automatically find tables from fields if "From" is not specified 2020-07-28 12:43:07 +08:00
common_test.go more tests 2020-07-01 20:53:55 +08:00
cursor.go support for dynamic value 2020-07-24 16:32:09 +08:00
cursor_test.go add go1.15 in travis 2020-08-17 13:26:55 +08:00
database.go make ctx available in interceptor 2020-08-18 17:50:33 +08:00
database_test.go tests on FetchAll 2020-07-02 20:35:48 +08:00
delete.go don't export intermediate interfaces 2020-06-18 12:17:41 +08:00
delete_test.go add more tests 2020-06-12 19:54:13 +08:00
dialect.go support for multiple dialects 2020-07-01 19:54:03 +08:00
dialect_test.go more tests 2020-07-01 20:53:55 +08:00
expression.go add NOT BETWEEN oeprator 2020-12-13 23:56:57 +08:00
expression_test.go add NOT BETWEEN oeprator 2020-12-13 23:56:57 +08:00
field.go fix StringField 2020-07-28 13:09:46 +08:00
field_test.go automatically find tables from fields if "From" is not specified 2020-07-28 12:43:07 +08:00
function.go add documents on all exported functions and interfaces 2020-07-07 17:07:14 +08:00
function_test.go tests 2020-06-17 16:19:54 +08:00
insert.go don't export intermediate interfaces 2020-06-18 12:17:41 +08:00
insert_test.go automatically find tables from fields if "From" is not specified 2020-07-28 12:43:07 +08:00
interceptor.go add documents on all exported functions and interfaces 2020-07-07 17:07:14 +08:00
logo.png initial commit 2018-11-18 22:11:43 +08:00
order.go add documents on all exported functions and interfaces 2020-07-07 17:07:14 +08:00
order_test.go fix gofmt 2020-06-18 12:29:34 +08:00
select.go fix gofmt issues 2020-12-28 22:20:17 +08:00
select_test.go add test for FetchAll of non-pointer 2020-12-15 23:10:10 +08:00
table.go add support for UNION family 2020-07-19 22:48:17 +08:00
table_test.go automatically find tables from fields if "From" is not specified 2020-07-28 12:43:07 +08:00
transaction.go add documents on all exported functions and interfaces 2020-07-07 17:07:14 +08:00
transaction_test.go add more tests 2020-07-02 20:16:07 +08:00
update.go fix gofmt issues 2020-12-28 22:20:17 +08:00
update_test.go add SetIf 2020-09-01 22:52:40 +08:00
utils_test.go support for multiple dialects 2020-07-01 19:54:03 +08:00
value.go fix bool value 2020-07-29 16:47:22 +08:00
value_test.go fix bool value 2020-07-29 16:47:22 +08:00

README.md

Mentioned in Awesome Go go.dev Travis CI Go Report Card codecov MIT license last commit

sqlingo is a SQL DSL (a.k.a. SQL Builder or ORM) library in Go. It generates code from the database and lets you write SQL queries in an elegant way.

Features

  • Auto-generating DSL objects and model structs from the database so you don't need to manually keep things in sync
  • SQL DML (SELECT / INSERT / UPDATE / DELETE) with some advanced SQL query syntaxes
  • Many common errors could be detected at compile time
  • Your can use the features in your editor / IDE, such as autocompleting the fields and queries, or finding the usage of a field or a table
  • Context support
  • Transaction support
  • Interceptor support

Database Support Status

Database Status
MySQL stable
PostgreSQL experimental
SQLite experimental

Tutorial

Install and use sqlingo code generator

The first step is to generate code from the database. In order to generate code, sqlingo requires your tables are already created in the database.

$ go get -u github.com/lqs/sqlingo/sqlingo-gen-mysql
$ mkdir -p generated/sqlingo
$ sqlingo-gen-mysql root:123456@/database_name >generated/sqlingo/database_name.dsl.go

Write your application

Here's a demonstration of some simple & advanced usage of sqlingo.

package main

import (
    "github.com/lqs/sqlingo"
    . "./generated/sqlingo"
)

func main() {
    db, err := sqlingo.Open("mysql", "root:123456@/database_name")
    if err != nil {
        panic(err)
    }

    // a simple query
    var customers []*CustomerModel
    db.SelectFrom(Customer).
        Where(Customer.Id.In(1, 2)).
    	OrderBy(Customer.Name.Desc()).
        FetchAll(&customers)

    // query from multiple tables
    var customerId int64
    var orderId int64
    err = db.Select(Customer.Id, Order.Id).
        From(Customer, Order).
        Where(Customer.Id.Equals(Order.CustomerId), Order.Id.Equals(1)).
        FetchFirst(&customerId, &orderId)
    
    // subquery and count
    count, err := db.SelectFrom(Order)
        Where(Order.CustomerId.In(db.Select(Customer.Id).
            From(Customer).
            Where(Customer.Name.Equals("Customer One")))).
    	Count()
        
    // group-by with auto conversion to map
    var customerIdToOrderCount map[int64]int64
    err = db.Select(Order.CustomerId, f.Count(1)).
    	From(Order).
    	GroupBy(Order.CustomerId).
    	FetchAll(&customerIdToOrderCount)
    if err != nil {
    	println(err)
    }
    
    // insert some rows
    customer1 := &CustomerModel{name: "Customer One"}
    customer2 := &CustomerModel{name: "Customer Two"}
    _, err = db.InsertInto(Customer).
        Models(customer1, customer2).
        Execute()
    
    // insert with on-duplicate-key-update
    _, err = db.InsertInto(Customer).
    	Fields(Customer.Id, Customer.Name).
    	Values(42, "Universe").
    	OnDuplicateKeyUpdate().
    	Set(Customer.Name, Customer.Name.Concat(" 2")).
    	Execute()
}