From 72ddc06453e1636a9ff385f3d0091431100052b2 Mon Sep 17 00:00:00 2001 From: Gert-Jan Timmer Date: Sun, 27 May 2018 23:00:56 +0200 Subject: [PATCH] Update README Add DSN Connections string table. [ci skip] --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index d1c271c..1f51f29 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ Supported Golang version: - [Installation](#installation) - [API Reference](#api-reference) +- [Connection String](#connection-string) - [Features](#features) - [Compilation](#compilation) - [Android](#android) @@ -53,6 +54,36 @@ API documentation can be found here: http://godoc.org/github.com/mattn/go-sqlite Examples can be found under the [examples](./_example) directory +# Connection String + +When creating a new SQLite database or connection to an existing one, with the file name additional options can be given. +This is also known as a DSN string. (Data Source Name). + +Options are append after the filename of the SQLite database. +The database filename and options are seperated by an `?` (Question Mark). + +This also applies when using an in-memory database instead of a file. + +Options can be given using the following format: `KEYWORD=VALUE` and multiple options can be combined with the `&` ampersand. + +This library supports dsn options of SQLite itself and provides additional options. + +| Name | Key | Value(s) | Description | +|------|-----|----------|-------------| +| Shared-Cache Mode | cache | | Set cache mode for more information see [sqlite.org](https://www.sqlite.org/sharedcache.html) | +| Time Zone Location | _loc | auto | Specify location of time format. | +| Busy Timeout | _busy_timeout | `int` | Specify value for sqlite3_busy_timeout. | +| Transaction Lock | _txlock | | Specify locking behavior for transactions. | +| Foreign Keys | _foreign_keys | | Enable or disable enforcement of foreign keys. | +| Recursive Triggers | _recursive_triggers | | Enable or disable recursive triggers. | +| Mutex Locking | _mutex | | Specify mutex mode. | + +## DSN Examples + +``` +file:test.db?cache=shared&mode=memory +``` + # Features This package allows additional configuration of features available within SQLite3 to be enabled or disabled by golang build constraints also known as build `tags`.