• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

.github/H15-Jul-2021-

_example/H15-Jul-2021-

upgrade/H15-Jul-2021-

.codecov.ymlH A D15-Jul-202152

.gitignoreH A D15-Jul-2021129

LICENSEH A D15-Jul-20211.1 KiB

README.mdH A D15-Jul-202128.5 KiB

backup.goH A D15-Jul-20212.2 KiB

backup_test.goH A D15-Jul-20219.7 KiB

callback.goH A D15-Jul-202111.2 KiB

callback_test.goH A D15-Jul-20213 KiB

convert.goH A D15-Jul-20216.7 KiB

doc.goH A D15-Jul-20213.6 KiB

error.goH A D15-Jul-20216 KiB

error_test.goH A D15-Jul-20216.1 KiB

go.modH A D15-Jul-202144

go.sumH A D15-Jul-20210

sqlite3-binding.cH A D15-Jul-20217.9 MiB

sqlite3-binding.hH A D15-Jul-2021578.7 KiB

sqlite3.goH A D15-Jul-202161.9 KiB

sqlite3_context.goH A D15-Jul-20213 KiB

sqlite3_func_crypt.goH A D15-Jul-20214 KiB

sqlite3_func_crypt_test.goH A D15-Jul-20211.9 KiB

sqlite3_go113_test.goH A D15-Jul-20212.5 KiB

sqlite3_go18.goH A D15-Jul-20211.9 KiB

sqlite3_go18_test.goH A D15-Jul-202111.6 KiB

sqlite3_libsqlite3.goH A D15-Jul-2021495

sqlite3_load_extension.goH A D15-Jul-20211.8 KiB

sqlite3_load_extension_omit.goH A D15-Jul-2021587

sqlite3_load_extension_test.goH A D15-Jul-20211.3 KiB

sqlite3_opt_allow_uri_authority.goH A D15-Jul-2021364

sqlite3_opt_app_armor.goH A D15-Jul-2021370

sqlite3_opt_column_metadata.goH A D15-Jul-2021495

sqlite3_opt_column_metadata_test.goH A D15-Jul-20211.1 KiB

sqlite3_opt_foreign_keys.goH A D15-Jul-2021360

sqlite3_opt_fts3_test.goH A D15-Jul-20213.2 KiB

sqlite3_opt_fts5.goH A D15-Jul-2021286

sqlite3_opt_icu.goH A D15-Jul-2021428

sqlite3_opt_introspect.goH A D15-Jul-2021355

sqlite3_opt_json1.goH A D15-Jul-2021283

sqlite3_opt_preupdate.goH A D15-Jul-2021513

sqlite3_opt_preupdate_hook.goH A D15-Jul-20213.2 KiB

sqlite3_opt_preupdate_hook_test.goH A D15-Jul-20213.2 KiB

sqlite3_opt_preupdate_omit.goH A D15-Jul-2021767

sqlite3_opt_secure_delete.goH A D15-Jul-2021354

sqlite3_opt_secure_delete_fast.goH A D15-Jul-2021362

sqlite3_opt_stat4.goH A D15-Jul-2021343

sqlite3_opt_unlock_notify.cH A D15-Jul-20211.7 KiB

sqlite3_opt_unlock_notify.goH A D15-Jul-20211.9 KiB

sqlite3_opt_unlock_notify_test.goH A D15-Jul-20214.7 KiB

sqlite3_opt_userauth.goH A D15-Jul-20217.4 KiB

sqlite3_opt_userauth_omit.goH A D15-Jul-20214.3 KiB

sqlite3_opt_userauth_test.goH A D15-Jul-202115 KiB

sqlite3_opt_vacuum_full.goH A D15-Jul-2021357

sqlite3_opt_vacuum_incr.goH A D15-Jul-2021357

sqlite3_opt_vtable.goH A D15-Jul-202119.5 KiB

sqlite3_opt_vtable_test.goH A D15-Jul-202113.8 KiB

sqlite3_other.goH A D15-Jul-2021376

sqlite3_solaris.goH A D15-Jul-2021275

sqlite3_test.goH A D15-Jul-202158.1 KiB

sqlite3_trace.goH A D15-Jul-20218.1 KiB

sqlite3_type.goH A D15-Jul-20211.6 KiB

sqlite3_usleep_windows.goH A D15-Jul-20211.2 KiB

sqlite3_windows.goH A D15-Jul-2021419

sqlite3ext.hH A D15-Jul-202134.8 KiB

static_mock.goH A D15-Jul-20211.3 KiB

README.md

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
16sqlite3 driver conforming to the built-in database/sql interface
17
18Supported Golang version: See [.github/workflows/go.yaml](./.github/workflows/go.yaml)
19
20[This 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 string. (Data Source Name).
87
88Options are append after the filename of the SQLite database.
89The database filename and options are seperated 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
141[Click here for more information about build tags / constraints.](https://golang.org/pkg/go/build/#hdr-Build_Constraints)
142
143### Usage
144
145If you wish to build this library with additional extensions / features.
146Use the following command.
147
148```bash
149go build --tags "<FEATURE>"
150```
151
152For available features see the extension list.
153When using multiple build tags, all the different tags should be space delimted.
154
155Example:
156
157```bash
158go build --tags "icu json1 fts5 secure_delete"
159```
160
161### Feature / Extension List
162
163| Extension | Build Tag | Description |
164|-----------|-----------|-------------|
165| 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 |
166| 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 |
167| 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`. |
168| 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`. |
169| 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 |
170| Full Auto Vacuum | sqlite_vacuum_full | Set the default auto vacuum to full |
171| Incremental Auto Vacuum | sqlite_vacuum_incr | Set the default auto vacuum to incremental |
172| 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 |
173|  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 |
174| 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> |
175| JSON SQL Functions | sqlite_json | When this option is defined in the amalgamation, the JSON SQL functions are added to the build automatically |
176| 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. |
177| 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 |
178| Secure Delete (FAST) | sqlite_secure_delete_fast | For more information see [PRAGMA secure_delete](https://www.sqlite.org/pragma.html#pragma_secure_delete) |
179| Tracing / Debug | sqlite_trace | Activate trace functions |
180| User Authentication | sqlite_userauth | SQLite User Authentication see [User Authentication](#user-authentication) for more information. |
181
182# Compilation
183
184This package requires `CGO_ENABLED=1` ennvironment variable if not set by default, and the presence of the `gcc` compiler.
185
186If 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.
187
188## Android
189
190This package can be compiled for android.
191Compile with:
192
193```bash
194go build --tags "android"
195```
196
197For more information see [#201](https://github.com/mattn/go-sqlite3/issues/201)
198
199# ARM
200
201To compile for `ARM` use the following environment.
202
203```bash
204env CC=arm-linux-gnueabihf-gcc CXX=arm-linux-gnueabihf-g++ \
205    CGO_ENABLED=1 GOOS=linux GOARCH=arm GOARM=7 \
206    go build -v
207```
208
209Additional information:
210- [#242](https://github.com/mattn/go-sqlite3/issues/242)
211- [#504](https://github.com/mattn/go-sqlite3/issues/504)
212
213# Cross Compile
214
215This library can be cross-compiled.
216
217In some cases you are required to the `CC` environment variable with the cross compiler.
218
219## Cross Compiling from MAC OSX
220The simplest way to cross compile from OSX is to use [xgo](https://github.com/karalabe/xgo).
221
222Steps:
223- Install [xgo](https://github.com/karalabe/xgo) (`go get github.com/karalabe/xgo`).
224- Ensure that your project is within your `GOPATH`.
225- Run `xgo local/path/to/project`.
226
227Please refer to the project's [README](https://github.com/karalabe/xgo/blob/master/README.md) for further information.
228
229# Google Cloud Platform
230
231Building on GCP is not possible because Google Cloud Platform does not allow `gcc` to be executed.
232
233Please work only with compiled final binaries.
234
235## Linux
236
237To compile this package on Linux you must install the development tools for your linux distribution.
238
239To compile under linux use the build tag `linux`.
240
241```bash
242go build --tags "linux"
243```
244
245If you wish to link directly to libsqlite3 then you can use the `libsqlite3` build tag.
246
247```
248go build --tags "libsqlite3 linux"
249```
250
251### Alpine
252
253When building in an `alpine` container run the following command before building.
254
255```
256apk add --update gcc musl-dev
257```
258
259### Fedora
260
261```bash
262sudo yum groupinstall "Development Tools" "Development Libraries"
263```
264
265### Ubuntu
266
267```bash
268sudo apt-get install build-essential
269```
270
271## Mac OSX
272
273OSX should have all the tools present to compile this package, if not install XCode this will add all the developers tools.
274
275Required dependency
276
277```bash
278brew install sqlite3
279```
280
281For OSX there is an additional package install which is required if you wish to build the `icu` extension.
282
283This additional package can be installed with `homebrew`.
284
285```bash
286brew upgrade icu4c
287```
288
289To compile for Mac OSX.
290
291```bash
292go build --tags "darwin"
293```
294
295If you wish to link directly to libsqlite3 then you can use the `libsqlite3` build tag.
296
297```
298go build --tags "libsqlite3 darwin"
299```
300
301Additional information:
302- [#206](https://github.com/mattn/go-sqlite3/issues/206)
303- [#404](https://github.com/mattn/go-sqlite3/issues/404)
304
305## Windows
306
307To compile this package on Windows OS you must have the `gcc` compiler installed.
308
3091) Install a Windows `gcc` toolchain.
3102) Add the `bin` folders to the Windows path if the installer did not do this by default.
3113) Open a terminal for the TDM-GCC toolchain, can be found in the Windows Start menu.
3124) Navigate to your project folder and run the `go build ...` command for this package.
313
314For example the TDM-GCC Toolchain can be found [here](https://sourceforge.net/projects/tdm-gcc/).
315
316## Errors
317
318- Compile error: `can not be used when making a shared object; recompile with -fPIC`
319
320    When receiving a compile time error referencing recompile with `-FPIC` then you
321    are probably using a hardend system.
322
323    You can compile the library on a hardend system with the following command.
324
325    ```bash
326    go build -ldflags '-extldflags=-fno-PIC'
327    ```
328
329    More details see [#120](https://github.com/mattn/go-sqlite3/issues/120)
330
331- Can't build go-sqlite3 on windows 64bit.
332
333    > Probably, you are using go 1.0, go1.0 has a problem when it comes to compiling/linking on windows 64bit.
334    > See: [#27](https://github.com/mattn/go-sqlite3/issues/27)
335
336- `go get github.com/mattn/go-sqlite3` throws compilation error.
337
338    `gcc` throws: `internal compiler error`
339
340    Remove the download repository from your disk and try re-install with:
341
342    ```bash
343    go install github.com/mattn/go-sqlite3
344    ```
345
346# User Authentication
347
348This package supports the SQLite User Authentication module.
349
350## Compile
351
352To use the User authentication module the package has to be compiled with the tag `sqlite_userauth`. See [Features](#features).
353
354## Usage
355
356### Create protected database
357
358To create a database protected by user authentication provide the following argument to the connection string `_auth`.
359This will enable user authentication within the database. This option however requires two additional arguments:
360
361- `_auth_user`
362- `_auth_pass`
363
364When `_auth` is present on the connection string user authentication will be enabled and the provided user will be created
365as an `admin` user. After initial creation, the parameter `_auth` has no effect anymore and can be omitted from the connection string.
366
367Example connection string:
368
369Create an user authentication database with user `admin` and password `admin`.
370
371`file:test.s3db?_auth&_auth_user=admin&_auth_pass=admin`
372
373Create an user authentication database with user `admin` and password `admin` and use `SHA1` for the password encoding.
374
375`file:test.s3db?_auth&_auth_user=admin&_auth_pass=admin&_auth_crypt=sha1`
376
377### Password Encoding
378
379The passwords within the user authentication module of SQLite are encoded with the SQLite function `sqlite_cryp`.
380This function uses a ceasar-cypher which is quite insecure.
381This library provides several additional password encoders which can be configured through the connection string.
382
383The password cypher can be configured with the key `_auth_crypt`. And if the configured password encoder also requires an
384salt this can be configured with `_auth_salt`.
385
386#### Available Encoders
387
388- SHA1
389- SSHA1 (Salted SHA1)
390- SHA256
391- SSHA256 (salted SHA256)
392- SHA384
393- SSHA384 (salted SHA384)
394- SHA512
395- SSHA512 (salted SHA512)
396
397### Restrictions
398
399Operations on the database regarding to user management can only be preformed by an administrator user.
400
401### Support
402
403The user authentication supports two kinds of users
404
405- administrators
406- regular users
407
408### User Management
409
410User management can be done by directly using the `*SQLiteConn` or by SQL.
411
412#### SQL
413
414The following sql functions are available for user management.
415
416| Function | Arguments | Description |
417|----------|-----------|-------------|
418| `authenticate` | username `string`, password `string` | Will authenticate an user, this is done by the connection; and should not be used manually. |
419| `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. |
420| `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. |
421| `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. |
422
423These functions will return an integer.
424
425- 0 (SQLITE_OK)
426- 23 (SQLITE_AUTH) Failed to perform due to authentication or insufficient privileges
427
428##### Examples
429
430```sql
431// Autheticate user
432// Create Admin User
433SELECT auth_user_add('admin2', 'admin2', 1);
434
435// Change password for user
436SELECT auth_user_change('user', 'userpassword', 0);
437
438// Delete user
439SELECT user_delete('user');
440```
441
442#### *SQLiteConn
443
444The following functions are available for User authentication from the `*SQLiteConn`.
445
446| Function | Description |
447|----------|-------------|
448| `Authenticate(username, password string) error` | Authenticate user |
449| `AuthUserAdd(username, password string, admin bool) error` | Add user |
450| `AuthUserChange(username, password string, admin bool) error` | Modify user |
451| `AuthUserDelete(username string) error` | Delete user |
452
453### Attached database
454
455When using attached databases. SQLite will use the authentication from the `main` database for the attached database(s).
456
457# Extensions
458
459If 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.
460
461## Spatialite
462
463Spatialite is available as an extension to SQLite, and can be used in combination with this repository.
464For an example see [shaxbee/go-spatialite](https://github.com/shaxbee/go-spatialite).
465
466## extension-functions.c from SQLite3 Contrib
467
468extension-functions.c is available as an extension to SQLite, and provides the following functions:
469
470- 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.
471- String: replicate, charindex, leftstr, rightstr, ltrim, rtrim, trim, replace, reverse, proper, padl, padr, padc, strfilter.
472- Aggregate: stdev, variance, mode, median, lower_quartile, upper_quartile
473
474For an example see [dinedal/go-sqlite3-extension-functions](https://github.com/dinedal/go-sqlite3-extension-functions).
475
476# FAQ
477
478- Getting insert error while query is opened.
479
480    > You can pass some arguments into the connection string, for example, a URI.
481    > See: [#39](https://github.com/mattn/go-sqlite3/issues/39)
482
483- Do you want to cross compile? mingw on Linux or Mac?
484
485    > See: [#106](https://github.com/mattn/go-sqlite3/issues/106)
486    > See also: http://www.limitlessfx.com/cross-compile-golang-app-for-windows-from-linux.html
487
488- Want to get time.Time with current locale
489
490    Use `_loc=auto` in SQLite3 filename schema like `file:foo.db?_loc=auto`.
491
492- Can I use this in multiple routines concurrently?
493
494    Yes for readonly. But, No 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).
495
496- Why I'm getting `no such table` error?
497
498    Why is it racy if I use a `sql.Open("sqlite3", ":memory:")` database?
499
500    Each connection to `":memory:"` opens a brand new in-memory sql database, so if
501    the stdlib's sql engine happens to open another connection and you've only
502    specified `":memory:"`, that connection will see a brand new database. A
503    workaround is to use `"file::memory:?cache=shared"` (or `"file:foobar?mode=memory&cache=shared"`). Every
504    connection to this string will point to the same in-memory database.
505
506    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.
507
508    For more information see
509    * [#204](https://github.com/mattn/go-sqlite3/issues/204)
510    * [#511](https://github.com/mattn/go-sqlite3/issues/511)
511    * https://www.sqlite.org/sharedcache.html#shared_cache_and_in_memory_databases
512    * https://www.sqlite.org/inmemorydb.html#sharedmemdb
513
514- Reading from database with large amount of goroutines fails on OSX.
515
516    OS X limits OS-wide to not have more than 1000 files open simultaneously by default.
517
518    For more information see [#289](https://github.com/mattn/go-sqlite3/issues/289)
519
520- Trying to execute a `.` (dot) command throws an error.
521
522    Error: `Error: near ".": syntax error`
523    Dot command are part of SQLite3 CLI not of this library.
524
525    You need to implement the feature or call the sqlite3 cli.
526
527    More information see [#305](https://github.com/mattn/go-sqlite3/issues/305)
528
529- Error: `database is locked`
530
531    When you get a database is locked. Please use the following options.
532
533    Add to DSN: `cache=shared`
534
535    Example:
536    ```go
537    db, err := sql.Open("sqlite3", "file:locked.sqlite?cache=shared")
538    ```
539
540    Second please set the database connections of the SQL package to 1.
541
542    ```go
543    db.SetMaxOpenConns(1)
544    ```
545
546    More information see [#209](https://github.com/mattn/go-sqlite3/issues/209)
547
548## Contributors
549
550### Code Contributors
551
552This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
553<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>
554
555### Financial Contributors
556
557Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/mattn-go-sqlite3/contribute)]
558
559#### Individuals
560
561<a href="https://opencollective.com/mattn-go-sqlite3"><img src="https://opencollective.com/mattn-go-sqlite3/individuals.svg?width=890"></a>
562
563#### Organizations
564
565Support 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)]
566
567<a href="https://opencollective.com/mattn-go-sqlite3/organization/0/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/0/avatar.svg"></a>
568<a href="https://opencollective.com/mattn-go-sqlite3/organization/1/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/1/avatar.svg"></a>
569<a href="https://opencollective.com/mattn-go-sqlite3/organization/2/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/2/avatar.svg"></a>
570<a href="https://opencollective.com/mattn-go-sqlite3/organization/3/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/3/avatar.svg"></a>
571<a href="https://opencollective.com/mattn-go-sqlite3/organization/4/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/4/avatar.svg"></a>
572<a href="https://opencollective.com/mattn-go-sqlite3/organization/5/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/5/avatar.svg"></a>
573<a href="https://opencollective.com/mattn-go-sqlite3/organization/6/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/6/avatar.svg"></a>
574<a href="https://opencollective.com/mattn-go-sqlite3/organization/7/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/7/avatar.svg"></a>
575<a href="https://opencollective.com/mattn-go-sqlite3/organization/8/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/8/avatar.svg"></a>
576<a href="https://opencollective.com/mattn-go-sqlite3/organization/9/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/9/avatar.svg"></a>
577
578# License
579
580MIT: http://mattn.mit-license.org/2018
581
582sqlite3-binding.c, sqlite3-binding.h, sqlite3ext.h
583
584The -binding suffix was added to avoid build failures under gccgo.
585
586In 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.
587
588# Author
589
590Yasuhiro Matsumoto (a.k.a mattn)
591
592G.J.R. Timmer
593