summarylogtreecommitdiffstats
path: root/README.md.in
diff options
context:
space:
mode:
authorIlya Basin2021-12-05 23:45:43 +0300
committerIlya Basin2021-12-05 23:45:43 +0300
commit87bb3f9d94a2ba19caa36232021d464b3aa463c4 (patch)
treeb382253444401f1724eb131425acaf3f879f0535 /README.md.in
downloadaur-mingw-w64-sqlite3.tar.gz
root
Diffstat (limited to 'README.md.in')
-rw-r--r--README.md.in24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md.in b/README.md.in
new file mode 100644
index 000000000000..fc47b2688805
--- /dev/null
+++ b/README.md.in
@@ -0,0 +1,24 @@
+# Sqlite Extensions - Usage (Sqlite @VERSION@)
+
+This folder contains shared libraries (dll files) `sqlite3.exe` can be
+instructed to load at run-time in order to add functions usable in `sqlite3` SQL code.
+
+
+Here an example of how to call an extension from the command line (example with
+extension `csv`, other extensions are in this directory):
+
+- open a shell (e.g. the `@MSYSTEM@` shell)
+- call `sqlite3.exe` (residing in `@MINGW_PREFIX@/bin`)
+- load the sqlite extension (use an absolute path in Windows notation, see below
+ for an example of an absolute path)
+
+~~~bash
+ sqlite3
+ sqlite3> .load "C:/msys64@MINGW_PREFIX@/share/sqlite/extensions/csv.dll"
+~~~
+
+Usage information to each extension is contained in the header of the c-file
+corresponding to the extension you can find in this directory.
+
+
+More information here: https://www.sqlite.org/loadext.html#loading_an_extension.