diff options
Diffstat (limited to 'vendor/github.com/uptrace/bun/README.md')
| -rw-r--r-- | vendor/github.com/uptrace/bun/README.md | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/vendor/github.com/uptrace/bun/README.md b/vendor/github.com/uptrace/bun/README.md index e7cc77a60..b5583c904 100644 --- a/vendor/github.com/uptrace/bun/README.md +++ b/vendor/github.com/uptrace/bun/README.md @@ -4,17 +4,21 @@ </a> </p> -# Simple and performant SQL database client +# Simple and performant client for PostgreSQL, MySQL, and SQLite [](https://github.com/uptrace/bun/actions) [](https://pkg.go.dev/github.com/uptrace/bun) [](https://bun.uptrace.dev/) [](https://discord.gg/rWtp5Aj) +**Status**: API freeze (stable release). Note that all sub-packages (mainly extra/\* packages) are +not part of the API freeze and are developed independently. You can think of them as 3-rd party +packages that share one repo with the core. + Main features are: - Works with [PostgreSQL](https://bun.uptrace.dev/guide/drivers.html#postgresql), - [MySQL](https://bun.uptrace.dev/guide/drivers.html#mysql), + [MySQL](https://bun.uptrace.dev/guide/drivers.html#mysql) (including MariaDB), [SQLite](https://bun.uptrace.dev/guide/drivers.html#sqlite). - [Selecting](/example/basic/) into a map, struct, slice of maps/structs/vars. - [Bulk inserts](https://bun.uptrace.dev/guide/queries.html#insert). @@ -96,7 +100,7 @@ You also need to install a database/sql driver and the corresponding Bun ## Quickstart First you need to create a `sql.DB`. Here we are using the -[sqliteshim](https://pkg.go.dev/github.com/uptrace/bun/driver/sqliteshim) driver which choses +[sqliteshim](https://pkg.go.dev/github.com/uptrace/bun/driver/sqliteshim) driver which chooses between [modernc.org/sqlite](https://modernc.org/sqlite/) and [mattn/go-sqlite3](https://github.com/mattn/go-sqlite3) depending on your platform. @@ -109,7 +113,8 @@ if err != nil { } ``` -And then create a `bun.DB` on top of it using the corresponding SQLite dialect: +And then create a `bun.DB` on top of it using the corresponding SQLite +[dialect](https://bun.uptrace.dev/guide/drivers.html) that comes with Bun: ```go import ( |