aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEli Zaretskii2025-04-14 12:42:28 +0300
committerEli Zaretskii2025-04-14 12:42:28 +0300
commit4918de1699152e98c7aaa3ecb21795a3cbd05194 (patch)
treed97089e461e0e0f2b1c97824e0b125210756dbfa /doc
parentf7ca720e2d0aebeabc454a24a600c23fd444b60b (diff)
downloademacs-4918de1699152e98c7aaa3ecb21795a3cbd05194.tar.gz
emacs-4918de1699152e98c7aaa3ecb21795a3cbd05194.zip
Support file:// URIs and readonly DB in 'sqlite-open'
* src/sqlite.c (Fsqlite_open): Two new optional arguments, READONLY and DISABLE-URI. Doc fix. * etc/NEWS: * doc/lispref/text.texi (Database): Document the new optional arguments to 'sqlite-open'. (Bug#65274)
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/text.texi10
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 954979a00e6..a20699d1944 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -5366,11 +5366,17 @@ available in this Emacs session.
5366When SQLite support is available, the following functions can be used. 5366When SQLite support is available, the following functions can be used.
5367 5367
5368@cindex database object 5368@cindex database object
5369@defun sqlite-open &optional file 5369@defun sqlite-open &optional file readonly disable-uri
5370This function opens @var{file} as an SQLite database file. If 5370This function opens @var{file} as an SQLite database file. If
5371@var{file} doesn't exist, a new database will be created and stored in 5371@var{file} doesn't exist, a new database will be created and stored in
5372that file. If @var{file} is omitted or @code{nil}, a new in-memory 5372that file. If @var{file} is omitted or @code{nil}, a new in-memory
5373database is created instead. 5373database is created instead. Second optional argument @var{readonly},
5374if non-@code{nil}, means open the database only for reading; the
5375database must already exist in that case. By default, @var{file} can be
5376a @file{file://} URI as well as a file name; in the unusual case that
5377you have a local file whose name begins with @file{file:}, specify a
5378non-@code{nil} value for the third optional argument @var{disable-uri}
5379to disable the automatic recognition and processing of URIs.
5374 5380
5375The return value is a @dfn{database object} that can be used as the 5381The return value is a @dfn{database object} that can be used as the
5376argument to most of the subsequent functions described below. 5382argument to most of the subsequent functions described below.