https://github.com/chenquan/sqlbreaker

A low-code intrusion library that provides SQL breaker capabilities, suitable for any relational database (Sqlite3, MySQL, Oracle, SQL Server, PostgreSQL, TiDB, TDengine, etc.) and ORM libraries for various relational database (gorm, xorm, sqlx, ent, etc.)
https://github.com/chenquan/sqlbreaker

breaker ent go golang gorm mysql oracle orm postgres postgresql sql sqlite3 sqlserver tidb xorm xsql

Last synced: 10 days ago
JSON representation

A low-code intrusion library that provides SQL breaker capabilities, suitable for any relational database (Sqlite3, MySQL, Oracle, SQL Server, PostgreSQL, TiDB, TDengine, etc.) and ORM libraries for various relational database (gorm, xorm, sqlx, ent, etc.)

• Host: GitHub
• URL: https://github.com/chenquan/sqlbreaker
• Owner: chenquan
• License: apache-2.0
• Created: 2022-09-14T12:04:31.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-03-01T21:55:59.000Z (9 months ago)
• Last Synced: 2024-06-20T00:32:19.398Z (5 months ago)
• Topics: breaker, ent, go, golang, gorm, mysql, oracle, orm, postgres, postgresql, sql, sqlite3, sqlserver, tidb, xorm, xsql
• Language: Go
• Homepage:
• Size: 195 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sqlbreaker

[![Godoc](https://img.shields.io/badge/godoc-reference-brightgreen)](https://pkg.go.dev/github.com/chenquan/sqlbreaker)

[![Go Report Card](https://goreportcard.com/badge/github.com/chenquan/sqlbreaker)](https://goreportcard.com/report/github.com/chenquan/sqlbreaker)

[![Release](https://img.shields.io/github/v/release/chenquan/sqlbreaker.svg?style=flat-square)](https://github.com/chenquan/sqlbreaker)

[![codecov](https://codecov.io/gh/chenquan/sqlbreaker/branch/master/graph/badge.svg?token=74phc5KVI7)](https://codecov.io/gh/chenquan/sqlbreaker)

[![Download](https://goproxy.cn/stats/github.com/chenquan/sqlbreaker/badges/download-count.svg)](https://github.com/chenquan/sqlbreaker)

[![GitHub](https://img.shields.io/github/license/chenquan/sqlbreaker)](https://github.com/chenquan/sqlbreaker/blob/master/LICENSE)

A low-code intrusion library that provides SQL breaker capabilities, suitable for any relational database (Sqlite3, MySQL, Oracle, SQL Server,

PostgreSQL, TiDB, TDengine, etc.) and ORM libraries for various relational database (gorm, xorm, sqlx, etc.)

> Unstable, use with caution in production environment

# 😜installation

```shell

go get -u github.com/chenquan/sqlbreaker

```

# 👏how to use

```go

package main

import (

	"context"

	"database/sql"

	"fmt"

	"github.com/chenquan/sqlbreaker"

	"github.com/chenquan/sqlbreaker/pkg/breaker"

	"github.com/chenquan/sqlplus"

	"github.com/chenquan/sqltrace"

	"github.com/mattn/go-sqlite3"

	"go.opentelemetry.io/otel"

	"go.opentelemetry.io/otel/trace"

)

func main() {

	// Create a sqlite3 driver with tracing and  breaker

	hook := sqlplus.NewMultiHook(

		sqltrace.NewTraceHook(sqltrace.Config{

			Name:           "sqlite3_trace",

			DataSourceName: "sqlite3",

			Endpoint:       "http://localhost:14268/api/traces",

			Sampler:        1,

			Batcher:        "jaeger",

		}),

		sqlbreaker.NewBreakerHook(breaker.NewBreaker()),

	)

	// register new driver

	sql.Register("sqlite3_trace", sqlplus.New(&sqlite3.SQLiteDriver{}, hook))

	defer sqltrace.StopAgent()

	// open database

	db, err := sql.Open("sqlite3_trace", "identifier.sqlite")

	if err != nil {

		panic(err)

	}

	tracer := otel.GetTracerProvider().Tracer("sqlite3_trace")

	ctx, span := tracer.Start(context.Background(),

		"test",

		trace.WithSpanKind(trace.SpanKindClient),

	)

	defer span.End()

	db.ExecContext(ctx, `CREATE TABLE  IF NOT EXISTS t

(

    age  integer,

    name TEXT

)`)

	db.ExecContext(ctx, "insert into t values (?,?)", 1, "chenquan")

	// transaction

	tx, err := db.BeginTx(ctx, nil)

	stmt, err := tx.PrepareContext(ctx, "select age+1 as age,name from t where age = ?;")

	stmt.QueryContext(ctx, 1)

	tx.Commit()

	rows, err := db.QueryContext(ctx, "select  age+1 as age,name from t;")

	for rows.Next() {

		var age int

		var name string

		err := rows.Scan(&age, &name)

		if err != nil {

			fmt.Println(err)

		}

		fmt.Println(age, name)

	}

}

```

![](images/trace-native.png)

# ⭐star

If you like or are using this project to learn or start your solution, please give it a star⭐. Thanks!

# 👐ecosystem

- [sqltrace](https://github.com/chenquan/sqltrace):A low-code intrusion library that provides SQL tracing capabilities, suitable for any

  relational database (Sqlite3, MySQL, Oracle, SQL Server, PostgreSQL, TiDB, TDengine, etc.) and ORM libraries for various

  relational database (gorm, xorm, sqlx, etc.)

- [sqlplus](https://github.com/chenquan/sqlplus): A sql enhancement tool library based on `database/sql/driver`