Skip to content

Commit 1a91193

Browse files
committed
doc: add subsections about using SQLite on windows and about installing the self contained sqlite module.
1 parent b052af8 commit 1a91193

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

doc/docs.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5568,6 +5568,31 @@ sql db {
55685568

55695569
For more examples and the docs, see [vlib/orm](https://github.com/vlang/v/tree/master/vlib/orm).
55705570

5571+
### Troubleshooting compilation problems with SQLite on Windows
5572+
On Windows, if you get a compilation error, about a missing sqlite3.h file, you have to run:
5573+
`v vlib/db/sqlite/install_thirdparty_sqlite.vsh` once, then retry your compilation.
5574+
5575+
### Using the self contained SQLite module
5576+
V also maintains a separate `sqlite` module, that wraps an SQLite amalgamation, but otherwise
5577+
has the same API as the `db.sqlite` module. Its benefit, is that with it, you do not need to
5578+
install a separate system level sqlite package/library on your system (which can be hard on
5579+
some systems like windows, or systems with musl for example).
5580+
Its negative is that it can make your compilations a bit slower (since it compiles SQLite
5581+
from C, in addition to your own code).
5582+
5583+
To use it, do:
5584+
```sh
5585+
v install sqlite
5586+
```
5587+
and later, in your code, use this:
5588+
```v ignore
5589+
import sqlite
5590+
```
5591+
instead of:
5592+
```v ignore
5593+
import db.sqlite
5594+
```
5595+
55715596
## Writing Documentation
55725597

55735598
The way it works is very similar to Go. It's very simple: there's no need to

0 commit comments

Comments
 (0)