gemini-search

A simple search engine for Geminispace
git clone git://git.laack.co/gemini-search.git
Log | Files | Refs | README

README.md (30319B)


      1 go-sqlite3
      2 ==========
      3 
      4 [![Go Reference](https://pkg.go.dev/badge/github.com/mattn/go-sqlite3.svg)](https://pkg.go.dev/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 
     10 Latest 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 
     16 A sqlite3 driver that conforms to the built-in database/sql interface.
     17 
     18 Supported 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 - [Compiling](#compiling)
     39   - [Linux](#linux)
     40     - [Alpine](#alpine)
     41     - [Fedora](#fedora)
     42     - [Ubuntu](#ubuntu)
     43   - [macOS](#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 
     67 This 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.
     72 If you want to build your app using go-sqlite3, you need gcc.
     73 
     74 ***Important: because this is a `CGO` enabled package, you are required to set the environment variable `CGO_ENABLED=1` and have a `gcc` compiler present within your path.***
     75 
     76 # API Reference
     77 
     78 API documentation can be found [here](http://godoc.org/github.com/mattn/go-sqlite3).
     79 
     80 Examples can be found under the [examples](./_example) directory.
     81 
     82 # Connection String
     83 
     84 When creating a new SQLite database or connection to an existing one, with the file name additional options can be given.
     85 This is also known as a DSN (Data Source Name) string.
     86 
     87 Options are append after the filename of the SQLite database.
     88 The database filename and options are separated by an `?` (Question Mark).
     89 Options should be URL-encoded (see [url.QueryEscape](https://golang.org/pkg/net/url/#QueryEscape)).
     90 
     91 This also applies when using an in-memory database instead of a file.
     92 
     93 Options can be given using the following format: `KEYWORD=VALUE` and multiple options can be combined with the `&` ampersand.
     94 
     95 This library supports DSN options of SQLite itself and provides additional options.
     96 
     97 Boolean values can be one of:
     98 * `0` `no` `false` `off`
     99 * `1` `yes` `true` `on`
    100 
    101 | Name | Key | Value(s) | Description |
    102 |------|-----|----------|-------------|
    103 | UA - Create | `_auth` | - | Create User Authentication, for more information see [User Authentication](#user-authentication) |
    104 | UA - Username | `_auth_user` | `string` | Username for User Authentication, for more information see [User Authentication](#user-authentication) |
    105 | UA - Password | `_auth_pass` | `string` | Password for User Authentication, for more information see [User Authentication](#user-authentication) |
    106 | 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) |
    107 | 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) |
    108 | 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) |
    109 | 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) |
    110 | 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) |
    111 | 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) |
    112 | Foreign Keys | `_foreign_keys` \| `_fk` | `boolean` | For more information see [PRAGMA foreign_keys](https://www.sqlite.org/pragma.html#pragma_foreign_keys) |
    113 | 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) |
    114 | Immutable | `immutable` | `boolean` | For more information see [Immutable](https://www.sqlite.org/c3ref/open.html) |
    115 | 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) |
    116 | 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) |
    117 | 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) |
    118 | Mutex Locking | `_mutex` | <ul><li>no</li><li>full</li></ul> | Specify mutex mode. |
    119 | Query Only | `_query_only` | `boolean` | For more information see [PRAGMA query_only](https://www.sqlite.org/pragma.html#pragma_query_only) |
    120 | Recursive Triggers | `_recursive_triggers` \| `_rt` | `boolean` | For more information see [PRAGMA recursive_triggers](https://www.sqlite.org/pragma.html#pragma_recursive_triggers) |
    121 | Secure Delete | `_secure_delete` | `boolean` \| `FAST` | For more information see [PRAGMA secure_delete](https://www.sqlite.org/pragma.html#pragma_secure_delete) |
    122 | 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) |
    123 | 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) |
    124 | Time Zone Location | `_loc` | auto | Specify location of time format. |
    125 | Transaction Lock | `_txlock` | <ul><li>immediate</li><li>deferred</li><li>exclusive</li></ul> | Specify locking behavior for transactions. |
    126 | 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. |
    127 | Cache Size | `_cache_size` | `int` | Maximum cache size; default is 2000K (2M). See [PRAGMA cache_size](https://sqlite.org/pragma.html#pragma_cache_size) |
    128 | Statement Cache Size | `_stmt_cache_size` | `int` | Maximum number of prepared statements cached per connection; default is 0 (disabled). Note that `sql.DB` is a connection pool, so each connection maintains its own independent cache. |
    129 
    130 
    131 ## DSN Examples
    132 
    133 ```
    134 file:test.db?cache=shared&mode=memory
    135 ```
    136 
    137 # Features
    138 
    139 This 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](https://golang.org/pkg/go/build/#hdr-Build_Constraints) for more information about build tags / constraints.
    142 
    143 ### Usage
    144 
    145 If you wish to build this library with additional extensions / features, use the following command:
    146 
    147 ```bash
    148 go build -tags "<FEATURE>"
    149 ```
    150 
    151 For available features, see the extension list.
    152 When using multiple build tags, all the different tags should be space delimited.
    153 
    154 Example:
    155 
    156 ```bash
    157 go 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 | Enable Serialization with `libsqlite3` | sqlite_serialize | Serialization and deserialization of a SQLite database is available by default, unless the build tag `libsqlite3` is set.<br><br>To enable this functionality even if `libsqlite3` is set, add the build tag `sqlite_serialize`. |
    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 | Math Functions | sqlite_math_functions | This compile-time option enables built-in scalar math functions. For more information see [Built-In Mathematical SQL Functions](https://www.sqlite.org/lang_mathfunc.html) |
    177 | OS Trace | sqlite_os_trace | This option enables OSTRACE() debug logging. This can be verbose and should not be used in production. |
    178 | Percentile | sqlite_percentile | This option enables [The Percentile Extension](sqlite.org/percentile.html). |
    179 | 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. |
    180 | 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 |
    181 | Secure Delete (FAST) | sqlite_secure_delete_fast | For more information see [PRAGMA secure_delete](https://www.sqlite.org/pragma.html#pragma_secure_delete) |
    182 | Tracing / Debug | sqlite_trace | Activate trace functions |
    183 | User Authentication | sqlite_userauth | SQLite User Authentication see [User Authentication](#user-authentication) for more information. |
    184 | 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) |
    185 
    186 # Compilation
    187 
    188 This package requires the `CGO_ENABLED=1` environment variable if not set by default, and the presence of the `gcc` compiler.
    189 
    190 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.
    191 
    192 ## Android
    193 
    194 This package can be compiled for android.
    195 Compile with:
    196 
    197 ```bash
    198 go build -tags "android"
    199 ```
    200 
    201 For more information see [#201](https://github.com/mattn/go-sqlite3/issues/201)
    202 
    203 # ARM
    204 
    205 To compile for `ARM` use the following environment:
    206 
    207 ```bash
    208 env CC=arm-linux-gnueabihf-gcc CXX=arm-linux-gnueabihf-g++ \
    209     CGO_ENABLED=1 GOOS=linux GOARCH=arm GOARM=7 \
    210     go build -v 
    211 ```
    212 
    213 Additional information:
    214 - [#242](https://github.com/mattn/go-sqlite3/issues/242)
    215 - [#504](https://github.com/mattn/go-sqlite3/issues/504)
    216 
    217 # Cross Compile
    218 
    219 This library can be cross-compiled.
    220 
    221 In some cases you are required to the `CC` environment variable with the cross compiler.
    222 
    223 ## Cross Compiling from macOS
    224 The simplest way to cross compile from macOS is to use [xgo](https://github.com/karalabe/xgo).
    225 
    226 Steps:
    227 - Install [musl-cross](https://github.com/FiloSottile/homebrew-musl-cross) (`brew install FiloSottile/musl-cross/musl-cross`).
    228 - 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"`.
    229 
    230 Please refer to the project's [README](https://github.com/FiloSottile/homebrew-musl-cross#readme) for further information.
    231 
    232 # Compiling
    233 
    234 ## Linux
    235 
    236 To compile this package on Linux, you must install the development tools for your linux distribution.
    237 
    238 To compile under linux use the build tag `linux`.
    239 
    240 ```bash
    241 go build -tags "linux"
    242 ```
    243 
    244 If you wish to link directly to libsqlite3 then you can use the `libsqlite3` build tag.
    245 
    246 ```
    247 go build -tags "libsqlite3 linux"
    248 ```
    249 
    250 ### Alpine
    251 
    252 When building in an `alpine` container  run the following command before building:
    253 
    254 ```
    255 apk add --update gcc musl-dev
    256 ```
    257 
    258 ### Fedora
    259 
    260 ```bash
    261 sudo yum groupinstall "Development Tools" "Development Libraries"
    262 ```
    263 
    264 ### Ubuntu
    265 
    266 ```bash
    267 sudo apt-get install build-essential
    268 ```
    269 
    270 ## macOS
    271 
    272 macOS should have all the tools present to compile this package. If not, install XCode to add all the developers tools.
    273 
    274 Required dependency:
    275 
    276 ```bash
    277 brew install sqlite3
    278 ```
    279 
    280 For macOS, there is an additional package to install which is required if you wish to build the `icu` extension.
    281 
    282 This additional package can be installed with `homebrew`:
    283 
    284 ```bash
    285 brew upgrade icu4c
    286 ```
    287 
    288 To compile for macOS on x86:
    289 
    290 ```bash
    291 go build -tags "darwin amd64"
    292 ```
    293 
    294 To compile for macOS on ARM chips:
    295 
    296 ```bash
    297 go build -tags "darwin arm64"
    298 ```
    299 
    300 If you wish to link directly to libsqlite3, use the `libsqlite3` build tag:
    301 
    302 ```
    303 # x86 
    304 go build -tags "libsqlite3 darwin amd64"
    305 # ARM
    306 go build -tags "libsqlite3 darwin arm64"
    307 ```
    308 
    309 Additional information:
    310 - [#206](https://github.com/mattn/go-sqlite3/issues/206)
    311 - [#404](https://github.com/mattn/go-sqlite3/issues/404)
    312 
    313 ## Windows
    314 
    315 To compile this package on Windows, you must have the `gcc` compiler installed.
    316 
    317 1) Install a Windows `gcc` toolchain.
    318 2) Add the `bin` folder to the Windows path, if the installer did not do this by default.
    319 3) Open a terminal for the TDM-GCC toolchain, which can be found in the Windows Start menu.
    320 4) Navigate to your project folder and run the `go build ...` command for this package.
    321 
    322 For example the TDM-GCC Toolchain can be found [here](https://jmeubank.github.io/tdm-gcc/).
    323 
    324 ## Errors
    325 
    326 - Compile error: `can not be used when making a shared object; recompile with -fPIC`
    327 
    328     When receiving a compile time error referencing recompile with `-FPIC` then you
    329     are probably using a hardend system.
    330 
    331     You can compile the library on a hardend system with the following command.
    332 
    333     ```bash
    334     go build -ldflags '-extldflags=-fno-PIC'
    335     ```
    336 
    337     More details see [#120](https://github.com/mattn/go-sqlite3/issues/120)
    338 
    339 - Can't build go-sqlite3 on windows 64bit.
    340 
    341     > Probably, you are using go 1.0, go1.0 has a problem when it comes to compiling/linking on windows 64bit.
    342     > See: [#27](https://github.com/mattn/go-sqlite3/issues/27)
    343 
    344 - `go get github.com/mattn/go-sqlite3` throws compilation error.
    345 
    346     `gcc` throws: `internal compiler error`
    347 
    348     Remove the download repository from your disk and try re-install with:
    349 
    350     ```bash
    351     go install github.com/mattn/go-sqlite3
    352     ```
    353 
    354 # User Authentication
    355 
    356 ***This is deprecated***
    357 
    358 This package supports the SQLite User Authentication module.
    359 
    360 ## Compile
    361 
    362 To use the User authentication module, the package has to be compiled with the tag `sqlite_userauth`. See [Features](#features).
    363 
    364 ## Usage
    365 
    366 ### Create protected database
    367 
    368 To create a database protected by user authentication, provide the following argument to the connection string `_auth`.
    369 This will enable user authentication within the database. This option however requires two additional arguments:
    370 
    371 - `_auth_user`
    372 - `_auth_pass`
    373 
    374 When `_auth` is present in the connection string user authentication will be enabled and the provided user will be created
    375 as an `admin` user. After initial creation, the parameter `_auth` has no effect anymore and can be omitted from the connection string.
    376 
    377 Example connection strings:
    378 
    379 Create an user authentication database with user `admin` and password `admin`:
    380 
    381 `file:test.s3db?_auth&_auth_user=admin&_auth_pass=admin`
    382 
    383 Create an user authentication database with user `admin` and password `admin` and use `SHA1` for the password encoding:
    384 
    385 `file:test.s3db?_auth&_auth_user=admin&_auth_pass=admin&_auth_crypt=sha1`
    386 
    387 ### Password Encoding
    388 
    389 The passwords within the user authentication module of SQLite are encoded with the SQLite function `sqlite_cryp`.
    390 This function uses a ceasar-cypher which is quite insecure.
    391 This library provides several additional password encoders which can be configured through the connection string.
    392 
    393 The password cypher can be configured with the key `_auth_crypt`. And if the configured password encoder also requires an
    394 salt this can be configured with `_auth_salt`.
    395 
    396 #### Available Encoders
    397 
    398 - SHA1
    399 - SSHA1 (Salted SHA1)
    400 - SHA256
    401 - SSHA256 (salted SHA256)
    402 - SHA384
    403 - SSHA384 (salted SHA384)
    404 - SHA512
    405 - SSHA512 (salted SHA512)
    406 
    407 ### Restrictions
    408 
    409 Operations on the database regarding user management can only be preformed by an administrator user.
    410 
    411 ### Support
    412 
    413 The user authentication supports two kinds of users:
    414 
    415 - administrators
    416 - regular users
    417 
    418 ### User Management
    419 
    420 User management can be done by directly using the `*SQLiteConn` or by SQL.
    421 
    422 #### SQL
    423 
    424 The following sql functions are available for user management:
    425 
    426 | Function | Arguments | Description |
    427 |----------|-----------|-------------|
    428 | `authenticate` | username `string`, password `string` | Will authenticate an user, this is done by the connection; and should not be used manually. |
    429 | `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. |
    430 | `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. |
    431 | `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. |
    432 
    433 These functions will return an integer:
    434 
    435 - 0 (SQLITE_OK)
    436 - 23 (SQLITE_AUTH) Failed to perform due to authentication or insufficient privileges
    437 
    438 ##### Examples
    439 
    440 ```sql
    441 // Autheticate user
    442 // Create Admin User
    443 SELECT auth_user_add('admin2', 'admin2', 1);
    444 
    445 // Change password for user
    446 SELECT auth_user_change('user', 'userpassword', 0);
    447 
    448 // Delete user
    449 SELECT user_delete('user');
    450 ```
    451 
    452 #### *SQLiteConn
    453 
    454 The following functions are available for User authentication from the `*SQLiteConn`:
    455 
    456 | Function | Description |
    457 |----------|-------------|
    458 | `Authenticate(username, password string) error` | Authenticate user |
    459 | `AuthUserAdd(username, password string, admin bool) error` | Add user |
    460 | `AuthUserChange(username, password string, admin bool) error` | Modify user |
    461 | `AuthUserDelete(username string) error` | Delete user |
    462 
    463 ### Attached database
    464 
    465 When using attached databases, SQLite will use the authentication from the `main` database for the attached database(s).
    466 
    467 # Extensions
    468 
    469 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.
    470 
    471 ## Spatialite
    472 
    473 Spatialite is available as an extension to SQLite, and can be used in combination with this repository.
    474 For an example, see [shaxbee/go-spatialite](https://github.com/shaxbee/go-spatialite).
    475 
    476 ## extension-functions.c from SQLite3 Contrib
    477 
    478 extension-functions.c is available as an extension to SQLite, and provides the following functions:
    479 
    480 - 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.
    481 - String: replicate, charindex, leftstr, rightstr, ltrim, rtrim, trim, replace, reverse, proper, padl, padr, padc, strfilter.
    482 - Aggregate: stdev, variance, mode, median, lower_quartile, upper_quartile
    483 
    484 For an example, see [dinedal/go-sqlite3-extension-functions](https://github.com/dinedal/go-sqlite3-extension-functions).
    485 
    486 # FAQ
    487 
    488 - Getting insert error while query is opened.
    489 
    490     > You can pass some arguments into the connection string, for example, a URI.
    491     > See: [#39](https://github.com/mattn/go-sqlite3/issues/39)
    492 
    493 - Do you want to cross compile? mingw on Linux or Mac?
    494 
    495     > See: [#106](https://github.com/mattn/go-sqlite3/issues/106)
    496     > See also: http://www.limitlessfx.com/cross-compile-golang-app-for-windows-from-linux.html
    497 
    498 - Want to get time.Time with current locale
    499 
    500     Use `_loc=auto` in SQLite3 filename schema like `file:foo.db?_loc=auto`.
    501 
    502 - Can I use this in multiple routines concurrently?
    503 
    504     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).
    505 
    506 - Why I'm getting `no such table` error?
    507 
    508     Why is it racy if I use a `sql.Open("sqlite3", ":memory:")` database?
    509 
    510     Each connection to `":memory:"` opens a brand new in-memory sql database, so if
    511     the stdlib's sql engine happens to open another connection and you've only
    512     specified `":memory:"`, that connection will see a brand new database. A
    513     workaround is to use `"file::memory:?cache=shared"` (or `"file:foobar?mode=memory&cache=shared"`). Every
    514     connection to this string will point to the same in-memory database.
    515     
    516     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.
    517     
    518     For more information see:
    519     * [#204](https://github.com/mattn/go-sqlite3/issues/204)
    520     * [#511](https://github.com/mattn/go-sqlite3/issues/511)
    521     * https://www.sqlite.org/sharedcache.html#shared_cache_and_in_memory_databases
    522     * https://www.sqlite.org/inmemorydb.html#sharedmemdb
    523 
    524 - Reading from database with large amount of goroutines fails on OSX.
    525 
    526     OS X limits OS-wide to not have more than 1000 files open simultaneously by default.
    527 
    528     For more information, see [#289](https://github.com/mattn/go-sqlite3/issues/289)
    529 
    530 - Trying to execute a `.` (dot) command throws an error.
    531 
    532     Error: `Error: near ".": syntax error`
    533     Dot command are part of SQLite3 CLI, not of this library.
    534 
    535     You need to implement the feature or call the sqlite3 cli.
    536 
    537     More information see [#305](https://github.com/mattn/go-sqlite3/issues/305).
    538 
    539 - Error: `database is locked`
    540 
    541     When you get a database is locked, please use the following options.
    542 
    543     Add to DSN: `cache=shared`
    544 
    545     Example:
    546     ```go
    547     db, err := sql.Open("sqlite3", "file:locked.sqlite?cache=shared")
    548     ```
    549 
    550     Next, please set the database connections of the SQL package to 1:
    551     
    552     ```go
    553     db.SetMaxOpenConns(1)
    554     ```
    555 
    556     For more information, see [#209](https://github.com/mattn/go-sqlite3/issues/209).
    557 
    558 ## Contributors
    559 
    560 ### Code Contributors
    561 
    562 This project exists thanks to all the people who [[contribute](CONTRIBUTING.md)].
    563 <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>
    564 
    565 ### Financial Contributors
    566 
    567 Become a financial contributor and help us sustain our community. [[Contribute here](https://opencollective.com/mattn-go-sqlite3/contribute)].
    568 
    569 #### Individuals
    570 
    571 <a href="https://opencollective.com/mattn-go-sqlite3"><img src="https://opencollective.com/mattn-go-sqlite3/individuals.svg?width=890"></a>
    572 
    573 #### Organizations
    574 
    575 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)]
    576 
    577 <a href="https://opencollective.com/mattn-go-sqlite3/organization/0/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/0/avatar.svg"></a>
    578 <a href="https://opencollective.com/mattn-go-sqlite3/organization/1/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/1/avatar.svg"></a>
    579 <a href="https://opencollective.com/mattn-go-sqlite3/organization/2/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/2/avatar.svg"></a>
    580 <a href="https://opencollective.com/mattn-go-sqlite3/organization/3/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/3/avatar.svg"></a>
    581 <a href="https://opencollective.com/mattn-go-sqlite3/organization/4/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/4/avatar.svg"></a>
    582 <a href="https://opencollective.com/mattn-go-sqlite3/organization/5/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/5/avatar.svg"></a>
    583 <a href="https://opencollective.com/mattn-go-sqlite3/organization/6/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/6/avatar.svg"></a>
    584 <a href="https://opencollective.com/mattn-go-sqlite3/organization/7/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/7/avatar.svg"></a>
    585 <a href="https://opencollective.com/mattn-go-sqlite3/organization/8/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/8/avatar.svg"></a>
    586 <a href="https://opencollective.com/mattn-go-sqlite3/organization/9/website"><img src="https://opencollective.com/mattn-go-sqlite3/organization/9/avatar.svg"></a>
    587 
    588 # License
    589 
    590 MIT: http://mattn.mit-license.org/2018
    591 
    592 sqlite3-binding.c, sqlite3-binding.h, sqlite3ext.h
    593 
    594 The -binding suffix was added to avoid build failures under gccgo.
    595 
    596 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.
    597 
    598 # Author
    599 
    600 Yasuhiro Matsumoto (a.k.a mattn)
    601 
    602 G.J.R. Timmer