sqle

KO | EN

gitlite — search

#react #typescript #golang #deep-learning #macos #windows #awesome #cli #awesome-list #security #ios #mcp #openai #open-source

(★ 57)

A package for fast mapping SQL rows to structures, maps and slices

sqle Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# sqle [![GoDoc](https://godoc.org/github.com/lazada/sqle?status.png)](https://godoc.org/github.com/lazada/sqle) [![Build Status](https://travis-ci.org/lazada/sqle.svg?branch=master)](https://travis-ci.org/lazada/sqle)
The `sqle` package is an extension of the standard `database/sql` package.

## Features
- fully implements the `database/sql` interface;
- it is fast, sometimes very fast (has a minimum overhead);
- `Scan` method can take composite types as arguments, such as pointers to structures (including nested ones), maps and slices;
- `Columns` and `ColumnTypes` methods cache the returned result.

## Prerequisites
This package requires Go 1.8 or later.

## Installation
```
go get -u github.com/lazada/sqle
```

## Usage
There are two ways of using this package:
1. by replacing standard `database/sql` package with this package in your imports;
2. by wrapping specific standard `database/sql` objects using the `Wrap` function.

## Examples
Additional examples of usage are available in [rows_test.go](https://github.com/lazada/sqle/blob/master/rows_test.go), [row_test.go](https://github.com/lazada/sqle/blob/master/row_test.go) and [wrap_test.go](https://github.com/lazada/sqle/blob/master/wrap_test.go).

### Working with structures
As it was:
```go
import "database/sql"

type User struct {
    Id      int32
    Name    string
    Email   string
    Created time.Time
    Updated time.Time
}

db, err := sql.Open(`sqlite3`, `testdata/testdata.db`)
if err != nil {
    log.Fatalln(err)
}
user := new(User)

err = db.QueryRowContext(ctx, `SELECT * FROM users WHERE id = ?`, userId).
    Scan(&user.Id, &user.Name, &user.Email, &user.Created, &user.Updated)
if err != nil {
    log.Fatalln(err)
}
```
It is now:
```go
import sql "github.com/lazada/sqle"

type User struct {
	Id      int32     `sql:"id"`
	Name    string    `sql:"name"`
	Email   string    `sql:"email"`
	Created time.Time `sql:"created"`
	Updated time.Time `sql:"updated"`
}

db, err := sql.Open(`sqlite3`, `testdata/testdata.db`)
if err != nil {
    log.Fatalln(err)
}
user := new(User)

err = db.QueryRowContext(ctx, `SELECT * FROM users WHERE id = ?`, userId).Scan(user)
if err != nil {
    log.Fatalln(err)
}
```
 
 ### Working with maps
As it was (simplified example):
```go
import "database/sql"

db, err := sql.Open(`sqlite3`, `testdata/testdata.db`)
if err != nil {
    log.Fatalln(err)
}
var (
    userId                   int32
    userName, userEmail      string
    userCreated, userUpdated time.Time
)
err = db.QueryRowContext(ctx, `SELECT * FROM users WHERE id = ?`, userId).
    Scan(&userId, &userName, &userEmail, &userCreated, &userUpdated)
if err != nil {
    log.Fatalln(err)
}
user := map[string]interface{}{
    `id`:      userId,
    `name`:    userName,
    `email`:   userEmail,
    `created`: userCreated,
    `updated`: userUpdated,
}
```
It is now:
```go
import sql "github.com/lazada/sqle"

db, err := sql.Open(`sqlite3`, `testdata/testdata.db`)
if err != nil {
    log.Fatalln(err)
}
user := make(map[string]interface{})

err = db.QueryRowContext(ctx, `SELECT * FROM users WHERE id = ?`, userId).Scan(user)
if err != nil {
    log.Fatalln(err)
}
```

sqle

sqle Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

sqle

sqle Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README