[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/emacsql 46850a75d0 268/427: Update the README.
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/emacsql 46850a75d0 268/427: Update the README. |
Date: |
Tue, 13 Dec 2022 02:59:50 -0500 (EST) |
branch: elpa/emacsql
commit 46850a75d05d71e1826feaa799b223fbcdbbd842
Author: Christopher Wellons <wellons@nullprogram.com>
Commit: Christopher Wellons <wellons@nullprogram.com>
Update the README.
---
README.md | 27 +++++++++++++++++++++++----
1 file changed, 23 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index ccfb6054c2..b9200b976a 100644
--- a/README.md
+++ b/README.md
@@ -3,8 +3,6 @@
Emacsql is a high-level Emacs Lisp front-end for SQLite (primarily),
PostgreSQL, MySQL, and potentially other SQL databases.
-It is currently a work-in-progress (around 90% complete).
-
It works by maintaining a inferior process running (a "connection")
for interacting with the back-end database. Connections are
automatically cleaned up if they are garbage collected. All requests
@@ -105,7 +103,7 @@ Here's an example using foreign keys.
:on-delete :cascade))
```
-Foreign keys are enabled by default in Emacsql.
+Foreign key constraints are enabled by default in Emacsql.
## Operators
@@ -277,7 +275,24 @@ rows.
This is why rows must be vectors and not lists.
-## Ignored Features
+## SQLite Support
+
+The included SQLite binary is compiled with [Soundex][soundex] and
+[full-text search][fts] (FTS4) enabled. These are disabled by the
+default SQLite build. Currently binaries are included for the
+following platforms:
+
+ * Linux x86 and x86_64
+ * OS X x86_64
+ * Windows x86 and x86_64, including Cygwin
+ * Linux armv6l (Raspberry Pi + Raspbian)
+
+Emacsql will run the binary matching Emacs, not necessarily the best
+one for the OS, so 32-bit Emacs will run the 32-bit back-end. More
+platforms could be supported in the future, but this is currently all
+I'm able to target and test at the moment.
+
+### Ignored Features
Emacsql doesn't cover all of SQLite's features. Here are a list of
things that aren't supported, and probably will never be.
@@ -332,6 +347,8 @@ inherits from `emacsql-connection`.
* Ensure that you properly read NULL as nil (hint: ask your back-end
to print it that way).
* Preferably provide `emacsql-reconnect` if possible.
+ * If available, ensure foreign key constraints are enabled by
+ default.
The provided implementations should serve as useful examples. If your
back-end outputs data in a clean, standard way you may be able to use
@@ -347,3 +364,5 @@ the emacsql-protocol-mixin class to do most of the work.
[foreign]: http://www.sqlite.org/foreignkeys.html
[batch]:
http://lists.gnu.org/archive/html/emacs-pretest-bug/2005-11/msg00320.html
[cask]: http://cask.github.io/
+[fts]: http://www.sqlite.org/fts3.html
+[soundex]: http://www.sqlite.org/compile.html#soundex
- [nongnu] elpa/emacsql 4b58a6717e 250/427: Don't use temporary tables in foreign key test., (continued)
- [nongnu] elpa/emacsql 4b58a6717e 250/427: Don't use temporary tables in foreign key test., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 462d1f1b31 252/427: Fix stupid backslash escape mode in MySQL., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql b0f0d3085d 258/427: Get OS tuple from Emacs., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 1b5891298a 255/427: Officially add MySQL to unit testing., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 127bb98df2 264/427: Set coding system to utf-8-auto for sqlite., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 933e6f109a 263/427: Clean up for easier cross-compilation., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 810243e823 290/427: Remember SQLite fetch preference in customization., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql fb2270509f 279/427: Adjust make clean., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 7e078e2b32 282/427: Change OS-detection in Makefile., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql cfde8bea56 291/427: Update README for new customization variable., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 46850a75d0 268/427: Update the README.,
ELPA Syncer <=
- [nongnu] elpa/emacsql 3e6a24e22a 303/427: Escape identifiers that collide with keywords., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql c4036cbdc8 280/427: Move test print statement., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 1bf92bab9e 285/427: Add a special case for unary not., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql da2b137771 289/427: Fix the parameter naming in emacsql-show-last-sql., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql c1ede49bbe 283/427: Update headers., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 965039cec2 314/427: Adjust header lines for each back-end., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 57c40202e8 307/427: Set correct default transaction type in PostgreSQL., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 7b505b6e94 309/427: Update back-end documentation., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 649fc6b0b4 312/427: Add emacsql-pg using pg.el as a back-end., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 4a535e2cca 318/427: Fix typo in emacsql-buffer's doc-string, ELPA Syncer, 2022/12/13