Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rocketlaunchr/mysql-go
Make mysql cancelation a breeze
https://github.com/rocketlaunchr/mysql-go
cancellation context go golang mysql transactions
Last synced: 8 days ago
JSON representation
Make mysql cancelation a breeze
- Host: GitHub
- URL: https://github.com/rocketlaunchr/mysql-go
- Owner: rocketlaunchr
- License: other
- Created: 2018-10-27T23:20:32.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-17T02:37:04.000Z (about 5 years ago)
- Last Synced: 2024-06-18T17:05:22.946Z (5 months ago)
- Topics: cancellation, context, go, golang, mysql, transactions
- Language: Go
- Size: 39.1 KB
- Stars: 35
- Watchers: 7
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Canceling MySQL in Go [](http://godoc.org/github.com/rocketlaunchr/mysql-go) [](https://goreportcard.com/report/github.com/rocketlaunchr/mysql-go)
This package will properly implement context cancelation for MySQL. Without this package, context cancelation does not actually cancel a MySQL query.
See [Article](https://medium.com/@rocketlaunchr.cloud/canceling-mysql-in-go-827ed8f83b30) for details of the behind-the-scenes magic.
The API is designed to resemble the standard library. It is fully compatible with the [dbq](https://github.com/rocketlaunchr/dbq) package which allows for zero boilerplate database operations in Go.
⭐ **the project to show your appreciation.**
## Dependencies
- [Go MySQL Driver](https://github.com/go-sql-driver/mysql)
## Installation
```
go get -u github.com/rocketlaunchr/mysql-go
```
## QuickStart
```go
import (
sql "github.com/rocketlaunchr/mysql-go"
)
pool, _ := sql.Open("user:password@tcp(localhost:3306)/db")
```
## Read Query
```go
// Obtain an exclusive connection
conn, err := pool.Conn(ctx)
defer conn.Close() // Return the connection back to the pool
// Perform your read operation.
rows, err := conn.QueryContext(ctx, stmt)
if err != nil {
return err
}
```
## Write Query
```go
// Obtain an exclusive connection
conn, err := pool.Conn(ctx)
defer conn.Close() // Return the connection back to the pool
// Perform the write operation
tx, err := conn.BeginTx(ctx, nil)
_, err = tx.ExecContext(ctx, stmt)
if err != nil {
return tx.Rollback()
}
tx.Commit()
```
## Cancel Query
Cancel the context. This will send a `KILL` signal to MySQL automatically.
It is highly recommended you set a KillerPool when you instantiate the `DB` object.
The KillerPool is used to call the `KILL` signal.
## Reverse Proxy Support
Checkout the `proxy-protection` branch if your database is behind a reverse proxy in order to better guarantee that you are killing the correct query.
## Other useful packages
- [dataframe-go](https://github.com/rocketlaunchr/dataframe-go) - Statistics and data manipulation
- [dbq](https://github.com/rocketlaunchr/dbq) - Zero boilerplate database operations for Go
- [igo](https://github.com/rocketlaunchr/igo) - A Go transpiler with cool new syntax such as fordefer (defer for for-loops)
- [react](https://github.com/rocketlaunchr/react) - Build front end applications using Go
- [remember-go](https://github.com/rocketlaunchr/remember-go) - Cache slow database queries
#
### Legal Information
The license is a modified MIT license. Refer to `LICENSE` file for more details.
**© 2018-19 PJ Engineering and Business Solutions Pty. Ltd.**
### Final Notes
Feel free to enhance features by issuing pull-requests.