Git Product home page Git Product logo

lorm's Introduction

lorm

Django ispired ORM.

Install

go get -u github.com/tada-team/lorm

Setup database

package main

import (
    "database/sql"
    "github.com/tada-team/lorm"
)

func init() {
    connStr := "dbname=... user=... password=... host=... port=... sslmode=..."
    conn, err := sql.Open("postgres", connStr)
    if err != nil {
        panic(err)
    }
    lorm.SetConn(conn)
}

Django models

  1. install django app: https://github.com/tada-team/lorm_exporter
  2. generate models.go from your django models

Examples

Single object

Django:

try:
    user = User.objects.get(id=42)
except User.DoesNotExist:
    raise Exception("user not found")

user.is_archive = False
user.save()

user.delete()

lorm:

user := UserTable.MustGet(42) // same as UserTable.Filter().Id(42).MustGet() 
if user == nil {
    panic("user not found")
}

user.IsArchive = false
if err := user.Save(); err != nil {
    panic(err)
}

if err := user.Delete(); err != nil {
    panic(err)
}

Filter

Django:

for user in User.objects.filter(is_admin=False, created__gt=dt):
    print(user.login)

lorm:

for _, user := range UserTable.Filter().IsAdmin(false).CreatedGt(dt).MustList() {
    fmt.Println(user.login)
}

Low-level queries

package main

import (
    "github.com/tada-team/lorm"
    "github.com/tada-team/lorm/op"
)

func ExampleQuery(i, j int) (int, error) {
    args := op.NewArgs()
    query := op.RawQuery("SELECT", args.Next(i), "*", args.Next(j))
    
    var res int    
    err := lorm.TxScan(nil, query, args, &res)

    return res, err
}

args and query in example above equals to:

args := op.Args{i, j}
query := "SELECT $1 * $2"

RawQuery() works like fmt.Splintln().

API

Supported 3 base functions for database access:

  • lorm.TxExec(tx *lorm.Tx, q op.Query, args op.Args) (sql.Result, error)
  • lorm.TxQuery(tx *lorm.Tx, q op.Query, args op.Args, each func(*sql.Rows) error) error
  • lorm.TxScan(tx *lorm.Tx, q op.Query, args op.Args, dest ...interface{}) error

Query constructor

github.com/tada-team/lorm/op has many helpers. For example:

  • op.Select()
  • op.Delete()
  • op.Insert()
  • op.Or()
  • op.And()
  • op.Not()
  • etc. Try autocomplete.
args := op.NewArgs()
query := op.Select(
    UserTable.Id(),
    UserTable.Created(),
).From(
    UserTable,
).OrderBy(
    UserTable.Created(),
).Where( // .Where() arguments concatenated with "AND" statement
    UserTable.Created().Gt(args.Next(time.Now().Add(-time.Hour))),
    op.Or(
        UserTable.IsArchive(),        
        op.Not(UserTable.IsAdmin()),
        UserTable.GroupId().InSubquery( // wow, subqueries!
            op.Select(
                GroupTable.Id(),
            ).From(
                GroupTable,
            ).Where(
                // HasPrefix is shortcut for "...%"
                GroupTable.Title().ILike(args.Next(op.HasPrefix("aaaaa"))),
            ),
        ),
    ),
).Limit(
    args.Next(10),
)
args := op.NewArgs()
query := op.Insert(t, op.Set{
    op.Column("date"): op.Raw("CURRENT_DATE"),
    op.Column("value"): args.Next(1),
}, op.Set{
    op.Column("date"): op.Raw("CURRENT_DATE"),
    op.Column("value"): args.Next(2),
})

Transactions

package main

import (
    "github.com/tada-team/lorm"
    "github.com/tada-team/lorm/op"
)

func ExampleTransaction(i, j int) (int, error) {
    args := op.NewArgs()
    query := op.RawQuery("SELECT", args.Next(i), "*", args.Next(j))
    
    var res int    
    if err := lorm.Atomic(func(tx *lorm.Tx) error {
        return lorm.TxScan(tx, query, args, &res)    	
    }); err != nil {
        return res, err
    }

    return res, nil
} 

Internal naming

  • r — record (row in database)
  • l – list of records
  • t — table
  • f – filter
  • q — query

lorm's People

Contributors

malekvictor avatar palage4a avatar sdfsdhgjkbmnmxc avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

rootgrandfather

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.