[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/emacsql 203cff9007 269/427: Rename the project to EmacSQL.
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/emacsql 203cff9007 269/427: Rename the project to EmacSQL. |
Date: |
Tue, 13 Dec 2022 02:59:50 -0500 (EST) |
branch: elpa/emacsql
commit 203cff9007dac17baebb41be4aa82be217836549
Author: Christopher Wellons <wellons@nullprogram.com>
Commit: Christopher Wellons <wellons@nullprogram.com>
Rename the project to EmacSQL.
---
README.md | 44 ++++++++++++++++++++---------------------
emacsql-compiler.el | 6 +++---
emacsql-psql.el | 2 +-
emacsql-sqlite.el | 4 ++--
emacsql.el | 8 ++++----
tests/emacsql-external-tests.el | 2 +-
tests/emacsql-tests.el | 2 +-
7 files changed, 34 insertions(+), 34 deletions(-)
diff --git a/README.md b/README.md
index b9200b976a..4b280ab916 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# Emacsql
+# EmacSQL
-Emacsql is a high-level Emacs Lisp front-end for SQLite (primarily),
+EmacSQL is a high-level Emacs Lisp front-end for SQLite (primarily),
PostgreSQL, MySQL, and potentially other SQL databases.
It works by maintaining a inferior process running (a "connection")
@@ -9,15 +9,15 @@ automatically cleaned up if they are garbage collected. All
requests
are synchronous.
Any [readable lisp value][readable] can be stored as a value in
-Emacsql, including numbers, strings, symbols, lists, vectors, and
-closures. Emacsql has no concept of "TEXT" values; it's all just lisp
+EmacSQL, including numbers, strings, symbols, lists, vectors, and
+closures. EmacSQL has no concept of "TEXT" values; it's all just lisp
objects. The lisp object `nil` corresponds 1:1 with `NULL` in the
database.
This package includes custom native binaries for communicating with a
SQLite database. When linked with GNU Readline, or when run in
Windows, the official sqlite3 command shell is incapable of correct
-interaction. If your own package depends on Emacsql as a database it
+interaction. If your own package depends on EmacSQL as a database it
also means you don't have to rely on the user having particular
software installed.
@@ -25,8 +25,8 @@ Requires Emacs 24 or later.
### Windows Issue
-Due to a [long-standing Emacs bug][batch], Emacsql cannot be used in
-Emacs' "-batch" mode on Windows, which includes running the Emacsql
+Due to a [long-standing Emacs bug][batch], EmacSQL cannot be used in
+Emacs' "-batch" mode on Windows, which includes running the EmacSQL
test suite from the Makefile.
## Example Usage
@@ -69,7 +69,7 @@ A table schema is a list whose first element is a vector of
column
specifications. The rest of the list specifies table constraints. A
column identifier is a symbol and a column's specification can either
be just this symbol or it can include constraints as a list. Because
-Emacsql stores entire lisp objects as values, the only relevant (and
+EmacSQL stores entire lisp objects as values, the only relevant (and
allowed) types are `integer`, `float`, and `object` (default).
([(<column>) ...] (<table-constraint> ...) ...])
@@ -103,12 +103,12 @@ Here's an example using foreign keys.
:on-delete :cascade))
```
-Foreign key constraints are enabled by default in Emacsql.
+Foreign key constraints are enabled by default in EmacSQL.
## Operators
Expressions are written lisp-style, with the operator first. If it
-looks like an operator Emacsql treats it like an operator. However,
+looks like an operator EmacSQL treats it like an operator. However,
several operators are special.
<= >= funcall quote
@@ -123,7 +123,7 @@ For function-like "operators" like `count` and `max` use
the `funcall`
[:select (funcall max age) :from people]
```
-Inside expressions, Emacsql cannot tell the difference between symbol
+Inside expressions, EmacSQL cannot tell the difference between symbol
literals and column references. If you're talking about the symbol
itself, just quote it as you would in normal Elisp. Note that this
does not "escape" `$tn` parameter symbols.
@@ -151,7 +151,7 @@ own. (And it leaves out any possibility of a SQL
injection!) See the
"Usage" section above for examples. A statement is a vector of
keywords and other lisp object.
-Prepared Emacsql s-expression statements are compiled into SQL
+Prepared EmacSQL s-expression statements are compiled into SQL
statements. The statement compiler is memoized so that using the same
statement multiple times is fast. To assist in this, the statement can
act as a template -- using `$i1`, `$s2`, etc. -- working like the
@@ -160,7 +160,7 @@ Elisp `format` function.
### Compilation Rules
Rather than the typical uppercase SQL keywords, keywords in a prepared
-Emacsql statement are literally just that: lisp keywords. Emacsql only
+EmacSQL statement are literally just that: lisp keywords. EmacSQL only
understands a very small amount of SQL's syntax. The compiler follows
some simple rules to convert an s-expression into SQL.
@@ -185,7 +185,7 @@ combine keywords is up to your personal taste (e.g. `:drop
:table` vs.
#### Standalone symbols are identifiers.
-Emacsql doesn't know what symbols refer to identifiers and what
+EmacSQL doesn't know what symbols refer to identifiers and what
symbols should be treated as values. Use quotes to mark a symbol as a
value. For example, `people` here will be treated as an identifier.
@@ -287,30 +287,30 @@ following platforms:
* Windows x86 and x86_64, including Cygwin
* Linux armv6l (Raspberry Pi + Raspbian)
-Emacsql will run the binary matching Emacs, not necessarily the best
+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
+EmacSQL doesn't cover all of SQLite's features. Here are a list of
things that aren't supported, and probably will never be.
* Collating. SQLite has three built-in collation functions: BINARY
- (default), NOCASE, and RTRIM. Emacsql values never have right-hand
+ (default), NOCASE, and RTRIM. EmacSQL values never have right-hand
whitespace, so RTRIM won't be of any use. NOCASE is broken
(ASCII-only) and there's little reason to use it.
* Text manipulation functions. Like collating this is incompatible
- with Emacsql s-expression storage.
+ with EmacSQL s-expression storage.
* Date and time. These are incompatible with the printed values
- stored by Emacsql and therefore have little use.
+ stored by EmacSQL and therefore have little use.
## Limitations
-Emacsql is *not* intended to play well with other programs accessing
+EmacSQL is *not* intended to play well with other programs accessing
the SQLite database. Non-numeric values are are stored encoded as
s-expressions TEXT values. This avoids ambiguities in parsing output
from the command line and allows for storage of Emacs richer data
@@ -331,11 +331,11 @@ tests will also be run with PostgreSQL. Also provide
`PGHOST`,
If the environment variable `MYSQL_DBNAME` is present then the unit
tests will also be run with MySQL in the named database. Note that
this is not an official MySQL variable, just something made up for
-Emacsql.
+EmacSQL.
### Creating a New Front-end
-Emacsql uses EIEIO so that interactions with a connection occur
+EmacSQL uses EIEIO so that interactions with a connection occur
through generic functions. You need to define a new class that
inherits from `emacsql-connection`.
diff --git a/emacsql-compiler.el b/emacsql-compiler.el
index 6ef3f150fa..9678353ffd 100644
--- a/emacsql-compiler.el
+++ b/emacsql-compiler.el
@@ -5,7 +5,7 @@
(require 'cl-lib)
(defmacro emacsql-deferror (symbol parents message)
- "Defines a new error symbol for Emacsql."
+ "Defines a new error symbol for EmacSQL."
(declare (indent 2))
(let ((conditions (cl-remove-duplicates
(append parents (list symbol 'emacsql-error 'error)))))
@@ -14,7 +14,7 @@
(get ',symbol 'error-message) ,message))))
(emacsql-deferror emacsql-error () ;; parent condition for all others
- "Emacsql had an unhandled condition")
+ "EmacSQL had an unhandled condition")
(emacsql-deferror emacsql-syntax () "Invalid SQL statement")
(emacsql-deferror emacsql-internal () "Internal error")
@@ -89,7 +89,7 @@ KIND should be :scalar or :identifier."
(float "&REAL")
(object "&TEXT")
(nil "&NONE"))
- "An alist mapping Emacsql types to SQL types.")
+ "An alist mapping EmacSQL types to SQL types.")
(defun emacsql--from-keyword (keyword)
"Convert KEYWORD into SQL."
diff --git a/emacsql-psql.el b/emacsql-psql.el
index d96a78ad1a..ab1fc44040 100644
--- a/emacsql-psql.el
+++ b/emacsql-psql.el
@@ -1,4 +1,4 @@
-;;; emacsql-psql.el --- PostgreSQL front-end for Emacsql -*- lexical-binding:
t; -*-
+;;; emacsql-psql.el --- PostgreSQL front-end for EmacSQL -*- lexical-binding:
t; -*-
;;; Code:
diff --git a/emacsql-sqlite.el b/emacsql-sqlite.el
index f236e631e0..abf0b4c322 100644
--- a/emacsql-sqlite.el
+++ b/emacsql-sqlite.el
@@ -1,4 +1,4 @@
-;; emacsql-sqlite.el --- SQLite front-end for Emacsql -*- lexical-binding: t;
-*-
+;; emacsql-sqlite.el --- SQLite front-end for EmacSQL -*- lexical-binding: t;
-*-
;;; Code:
@@ -10,7 +10,7 @@
(defvar emacsql-sqlite-executable
(expand-file-name (concat "bin/emacsql-sqlite-" (emacsql-system-tuple))
(file-name-directory load-file-name))
- "Path to the Emacsql backend (this is not the sqlite3 shell).")
+ "Path to the EmacSQL backend (this is not the sqlite3 shell).")
(defclass emacsql-sqlite-connection (emacsql-connection emacsql-protocol-mixin)
((file :initarg :file
diff --git a/emacsql.el b/emacsql.el
index f79150aaa3..bbab2e392c 100644
--- a/emacsql.el
+++ b/emacsql.el
@@ -79,7 +79,7 @@ If nil, wait forever.")
(types :allocation :class
:initform nil
:reader emacsql-types
- :documentation "Maps Emacsql types to SQL types."))
+ :documentation "Maps EmacSQL types to SQL types."))
(:documentation "A connection to a SQL database.")
:abstract t)
@@ -94,7 +94,7 @@ If nil, wait forever.")
(not (null (process-live-p (emacsql-process connection)))))
(defgeneric emacsql-types (connection)
- "Return an alist mapping Emacsql types to database types.
+ "Return an alist mapping EmacSQL types to database types.
This will mask `emacsql-type-map' during expression compilation.
This alist should have four key symbols: integer, float, object,
nil (default type). The values are strings to be inserted into a
@@ -168,7 +168,7 @@ MESSAGE should not have a newline on the end."
(defclass emacsql-protocol-mixin ()
()
(:documentation
- "A mixin for back-ends following the Emacsql protocol.
+ "A mixin for back-ends following the EmacSQL protocol.
The back-end prompt must be a single \"]\" character. This prompt
value was chosen because it is unreadable. Output must have
exactly one row per line, fields separated by whitespace. NULL
@@ -213,7 +213,7 @@ specific error conditions."
(defalias 'emacsql-connect 'emacsql-sqlite)
(defmacro emacsql-with-connection (connection-spec &rest body)
- "Open an Emacsql connection, evaluate BODY, and close the connection.
+ "Open an EmacSQL connection, evaluate BODY, and close the connection.
CONNECTION-SPEC establishes a single binding.
(emacsql-with-connection (db (emacsql-sqlite \"company.db\"))
diff --git a/tests/emacsql-external-tests.el b/tests/emacsql-external-tests.el
index 8e3ef5d793..0a4a555eff 100644
--- a/tests/emacsql-external-tests.el
+++ b/tests/emacsql-external-tests.el
@@ -41,7 +41,7 @@
'((1) (2) (3))))))))
(ert-deftest emacsql-foreign-key ()
- "Tests that foreign keys work properly through Emacsql."
+ "Tests that foreign keys work properly through EmacSQL."
(let ((emacsql-global-timeout emacsql-tests-timeout))
(dolist (factory emacsql-tests-connection-factories)
(emacsql-with-connection (db (funcall (cdr factory)))
diff --git a/tests/emacsql-tests.el b/tests/emacsql-tests.el
index 53cb7be8b1..1537485e81 100644
--- a/tests/emacsql-tests.el
+++ b/tests/emacsql-tests.el
@@ -1,4 +1,4 @@
-;;; emacsql-tests.el --- test suite for Emacsql -*- lexical-binding: t; -*-
+;;; emacsql-tests.el --- test suite for EmacSQL -*- lexical-binding: t; -*-
(require 'emacsql-compiler-tests)
(require 'emacsql-external-tests)
- [nongnu] elpa/emacsql d3fa5b908f 234/427: Add funcall operator., (continued)
- [nongnu] elpa/emacsql d3fa5b908f 234/427: Add funcall operator., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql b29ea275d4 236/427: Tweak limitations notes., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 45ac14390a 239/427: Fix up emacsql.el header to match new syntax., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 7c774ffe12 248/427: Improve MySQL error parsing., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 89e42aed13 253/427: Add docstring to emacsql-mysql., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 5c423307a8 254/427: Fix README typo., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql c5e1ccef73 257/427: Flesh out the rest of mysql-connection's constructor., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql be9c46c274 259/427: Change the way tuples are computed., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql de9b3633d2 262/427: Oops do clean with distclean., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 0f5f560f8b 267/427: Fix README example typo., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 203cff9007 269/427: Rename the project to EmacSQL.,
ELPA Syncer <=
- [nongnu] elpa/emacsql 38bd19ed6f 276/427: Oops, use the right equality., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 50e47ee01a 278/427: Remove shell quote., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 6c7576e497 295/427: Rename condition emacsql-lock to emacsql-locked., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 39ce3b9736 287/427: Smarter identifier identification in expressions., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 20391923d1 292/427: Add option to disable local builds., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql b375cd7759 294/427: Bump version number due to protocol change., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql b60d9e05e2 277/427: Flesh out some docstrings., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql ce05c8b2e2 305/427: Fix MySQL quoting., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 3e16afce8b 281/427: Escape backslashes as well., ELPA Syncer, 2022/12/13
- [nongnu] elpa/emacsql 3c57f9a986 308/427: Adjust MySQL isolation level., ELPA Syncer, 2022/12/13