diff options
| author | 2020-10-30 00:04:17 +0100 | |
|---|---|---|
| committer | 2020-10-30 00:04:17 +0100 | |
| commit | 68b031254dc1fd2a38f0d35315a422d367c24a1f (patch) | |
| tree | 80e7a4d56d945641607229056234d7332a7090de | |
| parent | update documentation (diff) | |
| download | zig-sqlite-68b031254dc1fd2a38f0d35315a422d367c24a1f.tar.gz zig-sqlite-68b031254dc1fd2a38f0d35315a422d367c24a1f.tar.xz zig-sqlite-68b031254dc1fd2a38f0d35315a422d367c24a1f.zip | |
update readme
Diffstat (limited to '')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
| @@ -9,6 +9,11 @@ This package is a thin wrapper around [sqlite](https://sqlite.org/index.html)'s | |||
| 9 | * `libsqlite3-dev` for Debian and derivatives | 9 | * `libsqlite3-dev` for Debian and derivatives |
| 10 | * `sqlite3-devel` for Fedora | 10 | * `sqlite3-devel` for Fedora |
| 11 | 11 | ||
| 12 | ## Features | ||
| 13 | |||
| 14 | * Preparing, executing statements | ||
| 15 | * comptime checked bind parameters | ||
| 16 | |||
| 12 | ## Installation | 17 | ## Installation |
| 13 | 18 | ||
| 14 | Since there's no package manager for Zig yet, the recommended way is to use a git submodule: | 19 | Since there's no package manager for Zig yet, the recommended way is to use a git submodule: |
| @@ -118,3 +123,9 @@ Here are the resules for resultset rows: | |||
| 118 | * `TEXT` can be read into a `[]const u8` or `[]u8`. | 123 | * `TEXT` can be read into a `[]const u8` or `[]u8`. |
| 119 | * `TEXT` can be read into any array of `u8` provided the data fits. | 124 | * `TEXT` can be read into any array of `u8` provided the data fits. |
| 120 | * `BLOB` follows the same rules as `TEXT`. | 125 | * `BLOB` follows the same rules as `TEXT`. |
| 126 | |||
| 127 | ### Comptime checked statements | ||
| 128 | |||
| 129 | Prepared statements contain _comptime_ metadata which is used to validate that every call to `exec`, `one` and `all` provides the appropriate number of bind parameters. | ||
| 130 | |||
| 131 | Right now there's no _type_ checking of bind parameters but it could probably be done. | ||