|
1 | 1 | # go-mysql |
2 | 2 |
|
3 | | -A pure go library to handle MySQL network protocol and replication. |
| 3 | +A pure go library to handle MySQL network protocol and replication as used by MySQL and MariaDB. |
4 | 4 |
|
5 | 5 |  |
6 | 6 |  |
7 | 7 |  |
8 | | - |
9 | | -## How to migrate to this repo |
10 | | -To change the used package in your repo it's enough to add this `replace` directive to your `go.mod`: |
11 | | -``` |
12 | | -replace github.com/siddontang/go-mysql => github.com/go-mysql-org/go-mysql v1.10.0 |
13 | | -``` |
14 | | - |
15 | | -v1.10.0 - is the last tag in repo, feel free to choose what you want. |
| 8 | +[](https://pkg.go.dev/github.com/go-mysql-org/go-mysql) |
16 | 9 |
|
17 | 10 | ## Changelog |
18 | 11 | This repo uses [Changelog](CHANGELOG.md). |
19 | 12 |
|
20 | 13 | --- |
21 | 14 | # Content |
22 | | -* [Replication](#replication) |
23 | | -* [Incremental dumping](#canal) |
24 | | -* [Client](#client) |
25 | | -* [Fake server](#server) |
26 | | -* [database/sql like driver](#driver) |
| 15 | +* [Replication](#replication) - Process events from a binlog stream. |
| 16 | +* [Incremental dumping](#canal) - Sync from MySQL to Redis, Elasticsearch, etc. |
| 17 | +* [Client](#client) - Simple MySQL client. |
| 18 | +* [Fake server](#server) - server side of the MySQL protocol, as library. |
| 19 | +* [database/sql like driver](#driver) - An alternative `database/sql` driver for MySQL. |
| 20 | +* [Migration](#how-to-migrate-to-this-repo) - Information for how to migrate if you used the old location of this project. |
| 21 | + |
| 22 | +## Examples |
| 23 | + |
| 24 | +The `cmd` directory contains example applications that can be build by running `make build` in the root of the project. The resulting binaries will be places in `bin/`. |
| 25 | + |
| 26 | +- `go-binlogparser` |
| 27 | +- `go-canal` |
| 28 | +- `go-mysqlbinlog` |
| 29 | +- `go-mysqldump` |
| 30 | +- `go-mysqlserver` |
27 | 31 |
|
28 | 32 | ## Replication |
29 | 33 |
|
@@ -492,6 +496,14 @@ func main() { |
492 | 496 |
|
493 | 497 | We pass all tests in https://github.com/bradfitz/go-sql-test using go-mysql driver. :-) |
494 | 498 |
|
| 499 | +## How to migrate to this repo |
| 500 | +To change the used package in your repo it's enough to add this `replace` directive to your `go.mod`: |
| 501 | +``` |
| 502 | +replace github.com/siddontang/go-mysql => github.com/go-mysql-org/go-mysql v1.10.0 |
| 503 | +``` |
| 504 | + |
| 505 | +v1.10.0 - is the last tag in repo, feel free to choose what you want. |
| 506 | + |
495 | 507 | ## Donate |
496 | 508 |
|
497 | 509 | If you like the project and want to buy me a cola, you can through: |
|
0 commit comments