Fossil SCM

Enhancements to the help page for the "sql" command.

drh 2020-07-18 21:31 trunk
Commit a370043ffa1e58545f4a572a0e9c182ebd4d567af7ed657e3f2dbff62cbc3f54
Parent 6169c8906f14851…
1 file changed +27 -11
~ src/sqlcmd.c
M src/sqlcmd.c
+27 -11
--- src/sqlcmd.c
+++ src/sqlcmd.c
@@ -266,31 +266,41 @@
266266
 ** COMMAND: sql
267267
 ** COMMAND: sqlite3*
268268
 **
269269
 ** Usage: %fossil sql ?OPTIONS?
270270
 **
271
-** Run the standalone sqlite3 command-line shell on DATABASE with SHELL_OPTS.
272
-** If DATABASE is omitted, then the repository that serves the working
273
-** directory is opened. See https://www.sqlite.org/cli.html for additional
274
-** information.
271
+** Run the sqlite3 command-line shell on the Fossil repository
272
+** identified by the -R option, or on the current repository.
273
+** See https://www.sqlite.org/cli.html for additional information about
274
+** the sqlite3 command-line shell.
275
+**
276
+** WARNING: Careless use of this command can corrupt a Fossil repository
277
+** in ways that are unrecoverable. Be sure you know what you are doing before
278
+** running any SQL commands that modify the repository database. Use the
279
+** --readonly option to prevent accidental damage to the repository.
275280
 **
276281
 ** Options:
277282
 **
278283
 ** --no-repository Skip opening the repository database.
284
+**
285
+** --readonly Open the repository read-only. No changes
286
+** are allowed. This is a recommended safety
287
+** precaution to prevent repository damage.
279288
 **
280289
 ** -R REPOSITORY Use REPOSITORY as the repository database
281290
 **
282
-** WARNING: Careless use of this command can corrupt a Fossil repository
283
-** in ways that are unrecoverable. Be sure you know what you are doing before
284
-** running any SQL commands that modify the repository database.
291
+** All of the standard sqlite3 command-line shell options should also
292
+** work.
285293
 **
286
-** The following extensions to the usual SQLite commands are provided:
294
+** The following SQL extensions are provided with this Fossil-enhanced
295
+** version of the sqlite3 command-line shell:
287296
 **
288297
 ** checkin_mtime(X,Y) Return the mtime for the file Y (a BLOB.RID)
289298
 ** found in check-in X (another BLOB.RID value).
290299
 **
291
-** compress(X) Compress text X.
300
+** compress(X) Compress text X with the same algorithm used
301
+** to compress artifacts in the BLOB table.
292302
 **
293303
 ** content(X) Return the content of artifact X. X can be an
294304
 ** artifact hash or hash prefix or a tag. Artifacts
295305
 ** are stored compressed and deltaed. This function
296306
 ** does all necessary decompression and undeltaing.
@@ -311,15 +321,21 @@
311321
 ** delta D and returns rows for each element of
312322
 ** that delta.
313323
 **
314324
 ** files_of_checkin(X) A table-valued function that returns info on
315325
 ** all files contained in check-in X. Example:
316
-** SELECT * FROM files_of_checkin('trunk');
326
+**
327
+** SELECT * FROM files_of_checkin('trunk');
317328
 **
318329
 ** now() Return the number of seconds since 1970.
319330
 **
320
-** REGEXP The REGEXP operator works, unlike in
331
+** obscure(T) Obfuscate the text password T so that its
332
+** original value is not readily visible. Fossil
333
+** uses this same algorithm when storing passwords
334
+** of remote URLs.
335
+**
336
+** regexp The REGEXP operator works, unlike in
321337
 ** standard SQLite.
322338
 **
323339
 ** symbolic_name_to_rid(X) Return the BLOB.RID corresponding to symbolic
324340
 ** name X.
325341
 */
326342
--- src/sqlcmd.c
+++ src/sqlcmd.c
@@ -266,31 +266,41 @@
266 ** COMMAND: sql
267 ** COMMAND: sqlite3*
268 **
269 ** Usage: %fossil sql ?OPTIONS?
270 **
271 ** Run the standalone sqlite3 command-line shell on DATABASE with SHELL_OPTS.
272 ** If DATABASE is omitted, then the repository that serves the working
273 ** directory is opened. See https://www.sqlite.org/cli.html for additional
274 ** information.
 
 
 
 
 
275 **
276 ** Options:
277 **
278 ** --no-repository Skip opening the repository database.
 
 
 
 
279 **
280 ** -R REPOSITORY Use REPOSITORY as the repository database
281 **
282 ** WARNING: Careless use of this command can corrupt a Fossil repository
283 ** in ways that are unrecoverable. Be sure you know what you are doing before
284 ** running any SQL commands that modify the repository database.
285 **
286 ** The following extensions to the usual SQLite commands are provided:
 
287 **
288 ** checkin_mtime(X,Y) Return the mtime for the file Y (a BLOB.RID)
289 ** found in check-in X (another BLOB.RID value).
290 **
291 ** compress(X) Compress text X.
 
292 **
293 ** content(X) Return the content of artifact X. X can be an
294 ** artifact hash or hash prefix or a tag. Artifacts
295 ** are stored compressed and deltaed. This function
296 ** does all necessary decompression and undeltaing.
@@ -311,15 +321,21 @@
311 ** delta D and returns rows for each element of
312 ** that delta.
313 **
314 ** files_of_checkin(X) A table-valued function that returns info on
315 ** all files contained in check-in X. Example:
316 ** SELECT * FROM files_of_checkin('trunk');
 
317 **
318 ** now() Return the number of seconds since 1970.
319 **
320 ** REGEXP The REGEXP operator works, unlike in
 
 
 
 
 
321 ** standard SQLite.
322 **
323 ** symbolic_name_to_rid(X) Return the BLOB.RID corresponding to symbolic
324 ** name X.
325 */
326
--- src/sqlcmd.c
+++ src/sqlcmd.c
@@ -266,31 +266,41 @@
266 ** COMMAND: sql
267 ** COMMAND: sqlite3*
268 **
269 ** Usage: %fossil sql ?OPTIONS?
270 **
271 ** Run the sqlite3 command-line shell on the Fossil repository
272 ** identified by the -R option, or on the current repository.
273 ** See https://www.sqlite.org/cli.html for additional information about
274 ** the sqlite3 command-line shell.
275 **
276 ** WARNING: Careless use of this command can corrupt a Fossil repository
277 ** in ways that are unrecoverable. Be sure you know what you are doing before
278 ** running any SQL commands that modify the repository database. Use the
279 ** --readonly option to prevent accidental damage to the repository.
280 **
281 ** Options:
282 **
283 ** --no-repository Skip opening the repository database.
284 **
285 ** --readonly Open the repository read-only. No changes
286 ** are allowed. This is a recommended safety
287 ** precaution to prevent repository damage.
288 **
289 ** -R REPOSITORY Use REPOSITORY as the repository database
290 **
291 ** All of the standard sqlite3 command-line shell options should also
292 ** work.
 
293 **
294 ** The following SQL extensions are provided with this Fossil-enhanced
295 ** version of the sqlite3 command-line shell:
296 **
297 ** checkin_mtime(X,Y) Return the mtime for the file Y (a BLOB.RID)
298 ** found in check-in X (another BLOB.RID value).
299 **
300 ** compress(X) Compress text X with the same algorithm used
301 ** to compress artifacts in the BLOB table.
302 **
303 ** content(X) Return the content of artifact X. X can be an
304 ** artifact hash or hash prefix or a tag. Artifacts
305 ** are stored compressed and deltaed. This function
306 ** does all necessary decompression and undeltaing.
@@ -311,15 +321,21 @@
321 ** delta D and returns rows for each element of
322 ** that delta.
323 **
324 ** files_of_checkin(X) A table-valued function that returns info on
325 ** all files contained in check-in X. Example:
326 **
327 ** SELECT * FROM files_of_checkin('trunk');
328 **
329 ** now() Return the number of seconds since 1970.
330 **
331 ** obscure(T) Obfuscate the text password T so that its
332 ** original value is not readily visible. Fossil
333 ** uses this same algorithm when storing passwords
334 ** of remote URLs.
335 **
336 ** regexp The REGEXP operator works, unlike in
337 ** standard SQLite.
338 **
339 ** symbolic_name_to_rid(X) Return the BLOB.RID corresponding to symbolic
340 ** name X.
341 */
342

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button