diff options
| author |  Vincent Rischmann | 2022-04-17 01:48:26 +0200 |
|---|---|---|
| committer | Vincent Rischmann | 2022-04-17 01:50:06 +0200 |
| commit | 49c570ce0e2a76e5003c14443ef2cad260f43a44 (patch) | |
| tree | 2906ed84bcb5a906a6bc00876f530376fb9f8784 | |
| parent | Merge branch 'document-functions' (diff) | |
| download | zig-sqlite-49c570ce0e2a76e5003c14443ef2cad260f43a44.tar.gz zig-sqlite-49c570ce0e2a76e5003c14443ef2cad260f43a44.tar.xz zig-sqlite-49c570ce0e2a76e5003c14443ef2cad260f43a44.zip | |
readme: add a table of contents
Diffstat (limited to '')
| -rw-r--r-- | README.md | 34 |
1 files changed, 33 insertions, 1 deletions
| @@ -8,6 +8,38 @@ While the core functionality works right now, the API is still subject to change | |||
| 8 | 8 | ||
| 9 | If you use this library, expect to have to make changes when you update the code. | 9 | If you use this library, expect to have to make changes when you update the code. |
| 10 | 10 | ||
| 11 | # Table of contents | ||
| 12 | |||
| 13 | * [Status](#status) | ||
| 14 | * [Requirements](#requirements) | ||
| 15 | * [Features](#features) | ||
| 16 | * [Installation](#installation) | ||
| 17 | * [zigmod](#zigmod) | ||
| 18 | * [Git submodule](#git-submodule) | ||
| 19 | * [Using the system sqlite library](#using-the-system-sqlite-library) | ||
| 20 | * [Using the bundled sqlite source code file](#using-the-bundled-sqlite-source-code-file) | ||
| 21 | * [Usage](#usage) | ||
| 22 | * [Initialization](#initialization) | ||
| 23 | * [Preparing a statement](#preparing-a-statement) | ||
| 24 | * [Common use](#common-use) | ||
| 25 | * [Diagnostics](#diagnostics) | ||
| 26 | * [Executing a statement](#executing-a-statement) | ||
| 27 | * [Reuse a statement](#reuse-a-statement) | ||
| 28 | * [Reading data](#reading-data) | ||
| 29 | * [Type parameter](#type-parameter) | ||
| 30 | * [Non allocating](#non-allocating) | ||
| 31 | * [Allocating](#allocating) | ||
| 32 | * [Iterating](#iterating) | ||
| 33 | * [Non allocating](#non-allocating-1) | ||
| 34 | * [Allocating](#allocating-1) | ||
| 35 | * [Bind parameters and resultset rows](#bind-parameters-and-resultset-rows) | ||
| 36 | * [Comptime checks](#comptime-checks) | ||
| 37 | * [Check the number of bind parameters.](#check-the-number-of-bind-parameters) | ||
| 38 | * [Assign types to bind markers and check them.](#assign-types-to-bind-markers-and-check-them) | ||
| 39 | * [User defined functions](#user-defined-functions) | ||
| 40 | * [Scalar functions](#scalar-functions) | ||
| 41 | * [Aggregate functions](#aggregate-functions) | ||
| 42 | |||
| 11 | # Requirements | 43 | # Requirements |
| 12 | 44 | ||
| 13 | [Zig master](https://ziglang.org/download/) is the only required dependency. | 45 | [Zig master](https://ziglang.org/download/) is the only required dependency. |
| @@ -504,7 +536,7 @@ const rows = try stmt.all(usize, .{}, .{ | |||
| 504 | _ = rows; | 536 | _ = rows; |
| 505 | ``` | 537 | ``` |
| 506 | 538 | ||
| 507 | ## User defined functions | 539 | # User defined functions |
| 508 | 540 | ||
| 509 | sqlite supports [user-defined functions](https://www.sqlite.org/c3ref/create_function.html) which come in two types: | 541 | sqlite supports [user-defined functions](https://www.sqlite.org/c3ref/create_function.html) which come in two types: |
| 510 | * scalar functions | 542 | * scalar functions |