[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/emacsql 4332bd67ec 271/427: Flesh out the main header a bi
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/emacsql 4332bd67ec 271/427: Flesh out the main header a bit more. |
Date: |
Tue, 13 Dec 2022 02:59:50 -0500 (EST) |
branch: elpa/emacsql
commit 4332bd67ec2818aef07280a1b56f17cebd710daa
Author: Christopher Wellons <wellons@nullprogram.com>
Commit: Christopher Wellons <wellons@nullprogram.com>
Flesh out the main header a bit more.
---
emacsql.el | 20 +++++++++++++++-----
1 file changed, 15 insertions(+), 5 deletions(-)
diff --git a/emacsql.el b/emacsql.el
index 8daf13ac38..a35ee3c02a 100644
--- a/emacsql.el
+++ b/emacsql.el
@@ -9,11 +9,18 @@
;;; Commentary:
-;; The purpose of this package is to provide a high-level Elisp
-;; interface to a high-performance database back-end. Not every feature
-;; of SQL will be exposed, but the important parts should be.
-
-;; Most emacsql functions operate on a database connection. A
+;; EmacSQL is a high-level Emacs Lisp front-end for SQLite
+;; (primarily), PostgreSQL, MySQL, and potentially other SQL
+;; databases.
+
+;; Notice: this package is bundled with custom SQLite native binaries
+;; for a number of platforms. This means you do *not* need to install
+;; any sort of SQLite software on your system for EmacSQL to work.
+;; Unless you're on an unusual platform, in which case you'll need to
+;; compile your own. This is not the case for any other SQL database,
+;; however.
+
+;; Most EmacSQL functions operate on a database connection. A
;; connection to SQLite is established with `emacsql-connect'. For
;; each such connection a sqlite3 inferior process is kept alive in
;; the background. Connections are closed with `emacsql-close'.
@@ -54,6 +61,9 @@
;; 50000)
;; ;; => (("Jeff" 1000) ("Susan" 1001))
+;; The letter declares the type (identifier, scalar, vector, Schema)
+;; and the number declares the argument position.
+
;; See README.md for much more complete documentation.
;;; Code:
- [nongnu] elpa/emacsql 1146f2e26a 233/427: Flesh out the changes in the README., (continued)
- [nongnu] elpa/emacsql 1146f2e26a 233/427: Flesh out the changes in the README., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql ed77eac846 237/427: Add string prepared statements., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 847196cafa 226/427: Set tty to raw in psql., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 3e5ce21b0d 242/427: Tweak the new implementation notes., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql a459708684 244/427: Move tests into their own directory., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 4db068920d 247/427: Provide MySQL front-end., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql dce6736e04 249/427: Oops, add new MySQL module to the Makefile., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql fcba876d0e 251/427: Solve the tty (pty) issue in MySQL., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql fb0e2d5423 256/427: Fix typecase typo., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql a6e859f1b5 260/427: Normalize darwin OS., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 4332bd67ec 271/427: Flesh out the main header a bit more.,
ELPA Syncer <=
- [nongnu] elpa/emacsql 4e9297233d 273/427: Don't rely on C99 mode., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 7963261ef3 270/427: Bump to version 1.0.0., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 6f6533ab70 272/427: Add Cygwin note., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 45f43323ad 275/427: Check the compiler error code., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 2f606fdd2d 300/427: Fix with-transaction macro to return results., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 76acd4f8a1 304/427: Add a test for reserved word escaping., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql a6155464c7 274/427: Try to build the package locally if possible., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 4a58806d64 299/427: Improve new indentation a little bit., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql c512f4287c 315/427: Add back-end note to README., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql a0587f1b5f 311/427: Fix docstring on emacsql-enable-debugging., ELPA Syncer, 2022/12/13