mattn/go-sqlite3
GitHub: mattn/go-sqlite3
Go 语言标准 database/sql 接口的 SQLite3 驱动，为 Go 应用提供轻量级嵌入式数据库支持。
Stars: 9071 | Forks: 1157
# go-sqlite3
[](https://pkg.go.dev/github.com/mattn/go-sqlite3)
[](https://github.com/mattn/go-sqlite3/actions?query=workflow%3AGo)
[](https://opencollective.com/mattn-go-sqlite3)
[](https://codecov.io/gh/mattn/go-sqlite3)
[](https://goreportcard.com/report/github.com/mattn/go-sqlite3)
最新的稳定版本是 v1.14 或更高版本，而不是 v2。
~~**注意：** 升级到 v2 是一个意外。并没有任何重大的更改或新功能。~~
# 描述
一个符合内建 database/sql 接口的 sqlite3 驱动。
支持的 Golang 版本：请参见 [.github/workflows/go.yaml](./.github/workflows/go.yaml)。
此包遵循官方的 [Golang 发布策略](https://golang.org/doc/devel/release.html#policy)。
### 概述
- [go-sqlite3](#go-sqlite3)
- [描述](#description)
- [概述](#overview)
- [安装](#installation)
- [API 参考](#api-reference)
- [连接字符串](#connection-string)
- [DSN 示例](#dsn-examples)
- [功能](#features)
- [用法](#usage)
- [功能 / 扩展列表](#feature--extension-list)
- [编译](#compilation)
- [Android](#android)
- [ARM](#arm)
- [交叉编译](#cross-compile)
- [编译中](#compiling)
- [Linux](#linux)
- [Alpine](#alpine)
- [Fedora](#fedora)
- [Ubuntu](#ubuntu)
- [macOS](#mac-osx)
- [Windows](#windows)
- [错误](#errors)
- [用户认证](#user-authentication)
- [编译](#compile)
- [用法](#usage-1)
- [创建受保护的数据库](#create-protected-database)
- [密码编码](#password-encoding)
- [可用的编码器](#available-encoders)
- [限制](#restrictions)
- [支持](#support)
- [用户管理](#user-management)
- [SQL](#sql)
- [示例](#examples)
- [*SQLiteConn](#sqliteconn)
- [附加数据库](#attached-database)
- [扩展](#extensions)
- [Spatialite](#spatialite)
- [常见问题](#faq)
- [许可证](#license)
- [作者](#author)
# 安装
此包可以通过 `go get` 命令安装：
```
go get github.com/mattn/go-sqlite3
```
_go-sqlite3_ 是一个 *cgo* 包。
如果你想使用 go-sqlite3 构建你的应用程序，你需要 gcc。
***重要提示：因为这是一个启用了 `CGO` 的包，你必须设置环境变量 `CGO_ENABLED=1` 并确保在你的路径中包含 `gcc` 编译器。***
# API 参考
API 文档可以在[这里](http://godoc.org/github.com/mattn/go-sqlite3)找到。
示例可以在 [examples](./_example) 目录下找到。
# 连接字符串
当创建新的 SQLite 数据库或连接到现有数据库时，可以在文件名后提供附加选项。
这也被称为 DSN (Data Source Name) 字符串。
选项附加在 SQLite 数据库的文件名之后。
数据库文件名和选项由 `?` （问号）分隔。
选项应进行 URL 编码（参见 [url.QueryEscape](https://golang.org/pkg/net/url/#QueryEscape)）。
这也适用于使用内存数据库而不是文件的情况。
可以使用以下格式给出选项：`KEYWORD=VALUE`，多个选项可以用 `&` 符号组合。
此库支持 SQLite 本身的 DSN 选项，并提供了额外的选项。
布尔值可以是以下之一：
* `0` `no` `false` `off`
* `1` `yes` `true` `on`
| 名称 | 键 | 值 | 描述 |
|------|-----|----------|-------------|
| UA - 创建 | `_auth` | - | 创建用户认证，更多信息请参见[用户认证](#user-authentication) |
| UA - 用户名 | `_auth_user` | `string` | 用于用户认证的用户名，更多信息请参见[用户认证](#user-authentication) |
| UA - 密码 | `_auth_pass` | `string` | 用于用户认证的密码，更多信息请参见[用户认证](#user-authentication) |
| UA - 加密 | `_auth_crypt` | "
For available features, see the extension list.
When using multiple build tags, all the different tags should be space delimited.
Example:
```bash
#### go build -tags "icu json1 fts5 secure_delete"
### 特性 / 扩展列表
| Extension | Build Tag | Description |
|-----------|-----------|-------------|
| Additional Statistics | sqlite_stat4 | This option adds additional logic to the ANALYZE command and to the query planner that can help SQLite to chose a better query plan under certain situations. The ANALYZE command is enhanced to collect histogram data from all columns of every index and store that data in the sqlite_stat4 table.
The query planner will then use the histogram data to help it make better index choices. The downside of this compile-time option is that it violates the query planner stability guarantee making it more difficult to ensure consistent performance in mass-produced applications.
SQLITE_ENABLE_STAT4 is an enhancement of SQLITE_ENABLE_STAT3. STAT3 only recorded histogram data for the left-most column of each index whereas the STAT4 enhancement records histogram data from all columns of each index.
The SQLITE_ENABLE_STAT3 compile-time option is a no-op and is ignored if the SQLITE_ENABLE_STAT4 compile-time option is used | | Allow URI Authority | sqlite_allow_uri_authority | URI filenames normally throws an error if the authority section is not either empty or "localhost".
However, if SQLite is compiled with the SQLITE_ALLOW_URI_AUTHORITY compile-time option, then the URI is converted into a Uniform Naming Convention (UNC) filename and passed down to the underlying operating system that way | | App Armor | sqlite_app_armor | When defined, this C-preprocessor macro activates extra code that attempts to detect misuse of the SQLite API, such as passing in NULL pointers to required parameters or using objects after they have been destroyed.
App Armor is not available under `Windows`. | | Disable Load Extensions | sqlite_omit_load_extension | Loading of external extensions is enabled by default.
To disable extension loading add the build tag `sqlite_omit_load_extension`. | | Enable Serialization with `libsqlite3` | sqlite_serialize | Serialization and deserialization of a SQLite database is available by default, unless the build tag `libsqlite3` is set.
To enable this functionality even if `libsqlite3` is set, add the build tag `sqlite_serialize`. | | Foreign Keys | sqlite_foreign_keys | This macro determines whether enforcement of foreign key constraints is enabled or disabled by default for new database connections.
Each database connection can always turn enforcement of foreign key constraints on and off and run-time using the foreign_keys pragma.
Enforcement of foreign key constraints is normally off by default, but if this compile-time parameter is set to 1, enforcement of foreign key constraints will be on by default | | Full Auto Vacuum | sqlite_vacuum_full | Set the default auto vacuum to full | | Incremental Auto Vacuum | sqlite_vacuum_incr | Set the default auto vacuum to incremental | | Full Text Search Engine | sqlite_fts5 | When this option is defined in the amalgamation, versions 5 of the full-text search engine (fts5) is added to the build automatically | | International Components for Unicode | sqlite_icu | This option causes the International Components for Unicode or "ICU" extension to SQLite to be added to the build | | Introspect PRAGMAS | sqlite_introspect | This option adds some extra PRAGMA statements.
When this option is not used, secure_delete defaults to off. When this option is present, secure_delete defaults to on.
The secure_delete setting causes deleted content to be overwritten with zeros. There is a small performance penalty since additional I/O must occur.
On the other hand, secure_delete can prevent fragments of sensitive information from lingering in unused parts of the database file after it has been deleted. See the documentation on the secure_delete pragma for additional information | | Secure Delete (FAST) | sqlite_secure_delete_fast | For more information see [PRAGMA secure_delete](https://www.sqlite.org/pragma.html#pragma_secure_delete) | | Tracing / Debug | sqlite_trace | Activate trace functions | | User Authentication | sqlite_userauth | SQLite User Authentication see [User Authentication](#user-authentication) for more information. | | Virtual Tables | sqlite_vtable | SQLite Virtual Tables see [SQLite Official VTABLE Documentation](https://www.sqlite.org/vtab.html) for more information, and a [full example here](https://github.com/mattn/go-sqlite3/tree/master/_example/vtable) | # 编译 This package requires the `CGO_ENABLED=1` environment variable if not set by default, and the presence of the `gcc` compiler. If you need to add additional CFLAGS or LDFLAGS to the build command, and do not want to modify this package, then this can be achieved by using the `CGO_CFLAGS` and `CGO_LDFLAGS` environment variables. ## Android This package can be compiled for android. Compile with: ```bash #### go build -tags "android" For more information see [#201](https://github.com/mattn/go-sqlite3/issues/201) # ARM To compile for `ARM` use the following environment: ```bash env CC=arm-linux-gnueabihf-gcc CXX=arm-linux-gnueabihf-g++ \ CGO_ENABLED=1 GOOS=linux GOARCH=arm GOARM=7 \ #### go build -v Additional information: - [#242](https://github.com/mattn/go-sqlite3/issues/242) - [#504](https://github.com/mattn/go-sqlite3/issues/504) # 交叉编译 This library can be cross-compiled. In some cases you are required to the `CC` environment variable with the cross compiler. ## 从 macOS 交叉编译 The simplest way to cross compile from macOS is to use [xgo](https://github.com/karalabe/xgo). Steps: - Install [musl-cross](https://github.com/FiloSottile/homebrew-musl-cross) (`brew install FiloSottile/musl-cross/musl-cross`). - Run `CC=x86_64-linux-musl-gcc CXX=x86_64-linux-musl-g++ GOARCH=amd64 GOOS=linux CGO_ENABLED=1 go build -ldflags "-linkmode external -extldflags -static"`. Please refer to the project's [README](https://github.com/FiloSottile/homebrew-musl-cross#readme) for further information. # 编译 ## Linux To compile this package on Linux, you must install the development tools for your linux distribution. To compile under linux use the build tag `linux`. ```bash #### go build -tags "linux" #### 如果你想直接链接到 libsqlite3，可以使用 `libsqlite3` 构建标签。 #### go build -tags "libsqlite3 linux" ### Alpine #### 在 `alpine` 容器中构建时，请在构建前运行以下命令： #### apk add --update gcc musl-dev ### Fedora ```bash #### sudo yum groupinstall "Development Tools" "Development Libraries" ### Ubuntu ```bash #### sudo apt-get install build-essential ## macOS macOS should have all the tools present to compile this package. If not, install XCode to add all the developers tools. Required dependency: ```bash #### brew install sqlite3 For macOS, there is an additional package to install which is required if you wish to build the `icu` extension. This additional package can be installed with `homebrew`: ```bash #### brew upgrade icu4c To compile for macOS on x86: ```bash #### go build -tags "darwin amd64" To compile for macOS on ARM chips: ```bash #### go build -tags "darwin arm64" #### 如果你想直接链接到 libsqlite3，请使用 `libsqlite3` 构建标签： # x86 go build -tags "libsqlite3 darwin amd64" # ARM #### go build -tags "libsqlite3 darwin arm64" Additional information: - [#206](https://github.com/mattn/go-sqlite3/issues/206) - [#404](https://github.com/mattn/go-sqlite3/issues/404) ## Windows To compile this package on Windows, you must have the `gcc` compiler installed. 1) Install a Windows `gcc` toolchain. 2) Add the `bin` folder to the Windows path, if the installer did not do this by default. 3) Open a terminal for the TDM-GCC toolchain, which can be found in the Windows Start menu. 4) Navigate to your project folder and run the `go build ...` command for this package. For example the TDM-GCC Toolchain can be found [here](https://jmeubank.github.io/tdm-gcc/). ## 错误 - Compile error: `can not be used when making a shared object; recompile with -fPIC` When receiving a compile time error referencing recompile with `-FPIC` then you are probably using a hardend system. You can compile the library on a hardend system with the following command. ```bash go build -ldflags '-extldflags=-fno-PIC' ``` More details see [#120](https://github.com/mattn/go-sqlite3/issues/120) - Can't build go-sqlite3 on windows 64bit. > Probably, you are using go 1.0, go1.0 has a problem when it comes to compiling/linking on windows 64bit. > See: [#27](https://github.com/mattn/go-sqlite3/issues/27) - `go get github.com/mattn/go-sqlite3` throws compilation error. `gcc` throws: `internal compiler error` Remove the download repository from your disk and try re-install with: ```bash go install github.com/mattn/go-sqlite3 ``` # 用户认证 ***This is deprecated*** This package supports the SQLite User Authentication module. ## 编译 To use the User authentication module, the package has to be compiled with the tag `sqlite_userauth`. See [Features](#features). ## 用法 ### 创建受保护的数据库 To create a database protected by user authentication, provide the following argument to the connection string `_auth`. This will enable user authentication within the database. This option however requires two additional arguments: - `_auth_user` - `_auth_pass` When `_auth` is present in the connection string user authentication will be enabled and the provided user will be created as an `admin` user. After initial creation, the parameter `_auth` has no effect anymore and can be omitted from the connection string. Example connection strings: Create an user authentication database with user `admin` and password `admin`: `file:test.s3db?_auth&_auth_user=admin&_auth_pass=admin` Create an user authentication database with user `admin` and password `admin` and use `SHA1` for the password encoding: `file:test.s3db?_auth&_auth_user=admin&_auth_pass=admin&_auth_crypt=sha1` ### 密码编码 The passwords within the user authentication module of SQLite are encoded with the SQLite function `sqlite_cryp`. This function uses a ceasar-cypher which is quite insecure. This library provides several additional password encoders which can be configured through the connection string. The password cypher can be configured with the key `_auth_crypt`. And if the configured password encoder also requires an salt this can be configured with `_auth_salt`. #### 可用的编码器 - SHA1 - SSHA1 (Salted SHA1) - SHA256 - SSHA256 (salted SHA256) - SHA384 - SSHA384 (salted SHA384) - SHA512 - SSHA512 (salted SHA512) ### 限制 Operations on the database regarding user management can only be preformed by an administrator user. ### 支持 The user authentication supports two kinds of users: - administrators - regular users ### 用户管理 User management can be done by directly using the `*SQLiteConn` or by SQL. #### SQL The following sql functions are available for user management: | Function | Arguments | Description | |----------|-----------|-------------| | `authenticate` | username `string`, password `string` | Will authenticate an user, this is done by the connection; and should not be used manually. | | `auth_user_add` | username `string`, password `string`, admin `int` | This function will add an user to the database.
if the database is not protected by user authentication it will enable it. Argument `admin` is an integer identifying if the added user should be an administrator. Only Administrators can add administrators. | | `auth_user_change` | username `string`, password `string`, admin `int` | Function to modify an user. Users can change their own password, but only an administrator can change the administrator flag. | | `authUserDelete` | username `string` | Delete an user from the database. Can only be used by an administrator. The current logged in administrator cannot be deleted. This is to make sure their is always an administrator remaining. | These functions will return an integer: - 0 (SQLITE_OK) - 23 (SQLITE_AUTH) Failed to perform due to authentication or insufficient privileges ##### 示例 ```sql // Autheticate user // Create Admin User SELECT auth_user_add('admin2', 'admin2', 1); // Change password for user SELECT auth_user_change('user', 'userpassword', 0); // Delete user #### SELECT user_delete('user'); #### *SQLiteConn The following functions are available for User authentication from the `*SQLiteConn`: | Function | Description | |----------|-------------| | `Authenticate(username, password string) error` | Authenticate user | | `AuthUserAdd(username, password string, admin bool) error` | Add user | | `AuthUserChange(username, password string, admin bool) error` | Modify user | | `AuthUserDelete(username string) error` | Delete user | ### 附加数据库 When using attached databases, SQLite will use the authentication from the `main` database for the attached database(s). # 扩展 If you want your own extension to be listed here, or you want to add a reference to an extension; please submit an Issue for this. ## Spatialite Spatialite is available as an extension to SQLite, and can be used in combination with this repository. For an example, see [shaxbee/go-spatialite](https://github.com/shaxbee/go-spatialite). ## SQLite3 Contrib 中的 extension-functions.c extension-functions.c is available as an extension to SQLite, and provides the following functions: - Math: acos, asin, atan, atn2, atan2, acosh, asinh, atanh, difference, degrees, radians, cos, sin, tan, cot, cosh, sinh, tanh, coth, exp, log, log10, power, sign, sqrt, square, ceil, floor, pi. - String: replicate, charindex, leftstr, rightstr, ltrim, rtrim, trim, replace, reverse, proper, padl, padr, padc, strfilter. - Aggregate: stdev, variance, mode, median, lower_quartile, upper_quartile For an example, see [dinedal/go-sqlite3-extension-functions](https://github.com/dinedal/go-sqlite3-extension-functions). # 常见问题 - Getting insert error while query is opened. > You can pass some arguments into the connection string, for example, a URI. > See: [#39](https://github.com/mattn/go-sqlite3/issues/39) - Do you want to cross compile? mingw on Linux or Mac? > See: [#106](https://github.com/mattn/go-sqlite3/issues/106) > See also: http://www.limitlessfx.com/cross-compile-golang-app-for-windows-from-linux.html - Want to get time.Time with current locale Use `_loc=auto` in SQLite3 filename schema like `file:foo.db?_loc=auto`. - Can I use this in multiple routines concurrently? Yes for readonly. But not for writable. See [#50](https://github.com/mattn/go-sqlite3/issues/50), [#51](https://github.com/mattn/go-sqlite3/issues/51), [#209](https://github.com/mattn/go-sqlite3/issues/209), [#274](https://github.com/mattn/go-sqlite3/issues/274). - Why I'm getting `no such table` error? Why is it racy if I use a `sql.Open("sqlite3", ":memory:")` database? Each connection to `":memory:"` opens a brand new in-memory sql database, so if the stdlib's sql engine happens to open another connection and you've only specified `":memory:"`, that connection will see a brand new database. A workaround is to use `"file::memory:?cache=shared"` (or `"file:foobar?mode=memory&cache=shared"`). Every connection to this string will point to the same in-memory database. Note that if the last database connection in the pool closes, the in-memory database is deleted. Make sure the [max idle connection limit](https://golang.org/pkg/database/sql/#DB.SetMaxIdleConns) is > 0, and the [connection lifetime](https://golang.org/pkg/database/sql/#DB.SetConnMaxLifetime) is infinite. For more information see: * [#204](https://github.com/mattn/go-sqlite3/issues/204) * [#511](https://github.com/mattn/go-sqlite3/issues/511) * https://www.sqlite.org/sharedcache.html#shared_cache_and_in_memory_databases * https://www.sqlite.org/inmemorydb.html#sharedmemdb - Reading from database with large amount of goroutines fails on OSX. OS X limits OS-wide to not have more than 1000 files open simultaneously by default. For more information, see [#289](https://github.com/mattn/go-sqlite3/issues/289) - Trying to execute a `.` (dot) command throws an error. Error: `Error: near ".": syntax error` Dot command are part of SQLite3 CLI, not of this library. You need to implement the feature or call the sqlite3 cli. More information see [#305](https://github.com/mattn/go-sqlite3/issues/305). - Error: `database is locked` When you get a database is locked, please use the following options. Add to DSN: `cache=shared` Example: ```go db, err := sql.Open("sqlite3", "file:locked.sqlite?cache=shared") ``` Next, please set the database connections of the SQL package to 1: ```go db.SetMaxOpenConns(1) ``` For more information, see [#209](https://github.com/mattn/go-sqlite3/issues/209). ## 贡献者 ### 代码贡献者 This project exists thanks to all the people who [[contribute](CONTRIBUTING.md)].
### 资金贡献者
Become a financial contributor and help us sustain our community. [[Contribute here](https://opencollective.com/mattn-go-sqlite3/contribute)].
#### 个人
#### 组织
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/mattn-go-sqlite3/contribute)]
# 许可证
MIT: http://mattn.mit-license.org/2018
sqlite3-binding.c, sqlite3-binding.h, sqlite3ext.h
The -binding suffix was added to avoid build failures under gccgo.
In this repository, those files are an amalgamation of code that was copied from SQLite3. The license of that code is the same as the license of SQLite3.
# 作者
Yasuhiro Matsumoto (a.k.a mattn)
G.J.R. Timmer
```
- SHA1
- SSHA1
- SHA256
- SSHA256
- SHA384
- SSHA384
- SHA512
- SSHA512
- `0` \| `none`
- `1` \| `full`
- `2` \| `incremental`
- DELETE
- TRUNCATE
- PERSIST
- MEMORY
- WAL
- OFF
- NORMAL
- EXCLUSIVE
- ro
- rw
- rwc
- memory
- no
- full
- shared
- private
- 0 \| OFF
- 1 \| NORMAL
- 2 \| FULL
- 3 \| EXTRA
- immediate
- deferred
- exclusive
The query planner will then use the histogram data to help it make better index choices. The downside of this compile-time option is that it violates the query planner stability guarantee making it more difficult to ensure consistent performance in mass-produced applications.
SQLITE_ENABLE_STAT4 is an enhancement of SQLITE_ENABLE_STAT3. STAT3 only recorded histogram data for the left-most column of each index whereas the STAT4 enhancement records histogram data from all columns of each index.
The SQLITE_ENABLE_STAT3 compile-time option is a no-op and is ignored if the SQLITE_ENABLE_STAT4 compile-time option is used | | Allow URI Authority | sqlite_allow_uri_authority | URI filenames normally throws an error if the authority section is not either empty or "localhost".
However, if SQLite is compiled with the SQLITE_ALLOW_URI_AUTHORITY compile-time option, then the URI is converted into a Uniform Naming Convention (UNC) filename and passed down to the underlying operating system that way | | App Armor | sqlite_app_armor | When defined, this C-preprocessor macro activates extra code that attempts to detect misuse of the SQLite API, such as passing in NULL pointers to required parameters or using objects after they have been destroyed.
App Armor is not available under `Windows`. | | Disable Load Extensions | sqlite_omit_load_extension | Loading of external extensions is enabled by default.
To disable extension loading add the build tag `sqlite_omit_load_extension`. | | Enable Serialization with `libsqlite3` | sqlite_serialize | Serialization and deserialization of a SQLite database is available by default, unless the build tag `libsqlite3` is set.
To enable this functionality even if `libsqlite3` is set, add the build tag `sqlite_serialize`. | | Foreign Keys | sqlite_foreign_keys | This macro determines whether enforcement of foreign key constraints is enabled or disabled by default for new database connections.
Each database connection can always turn enforcement of foreign key constraints on and off and run-time using the foreign_keys pragma.
Enforcement of foreign key constraints is normally off by default, but if this compile-time parameter is set to 1, enforcement of foreign key constraints will be on by default | | Full Auto Vacuum | sqlite_vacuum_full | Set the default auto vacuum to full | | Incremental Auto Vacuum | sqlite_vacuum_incr | Set the default auto vacuum to incremental | | Full Text Search Engine | sqlite_fts5 | When this option is defined in the amalgamation, versions 5 of the full-text search engine (fts5) is added to the build automatically | | International Components for Unicode | sqlite_icu | This option causes the International Components for Unicode or "ICU" extension to SQLite to be added to the build | | Introspect PRAGMAS | sqlite_introspect | This option adds some extra PRAGMA statements.
- PRAGMA function_list
- PRAGMA module_list
- PRAGMA pragma_list
When this option is not used, secure_delete defaults to off. When this option is present, secure_delete defaults to on.
The secure_delete setting causes deleted content to be overwritten with zeros. There is a small performance penalty since additional I/O must occur.
On the other hand, secure_delete can prevent fragments of sensitive information from lingering in unused parts of the database file after it has been deleted. See the documentation on the secure_delete pragma for additional information | | Secure Delete (FAST) | sqlite_secure_delete_fast | For more information see [PRAGMA secure_delete](https://www.sqlite.org/pragma.html#pragma_secure_delete) | | Tracing / Debug | sqlite_trace | Activate trace functions | | User Authentication | sqlite_userauth | SQLite User Authentication see [User Authentication](#user-authentication) for more information. | | Virtual Tables | sqlite_vtable | SQLite Virtual Tables see [SQLite Official VTABLE Documentation](https://www.sqlite.org/vtab.html) for more information, and a [full example here](https://github.com/mattn/go-sqlite3/tree/master/_example/vtable) | # 编译 This package requires the `CGO_ENABLED=1` environment variable if not set by default, and the presence of the `gcc` compiler. If you need to add additional CFLAGS or LDFLAGS to the build command, and do not want to modify this package, then this can be achieved by using the `CGO_CFLAGS` and `CGO_LDFLAGS` environment variables. ## Android This package can be compiled for android. Compile with: ```bash #### go build -tags "android" For more information see [#201](https://github.com/mattn/go-sqlite3/issues/201) # ARM To compile for `ARM` use the following environment: ```bash env CC=arm-linux-gnueabihf-gcc CXX=arm-linux-gnueabihf-g++ \ CGO_ENABLED=1 GOOS=linux GOARCH=arm GOARM=7 \ #### go build -v Additional information: - [#242](https://github.com/mattn/go-sqlite3/issues/242) - [#504](https://github.com/mattn/go-sqlite3/issues/504) # 交叉编译 This library can be cross-compiled. In some cases you are required to the `CC` environment variable with the cross compiler. ## 从 macOS 交叉编译 The simplest way to cross compile from macOS is to use [xgo](https://github.com/karalabe/xgo). Steps: - Install [musl-cross](https://github.com/FiloSottile/homebrew-musl-cross) (`brew install FiloSottile/musl-cross/musl-cross`). - Run `CC=x86_64-linux-musl-gcc CXX=x86_64-linux-musl-g++ GOARCH=amd64 GOOS=linux CGO_ENABLED=1 go build -ldflags "-linkmode external -extldflags -static"`. Please refer to the project's [README](https://github.com/FiloSottile/homebrew-musl-cross#readme) for further information. # 编译 ## Linux To compile this package on Linux, you must install the development tools for your linux distribution. To compile under linux use the build tag `linux`. ```bash #### go build -tags "linux" #### 如果你想直接链接到 libsqlite3，可以使用 `libsqlite3` 构建标签。 #### go build -tags "libsqlite3 linux" ### Alpine #### 在 `alpine` 容器中构建时，请在构建前运行以下命令： #### apk add --update gcc musl-dev ### Fedora ```bash #### sudo yum groupinstall "Development Tools" "Development Libraries" ### Ubuntu ```bash #### sudo apt-get install build-essential ## macOS macOS should have all the tools present to compile this package. If not, install XCode to add all the developers tools. Required dependency: ```bash #### brew install sqlite3 For macOS, there is an additional package to install which is required if you wish to build the `icu` extension. This additional package can be installed with `homebrew`: ```bash #### brew upgrade icu4c To compile for macOS on x86: ```bash #### go build -tags "darwin amd64" To compile for macOS on ARM chips: ```bash #### go build -tags "darwin arm64" #### 如果你想直接链接到 libsqlite3，请使用 `libsqlite3` 构建标签： # x86 go build -tags "libsqlite3 darwin amd64" # ARM #### go build -tags "libsqlite3 darwin arm64" Additional information: - [#206](https://github.com/mattn/go-sqlite3/issues/206) - [#404](https://github.com/mattn/go-sqlite3/issues/404) ## Windows To compile this package on Windows, you must have the `gcc` compiler installed. 1) Install a Windows `gcc` toolchain. 2) Add the `bin` folder to the Windows path, if the installer did not do this by default. 3) Open a terminal for the TDM-GCC toolchain, which can be found in the Windows Start menu. 4) Navigate to your project folder and run the `go build ...` command for this package. For example the TDM-GCC Toolchain can be found [here](https://jmeubank.github.io/tdm-gcc/). ## 错误 - Compile error: `can not be used when making a shared object; recompile with -fPIC` When receiving a compile time error referencing recompile with `-FPIC` then you are probably using a hardend system. You can compile the library on a hardend system with the following command. ```bash go build -ldflags '-extldflags=-fno-PIC' ``` More details see [#120](https://github.com/mattn/go-sqlite3/issues/120) - Can't build go-sqlite3 on windows 64bit. > Probably, you are using go 1.0, go1.0 has a problem when it comes to compiling/linking on windows 64bit. > See: [#27](https://github.com/mattn/go-sqlite3/issues/27) - `go get github.com/mattn/go-sqlite3` throws compilation error. `gcc` throws: `internal compiler error` Remove the download repository from your disk and try re-install with: ```bash go install github.com/mattn/go-sqlite3 ``` # 用户认证 ***This is deprecated*** This package supports the SQLite User Authentication module. ## 编译 To use the User authentication module, the package has to be compiled with the tag `sqlite_userauth`. See [Features](#features). ## 用法 ### 创建受保护的数据库 To create a database protected by user authentication, provide the following argument to the connection string `_auth`. This will enable user authentication within the database. This option however requires two additional arguments: - `_auth_user` - `_auth_pass` When `_auth` is present in the connection string user authentication will be enabled and the provided user will be created as an `admin` user. After initial creation, the parameter `_auth` has no effect anymore and can be omitted from the connection string. Example connection strings: Create an user authentication database with user `admin` and password `admin`: `file:test.s3db?_auth&_auth_user=admin&_auth_pass=admin` Create an user authentication database with user `admin` and password `admin` and use `SHA1` for the password encoding: `file:test.s3db?_auth&_auth_user=admin&_auth_pass=admin&_auth_crypt=sha1` ### 密码编码 The passwords within the user authentication module of SQLite are encoded with the SQLite function `sqlite_cryp`. This function uses a ceasar-cypher which is quite insecure. This library provides several additional password encoders which can be configured through the connection string. The password cypher can be configured with the key `_auth_crypt`. And if the configured password encoder also requires an salt this can be configured with `_auth_salt`. #### 可用的编码器 - SHA1 - SSHA1 (Salted SHA1) - SHA256 - SSHA256 (salted SHA256) - SHA384 - SSHA384 (salted SHA384) - SHA512 - SSHA512 (salted SHA512) ### 限制 Operations on the database regarding user management can only be preformed by an administrator user. ### 支持 The user authentication supports two kinds of users: - administrators - regular users ### 用户管理 User management can be done by directly using the `*SQLiteConn` or by SQL. #### SQL The following sql functions are available for user management: | Function | Arguments | Description | |----------|-----------|-------------| | `authenticate` | username `string`, password `string` | Will authenticate an user, this is done by the connection; and should not be used manually. | | `auth_user_add` | username `string`, password `string`, admin `int` | This function will add an user to the database.
if the database is not protected by user authentication it will enable it. Argument `admin` is an integer identifying if the added user should be an administrator. Only Administrators can add administrators. | | `auth_user_change` | username `string`, password `string`, admin `int` | Function to modify an user. Users can change their own password, but only an administrator can change the administrator flag. | | `authUserDelete` | username `string` | Delete an user from the database. Can only be used by an administrator. The current logged in administrator cannot be deleted. This is to make sure their is always an administrator remaining. | These functions will return an integer: - 0 (SQLITE_OK) - 23 (SQLITE_AUTH) Failed to perform due to authentication or insufficient privileges ##### 示例 ```sql // Autheticate user // Create Admin User SELECT auth_user_add('admin2', 'admin2', 1); // Change password for user SELECT auth_user_change('user', 'userpassword', 0); // Delete user #### SELECT user_delete('user'); #### *SQLiteConn The following functions are available for User authentication from the `*SQLiteConn`: | Function | Description | |----------|-------------| | `Authenticate(username, password string) error` | Authenticate user | | `AuthUserAdd(username, password string, admin bool) error` | Add user | | `AuthUserChange(username, password string, admin bool) error` | Modify user | | `AuthUserDelete(username string) error` | Delete user | ### 附加数据库 When using attached databases, SQLite will use the authentication from the `main` database for the attached database(s). # 扩展 If you want your own extension to be listed here, or you want to add a reference to an extension; please submit an Issue for this. ## Spatialite Spatialite is available as an extension to SQLite, and can be used in combination with this repository. For an example, see [shaxbee/go-spatialite](https://github.com/shaxbee/go-spatialite). ## SQLite3 Contrib 中的 extension-functions.c extension-functions.c is available as an extension to SQLite, and provides the following functions: - Math: acos, asin, atan, atn2, atan2, acosh, asinh, atanh, difference, degrees, radians, cos, sin, tan, cot, cosh, sinh, tanh, coth, exp, log, log10, power, sign, sqrt, square, ceil, floor, pi. - String: replicate, charindex, leftstr, rightstr, ltrim, rtrim, trim, replace, reverse, proper, padl, padr, padc, strfilter. - Aggregate: stdev, variance, mode, median, lower_quartile, upper_quartile For an example, see [dinedal/go-sqlite3-extension-functions](https://github.com/dinedal/go-sqlite3-extension-functions). # 常见问题 - Getting insert error while query is opened. > You can pass some arguments into the connection string, for example, a URI. > See: [#39](https://github.com/mattn/go-sqlite3/issues/39) - Do you want to cross compile? mingw on Linux or Mac? > See: [#106](https://github.com/mattn/go-sqlite3/issues/106) > See also: http://www.limitlessfx.com/cross-compile-golang-app-for-windows-from-linux.html - Want to get time.Time with current locale Use `_loc=auto` in SQLite3 filename schema like `file:foo.db?_loc=auto`. - Can I use this in multiple routines concurrently? Yes for readonly. But not for writable. See [#50](https://github.com/mattn/go-sqlite3/issues/50), [#51](https://github.com/mattn/go-sqlite3/issues/51), [#209](https://github.com/mattn/go-sqlite3/issues/209), [#274](https://github.com/mattn/go-sqlite3/issues/274). - Why I'm getting `no such table` error? Why is it racy if I use a `sql.Open("sqlite3", ":memory:")` database? Each connection to `":memory:"` opens a brand new in-memory sql database, so if the stdlib's sql engine happens to open another connection and you've only specified `":memory:"`, that connection will see a brand new database. A workaround is to use `"file::memory:?cache=shared"` (or `"file:foobar?mode=memory&cache=shared"`). Every connection to this string will point to the same in-memory database. Note that if the last database connection in the pool closes, the in-memory database is deleted. Make sure the [max idle connection limit](https://golang.org/pkg/database/sql/#DB.SetMaxIdleConns) is > 0, and the [connection lifetime](https://golang.org/pkg/database/sql/#DB.SetConnMaxLifetime) is infinite. For more information see: * [#204](https://github.com/mattn/go-sqlite3/issues/204) * [#511](https://github.com/mattn/go-sqlite3/issues/511) * https://www.sqlite.org/sharedcache.html#shared_cache_and_in_memory_databases * https://www.sqlite.org/inmemorydb.html#sharedmemdb - Reading from database with large amount of goroutines fails on OSX. OS X limits OS-wide to not have more than 1000 files open simultaneously by default. For more information, see [#289](https://github.com/mattn/go-sqlite3/issues/289) - Trying to execute a `.` (dot) command throws an error. Error: `Error: near ".": syntax error` Dot command are part of SQLite3 CLI, not of this library. You need to implement the feature or call the sqlite3 cli. More information see [#305](https://github.com/mattn/go-sqlite3/issues/305). - Error: `database is locked` When you get a database is locked, please use the following options. Add to DSN: `cache=shared` Example: ```go db, err := sql.Open("sqlite3", "file:locked.sqlite?cache=shared") ``` Next, please set the database connections of the SQL package to 1: ```go db.SetMaxOpenConns(1) ``` For more information, see [#209](https://github.com/mattn/go-sqlite3/issues/209). ## 贡献者 ### 代码贡献者 This project exists thanks to all the people who [[contribute](CONTRIBUTING.md)].
### 资金贡献者
Become a financial contributor and help us sustain our community. [[Contribute here](https://opencollective.com/mattn-go-sqlite3/contribute)].
#### 个人
#### 组织
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/mattn-go-sqlite3/contribute)]
# 许可证
MIT: http://mattn.mit-license.org/2018
sqlite3-binding.c, sqlite3-binding.h, sqlite3ext.h
The -binding suffix was added to avoid build failures under gccgo.
In this repository, those files are an amalgamation of code that was copied from SQLite3. The license of that code is the same as the license of SQLite3.
# 作者
Yasuhiro Matsumoto (a.k.a mattn)
G.J.R. Timmer
```
标签：CGO, database/sql, Go, Golang, ORM底层支持, Ruby工具, SQLite3, 关系型数据库, 后端开发, 安全编程, 嵌入式数据库, 开源库, 搜索引擎爬虫, 数据库驱动, 数据持久化, 日志审计, 本地存储, 跨平台编译, 轻量级数据库