1go-sqlite3 2========== 3 4[![GoDoc Reference](https://godoc.org/github.com/mattn/go-sqlite3?status.svg)](http://godoc.org/github.com/mattn/go-sqlite3) 5[![GitHub Actions](https://github.com/mattn/go-sqlite3/workflows/Go/badge.svg)](https://github.com/mattn/go-sqlite3/actions?query=workflow%3AGo) 6[![Financial Contributors on Open Collective](https://opencollective.com/mattn-go-sqlite3/all/badge.svg?label=financial+contributors)](https://opencollective.com/mattn-go-sqlite3) 7[![codecov](https://codecov.io/gh/mattn/go-sqlite3/branch/master/graph/badge.svg)](https://codecov.io/gh/mattn/go-sqlite3) 8[![Go Report Card](https://goreportcard.com/badge/github.com/mattn/go-sqlite3)](https://goreportcard.com/report/github.com/mattn/go-sqlite3) 9 10Latest stable version is v1.14 or later, not v2. 11 12~~**NOTE:** The increase to v2 was an accident. There were no major changes or features.~~ 13 14# Description 15 16A sqlite3 driver that conforms to the built-in database/sql interface. 17 18Supported Golang version: See [.github/workflows/go.yaml](./.github/workflows/go.yaml). 19 20This package follows the official [Golang Release Policy](https://golang.org/doc/devel/release.html#policy). 21 22### Overview 23 24- [go-sqlite3](#go-sqlite3) 25- [Description](#description) 26 - [Overview](#overview) 27- [Installation](#installation) 28- [API Reference](#api-reference) 29- [Connection String](#connection-string) 30 - [DSN Examples](#dsn-examples) 31- [Features](#features) 32 - [Usage](#usage) 33 - [Feature / Extension List](#feature--extension-list) 34- [Compilation](#compilation) 35 - [Android](#android) 36- [ARM](#arm) 37- [Cross Compile](#cross-compile) 38- [Google Cloud Platform](#google-cloud-platform) 39 - [Linux](#linux) 40 - [Alpine](#alpine) 41 - [Fedora](#fedora) 42 - [Ubuntu](#ubuntu) 43 - [Mac OSX](#mac-osx) 44 - [Windows](#windows) 45 - [Errors](#errors) 46- [User Authentication](#user-authentication) 47 - [Compile](#compile) 48 - [Usage](#usage-1) 49 - [Create protected database](#create-protected-database) 50 - [Password Encoding](#password-encoding) 51 - [Available Encoders](#available-encoders) 52 - [Restrictions](#restrictions) 53 - [Support](#support) 54 - [User Management](#user-management) 55 - [SQL](#sql) 56 - [Examples](#examples) 57 - [*SQLiteConn](#sqliteconn) 58 - [Attached database](#attached-database) 59- [Extensions](#extensions) 60 - [Spatialite](#spatialite) 61- [FAQ](#faq) 62- [License](#license) 63- [Author](#author) 64 65# Installation 66 67This package can be installed with the `go get` command: 68 69 go get github.com/mattn/go-sqlite3 70 71_go-sqlite3_ is *cgo* package. 72If you want to build your app using go-sqlite3, you need gcc. 73However, after you have built and installed _go-sqlite3_ with `go install github.com/mattn/go-sqlite3` (which requires gcc), you can build your app without relying on gcc in future. 74 75***Important: because this is a `CGO` enabled package, you are required to set the environment variable `CGO_ENABLED=1` and have a `gcc` compile present within your path.*** 76 77# API Reference 78 79API documentation can be found [here](http://godoc.org/github.com/mattn/go-sqlite3). 80 81Examples can be found under the [examples](./_example) directory. 82 83# Connection String 84 85When creating a new SQLite database or connection to an existing one, with the file name additional options can be given. 86This is also known as a DSN (Data Source Name) string. 87 88Options are append after the filename of the SQLite database. 89The database filename and options are separated by an `?` (Question Mark). 90Options should be URL-encoded (see [url.QueryEscape](https://golang.org/pkg/net/url/#QueryEscape)). 91 92This also applies when using an in-memory database instead of a file. 93 94Options can be given using the following format: `KEYWORD=VALUE` and multiple options can be combined with the `&` ampersand. 95 96This library supports DSN options of SQLite itself and provides additional options. 97 98Boolean values can be one of: 99* `0` `no` `false` `off` 100* `1` `yes` `true` `on` 101 102| Name | Key | Value(s) | Description | 103|------|-----|----------|-------------| 104| UA - Create | `_auth` | - | Create User Authentication, for more information see [User Authentication](#user-authentication) | 105| UA - Username | `_auth_user` | `string` | Username for User Authentication, for more information see [User Authentication](#user-authentication) | 106| UA - Password | `_auth_pass` | `string` | Password for User Authentication, for more information see [User Authentication](#user-authentication) | 107| UA - Crypt | `_auth_crypt` | <ul><li>SHA1</li><li>SSHA1</li><li>SHA256</li><li>SSHA256</li><li>SHA384</li><li>SSHA384</li><li>SHA512</li><li>SSHA512</li></ul> | Password encoder to use for User Authentication, for more information see [User Authentication](#user-authentication) | 108| UA - Salt | `_auth_salt` | `string` | Salt to use if the configure password encoder requires a salt, for User Authentication, for more information see [User Authentication](#user-authentication) | 109| Auto Vacuum | `_auto_vacuum` \| `_vacuum` | <ul><li>`0` \| `none`</li><li>`1` \| `full`</li><li>`2` \| `incremental`</li></ul> | For more information see [PRAGMA auto_vacuum](https://www.sqlite.org/pragma.html#pragma_auto_vacuum) | 110| Busy Timeout | `_busy_timeout` \| `_timeout` | `int` | Specify value for sqlite3_busy_timeout. For more information see [PRAGMA busy_timeout](https://www.sqlite.org/pragma.html#pragma_busy_timeout) | 111| Case Sensitive LIKE | `_case_sensitive_like` \| `_cslike` | `boolean` | For more information see [PRAGMA case_sensitive_like](https://www.sqlite.org/pragma.html#pragma_case_sensitive_like) | 112| Defer Foreign Keys | `_defer_foreign_keys` \| `_defer_fk` | `boolean` | For more information see [PRAGMA defer_foreign_keys](https://www.sqlite.org/pragma.html#pragma_defer_foreign_keys) | 113| Foreign Keys | `_foreign_keys` \| `_fk` | `boolean` | For more information see [PRAGMA foreign_keys](https://www.sqlite.org/pragma.html#pragma_foreign_keys) | 114| Ignore CHECK Constraints | `_ignore_check_constraints` | `boolean` | For more information see [PRAGMA ignore_check_constraints](https://www.sqlite.org/pragma.html#pragma_ignore_check_constraints) | 115| Immutable | `immutable` | `boolean` | For more information see [Immutable](https://www.sqlite.org/c3ref/open.html) | 116| Journal Mode | `_journal_mode` \| `_journal` | <ul><li>DELETE</li><li>TRUNCATE</li><li>PERSIST</li><li>MEMORY</li><li>WAL</li><li>OFF</li></ul> | For more information see [PRAGMA journal_mode](https://www.sqlite.org/pragma.html#pragma_journal_mode) | 117| Locking Mode | `_locking_mode` \| `_locking` | <ul><li>NORMAL</li><li>EXCLUSIVE</li></ul> | For more information see [PRAGMA locking_mode](https://www.sqlite.org/pragma.html#pragma_locking_mode) | 118| Mode | `mode` | <ul><li>ro</li><li>rw</li><li>rwc</li><li>memory</li></ul> | Access Mode of the database. For more information see [SQLite Open](https://www.sqlite.org/c3ref/open.html) | 119| Mutex Locking | `_mutex` | <ul><li>no</li><li>full</li></ul> | Specify mutex mode. | 120| Query Only | `_query_only` | `boolean` | For more information see [PRAGMA query_only](https://www.sqlite.org/pragma.html#pragma_query_only) | 121| Recursive Triggers | `_recursive_triggers` \| `_rt` | `boolean` | For more information see [PRAGMA recursive_triggers](https://www.sqlite.org/pragma.html#pragma_recursive_triggers) | 122| Secure Delete | `_secure_delete` | `boolean` \| `FAST` | For more information see [PRAGMA secure_delete](https://www.sqlite.org/pragma.html#pragma_secure_delete) | 123| Shared-Cache Mode | `cache` | <ul><li>shared</li><li>private</li></ul> | Set cache mode for more information see [sqlite.org](https://www.sqlite.org/sharedcache.html) | 124| Synchronous | `_synchronous` \| `_sync` | <ul><li>0 \| OFF</li><li>1 \| NORMAL</li><li>2 \| FULL</li><li>3 \| EXTRA</li></ul> | For more information see [PRAGMA synchronous](https://www.sqlite.org/pragma.html#pragma_synchronous) | 125| Time Zone Location | `_loc` | auto | Specify location of time format. | 126| Transaction Lock | `_txlock` | <ul><li>immediate</li><li>deferred</li><li>exclusive</li></ul> | Specify locking behavior for transactions. | 127| Writable Schema | `_writable_schema` | `Boolean` | When this pragma is on, the SQLITE_MASTER tables in which database can be changed using ordinary UPDATE, INSERT, and DELETE statements. Warning: misuse of this pragma can easily result in a corrupt database file. | 128| Cache Size | `_cache_size` | `int` | Maximum cache size; default is 2000K (2M). See [PRAGMA cache_size](https://sqlite.org/pragma.html#pragma_cache_size) | 129 130 131## DSN Examples 132 133``` 134file:test.db?cache=shared&mode=memory 135``` 136 137# Features 138 139This package allows additional configuration of features available within SQLite3 to be enabled or disabled by golang build constraints also known as build `tags`. 140 141Click [here](https://golang.org/pkg/go/build/#hdr-Build_Constraints) for more information about build tags / constraints. 142 143### Usage 144 145If you wish to build this library with additional extensions / features, use the following command: 146 147```bash 148go build --tags "<FEATURE>" 149``` 150 151For available features, see the extension list. 152When using multiple build tags, all the different tags should be space delimited. 153 154Example: 155 156```bash 157go build --tags "icu json1 fts5 secure_delete" 158``` 159 160### Feature / Extension List 161 162| Extension | Build Tag | Description | 163|-----------|-----------|-------------| 164| 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.<br><br>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.<br><br>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.<br><br>The SQLITE_ENABLE_STAT3 compile-time option is a no-op and is ignored if the SQLITE_ENABLE_STAT4 compile-time option is used | 165| Allow URI Authority | sqlite_allow_uri_authority | URI filenames normally throws an error if the authority section is not either empty or "localhost".<br><br>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 | 166| 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. <br><br>App Armor is not available under `Windows`. | 167| Disable Load Extensions | sqlite_omit_load_extension | Loading of external extensions is enabled by default.<br><br>To disable extension loading add the build tag `sqlite_omit_load_extension`. | 168| Foreign Keys | sqlite_foreign_keys | This macro determines whether enforcement of foreign key constraints is enabled or disabled by default for new database connections.<br><br>Each database connection can always turn enforcement of foreign key constraints on and off and run-time using the foreign_keys pragma.<br><br>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 | 169| Full Auto Vacuum | sqlite_vacuum_full | Set the default auto vacuum to full | 170| Incremental Auto Vacuum | sqlite_vacuum_incr | Set the default auto vacuum to incremental | 171| 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 | 172| 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 | 173| Introspect PRAGMAS | sqlite_introspect | This option adds some extra PRAGMA statements. <ul><li>PRAGMA function_list</li><li>PRAGMA module_list</li><li>PRAGMA pragma_list</li></ul> | 174| JSON SQL Functions | sqlite_json | When this option is defined in the amalgamation, the JSON SQL functions are added to the build automatically | 175| Pre Update Hook | sqlite_preupdate_hook | Registers a callback function that is invoked prior to each INSERT, UPDATE, and DELETE operation on a database table. | 176| Secure Delete | sqlite_secure_delete | This compile-time option changes the default setting of the secure_delete pragma.<br><br>When this option is not used, secure_delete defaults to off. When this option is present, secure_delete defaults to on.<br><br>The secure_delete setting causes deleted content to be overwritten with zeros. There is a small performance penalty since additional I/O must occur.<br><br>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 | 177| Secure Delete (FAST) | sqlite_secure_delete_fast | For more information see [PRAGMA secure_delete](https://www.sqlite.org/pragma.html#pragma_secure_delete) | 178| Tracing / Debug | sqlite_trace | Activate trace functions | 179| User Authentication | sqlite_userauth | SQLite User Authentication see [User Authentication](#user-authentication) for more information. | 180 181# Compilation 182 183This package requires the `CGO_ENABLED=1` ennvironment variable if not set by default, and the presence of the `gcc` compiler. 184 185If 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. 186 187## Android 188 189This package can be compiled for android. 190Compile with: 191 192```bash 193go build --tags "android" 194``` 195 196For more information see [#201](https://github.com/mattn/go-sqlite3/issues/201) 197 198# ARM 199 200To compile for `ARM` use the following environment: 201 202```bash 203env CC=arm-linux-gnueabihf-gcc CXX=arm-linux-gnueabihf-g++ \ 204 CGO_ENABLED=1 GOOS=linux GOARCH=arm GOARM=7 \ 205 go build -v 206``` 207 208Additional information: 209- [#242](https://github.com/mattn/go-sqlite3/issues/242) 210- [#504](https://github.com/mattn/go-sqlite3/issues/504) 211 212# Cross Compile 213 214This library can be cross-compiled. 215 216In some cases you are required to the `CC` environment variable with the cross compiler. 217 218## Cross Compiling from MAC OSX 219The simplest way to cross compile from OSX is to use [xgo](https://github.com/karalabe/xgo). 220 221Steps: 222- Install [xgo](https://github.com/karalabe/xgo) (`go get github.com/karalabe/xgo`). 223- Ensure that your project is within your `GOPATH`. 224- Run `xgo local/path/to/project`. 225 226Please refer to the project's [README](https://github.com/karalabe/xgo/blob/master/README.md) for further information. 227 228# Google Cloud Platform 229 230Building on GCP is not possible because Google Cloud Platform does not allow `gcc` to be executed. 231 232Please work only with compiled final binaries. 233 234## Linux 235 236To compile this package on Linux, you must install the development tools for your linux distribution. 237 238To compile under linux use the build tag `linux`. 239 240```bash 241go build --tags "linux" 242``` 243 244If you wish to link directly to libsqlite3 then you can use the `libsqlite3` build tag. 245 246``` 247go build --tags "libsqlite3 linux" 248``` 249 250### Alpine 251 252When building in an `alpine` container run the following command before building: 253 254``` 255apk add --update gcc musl-dev 256``` 257 258### Fedora 259 260```bash 261sudo yum groupinstall "Development Tools" "Development Libraries" 262``` 263 264### Ubuntu 265 266```bash 267sudo apt-get install build-essential 268``` 269 270## Mac OSX 271 272OSX should have all the tools present to compile this package. If not, install XCode to add all the developers tools. 273 274Required dependency: 275 276```bash 277brew install sqlite3 278``` 279 280For OSX, there is an additional package to install which is required if you wish to build the `icu` extension. 281 282This additional package can be installed with `homebrew`: 283 284```bash 285brew upgrade icu4c 286``` 287 288To compile for Mac OSX: 289 290```bash 291go build --tags "darwin" 292``` 293 294If you wish to link directly to libsqlite3, use the `libsqlite3` build tag: 295 296``` 297go build --tags "libsqlite3 darwin" 298``` 299 300Additional information: 301- [#206](https://github.com/mattn/go-sqlite3/issues/206) 302- [#404](https://github.com/mattn/go-sqlite3/issues/404) 303 304## Windows 305 306To compile this package on Windows, you must have the `gcc` compiler installed. 307 3081) Install a Windows `gcc` toolchain. 3092) Add the `bin` folder to the Windows path, if the installer did not do this by default. 3103) Open a terminal for the TDM-GCC toolchain, which can be found in the Windows Start menu. 3114) Navigate to your project folder and run the `go build ...` command for this package. 312 313For example the TDM-GCC Toolchain can be found [here](https://jmeubank.github.io/tdm-gcc/). 314 315## Errors 316 317- Compile error: `can not be used when making a shared object; recompile with -fPIC` 318 319 When receiving a compile time error referencing recompile with `-FPIC` then you 320 are probably using a hardend system. 321 322 You can compile the library on a hardend system with the following command. 323 324 ```bash 325 go build -ldflags '-extldflags=-fno-PIC' 326 ``` 327 328 More details see [#120](https://github.com/mattn/go-sqlite3/issues/120) 329 330- Can't build go-sqlite3 on windows 64bit. 331 332 > Probably, you are using go 1.0, go1.0 has a problem when it comes to compiling/linking on windows 64bit. 333 > See: [#27](https://github.com/mattn/go-sqlite3/issues/27) 334 335- `go get github.com/mattn/go-sqlite3` throws compilation error. 336 337 `gcc` throws: `internal compiler error` 338 339 Remove the download repository from your disk and try re-install with: 340 341 ```bash 342 go install github.com/mattn/go-sqlite3 343 ``` 344 345# User Authentication 346 347This package supports the SQLite User Authentication module. 348 349## Compile 350 351To use the User authentication module, the package has to be compiled with the tag `sqlite_userauth`. See [Features](#features). 352 353## Usage 354 355### Create protected database 356 357To create a database protected by user authentication, provide the following argument to the connection string `_auth`. 358This will enable user authentication within the database. This option however requires two additional arguments: 359 360- `_auth_user` 361- `_auth_pass` 362 363When `_auth` is present in the connection string user authentication will be enabled and the provided user will be created 364as an `admin` user. After initial creation, the parameter `_auth` has no effect anymore and can be omitted from the connection string. 365 366Example connection strings: 367 368Create an user authentication database with user `admin` and password `admin`: 369 370`file:test.s3db?_auth&_auth_user=admin&_auth_pass=admin` 371 372Create an user authentication database with user `admin` and password `admin` and use `SHA1` for the password encoding: 373 374`file:test.s3db?_auth&_auth_user=admin&_auth_pass=admin&_auth_crypt=sha1` 375 376### Password Encoding 377 378The passwords within the user authentication module of SQLite are encoded with the SQLite function `sqlite_cryp`. 379This function uses a ceasar-cypher which is quite insecure. 380This library provides several additional password encoders which can be configured through the connection string. 381 382The password cypher can be configured with the key `_auth_crypt`. And if the configured password encoder also requires an 383salt this can be configured with `_auth_salt`. 384 385#### Available Encoders 386 387- SHA1 388- SSHA1 (Salted SHA1) 389- SHA256 390- SSHA256 (salted SHA256) 391- SHA384 392- SSHA384 (salted SHA384) 393- SHA512 394- SSHA512 (salted SHA512) 395 396### Restrictions 397 398Operations on the database regarding user management can only be preformed by an administrator user. 399 400### Support 401 402The user authentication supports two kinds of users: 403 404- administrators 405- regular users 406 407### User Management 408 409User management can be done by directly using the `*SQLiteConn` or by SQL. 410 411#### SQL 412 413The following sql functions are available for user management: 414 415| Function | Arguments | Description | 416|----------|-----------|-------------| 417| `authenticate` | username `string`, password `string` | Will authenticate an user, this is done by the connection; and should not be used manually. | 418| `auth_user_add` | username `string`, password `string`, admin `int` | This function will add an user to the database.<br>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. | 419| `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. | 420| `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. | 421 422These functions will return an integer: 423 424- 0 (SQLITE_OK) 425- 23 (SQLITE_AUTH) Failed to perform due to authentication or insufficient privileges 426 427##### Examples 428 429```sql 430// Autheticate user 431// Create Admin User 432SELECT auth_user_add('admin2', 'admin2', 1); 433 434// Change password for user 435SELECT auth_user_change('user', 'userpassword', 0); 436 437// Delete user 438SELECT user_delete('user'); 439``` 440 441#### *SQLiteConn 442 443The following functions are available for User authentication from the `*SQLiteConn`: 444 445| Function | Description | 446|----------|-------------| 447| `Authenticate(username, password string) error` | Authenticate user | 448| `AuthUserAdd(username, password string, admin bool) error` | Add user | 449| `AuthUserChange(username, password string, admin bool) error` | Modify user | 450| `AuthUserDelete(username string) error` | Delete user | 451 452### Attached database 453 454When using attached databases, SQLite will use the authentication from the `main` database for the attached database(s). 455 456# Extensions 457 458If 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. 459 460## Spatialite 461 462Spatialite is available as an extension to SQLite, and can be used in combination with this repository. 463For an example, see [shaxbee/go-spatialite](https://github.com/shaxbee/go-spatialite). 464 465## extension-functions.c from SQLite3 Contrib 466 467extension-functions.c is available as an extension to SQLite, and provides the following functions: 468 469- 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. 470- String: replicate, charindex, leftstr, rightstr, ltrim, rtrim, trim, replace, reverse, proper, padl, padr, padc, strfilter. 471- Aggregate: stdev, variance, mode, median, lower_quartile, upper_quartile 472 473For an example, see [dinedal/go-sqlite3-extension-functions](https://github.com/dinedal/go-sqlite3-extension-functions). 474 475# FAQ 476 477- Getting insert error while query is opened. 478 479 > You can pass some arguments into the connection string, for example, a URI. 480 > See: [#39](https://github.com/mattn/go-sqlite3/issues/39) 481 482- Do you want to cross compile? mingw on Linux or Mac? 483 484 > See: [#106](https://github.com/mattn/go-sqlite3/issues/106) 485 > See also: http://www.limitlessfx.com/cross-compile-golang-app-for-windows-from-linux.html 486 487- Want to get time.Time with current locale 488 489 Use `_loc=auto` in SQLite3 filename schema like `file:foo.db?_loc=auto`. 490 491- Can I use this in multiple routines concurrently? 492 493 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). 494 495- Why I'm getting `no such table` error? 496 497 Why is it racy if I use a `sql.Open("sqlite3", ":memory:")` database? 498 499 Each connection to `":memory:"` opens a brand new in-memory sql database, so if 500 the stdlib's sql engine happens to open another connection and you've only 501 specified `":memory:"`, that connection will see a brand new database. A 502 workaround is to use `"file::memory:?cache=shared"` (or `"file:foobar?mode=memory&cache=shared"`). Every 503 connection to this string will point to the same in-memory database. 504 505 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. 506 507 For more information see: 508 * [#204](https://github.com/mattn/go-sqlite3/issues/204) 509 * [#511](https://github.com/mattn/go-sqlite3/issues/511) 510 * https://www.sqlite.org/sharedcache.html#shared_cache_and_in_memory_databases 511 * https://www.sqlite.org/inmemorydb.html#sharedmemdb 512 513- Reading from database with large amount of goroutines fails on OSX. 514 515 OS X limits OS-wide to not have more than 1000 files open simultaneously by default. 516 517 For more information, see [#289](https://github.com/mattn/go-sqlite3/issues/289) 518 519- Trying to execute a `.` (dot) command throws an error. 520 521 Error: `Error: near ".": syntax error` 522 Dot command are part of SQLite3 CLI, not of this library. 523 524 You need to implement the feature or call the sqlite3 cli. 525 526 More information see [#305](https://github.com/mattn/go-sqlite3/issues/305). 527 528- Error: `database is locked` 529 530 When you get a database is locked, please use the following options. 531 532 Add to DSN: `cache=shared` 533 534 Example: 535 ```go 536 db, err := sql.Open("sqlite3", "file:locked.sqlite?cache=shared") 537 ``` 538 539 Next, please set the database connections of the SQL package to 1: 540 541 ```go 542 db.SetMaxOpenConns(1) 543 ``` 544 545 For more information, see [#209](https://github.com/mattn/go-sqlite3/issues/209). 546 547## Contributors 548 549### Code Contributors 550 551This project exists thanks to all the people who [[contribute](CONTRIBUTING.md)]. 552<a href="https://github.com/mattn/go-sqlite3/graphs/contributors"><img src="https://opencollective.com/mattn-go-sqlite3/contributors.svg?width=890&button=false" /></a> 553 554### Financial Contributors 555 556Become a financial contributor and help us sustain our community. [[Contribute here](https://opencollective.com/mattn-go-sqlite3/contribute)]. 557 558#### Individuals 559 560<a href="https://opencollective.com/mattn-go-sqlite3"><img src="https://opencollective.com/mattn-go-sqlite3/individuals.svg?width=890"></a> 561 562#### Organizations 563 564Support 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)] 565 566<a href="https://opencollective.com/mattn-go-sqlite3/organization/0/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/0/avatar.svg"></a> 567<a href="https://opencollective.com/mattn-go-sqlite3/organization/1/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/1/avatar.svg"></a> 568<a href="https://opencollective.com/mattn-go-sqlite3/organization/2/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/2/avatar.svg"></a> 569<a href="https://opencollective.com/mattn-go-sqlite3/organization/3/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/3/avatar.svg"></a> 570<a href="https://opencollective.com/mattn-go-sqlite3/organization/4/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/4/avatar.svg"></a> 571<a href="https://opencollective.com/mattn-go-sqlite3/organization/5/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/5/avatar.svg"></a> 572<a href="https://opencollective.com/mattn-go-sqlite3/organization/6/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/6/avatar.svg"></a> 573<a href="https://opencollective.com/mattn-go-sqlite3/organization/7/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/7/avatar.svg"></a> 574<a href="https://opencollective.com/mattn-go-sqlite3/organization/8/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/8/avatar.svg"></a> 575<a href="https://opencollective.com/mattn-go-sqlite3/organization/9/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/9/avatar.svg"></a> 576 577# License 578 579MIT: http://mattn.mit-license.org/2018 580 581sqlite3-binding.c, sqlite3-binding.h, sqlite3ext.h 582 583The -binding suffix was added to avoid build failures under gccgo. 584 585In 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. 586 587# Author 588 589Yasuhiro Matsumoto (a.k.a mattn) 590 591G.J.R. Timmer 592