Skip to content

Commit 92e4da0

Browse files
committed
Relocated FAQ item to usage subsection of Features
1 parent b8b158d commit 92e4da0

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,26 @@ This package allows additional configuration of features available within SQLite
4040

4141
[Click here for more information about build tags / constraints.](https://golang.org/pkg/go/build/#hdr-Build_Constraints)
4242

43+
### Usage
44+
45+
If you wish to build this library with additional extensions / features.
46+
Use the following command.
47+
48+
```bash
49+
go build --tags "<FEATURE>"
50+
```
51+
52+
For available features see the extension list.
53+
When using multiple build tags, all the different tags should be space delimted.
54+
55+
Example:
56+
57+
```bash
58+
go build --tags "icu json1 fts5 secure_delete"
59+
```
60+
61+
### Feature / Extension List
62+
4363
| Extension | Build Tag | Description |
4464
|-----------|-----------|-------------|
4565
| 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 |
@@ -68,16 +88,6 @@ This package allows additional configuration of features available within SQLite
6888

6989
Use `go build --tags "libsqlite3 darwin"`
7090

71-
- Want to build go-sqlite3 with additional extensions / features.
72-
73-
Use `go build --tags "<FEATURE>"`
74-
75-
When using multiple build tags, all the different tags should be space delimted.
76-
77-
For available features / extensions see [Features](#features).
78-
79-
Example building multiple features: `go build --tags "icu json1 fts5 secure_delete"`
80-
8191
- Can't build go-sqlite3 on windows 64bit.
8292

8393
> Probably, you are using go 1.0, go1.0 has a problem when it comes to compiling/linking on windows 64bit.

0 commit comments

Comments
 (0)