amalgalite 1.9.4-x64-mingw-ucrt → 2.0.0-x64-mingw-ucrt

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. checksums.yaml +4 -4
  2. data/HISTORY.md +19 -2
  3. data/Manifest.txt +4 -54
  4. data/README.md +1 -1
  5. data/TODO.md +4 -3
  6. data/amalgalite.gemspec +39 -0
  7. data/ext/amalgalite/c/amalgalite.c +0 -1
  8. data/ext/amalgalite/c/amalgalite_constants.c +155 -10
  9. data/ext/amalgalite/c/extconf.rb +5 -2
  10. data/ext/amalgalite/c/gen_constants.rb +32 -1
  11. data/ext/amalgalite/c/sqlite3.c +19308 -9112
  12. data/ext/amalgalite/c/sqlite3.h +909 -296
  13. data/ext/amalgalite/c/sqlite3ext.h +11 -0
  14. data/lib/amalgalite/3.1/amalgalite.so +0 -0
  15. data/lib/amalgalite/3.2/amalgalite.so +0 -0
  16. data/lib/amalgalite/3.3/amalgalite.so +0 -0
  17. data/lib/amalgalite/3.4/amalgalite.so +0 -0
  18. data/lib/amalgalite/column.rb +20 -2
  19. data/lib/amalgalite/result/row.rb +83 -0
  20. data/lib/amalgalite/result.rb +15 -0
  21. data/lib/amalgalite/statement.rb +32 -24
  22. data/lib/amalgalite/type_maps/default_map.rb +48 -56
  23. data/lib/amalgalite/version.rb +1 -1
  24. metadata +35 -119
  25. data/Rakefile +0 -27
  26. data/bin/amalgalite-pack +0 -147
  27. data/examples/a.rb +0 -9
  28. data/examples/blob.rb +0 -88
  29. data/examples/bootstrap.rb +0 -36
  30. data/examples/define_aggregate.rb +0 -75
  31. data/examples/define_function.rb +0 -104
  32. data/examples/fts5.rb +0 -152
  33. data/examples/gem-db.rb +0 -94
  34. data/examples/require_me.rb +0 -11
  35. data/examples/requires.rb +0 -42
  36. data/examples/schema-info.rb +0 -34
  37. data/ext/amalgalite/c/amalgalite_requires_bootstrap.c +0 -283
  38. data/lib/amalgalite/core_ext/kernel/require.rb +0 -21
  39. data/lib/amalgalite/packer.rb +0 -231
  40. data/lib/amalgalite/requires.rb +0 -151
  41. data/spec/aggregate_spec.rb +0 -158
  42. data/spec/amalgalite_spec.rb +0 -4
  43. data/spec/blob_spec.rb +0 -78
  44. data/spec/boolean_spec.rb +0 -24
  45. data/spec/busy_handler.rb +0 -157
  46. data/spec/data/iso-3166-country.txt +0 -242
  47. data/spec/data/iso-3166-schema.sql +0 -22
  48. data/spec/data/iso-3166-subcountry.txt +0 -3995
  49. data/spec/data/make-iso-db.sh +0 -12
  50. data/spec/database_spec.rb +0 -505
  51. data/spec/default_map_spec.rb +0 -92
  52. data/spec/function_spec.rb +0 -78
  53. data/spec/integeration_spec.rb +0 -97
  54. data/spec/iso_3166_database.rb +0 -58
  55. data/spec/json_spec.rb +0 -24
  56. data/spec/packer_spec.rb +0 -60
  57. data/spec/paths_spec.rb +0 -28
  58. data/spec/progress_handler_spec.rb +0 -91
  59. data/spec/requires_spec.rb +0 -54
  60. data/spec/rtree_spec.rb +0 -66
  61. data/spec/schema_spec.rb +0 -131
  62. data/spec/spec_helper.rb +0 -48
  63. data/spec/sqlite3/constants_spec.rb +0 -108
  64. data/spec/sqlite3/database_status_spec.rb +0 -36
  65. data/spec/sqlite3/status_spec.rb +0 -22
  66. data/spec/sqlite3/version_spec.rb +0 -28
  67. data/spec/sqlite3_spec.rb +0 -53
  68. data/spec/statement_spec.rb +0 -168
  69. data/spec/storage_map_spec.rb +0 -38
  70. data/spec/tap_spec.rb +0 -57
  71. data/spec/text_map_spec.rb +0 -20
  72. data/spec/type_map_spec.rb +0 -14
  73. data/spec/version_spec.rb +0 -8
  74. data/tasks/custom.rake +0 -101
  75. data/tasks/default.rake +0 -257
  76. data/tasks/extension.rake +0 -28
  77. data/tasks/this.rb +0 -208
  78. /data/{LICENSE → LICENSE.txt} +0 -0
@@ -133,7 +133,7 @@ extern "C" {
133
133
  **
134
134
  ** Since [version 3.6.18] ([dateof:3.6.18]),
135
135
  ** SQLite source code has been stored in the
136
- ** <a href="http://www.fossil-scm.org/">Fossil configuration management
136
+ ** <a href="http://fossil-scm.org/">Fossil configuration management
137
137
  ** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to
138
138
  ** a string which identifies a particular check-in of SQLite
139
139
  ** within its configuration management system. ^The SQLITE_SOURCE_ID
@@ -146,9 +146,12 @@ extern "C" {
146
146
  ** [sqlite3_libversion_number()], [sqlite3_sourceid()],
147
147
  ** [sqlite_version()] and [sqlite_source_id()].
148
148
  */
149
- #define SQLITE_VERSION "3.45.1"
150
- #define SQLITE_VERSION_NUMBER 3045001
151
- #define SQLITE_SOURCE_ID "2024-01-30 16:01:20 e876e51a0ed5c5b3126f52e532044363a014bc594cfefa87ffb5b82257cc467a"
149
+ #define SQLITE_VERSION "3.51.0"
150
+ #define SQLITE_VERSION_NUMBER 3051000
151
+ #define SQLITE_SOURCE_ID "2025-11-04 19:38:17 fb2c931ae597f8d00a37574ff67aeed3eced4e5547f9120744ae4bfa8e74527b"
152
+ #define SQLITE_SCM_BRANCH "trunk"
153
+ #define SQLITE_SCM_TAGS "release major-release version-3.51.0"
154
+ #define SQLITE_SCM_DATETIME "2025-11-04T19:38:17.314Z"
152
155
 
153
156
  /*
154
157
  ** CAPI3REF: Run-Time Library Version Numbers
@@ -168,9 +171,9 @@ extern "C" {
168
171
  ** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
169
172
  ** </pre></blockquote>)^
170
173
  **
171
- ** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
172
- ** macro. ^The sqlite3_libversion() function returns a pointer to the
173
- ** to the sqlite3_version[] string constant. The sqlite3_libversion()
174
+ ** ^The sqlite3_version[] string constant contains the text of the
175
+ ** [SQLITE_VERSION] macro. ^The sqlite3_libversion() function returns a
176
+ ** pointer to the sqlite3_version[] string constant. The sqlite3_libversion()
174
177
  ** function is provided for use in DLLs since DLL users usually do not have
175
178
  ** direct access to string constants within the DLL. ^The
176
179
  ** sqlite3_libversion_number() function returns an integer equal to
@@ -370,7 +373,7 @@ typedef int (*sqlite3_callback)(void*,int,char**, char**);
370
373
  ** without having to use a lot of C code.
371
374
  **
372
375
  ** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
373
- ** semicolon-separate SQL statements passed into its 2nd argument,
376
+ ** semicolon-separated SQL statements passed into its 2nd argument,
374
377
  ** in the context of the [database connection] passed in as its 1st
375
378
  ** argument. ^If the callback function of the 3rd argument to
376
379
  ** sqlite3_exec() is not NULL, then it is invoked for each result row
@@ -403,7 +406,7 @@ typedef int (*sqlite3_callback)(void*,int,char**, char**);
403
406
  ** result row is NULL then the corresponding string pointer for the
404
407
  ** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the
405
408
  ** sqlite3_exec() callback is an array of pointers to strings where each
406
- ** entry represents the name of corresponding result column as obtained
409
+ ** entry represents the name of a corresponding result column as obtained
407
410
  ** from [sqlite3_column_name()].
408
411
  **
409
412
  ** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
@@ -420,6 +423,8 @@ typedef int (*sqlite3_callback)(void*,int,char**, char**);
420
423
  ** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
421
424
  ** <li> The application must not modify the SQL statement text passed into
422
425
  ** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
426
+ ** <li> The application must not dereference the arrays or string pointers
427
+ ** passed as the 3rd and 4th callback parameters after it returns.
423
428
  ** </ul>
424
429
  */
425
430
  SQLITE_API int sqlite3_exec(
@@ -495,6 +500,9 @@ SQLITE_API int sqlite3_exec(
495
500
  #define SQLITE_ERROR_MISSING_COLLSEQ (SQLITE_ERROR | (1<<8))
496
501
  #define SQLITE_ERROR_RETRY (SQLITE_ERROR | (2<<8))
497
502
  #define SQLITE_ERROR_SNAPSHOT (SQLITE_ERROR | (3<<8))
503
+ #define SQLITE_ERROR_RESERVESIZE (SQLITE_ERROR | (4<<8))
504
+ #define SQLITE_ERROR_KEY (SQLITE_ERROR | (5<<8))
505
+ #define SQLITE_ERROR_UNABLE (SQLITE_ERROR | (6<<8))
498
506
  #define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
499
507
  #define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
500
508
  #define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
@@ -529,6 +537,8 @@ SQLITE_API int sqlite3_exec(
529
537
  #define SQLITE_IOERR_DATA (SQLITE_IOERR | (32<<8))
530
538
  #define SQLITE_IOERR_CORRUPTFS (SQLITE_IOERR | (33<<8))
531
539
  #define SQLITE_IOERR_IN_PAGE (SQLITE_IOERR | (34<<8))
540
+ #define SQLITE_IOERR_BADKEY (SQLITE_IOERR | (35<<8))
541
+ #define SQLITE_IOERR_CODEC (SQLITE_IOERR | (36<<8))
532
542
  #define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8))
533
543
  #define SQLITE_LOCKED_VTAB (SQLITE_LOCKED | (2<<8))
534
544
  #define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8))
@@ -587,7 +597,7 @@ SQLITE_API int sqlite3_exec(
587
597
  ** Note in particular that passing the SQLITE_OPEN_EXCLUSIVE flag into
588
598
  ** [sqlite3_open_v2()] does *not* cause the underlying database file
589
599
  ** to be opened using O_EXCL. Passing SQLITE_OPEN_EXCLUSIVE into
590
- ** [sqlite3_open_v2()] has historically be a no-op and might become an
600
+ ** [sqlite3_open_v2()] has historically been a no-op and might become an
591
601
  ** error in future versions of SQLite.
592
602
  */
593
603
  #define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
@@ -650,6 +660,13 @@ SQLITE_API int sqlite3_exec(
650
660
  ** filesystem supports doing multiple write operations atomically when those
651
661
  ** write operations are bracketed by [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] and
652
662
  ** [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE].
663
+ **
664
+ ** The SQLITE_IOCAP_SUBPAGE_READ property means that it is ok to read
665
+ ** from the database file in amounts that are not a multiple of the
666
+ ** page size and that do not begin at a page boundary. Without this
667
+ ** property, SQLite is careful to only do full-page reads and write
668
+ ** on aligned pages, with the one exception that it will do a sub-page
669
+ ** read of the first page to access the database header.
653
670
  */
654
671
  #define SQLITE_IOCAP_ATOMIC 0x00000001
655
672
  #define SQLITE_IOCAP_ATOMIC512 0x00000002
@@ -666,6 +683,7 @@ SQLITE_API int sqlite3_exec(
666
683
  #define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000
667
684
  #define SQLITE_IOCAP_IMMUTABLE 0x00002000
668
685
  #define SQLITE_IOCAP_BATCH_ATOMIC 0x00004000
686
+ #define SQLITE_IOCAP_SUBPAGE_READ 0x00008000
669
687
 
670
688
  /*
671
689
  ** CAPI3REF: File Locking Levels
@@ -673,7 +691,7 @@ SQLITE_API int sqlite3_exec(
673
691
  ** SQLite uses one of these integer values as the second
674
692
  ** argument to calls it makes to the xLock() and xUnlock() methods
675
693
  ** of an [sqlite3_io_methods] object. These values are ordered from
676
- ** lest restrictive to most restrictive.
694
+ ** least restrictive to most restrictive.
677
695
  **
678
696
  ** The argument to xLock() is always SHARED or higher. The argument to
679
697
  ** xUnlock is either SHARED or NONE.
@@ -762,16 +780,16 @@ struct sqlite3_file {
762
780
  ** </ul>
763
781
  ** xLock() upgrades the database file lock. In other words, xLock() moves the
764
782
  ** database file lock in the direction NONE toward EXCLUSIVE. The argument to
765
- ** xLock() is always on of SHARED, RESERVED, PENDING, or EXCLUSIVE, never
783
+ ** xLock() is always one of SHARED, RESERVED, PENDING, or EXCLUSIVE, never
766
784
  ** SQLITE_LOCK_NONE. If the database file lock is already at or above the
767
785
  ** requested lock, then the call to xLock() is a no-op.
768
786
  ** xUnlock() downgrades the database file lock to either SHARED or NONE.
769
- * If the lock is already at or below the requested lock state, then the call
787
+ ** If the lock is already at or below the requested lock state, then the call
770
788
  ** to xUnlock() is a no-op.
771
789
  ** The xCheckReservedLock() method checks whether any database connection,
772
790
  ** either in this process or in some other process, is holding a RESERVED,
773
- ** PENDING, or EXCLUSIVE lock on the file. It returns true
774
- ** if such a lock exists and false otherwise.
791
+ ** PENDING, or EXCLUSIVE lock on the file. It returns, via its output
792
+ ** pointer parameter, true if such a lock exists and false otherwise.
775
793
  **
776
794
  ** The xFileControl() method is a generic interface that allows custom
777
795
  ** VFS implementations to directly control an open file using the
@@ -812,6 +830,7 @@ struct sqlite3_file {
812
830
  ** <li> [SQLITE_IOCAP_POWERSAFE_OVERWRITE]
813
831
  ** <li> [SQLITE_IOCAP_IMMUTABLE]
814
832
  ** <li> [SQLITE_IOCAP_BATCH_ATOMIC]
833
+ ** <li> [SQLITE_IOCAP_SUBPAGE_READ]
815
834
  ** </ul>
816
835
  **
817
836
  ** The SQLITE_IOCAP_ATOMIC property means that all writes of
@@ -913,7 +932,7 @@ struct sqlite3_io_methods {
913
932
  ** connection. See also [SQLITE_FCNTL_FILE_POINTER].
914
933
  **
915
934
  ** <li>[[SQLITE_FCNTL_SYNC_OMITTED]]
916
- ** No longer in use.
935
+ ** The SQLITE_FCNTL_SYNC_OMITTED file-control is no longer used.
917
936
  **
918
937
  ** <li>[[SQLITE_FCNTL_SYNC]]
919
938
  ** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and
@@ -988,7 +1007,7 @@ struct sqlite3_io_methods {
988
1007
  **
989
1008
  ** <li>[[SQLITE_FCNTL_VFSNAME]]
990
1009
  ** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
991
- ** all [VFSes] in the VFS stack. The names are of all VFS shims and the
1010
+ ** all [VFSes] in the VFS stack. The names of all VFS shims and the
992
1011
  ** final bottom-level VFS are written into memory obtained from
993
1012
  ** [sqlite3_malloc()] and the result is stored in the char* variable
994
1013
  ** that the fourth parameter of [sqlite3_file_control()] points to.
@@ -1002,7 +1021,7 @@ struct sqlite3_io_methods {
1002
1021
  ** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level
1003
1022
  ** [VFSes] currently in use. ^(The argument X in
1004
1023
  ** sqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be
1005
- ** of type "[sqlite3_vfs] **". This opcodes will set *X
1024
+ ** of type "[sqlite3_vfs] **". This opcode will set *X
1006
1025
  ** to a pointer to the top-level VFS.)^
1007
1026
  ** ^When there are multiple VFS shims in the stack, this opcode finds the
1008
1027
  ** upper-most shim only.
@@ -1089,6 +1108,11 @@ struct sqlite3_io_methods {
1089
1108
  ** pointed to by the pArg argument. This capability is used during testing
1090
1109
  ** and only needs to be supported when SQLITE_TEST is defined.
1091
1110
  **
1111
+ ** <li>[[SQLITE_FCNTL_NULL_IO]]
1112
+ ** The [SQLITE_FCNTL_NULL_IO] opcode sets the low-level file descriptor
1113
+ ** or file handle for the [sqlite3_file] object such that it will no longer
1114
+ ** read or write to the database file.
1115
+ **
1092
1116
  ** <li>[[SQLITE_FCNTL_WAL_BLOCK]]
1093
1117
  ** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might
1094
1118
  ** be advantageous to block on the next WAL lock if the lock is not immediately
@@ -1147,6 +1171,12 @@ struct sqlite3_io_methods {
1147
1171
  ** the value that M is to be set to. Before returning, the 32-bit signed
1148
1172
  ** integer is overwritten with the previous value of M.
1149
1173
  **
1174
+ ** <li>[[SQLITE_FCNTL_BLOCK_ON_CONNECT]]
1175
+ ** The [SQLITE_FCNTL_BLOCK_ON_CONNECT] opcode is used to configure the
1176
+ ** VFS to block when taking a SHARED lock to connect to a wal mode database.
1177
+ ** This is used to implement the functionality associated with
1178
+ ** SQLITE_SETLK_BLOCK_ON_CONNECT.
1179
+ **
1150
1180
  ** <li>[[SQLITE_FCNTL_DATA_VERSION]]
1151
1181
  ** The [SQLITE_FCNTL_DATA_VERSION] opcode is used to detect changes to
1152
1182
  ** a database file. The argument is a pointer to a 32-bit unsigned integer.
@@ -1181,7 +1211,7 @@ struct sqlite3_io_methods {
1181
1211
  ** <li>[[SQLITE_FCNTL_EXTERNAL_READER]]
1182
1212
  ** The EXPERIMENTAL [SQLITE_FCNTL_EXTERNAL_READER] opcode is used to detect
1183
1213
  ** whether or not there is a database client in another process with a wal-mode
1184
- ** transaction open on the database or not. It is only available on unix.The
1214
+ ** transaction open on the database or not. It is only available on unix. The
1185
1215
  ** (void*) argument passed with this file-control should be a pointer to a
1186
1216
  ** value of type (int). The integer value is set to 1 if the database is a wal
1187
1217
  ** mode database and there exists at least one client in another process that
@@ -1199,6 +1229,15 @@ struct sqlite3_io_methods {
1199
1229
  ** database is not a temp db, then the [SQLITE_FCNTL_RESET_CACHE] file-control
1200
1230
  ** purges the contents of the in-memory page cache. If there is an open
1201
1231
  ** transaction, or if the db is a temp-db, this opcode is a no-op, not an error.
1232
+ **
1233
+ ** <li>[[SQLITE_FCNTL_FILESTAT]]
1234
+ ** The [SQLITE_FCNTL_FILESTAT] opcode returns low-level diagnostic information
1235
+ ** about the [sqlite3_file] objects used access the database and journal files
1236
+ ** for the given schema. The fourth parameter to [sqlite3_file_control()]
1237
+ ** should be an initialized [sqlite3_str] pointer. JSON text describing
1238
+ ** various aspects of the sqlite3_file object is appended to the sqlite3_str.
1239
+ ** The SQLITE_FCNTL_FILESTAT opcode is usually a no-op, unless compile-time
1240
+ ** options are used to enable it.
1202
1241
  ** </ul>
1203
1242
  */
1204
1243
  #define SQLITE_FCNTL_LOCKSTATE 1
@@ -1242,6 +1281,9 @@ struct sqlite3_io_methods {
1242
1281
  #define SQLITE_FCNTL_EXTERNAL_READER 40
1243
1282
  #define SQLITE_FCNTL_CKSM_FILE 41
1244
1283
  #define SQLITE_FCNTL_RESET_CACHE 42
1284
+ #define SQLITE_FCNTL_NULL_IO 43
1285
+ #define SQLITE_FCNTL_BLOCK_ON_CONNECT 44
1286
+ #define SQLITE_FCNTL_FILESTAT 45
1245
1287
 
1246
1288
  /* deprecated names */
1247
1289
  #define SQLITE_GET_LOCKPROXYFILE SQLITE_FCNTL_GET_LOCKPROXYFILE
@@ -1604,7 +1646,7 @@ struct sqlite3_vfs {
1604
1646
  ** SQLite interfaces so that an application usually does not need to
1605
1647
  ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
1606
1648
  ** calls sqlite3_initialize() so the SQLite library will be automatically
1607
- ** initialized when [sqlite3_open()] is called if it has not be initialized
1649
+ ** initialized when [sqlite3_open()] is called if it has not been initialized
1608
1650
  ** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
1609
1651
  ** compile-time option, then the automatic calls to sqlite3_initialize()
1610
1652
  ** are omitted and the application must call sqlite3_initialize() directly
@@ -1861,21 +1903,21 @@ struct sqlite3_mem_methods {
1861
1903
  ** The [sqlite3_mem_methods]
1862
1904
  ** structure is filled with the currently defined memory allocation routines.)^
1863
1905
  ** This option can be used to overload the default memory allocation
1864
- ** routines with a wrapper that simulations memory allocation failure or
1906
+ ** routines with a wrapper that simulates memory allocation failure or
1865
1907
  ** tracks memory usage, for example. </dd>
1866
1908
  **
1867
1909
  ** [[SQLITE_CONFIG_SMALL_MALLOC]] <dt>SQLITE_CONFIG_SMALL_MALLOC</dt>
1868
- ** <dd> ^The SQLITE_CONFIG_SMALL_MALLOC option takes single argument of
1910
+ ** <dd> ^The SQLITE_CONFIG_SMALL_MALLOC option takes a single argument of
1869
1911
  ** type int, interpreted as a boolean, which if true provides a hint to
1870
1912
  ** SQLite that it should avoid large memory allocations if possible.
1871
1913
  ** SQLite will run faster if it is free to make large memory allocations,
1872
- ** but some application might prefer to run slower in exchange for
1914
+ ** but some applications might prefer to run slower in exchange for
1873
1915
  ** guarantees about memory fragmentation that are possible if large
1874
1916
  ** allocations are avoided. This hint is normally off.
1875
1917
  ** </dd>
1876
1918
  **
1877
1919
  ** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt>
1878
- ** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int,
1920
+ ** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes a single argument of type int,
1879
1921
  ** interpreted as a boolean, which enables or disables the collection of
1880
1922
  ** memory allocation statistics. ^(When memory allocation statistics are
1881
1923
  ** disabled, the following SQLite interfaces become non-operational:
@@ -1920,7 +1962,7 @@ struct sqlite3_mem_methods {
1920
1962
  ** ^If pMem is NULL and N is non-zero, then each database connection
1921
1963
  ** does an initial bulk allocation for page cache memory
1922
1964
  ** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or
1923
- ** of -1024*N bytes if N is negative, . ^If additional
1965
+ ** of -1024*N bytes if N is negative. ^If additional
1924
1966
  ** page cache memory is needed beyond what is provided by the initial
1925
1967
  ** allocation, then SQLite goes to [sqlite3_malloc()] separately for each
1926
1968
  ** additional cache line. </dd>
@@ -1949,7 +1991,7 @@ struct sqlite3_mem_methods {
1949
1991
  ** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a
1950
1992
  ** pointer to an instance of the [sqlite3_mutex_methods] structure.
1951
1993
  ** The argument specifies alternative low-level mutex routines to be used
1952
- ** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of
1994
+ ** in place of the mutex routines built into SQLite.)^ ^SQLite makes a copy of
1953
1995
  ** the content of the [sqlite3_mutex_methods] structure before the call to
1954
1996
  ** [sqlite3_config()] returns. ^If SQLite is compiled with
1955
1997
  ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
@@ -1972,13 +2014,16 @@ struct sqlite3_mem_methods {
1972
2014
  **
1973
2015
  ** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt>
1974
2016
  ** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine
1975
- ** the default size of lookaside memory on each [database connection].
2017
+ ** the default size of [lookaside memory] on each [database connection].
1976
2018
  ** The first argument is the
1977
- ** size of each lookaside buffer slot and the second is the number of
1978
- ** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE
1979
- ** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
1980
- ** option to [sqlite3_db_config()] can be used to change the lookaside
1981
- ** configuration on individual connections.)^ </dd>
2019
+ ** size of each lookaside buffer slot ("sz") and the second is the number of
2020
+ ** slots allocated to each database connection ("cnt").)^
2021
+ ** ^(SQLITE_CONFIG_LOOKASIDE sets the <i>default</i> lookaside size.
2022
+ ** The [SQLITE_DBCONFIG_LOOKASIDE] option to [sqlite3_db_config()] can
2023
+ ** be used to change the lookaside configuration on individual connections.)^
2024
+ ** The [-DSQLITE_DEFAULT_LOOKASIDE] option can be used to change the
2025
+ ** default lookaside configuration at compile-time.
2026
+ ** </dd>
1982
2027
  **
1983
2028
  ** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt>
1984
2029
  ** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is
@@ -1988,7 +2033,7 @@ struct sqlite3_mem_methods {
1988
2033
  **
1989
2034
  ** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt>
1990
2035
  ** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which
1991
- ** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies of
2036
+ ** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies off
1992
2037
  ** the current page cache implementation into that object.)^ </dd>
1993
2038
  **
1994
2039
  ** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt>
@@ -2005,7 +2050,7 @@ struct sqlite3_mem_methods {
2005
2050
  ** the logger function is a copy of the first parameter to the corresponding
2006
2051
  ** [sqlite3_log()] call and is intended to be a [result code] or an
2007
2052
  ** [extended result code]. ^The third parameter passed to the logger is
2008
- ** log message after formatting via [sqlite3_snprintf()].
2053
+ ** a log message after formatting via [sqlite3_snprintf()].
2009
2054
  ** The SQLite logging interface is not reentrant; the logger function
2010
2055
  ** supplied by the application must not invoke any SQLite interface.
2011
2056
  ** In a multi-threaded application, the application-defined logger
@@ -2141,6 +2186,22 @@ struct sqlite3_mem_methods {
2141
2186
  ** configuration setting is never used, then the default maximum is determined
2142
2187
  ** by the [SQLITE_MEMDB_DEFAULT_MAXSIZE] compile-time option. If that
2143
2188
  ** compile-time option is not set, then the default maximum is 1073741824.
2189
+ **
2190
+ ** [[SQLITE_CONFIG_ROWID_IN_VIEW]]
2191
+ ** <dt>SQLITE_CONFIG_ROWID_IN_VIEW
2192
+ ** <dd>The SQLITE_CONFIG_ROWID_IN_VIEW option enables or disables the ability
2193
+ ** for VIEWs to have a ROWID. The capability can only be enabled if SQLite is
2194
+ ** compiled with -DSQLITE_ALLOW_ROWID_IN_VIEW, in which case the capability
2195
+ ** defaults to on. This configuration option queries the current setting or
2196
+ ** changes the setting to off or on. The argument is a pointer to an integer.
2197
+ ** If that integer initially holds a value of 1, then the ability for VIEWs to
2198
+ ** have ROWIDs is activated. If the integer initially holds zero, then the
2199
+ ** ability is deactivated. Any other initial value for the integer leaves the
2200
+ ** setting unchanged. After changes, if any, the integer is written with
2201
+ ** a 1 or 0, if the ability for VIEWs to have ROWIDs is on or off. If SQLite
2202
+ ** is compiled without -DSQLITE_ALLOW_ROWID_IN_VIEW (which is the usual and
2203
+ ** recommended case) then the integer is always filled with zero, regardless
2204
+ ** if its initial value.
2144
2205
  ** </dl>
2145
2206
  */
2146
2207
  #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
@@ -2172,12 +2233,21 @@ struct sqlite3_mem_methods {
2172
2233
  #define SQLITE_CONFIG_SMALL_MALLOC 27 /* boolean */
2173
2234
  #define SQLITE_CONFIG_SORTERREF_SIZE 28 /* int nByte */
2174
2235
  #define SQLITE_CONFIG_MEMDB_MAXSIZE 29 /* sqlite3_int64 */
2236
+ #define SQLITE_CONFIG_ROWID_IN_VIEW 30 /* int* */
2175
2237
 
2176
2238
  /*
2177
2239
  ** CAPI3REF: Database Connection Configuration Options
2178
2240
  **
2179
2241
  ** These constants are the available integer configuration options that
2180
- ** can be passed as the second argument to the [sqlite3_db_config()] interface.
2242
+ ** can be passed as the second parameter to the [sqlite3_db_config()] interface.
2243
+ **
2244
+ ** The [sqlite3_db_config()] interface is a var-args function. It takes a
2245
+ ** variable number of parameters, though always at least two. The number of
2246
+ ** parameters passed into sqlite3_db_config() depends on which of these
2247
+ ** constants is given as the second parameter. This documentation page
2248
+ ** refers to parameters beyond the second as "arguments". Thus, when this
2249
+ ** page says "the N-th argument" it means "the N-th parameter past the
2250
+ ** configuration option" or "the (N+2)-th parameter to sqlite3_db_config()".
2181
2251
  **
2182
2252
  ** New configuration options may be added in future releases of SQLite.
2183
2253
  ** Existing configuration options might be discontinued. Applications
@@ -2189,31 +2259,57 @@ struct sqlite3_mem_methods {
2189
2259
  ** <dl>
2190
2260
  ** [[SQLITE_DBCONFIG_LOOKASIDE]]
2191
2261
  ** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
2192
- ** <dd> ^This option takes three additional arguments that determine the
2193
- ** [lookaside memory allocator] configuration for the [database connection].
2194
- ** ^The first argument (the third parameter to [sqlite3_db_config()] is a
2262
+ ** <dd> The SQLITE_DBCONFIG_LOOKASIDE option is used to adjust the
2263
+ ** configuration of the [lookaside memory allocator] within a database
2264
+ ** connection.
2265
+ ** The arguments to the SQLITE_DBCONFIG_LOOKASIDE option are <i>not</i>
2266
+ ** in the [DBCONFIG arguments|usual format].
2267
+ ** The SQLITE_DBCONFIG_LOOKASIDE option takes three arguments, not two,
2268
+ ** so that a call to [sqlite3_db_config()] that uses SQLITE_DBCONFIG_LOOKASIDE
2269
+ ** should have a total of five parameters.
2270
+ ** <ol>
2271
+ ** <li><p>The first argument ("buf") is a
2195
2272
  ** pointer to a memory buffer to use for lookaside memory.
2196
- ** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb
2197
- ** may be NULL in which case SQLite will allocate the
2198
- ** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the
2199
- ** size of each lookaside buffer slot. ^The third argument is the number of
2200
- ** slots. The size of the buffer in the first argument must be greater than
2201
- ** or equal to the product of the second and third arguments. The buffer
2202
- ** must be aligned to an 8-byte boundary. ^If the second argument to
2203
- ** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally
2204
- ** rounded down to the next smaller multiple of 8. ^(The lookaside memory
2273
+ ** The first argument may be NULL in which case SQLite will allocate the
2274
+ ** lookaside buffer itself using [sqlite3_malloc()].
2275
+ ** <li><P>The second argument ("sz") is the
2276
+ ** size of each lookaside buffer slot. Lookaside is disabled if "sz"
2277
+ ** is less than 8. The "sz" argument should be a multiple of 8 less than
2278
+ ** 65536. If "sz" does not meet this constraint, it is reduced in size until
2279
+ ** it does.
2280
+ ** <li><p>The third argument ("cnt") is the number of slots. Lookaside is disabled
2281
+ ** if "cnt"is less than 1. The "cnt" value will be reduced, if necessary, so
2282
+ ** that the product of "sz" and "cnt" does not exceed 2,147,418,112. The "cnt"
2283
+ ** parameter is usually chosen so that the product of "sz" and "cnt" is less
2284
+ ** than 1,000,000.
2285
+ ** </ol>
2286
+ ** <p>If the "buf" argument is not NULL, then it must
2287
+ ** point to a memory buffer with a size that is greater than
2288
+ ** or equal to the product of "sz" and "cnt".
2289
+ ** The buffer must be aligned to an 8-byte boundary.
2290
+ ** The lookaside memory
2205
2291
  ** configuration for a database connection can only be changed when that
2206
2292
  ** connection is not currently using lookaside memory, or in other words
2207
- ** when the "current value" returned by
2208
- ** [sqlite3_db_status](D,[SQLITE_DBSTATUS_LOOKASIDE_USED],...) is zero.
2293
+ ** when the value returned by [SQLITE_DBSTATUS_LOOKASIDE_USED] is zero.
2209
2294
  ** Any attempt to change the lookaside memory configuration when lookaside
2210
2295
  ** memory is in use leaves the configuration unchanged and returns
2211
- ** [SQLITE_BUSY].)^</dd>
2296
+ ** [SQLITE_BUSY].
2297
+ ** If the "buf" argument is NULL and an attempt
2298
+ ** to allocate memory based on "sz" and "cnt" fails, then
2299
+ ** lookaside is silently disabled.
2300
+ ** <p>
2301
+ ** The [SQLITE_CONFIG_LOOKASIDE] configuration option can be used to set the
2302
+ ** default lookaside configuration at initialization. The
2303
+ ** [-DSQLITE_DEFAULT_LOOKASIDE] option can be used to set the default lookaside
2304
+ ** configuration at compile-time. Typical values for lookaside are 1200 for
2305
+ ** "sz" and 40 to 100 for "cnt".
2306
+ ** </dd>
2212
2307
  **
2213
2308
  ** [[SQLITE_DBCONFIG_ENABLE_FKEY]]
2214
2309
  ** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt>
2215
2310
  ** <dd> ^This option is used to enable or disable the enforcement of
2216
- ** [foreign key constraints]. There should be two additional arguments.
2311
+ ** [foreign key constraints]. This is the same setting that is
2312
+ ** enabled or disabled by the [PRAGMA foreign_keys] statement.
2217
2313
  ** The first argument is an integer which is 0 to disable FK enforcement,
2218
2314
  ** positive to enable FK enforcement or negative to leave FK enforcement
2219
2315
  ** unchanged. The second parameter is a pointer to an integer into which
@@ -2235,13 +2331,13 @@ struct sqlite3_mem_methods {
2235
2331
  ** <p>Originally this option disabled all triggers. ^(However, since
2236
2332
  ** SQLite version 3.35.0, TEMP triggers are still allowed even if
2237
2333
  ** this option is off. So, in other words, this option now only disables
2238
- ** triggers in the main database schema or in the schemas of ATTACH-ed
2334
+ ** triggers in the main database schema or in the schemas of [ATTACH]-ed
2239
2335
  ** databases.)^ </dd>
2240
2336
  **
2241
2337
  ** [[SQLITE_DBCONFIG_ENABLE_VIEW]]
2242
2338
  ** <dt>SQLITE_DBCONFIG_ENABLE_VIEW</dt>
2243
2339
  ** <dd> ^This option is used to enable or disable [CREATE VIEW | views].
2244
- ** There should be two additional arguments.
2340
+ ** There must be two additional arguments.
2245
2341
  ** The first argument is an integer which is 0 to disable views,
2246
2342
  ** positive to enable views or negative to leave the setting unchanged.
2247
2343
  ** The second parameter is a pointer to an integer into which
@@ -2257,17 +2353,20 @@ struct sqlite3_mem_methods {
2257
2353
  **
2258
2354
  ** [[SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER]]
2259
2355
  ** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt>
2260
- ** <dd> ^This option is used to enable or disable the
2261
- ** [fts3_tokenizer()] function which is part of the
2262
- ** [FTS3] full-text search engine extension.
2263
- ** There should be two additional arguments.
2264
- ** The first argument is an integer which is 0 to disable fts3_tokenizer() or
2265
- ** positive to enable fts3_tokenizer() or negative to leave the setting
2266
- ** unchanged.
2267
- ** The second parameter is a pointer to an integer into which
2268
- ** is written 0 or 1 to indicate whether fts3_tokenizer is disabled or enabled
2269
- ** following this call. The second parameter may be a NULL pointer, in
2270
- ** which case the new setting is not reported back. </dd>
2356
+ ** <dd> ^This option is used to enable or disable using the
2357
+ ** [fts3_tokenizer()] function - part of the [FTS3] full-text search engine
2358
+ ** extension - without using bound parameters as the parameters. Doing so
2359
+ ** is disabled by default. There must be two additional arguments. The first
2360
+ ** argument is an integer. If it is passed 0, then using fts3_tokenizer()
2361
+ ** without bound parameters is disabled. If it is passed a positive value,
2362
+ ** then calling fts3_tokenizer without bound parameters is enabled. If it
2363
+ ** is passed a negative value, this setting is not modified - this can be
2364
+ ** used to query for the current setting. The second parameter is a pointer
2365
+ ** to an integer into which is written 0 or 1 to indicate the current value
2366
+ ** of this setting (after it is modified, if applicable). The second
2367
+ ** parameter may be a NULL pointer, in which case the value of the setting
2368
+ ** is not reported back. Refer to [FTS3] documentation for further details.
2369
+ ** </dd>
2271
2370
  **
2272
2371
  ** [[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION]]
2273
2372
  ** <dt>SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</dt>
@@ -2275,12 +2374,12 @@ struct sqlite3_mem_methods {
2275
2374
  ** interface independently of the [load_extension()] SQL function.
2276
2375
  ** The [sqlite3_enable_load_extension()] API enables or disables both the
2277
2376
  ** C-API [sqlite3_load_extension()] and the SQL function [load_extension()].
2278
- ** There should be two additional arguments.
2377
+ ** There must be two additional arguments.
2279
2378
  ** When the first argument to this interface is 1, then only the C-API is
2280
2379
  ** enabled and the SQL function remains disabled. If the first argument to
2281
2380
  ** this interface is 0, then both the C-API and the SQL function are disabled.
2282
- ** If the first argument is -1, then no changes are made to state of either the
2283
- ** C-API or the SQL function.
2381
+ ** If the first argument is -1, then no changes are made to the state of either
2382
+ ** the C-API or the SQL function.
2284
2383
  ** The second parameter is a pointer to an integer into which
2285
2384
  ** is written 0 or 1 to indicate whether [sqlite3_load_extension()] interface
2286
2385
  ** is disabled or enabled following this call. The second parameter may
@@ -2289,23 +2388,30 @@ struct sqlite3_mem_methods {
2289
2388
  **
2290
2389
  ** [[SQLITE_DBCONFIG_MAINDBNAME]] <dt>SQLITE_DBCONFIG_MAINDBNAME</dt>
2291
2390
  ** <dd> ^This option is used to change the name of the "main" database
2292
- ** schema. ^The sole argument is a pointer to a constant UTF8 string
2293
- ** which will become the new schema name in place of "main". ^SQLite
2294
- ** does not make a copy of the new main schema name string, so the application
2295
- ** must ensure that the argument passed into this DBCONFIG option is unchanged
2296
- ** until after the database connection closes.
2391
+ ** schema. This option does not follow the
2392
+ ** [DBCONFIG arguments|usual SQLITE_DBCONFIG argument format].
2393
+ ** This option takes exactly one additional argument so that the
2394
+ ** [sqlite3_db_config()] call has a total of three parameters. The
2395
+ ** extra argument must be a pointer to a constant UTF8 string which
2396
+ ** will become the new schema name in place of "main". ^SQLite does
2397
+ ** not make a copy of the new main schema name string, so the application
2398
+ ** must ensure that the argument passed into SQLITE_DBCONFIG MAINDBNAME
2399
+ ** is unchanged until after the database connection closes.
2297
2400
  ** </dd>
2298
2401
  **
2299
2402
  ** [[SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE]]
2300
2403
  ** <dt>SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE</dt>
2301
- ** <dd> Usually, when a database in wal mode is closed or detached from a
2302
- ** database handle, SQLite checks if this will mean that there are now no
2303
- ** connections at all to the database. If so, it performs a checkpoint
2304
- ** operation before closing the connection. This option may be used to
2305
- ** override this behavior. The first parameter passed to this operation
2306
- ** is an integer - positive to disable checkpoints-on-close, or zero (the
2307
- ** default) to enable them, and negative to leave the setting unchanged.
2308
- ** The second parameter is a pointer to an integer
2404
+ ** <dd> Usually, when a database in [WAL mode] is closed or detached from a
2405
+ ** database handle, SQLite checks if if there are other connections to the
2406
+ ** same database, and if there are no other database connection (if the
2407
+ ** connection being closed is the last open connection to the database),
2408
+ ** then SQLite performs a [checkpoint] before closing the connection and
2409
+ ** deletes the WAL file. The SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE option can
2410
+ ** be used to override that behavior. The first argument passed to this
2411
+ ** operation (the third parameter to [sqlite3_db_config()]) is an integer
2412
+ ** which is positive to disable checkpoints-on-close, or zero (the default)
2413
+ ** to enable them, and negative to leave the setting unchanged.
2414
+ ** The second argument (the fourth parameter) is a pointer to an integer
2309
2415
  ** into which is written 0 or 1 to indicate whether checkpoints-on-close
2310
2416
  ** have been disabled - 0 if they are not disabled, 1 if they are.
2311
2417
  ** </dd>
@@ -2391,7 +2497,7 @@ struct sqlite3_mem_methods {
2391
2497
  ** [[SQLITE_DBCONFIG_LEGACY_ALTER_TABLE]]
2392
2498
  ** <dt>SQLITE_DBCONFIG_LEGACY_ALTER_TABLE</dt>
2393
2499
  ** <dd>The SQLITE_DBCONFIG_LEGACY_ALTER_TABLE option activates or deactivates
2394
- ** the legacy behavior of the [ALTER TABLE RENAME] command such it
2500
+ ** the legacy behavior of the [ALTER TABLE RENAME] command such that it
2395
2501
  ** behaves as it did prior to [version 3.24.0] (2018-06-04). See the
2396
2502
  ** "Compatibility Notice" on the [ALTER TABLE RENAME documentation] for
2397
2503
  ** additional information. This feature can also be turned on and off
@@ -2440,7 +2546,7 @@ struct sqlite3_mem_methods {
2440
2546
  ** <dt>SQLITE_DBCONFIG_LEGACY_FILE_FORMAT</dt>
2441
2547
  ** <dd>The SQLITE_DBCONFIG_LEGACY_FILE_FORMAT option activates or deactivates
2442
2548
  ** the legacy file format flag. When activated, this flag causes all newly
2443
- ** created database file to have a schema format version number (the 4-byte
2549
+ ** created database files to have a schema format version number (the 4-byte
2444
2550
  ** integer found at offset 44 into the database header) of 1. This in turn
2445
2551
  ** means that the resulting database file will be readable and writable by
2446
2552
  ** any SQLite version back to 3.0.0 ([dateof:3.0.0]). Without this setting,
@@ -2466,8 +2572,8 @@ struct sqlite3_mem_methods {
2466
2572
  ** statistics. For statistics to be collected, the flag must be set on
2467
2573
  ** the database handle both when the SQL statement is prepared and when it
2468
2574
  ** is stepped. The flag is set (collection of statistics is enabled)
2469
- ** by default. This option takes two arguments: an integer and a pointer to
2470
- ** an integer.. The first argument is 1, 0, or -1 to enable, disable, or
2575
+ ** by default. <p>This option takes two arguments: an integer and a pointer to
2576
+ ** an integer. The first argument is 1, 0, or -1 to enable, disable, or
2471
2577
  ** leave unchanged the statement scanstatus option. If the second argument
2472
2578
  ** is not NULL, then the value of the statement scanstatus setting after
2473
2579
  ** processing the first argument is written into the integer that the second
@@ -2480,7 +2586,7 @@ struct sqlite3_mem_methods {
2480
2586
  ** in which tables and indexes are scanned so that the scans start at the end
2481
2587
  ** and work toward the beginning rather than starting at the beginning and
2482
2588
  ** working toward the end. Setting SQLITE_DBCONFIG_REVERSE_SCANORDER is the
2483
- ** same as setting [PRAGMA reverse_unordered_selects]. This option takes
2589
+ ** same as setting [PRAGMA reverse_unordered_selects]. <p>This option takes
2484
2590
  ** two arguments which are an integer and a pointer to an integer. The first
2485
2591
  ** argument is 1, 0, or -1 to enable, disable, or leave unchanged the
2486
2592
  ** reverse scan order flag, respectively. If the second argument is not NULL,
@@ -2489,7 +2595,76 @@ struct sqlite3_mem_methods {
2489
2595
  ** first argument.
2490
2596
  ** </dd>
2491
2597
  **
2598
+ ** [[SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE]]
2599
+ ** <dt>SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE</dt>
2600
+ ** <dd>The SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE option enables or disables
2601
+ ** the ability of the [ATTACH DATABASE] SQL command to create a new database
2602
+ ** file if the database filed named in the ATTACH command does not already
2603
+ ** exist. This ability of ATTACH to create a new database is enabled by
2604
+ ** default. Applications can disable or reenable the ability for ATTACH to
2605
+ ** create new database files using this DBCONFIG option.<p>
2606
+ ** This option takes two arguments which are an integer and a pointer
2607
+ ** to an integer. The first argument is 1, 0, or -1 to enable, disable, or
2608
+ ** leave unchanged the attach-create flag, respectively. If the second
2609
+ ** argument is not NULL, then 0 or 1 is written into the integer that the
2610
+ ** second argument points to depending on if the attach-create flag is set
2611
+ ** after processing the first argument.
2612
+ ** </dd>
2613
+ **
2614
+ ** [[SQLITE_DBCONFIG_ENABLE_ATTACH_WRITE]]
2615
+ ** <dt>SQLITE_DBCONFIG_ENABLE_ATTACH_WRITE</dt>
2616
+ ** <dd>The SQLITE_DBCONFIG_ENABLE_ATTACH_WRITE option enables or disables the
2617
+ ** ability of the [ATTACH DATABASE] SQL command to open a database for writing.
2618
+ ** This capability is enabled by default. Applications can disable or
2619
+ ** reenable this capability using the current DBCONFIG option. If
2620
+ ** this capability is disabled, the [ATTACH] command will still work,
2621
+ ** but the database will be opened read-only. If this option is disabled,
2622
+ ** then the ability to create a new database using [ATTACH] is also disabled,
2623
+ ** regardless of the value of the [SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE]
2624
+ ** option.<p>
2625
+ ** This option takes two arguments which are an integer and a pointer
2626
+ ** to an integer. The first argument is 1, 0, or -1 to enable, disable, or
2627
+ ** leave unchanged the ability to ATTACH another database for writing,
2628
+ ** respectively. If the second argument is not NULL, then 0 or 1 is written
2629
+ ** into the integer to which the second argument points, depending on whether
2630
+ ** the ability to ATTACH a read/write database is enabled or disabled
2631
+ ** after processing the first argument.
2632
+ ** </dd>
2633
+ **
2634
+ ** [[SQLITE_DBCONFIG_ENABLE_COMMENTS]]
2635
+ ** <dt>SQLITE_DBCONFIG_ENABLE_COMMENTS</dt>
2636
+ ** <dd>The SQLITE_DBCONFIG_ENABLE_COMMENTS option enables or disables the
2637
+ ** ability to include comments in SQL text. Comments are enabled by default.
2638
+ ** An application can disable or reenable comments in SQL text using this
2639
+ ** DBCONFIG option.<p>
2640
+ ** This option takes two arguments which are an integer and a pointer
2641
+ ** to an integer. The first argument is 1, 0, or -1 to enable, disable, or
2642
+ ** leave unchanged the ability to use comments in SQL text,
2643
+ ** respectively. If the second argument is not NULL, then 0 or 1 is written
2644
+ ** into the integer that the second argument points to depending on if
2645
+ ** comments are allowed in SQL text after processing the first argument.
2646
+ ** </dd>
2647
+ **
2492
2648
  ** </dl>
2649
+ **
2650
+ ** [[DBCONFIG arguments]] <h3>Arguments To SQLITE_DBCONFIG Options</h3>
2651
+ **
2652
+ ** <p>Most of the SQLITE_DBCONFIG options take two arguments, so that the
2653
+ ** overall call to [sqlite3_db_config()] has a total of four parameters.
2654
+ ** The first argument (the third parameter to sqlite3_db_config()) is an integer.
2655
+ ** The second argument is a pointer to an integer. If the first argument is 1,
2656
+ ** then the option becomes enabled. If the first integer argument is 0, then the
2657
+ ** option is disabled. If the first argument is -1, then the option setting
2658
+ ** is unchanged. The second argument, the pointer to an integer, may be NULL.
2659
+ ** If the second argument is not NULL, then a value of 0 or 1 is written into
2660
+ ** the integer to which the second argument points, depending on whether the
2661
+ ** setting is disabled or enabled after applying any changes specified by
2662
+ ** the first argument.
2663
+ **
2664
+ ** <p>While most SQLITE_DBCONFIG options use the argument format
2665
+ ** described in the previous paragraph, the [SQLITE_DBCONFIG_MAINDBNAME]
2666
+ ** and [SQLITE_DBCONFIG_LOOKASIDE] options are different. See the
2667
+ ** documentation of those exceptional options for details.
2493
2668
  */
2494
2669
  #define SQLITE_DBCONFIG_MAINDBNAME 1000 /* const char* */
2495
2670
  #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
@@ -2511,7 +2686,10 @@ struct sqlite3_mem_methods {
2511
2686
  #define SQLITE_DBCONFIG_TRUSTED_SCHEMA 1017 /* int int* */
2512
2687
  #define SQLITE_DBCONFIG_STMT_SCANSTATUS 1018 /* int int* */
2513
2688
  #define SQLITE_DBCONFIG_REVERSE_SCANORDER 1019 /* int int* */
2514
- #define SQLITE_DBCONFIG_MAX 1019 /* Largest DBCONFIG */
2689
+ #define SQLITE_DBCONFIG_ENABLE_ATTACH_CREATE 1020 /* int int* */
2690
+ #define SQLITE_DBCONFIG_ENABLE_ATTACH_WRITE 1021 /* int int* */
2691
+ #define SQLITE_DBCONFIG_ENABLE_COMMENTS 1022 /* int int* */
2692
+ #define SQLITE_DBCONFIG_MAX 1022 /* Largest DBCONFIG */
2515
2693
 
2516
2694
  /*
2517
2695
  ** CAPI3REF: Enable Or Disable Extended Result Codes
@@ -2603,10 +2781,14 @@ SQLITE_API void sqlite3_set_last_insert_rowid(sqlite3*,sqlite3_int64);
2603
2781
  ** deleted by the most recently completed INSERT, UPDATE or DELETE
2604
2782
  ** statement on the database connection specified by the only parameter.
2605
2783
  ** The two functions are identical except for the type of the return value
2606
- ** and that if the number of rows modified by the most recent INSERT, UPDATE
2784
+ ** and that if the number of rows modified by the most recent INSERT, UPDATE,
2607
2785
  ** or DELETE is greater than the maximum value supported by type "int", then
2608
2786
  ** the return value of sqlite3_changes() is undefined. ^Executing any other
2609
2787
  ** type of SQL statement does not modify the value returned by these functions.
2788
+ ** For the purposes of this interface, a CREATE TABLE AS SELECT statement
2789
+ ** does not count as an INSERT, UPDATE or DELETE statement and hence the rows
2790
+ ** added to the new table by the CREATE TABLE AS SELECT statement are not
2791
+ ** counted.
2610
2792
  **
2611
2793
  ** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are
2612
2794
  ** considered - auxiliary changes caused by [CREATE TRIGGER | triggers],
@@ -2759,7 +2941,7 @@ SQLITE_API int sqlite3_is_interrupted(sqlite3*);
2759
2941
  ** ^These routines return 0 if the statement is incomplete. ^If a
2760
2942
  ** memory allocation fails, then SQLITE_NOMEM is returned.
2761
2943
  **
2762
- ** ^These routines do not parse the SQL statements thus
2944
+ ** ^These routines do not parse the SQL statements and thus
2763
2945
  ** will not detect syntactically incorrect SQL.
2764
2946
  **
2765
2947
  ** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior
@@ -2861,6 +3043,44 @@ SQLITE_API int sqlite3_busy_handler(sqlite3*,int(*)(void*,int),void*);
2861
3043
  */
2862
3044
  SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
2863
3045
 
3046
+ /*
3047
+ ** CAPI3REF: Set the Setlk Timeout
3048
+ ** METHOD: sqlite3
3049
+ **
3050
+ ** This routine is only useful in SQLITE_ENABLE_SETLK_TIMEOUT builds. If
3051
+ ** the VFS supports blocking locks, it sets the timeout in ms used by
3052
+ ** eligible locks taken on wal mode databases by the specified database
3053
+ ** handle. In non-SQLITE_ENABLE_SETLK_TIMEOUT builds, or if the VFS does
3054
+ ** not support blocking locks, this function is a no-op.
3055
+ **
3056
+ ** Passing 0 to this function disables blocking locks altogether. Passing
3057
+ ** -1 to this function requests that the VFS blocks for a long time -
3058
+ ** indefinitely if possible. The results of passing any other negative value
3059
+ ** are undefined.
3060
+ **
3061
+ ** Internally, each SQLite database handle stores two timeout values - the
3062
+ ** busy-timeout (used for rollback mode databases, or if the VFS does not
3063
+ ** support blocking locks) and the setlk-timeout (used for blocking locks
3064
+ ** on wal-mode databases). The sqlite3_busy_timeout() method sets both
3065
+ ** values, this function sets only the setlk-timeout value. Therefore,
3066
+ ** to configure separate busy-timeout and setlk-timeout values for a single
3067
+ ** database handle, call sqlite3_busy_timeout() followed by this function.
3068
+ **
3069
+ ** Whenever the number of connections to a wal mode database falls from
3070
+ ** 1 to 0, the last connection takes an exclusive lock on the database,
3071
+ ** then checkpoints and deletes the wal file. While it is doing this, any
3072
+ ** new connection that tries to read from the database fails with an
3073
+ ** SQLITE_BUSY error. Or, if the SQLITE_SETLK_BLOCK_ON_CONNECT flag is
3074
+ ** passed to this API, the new connection blocks until the exclusive lock
3075
+ ** has been released.
3076
+ */
3077
+ SQLITE_API int sqlite3_setlk_timeout(sqlite3*, int ms, int flags);
3078
+
3079
+ /*
3080
+ ** CAPI3REF: Flags for sqlite3_setlk_timeout()
3081
+ */
3082
+ #define SQLITE_SETLK_BLOCK_ON_CONNECT 0x01
3083
+
2864
3084
  /*
2865
3085
  ** CAPI3REF: Convenience Routines For Running Queries
2866
3086
  ** METHOD: sqlite3
@@ -2868,7 +3088,7 @@ SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
2868
3088
  ** This is a legacy interface that is preserved for backwards compatibility.
2869
3089
  ** Use of this interface is not recommended.
2870
3090
  **
2871
- ** Definition: A <b>result table</b> is memory data structure created by the
3091
+ ** Definition: A <b>result table</b> is a memory data structure created by the
2872
3092
  ** [sqlite3_get_table()] interface. A result table records the
2873
3093
  ** complete query results from one or more queries.
2874
3094
  **
@@ -3011,7 +3231,7 @@ SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list);
3011
3231
  ** ^Calling sqlite3_free() with a pointer previously returned
3012
3232
  ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
3013
3233
  ** that it might be reused. ^The sqlite3_free() routine is
3014
- ** a no-op if is called with a NULL pointer. Passing a NULL pointer
3234
+ ** a no-op if it is called with a NULL pointer. Passing a NULL pointer
3015
3235
  ** to sqlite3_free() is harmless. After being freed, memory
3016
3236
  ** should neither be read nor written. Even reading previously freed
3017
3237
  ** memory might result in a segmentation fault or other severe error.
@@ -3029,13 +3249,13 @@ SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list);
3029
3249
  ** sqlite3_free(X).
3030
3250
  ** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation
3031
3251
  ** of at least N bytes in size or NULL if insufficient memory is available.
3032
- ** ^If M is the size of the prior allocation, then min(N,M) bytes
3033
- ** of the prior allocation are copied into the beginning of buffer returned
3252
+ ** ^If M is the size of the prior allocation, then min(N,M) bytes of the
3253
+ ** prior allocation are copied into the beginning of the buffer returned
3034
3254
  ** by sqlite3_realloc(X,N) and the prior allocation is freed.
3035
3255
  ** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the
3036
3256
  ** prior allocation is not freed.
3037
3257
  **
3038
- ** ^The sqlite3_realloc64(X,N) interfaces works the same as
3258
+ ** ^The sqlite3_realloc64(X,N) interface works the same as
3039
3259
  ** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead
3040
3260
  ** of a 32-bit signed integer.
3041
3261
  **
@@ -3085,7 +3305,7 @@ SQLITE_API sqlite3_uint64 sqlite3_msize(void*);
3085
3305
  ** was last reset. ^The values returned by [sqlite3_memory_used()] and
3086
3306
  ** [sqlite3_memory_highwater()] include any overhead
3087
3307
  ** added by SQLite in its implementation of [sqlite3_malloc()],
3088
- ** but not overhead added by the any underlying system library
3308
+ ** but not overhead added by any underlying system library
3089
3309
  ** routines that [sqlite3_malloc()] may call.
3090
3310
  **
3091
3311
  ** ^The memory high-water mark is reset to the current value of
@@ -3286,8 +3506,8 @@ SQLITE_API int sqlite3_set_authorizer(
3286
3506
  #define SQLITE_RECURSIVE 33 /* NULL NULL */
3287
3507
 
3288
3508
  /*
3289
- ** CAPI3REF: Tracing And Profiling Functions
3290
- ** METHOD: sqlite3
3509
+ ** CAPI3REF: Deprecated Tracing And Profiling Functions
3510
+ ** DEPRECATED
3291
3511
  **
3292
3512
  ** These routines are deprecated. Use the [sqlite3_trace_v2()] interface
3293
3513
  ** instead of the routines described here.
@@ -3537,7 +3757,7 @@ SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
3537
3757
  ** there is no harm in trying.)
3538
3758
  **
3539
3759
  ** ^(<dt>[SQLITE_OPEN_SHAREDCACHE]</dt>
3540
- ** <dd>The database is opened [shared cache] enabled, overriding
3760
+ ** <dd>The database is opened with [shared cache] enabled, overriding
3541
3761
  ** the default shared cache setting provided by
3542
3762
  ** [sqlite3_enable_shared_cache()].)^
3543
3763
  ** The [use of shared cache mode is discouraged] and hence shared cache
@@ -3545,14 +3765,14 @@ SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
3545
3765
  ** this option is a no-op.
3546
3766
  **
3547
3767
  ** ^(<dt>[SQLITE_OPEN_PRIVATECACHE]</dt>
3548
- ** <dd>The database is opened [shared cache] disabled, overriding
3768
+ ** <dd>The database is opened with [shared cache] disabled, overriding
3549
3769
  ** the default shared cache setting provided by
3550
3770
  ** [sqlite3_enable_shared_cache()].)^
3551
3771
  **
3552
3772
  ** [[OPEN_EXRESCODE]] ^(<dt>[SQLITE_OPEN_EXRESCODE]</dt>
3553
3773
  ** <dd>The database connection comes up in "extended result code mode".
3554
- ** In other words, the database behaves has if
3555
- ** [sqlite3_extended_result_codes(db,1)] where called on the database
3774
+ ** In other words, the database behaves as if
3775
+ ** [sqlite3_extended_result_codes(db,1)] were called on the database
3556
3776
  ** connection as soon as the connection is created. In addition to setting
3557
3777
  ** the extended result code mode, this flag also causes [sqlite3_open_v2()]
3558
3778
  ** to return an extended result code.</dd>
@@ -3880,7 +4100,7 @@ SQLITE_API sqlite3_file *sqlite3_database_file_object(const char*);
3880
4100
  **
3881
4101
  ** The sqlite3_create_filename(D,J,W,N,P) allocates memory to hold a version of
3882
4102
  ** database filename D with corresponding journal file J and WAL file W and
3883
- ** with N URI parameters key/values pairs in the array P. The result from
4103
+ ** an array P of N URI Key/Value pairs. The result from
3884
4104
  ** sqlite3_create_filename(D,J,W,N,P) is a pointer to a database filename that
3885
4105
  ** is safe to pass to routines like:
3886
4106
  ** <ul>
@@ -3963,7 +4183,7 @@ SQLITE_API void sqlite3_free_filename(sqlite3_filename);
3963
4183
  ** subsequent calls to other SQLite interface functions.)^
3964
4184
  **
3965
4185
  ** ^The sqlite3_errstr(E) interface returns the English-language text
3966
- ** that describes the [result code] E, as UTF-8, or NULL if E is not an
4186
+ ** that describes the [result code] E, as UTF-8, or NULL if E is not a
3967
4187
  ** result code for which a text error message is available.
3968
4188
  ** ^(Memory to hold the error message string is managed internally
3969
4189
  ** and must not be freed by the application)^.
@@ -3971,7 +4191,7 @@ SQLITE_API void sqlite3_free_filename(sqlite3_filename);
3971
4191
  ** ^If the most recent error references a specific token in the input
3972
4192
  ** SQL, the sqlite3_error_offset() interface returns the byte offset
3973
4193
  ** of the start of that token. ^The byte offset returned by
3974
- ** sqlite3_error_offset() assumes that the input SQL is UTF8.
4194
+ ** sqlite3_error_offset() assumes that the input SQL is UTF-8.
3975
4195
  ** ^If the most recent error does not reference a specific token in the input
3976
4196
  ** SQL, then the sqlite3_error_offset() function returns -1.
3977
4197
  **
@@ -3996,6 +4216,34 @@ SQLITE_API const void *sqlite3_errmsg16(sqlite3*);
3996
4216
  SQLITE_API const char *sqlite3_errstr(int);
3997
4217
  SQLITE_API int sqlite3_error_offset(sqlite3 *db);
3998
4218
 
4219
+ /*
4220
+ ** CAPI3REF: Set Error Codes And Message
4221
+ ** METHOD: sqlite3
4222
+ **
4223
+ ** Set the error code of the database handle passed as the first argument
4224
+ ** to errcode, and the error message to a copy of nul-terminated string
4225
+ ** zErrMsg. If zErrMsg is passed NULL, then the error message is set to
4226
+ ** the default message associated with the supplied error code. Subsequent
4227
+ ** calls to [sqlite3_errcode()] and [sqlite3_errmsg()] and similar will
4228
+ ** return the values set by this routine in place of what was previously
4229
+ ** set by SQLite itself.
4230
+ **
4231
+ ** This function returns SQLITE_OK if the error code and error message are
4232
+ ** successfully set, SQLITE_NOMEM if an OOM occurs, and SQLITE_MISUSE if
4233
+ ** the database handle is NULL or invalid.
4234
+ **
4235
+ ** The error code and message set by this routine remains in effect until
4236
+ ** they are changed, either by another call to this routine or until they are
4237
+ ** changed to by SQLite itself to reflect the result of some subsquent
4238
+ ** API call.
4239
+ **
4240
+ ** This function is intended for use by SQLite extensions or wrappers. The
4241
+ ** idea is that an extension or wrapper can use this routine to set error
4242
+ ** messages and error codes and thus behave more like a core SQLite
4243
+ ** feature from the point of view of an application.
4244
+ */
4245
+ SQLITE_API int sqlite3_set_errmsg(sqlite3 *db, int errcode, const char *zErrMsg);
4246
+
3999
4247
  /*
4000
4248
  ** CAPI3REF: Prepared Statement Object
4001
4249
  ** KEYWORDS: {prepared statement} {prepared statements}
@@ -4070,8 +4318,8 @@ SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
4070
4318
  **
4071
4319
  ** These constants define various performance limits
4072
4320
  ** that can be lowered at run-time using [sqlite3_limit()].
4073
- ** The synopsis of the meanings of the various limits is shown below.
4074
- ** Additional information is available at [limits | Limits in SQLite].
4321
+ ** A concise description of these limits follows, and additional information
4322
+ ** is available at [limits | Limits in SQLite].
4075
4323
  **
4076
4324
  ** <dl>
4077
4325
  ** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt>
@@ -4136,7 +4384,7 @@ SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
4136
4384
  /*
4137
4385
  ** CAPI3REF: Prepare Flags
4138
4386
  **
4139
- ** These constants define various flags that can be passed into
4387
+ ** These constants define various flags that can be passed into the
4140
4388
  ** "prepFlags" parameter of the [sqlite3_prepare_v3()] and
4141
4389
  ** [sqlite3_prepare16_v3()] interfaces.
4142
4390
  **
@@ -4166,11 +4414,22 @@ SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
4166
4414
  ** <dd>The SQLITE_PREPARE_NO_VTAB flag causes the SQL compiler
4167
4415
  ** to return an error (error code SQLITE_ERROR) if the statement uses
4168
4416
  ** any virtual tables.
4417
+ **
4418
+ ** [[SQLITE_PREPARE_DONT_LOG]] <dt>SQLITE_PREPARE_DONT_LOG</dt>
4419
+ ** <dd>The SQLITE_PREPARE_DONT_LOG flag prevents SQL compiler
4420
+ ** errors from being sent to the error log defined by
4421
+ ** [SQLITE_CONFIG_LOG]. This can be used, for example, to do test
4422
+ ** compiles to see if some SQL syntax is well-formed, without generating
4423
+ ** messages on the global error log when it is not. If the test compile
4424
+ ** fails, the sqlite3_prepare_v3() call returns the same error indications
4425
+ ** with or without this flag; it just omits the call to [sqlite3_log()] that
4426
+ ** logs the error.
4169
4427
  ** </dl>
4170
4428
  */
4171
4429
  #define SQLITE_PREPARE_PERSISTENT 0x01
4172
4430
  #define SQLITE_PREPARE_NORMALIZE 0x02
4173
4431
  #define SQLITE_PREPARE_NO_VTAB 0x04
4432
+ #define SQLITE_PREPARE_DONT_LOG 0x10
4174
4433
 
4175
4434
  /*
4176
4435
  ** CAPI3REF: Compiling An SQL Statement
@@ -4203,13 +4462,17 @@ SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
4203
4462
  ** and sqlite3_prepare16_v3() use UTF-16.
4204
4463
  **
4205
4464
  ** ^If the nByte argument is negative, then zSql is read up to the
4206
- ** first zero terminator. ^If nByte is positive, then it is the
4207
- ** number of bytes read from zSql. ^If nByte is zero, then no prepared
4465
+ ** first zero terminator. ^If nByte is positive, then it is the maximum
4466
+ ** number of bytes read from zSql. When nByte is positive, zSql is read
4467
+ ** up to the first zero terminator or until the nByte bytes have been read,
4468
+ ** whichever comes first. ^If nByte is zero, then no prepared
4208
4469
  ** statement is generated.
4209
4470
  ** If the caller knows that the supplied string is nul-terminated, then
4210
4471
  ** there is a small performance advantage to passing an nByte parameter that
4211
4472
  ** is the number of bytes in the input string <i>including</i>
4212
4473
  ** the nul-terminator.
4474
+ ** Note that nByte measures the length of the input in bytes, not
4475
+ ** characters, even for the UTF-16 interfaces.
4213
4476
  **
4214
4477
  ** ^If pzTail is not NULL then *pzTail is made to point to the first byte
4215
4478
  ** past the end of the first SQL statement in zSql. These routines only
@@ -4342,7 +4605,7 @@ SQLITE_API int sqlite3_prepare16_v3(
4342
4605
  **
4343
4606
  ** ^The sqlite3_expanded_sql() interface returns NULL if insufficient memory
4344
4607
  ** is available to hold the result, or if the result would exceed the
4345
- ** the maximum string length determined by the [SQLITE_LIMIT_LENGTH].
4608
+ ** maximum string length determined by the [SQLITE_LIMIT_LENGTH].
4346
4609
  **
4347
4610
  ** ^The [SQLITE_TRACE_SIZE_LIMIT] compile-time option limits the size of
4348
4611
  ** bound parameter expansions. ^The [SQLITE_OMIT_TRACE] compile-time
@@ -4530,7 +4793,7 @@ typedef struct sqlite3_value sqlite3_value;
4530
4793
  **
4531
4794
  ** The context in which an SQL function executes is stored in an
4532
4795
  ** sqlite3_context object. ^A pointer to an sqlite3_context object
4533
- ** is always first parameter to [application-defined SQL functions].
4796
+ ** is always the first parameter to [application-defined SQL functions].
4534
4797
  ** The application-defined SQL function implementation will pass this
4535
4798
  ** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
4536
4799
  ** [sqlite3_aggregate_context()], [sqlite3_user_data()],
@@ -4546,7 +4809,7 @@ typedef struct sqlite3_context sqlite3_context;
4546
4809
  ** METHOD: sqlite3_stmt
4547
4810
  **
4548
4811
  ** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,
4549
- ** literals may be replaced by a [parameter] that matches one of following
4812
+ ** literals may be replaced by a [parameter] that matches one of the following
4550
4813
  ** templates:
4551
4814
  **
4552
4815
  ** <ul>
@@ -4591,7 +4854,7 @@ typedef struct sqlite3_context sqlite3_context;
4591
4854
  **
4592
4855
  ** [[byte-order determination rules]] ^The byte-order of
4593
4856
  ** UTF16 input text is determined by the byte-order mark (BOM, U+FEFF)
4594
- ** found in first character, which is removed, or in the absence of a BOM
4857
+ ** found in the first character, which is removed, or in the absence of a BOM
4595
4858
  ** the byte order is the native byte order of the host
4596
4859
  ** machine for sqlite3_bind_text16() or the byte order specified in
4597
4860
  ** the 6th parameter for sqlite3_bind_text64().)^
@@ -4611,7 +4874,7 @@ typedef struct sqlite3_context sqlite3_context;
4611
4874
  ** or sqlite3_bind_text16() or sqlite3_bind_text64() then
4612
4875
  ** that parameter must be the byte offset
4613
4876
  ** where the NUL terminator would occur assuming the string were NUL
4614
- ** terminated. If any NUL characters occurs at byte offsets less than
4877
+ ** terminated. If any NUL characters occur at byte offsets less than
4615
4878
  ** the value of the fourth parameter then the resulting string value will
4616
4879
  ** contain embedded NULs. The result of expressions involving strings
4617
4880
  ** with embedded NULs is undefined.
@@ -4654,9 +4917,11 @@ typedef struct sqlite3_context sqlite3_context;
4654
4917
  ** associated with the pointer P of type T. ^D is either a NULL pointer or
4655
4918
  ** a pointer to a destructor function for P. ^SQLite will invoke the
4656
4919
  ** destructor D with a single argument of P when it is finished using
4657
- ** P. The T parameter should be a static string, preferably a string
4658
- ** literal. The sqlite3_bind_pointer() routine is part of the
4659
- ** [pointer passing interface] added for SQLite 3.20.0.
4920
+ ** P, even if the call to sqlite3_bind_pointer() fails. Due to a
4921
+ ** historical design quirk, results are undefined if D is
4922
+ ** SQLITE_TRANSIENT. The T parameter should be a static string,
4923
+ ** preferably a string literal. The sqlite3_bind_pointer() routine is
4924
+ ** part of the [pointer passing interface] added for SQLite 3.20.0.
4660
4925
  **
4661
4926
  ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
4662
4927
  ** for the [prepared statement] or with a prepared statement for which
@@ -4823,7 +5088,7 @@ SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N);
4823
5088
  ** METHOD: sqlite3_stmt
4824
5089
  **
4825
5090
  ** ^These routines provide a means to determine the database, table, and
4826
- ** table column that is the origin of a particular result column in
5091
+ ** table column that is the origin of a particular result column in a
4827
5092
  ** [SELECT] statement.
4828
5093
  ** ^The name of the database or table or column can be returned as
4829
5094
  ** either a UTF-8 or UTF-16 string. ^The _database_ routines return
@@ -4961,7 +5226,7 @@ SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
4961
5226
  ** other than [SQLITE_ROW] before any subsequent invocation of
4962
5227
  ** sqlite3_step(). Failure to reset the prepared statement using
4963
5228
  ** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from
4964
- ** sqlite3_step(). But after [version 3.6.23.1] ([dateof:3.6.23.1],
5229
+ ** sqlite3_step(). But after [version 3.6.23.1] ([dateof:3.6.23.1]),
4965
5230
  ** sqlite3_step() began
4966
5231
  ** calling [sqlite3_reset()] automatically in this circumstance rather
4967
5232
  ** than returning [SQLITE_MISUSE]. This is not considered a compatibility
@@ -5267,7 +5532,7 @@ SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol);
5267
5532
  **
5268
5533
  ** ^The sqlite3_finalize() function is called to delete a [prepared statement].
5269
5534
  ** ^If the most recent evaluation of the statement encountered no errors
5270
- ** or if the statement is never been evaluated, then sqlite3_finalize() returns
5535
+ ** or if the statement has never been evaluated, then sqlite3_finalize() returns
5271
5536
  ** SQLITE_OK. ^If the most recent evaluation of statement S failed, then
5272
5537
  ** sqlite3_finalize(S) returns the appropriate [error code] or
5273
5538
  ** [extended error code].
@@ -5392,8 +5657,8 @@ SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
5392
5657
  **
5393
5658
  ** For best security, the [SQLITE_DIRECTONLY] flag is recommended for
5394
5659
  ** all application-defined SQL functions that do not need to be
5395
- ** used inside of triggers, view, CHECK constraints, or other elements of
5396
- ** the database schema. This flags is especially recommended for SQL
5660
+ ** used inside of triggers, views, CHECK constraints, or other elements of
5661
+ ** the database schema. This flag is especially recommended for SQL
5397
5662
  ** functions that have side effects or reveal internal application state.
5398
5663
  ** Without this flag, an attacker might be able to modify the schema of
5399
5664
  ** a database file to include invocations of the function with parameters
@@ -5424,7 +5689,7 @@ SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
5424
5689
  ** [user-defined window functions|available here].
5425
5690
  **
5426
5691
  ** ^(If the final parameter to sqlite3_create_function_v2() or
5427
- ** sqlite3_create_window_function() is not NULL, then it is destructor for
5692
+ ** sqlite3_create_window_function() is not NULL, then it is the destructor for
5428
5693
  ** the application data pointer. The destructor is invoked when the function
5429
5694
  ** is deleted, either by being overloaded or when the database connection
5430
5695
  ** closes.)^ ^The destructor is also invoked if the call to
@@ -5499,7 +5764,7 @@ SQLITE_API int sqlite3_create_window_function(
5499
5764
  /*
5500
5765
  ** CAPI3REF: Text Encodings
5501
5766
  **
5502
- ** These constant define integer codes that represent the various
5767
+ ** These constants define integer codes that represent the various
5503
5768
  ** text encodings supported by SQLite.
5504
5769
  */
5505
5770
  #define SQLITE_UTF8 1 /* IMP: R-37514-35566 */
@@ -5580,7 +5845,7 @@ SQLITE_API int sqlite3_create_window_function(
5580
5845
  ** This flag instructs SQLite to omit some corner-case optimizations that
5581
5846
  ** might disrupt the operation of the [sqlite3_value_subtype()] function,
5582
5847
  ** causing it to return zero rather than the correct subtype().
5583
- ** SQL functions that invokes [sqlite3_value_subtype()] should have this
5848
+ ** All SQL functions that invoke [sqlite3_value_subtype()] should have this
5584
5849
  ** property. If the SQLITE_SUBTYPE property is omitted, then the return
5585
5850
  ** value from [sqlite3_value_subtype()] might sometimes be zero even though
5586
5851
  ** a non-zero subtype was specified by the function argument expression.
@@ -5591,11 +5856,20 @@ SQLITE_API int sqlite3_create_window_function(
5591
5856
  ** result.
5592
5857
  ** Every function that invokes [sqlite3_result_subtype()] should have this
5593
5858
  ** property. If it does not, then the call to [sqlite3_result_subtype()]
5594
- ** might become a no-op if the function is used as term in an
5859
+ ** might become a no-op if the function is used as a term in an
5595
5860
  ** [expression index]. On the other hand, SQL functions that never invoke
5596
5861
  ** [sqlite3_result_subtype()] should avoid setting this property, as the
5597
5862
  ** purpose of this property is to disable certain optimizations that are
5598
5863
  ** incompatible with subtypes.
5864
+ **
5865
+ ** [[SQLITE_SELFORDER1]] <dt>SQLITE_SELFORDER1</dt><dd>
5866
+ ** The SQLITE_SELFORDER1 flag indicates that the function is an aggregate
5867
+ ** that internally orders the values provided to the first argument. The
5868
+ ** ordered-set aggregate SQL notation with a single ORDER BY term can be
5869
+ ** used to invoke this function. If the ordered-set aggregate notation is
5870
+ ** used on a function that lacks this flag, then an error is raised. Note
5871
+ ** that the ordered-set aggregate syntax is only available if SQLite is
5872
+ ** built using the -DSQLITE_ENABLE_ORDERED_SET_AGGREGATES compile-time option.
5599
5873
  ** </dd>
5600
5874
  ** </dl>
5601
5875
  */
@@ -5604,6 +5878,7 @@ SQLITE_API int sqlite3_create_window_function(
5604
5878
  #define SQLITE_SUBTYPE 0x000100000
5605
5879
  #define SQLITE_INNOCUOUS 0x000200000
5606
5880
  #define SQLITE_RESULT_SUBTYPE 0x001000000
5881
+ #define SQLITE_SELFORDER1 0x002000000
5607
5882
 
5608
5883
  /*
5609
5884
  ** CAPI3REF: Deprecated Functions
@@ -5708,7 +5983,7 @@ SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int6
5708
5983
  ** sqlite3_value_nochange(X) interface returns true if and only if
5709
5984
  ** the column corresponding to X is unchanged by the UPDATE operation
5710
5985
  ** that the xUpdate method call was invoked to implement and if
5711
- ** and the prior [xColumn] method call that was invoked to extracted
5986
+ ** the prior [xColumn] method call that was invoked to extract
5712
5987
  ** the value for that column returned without setting a result (probably
5713
5988
  ** because it queried [sqlite3_vtab_nochange()] and found that the column
5714
5989
  ** was unchanging). ^Within an [xUpdate] method, any value for which
@@ -5801,7 +6076,7 @@ SQLITE_API int sqlite3_value_encoding(sqlite3_value*);
5801
6076
  ** one SQL function to another. Use the [sqlite3_result_subtype()]
5802
6077
  ** routine to set the subtype for the return value of an SQL function.
5803
6078
  **
5804
- ** Every [application-defined SQL function] that invoke this interface
6079
+ ** Every [application-defined SQL function] that invokes this interface
5805
6080
  ** should include the [SQLITE_SUBTYPE] property in the text
5806
6081
  ** encoding argument when the function is [sqlite3_create_function|registered].
5807
6082
  ** If the [SQLITE_SUBTYPE] property is omitted, then sqlite3_value_subtype()
@@ -5814,7 +6089,7 @@ SQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value*);
5814
6089
  ** METHOD: sqlite3_value
5815
6090
  **
5816
6091
  ** ^The sqlite3_value_dup(V) interface makes a copy of the [sqlite3_value]
5817
- ** object D and returns a pointer to that copy. ^The [sqlite3_value] returned
6092
+ ** object V and returns a pointer to that copy. ^The [sqlite3_value] returned
5818
6093
  ** is a [protected sqlite3_value] object even if the input is not.
5819
6094
  ** ^The sqlite3_value_dup(V) interface returns NULL if V is NULL or if a
5820
6095
  ** memory allocation fails. ^If V is a [pointer value], then the result
@@ -5852,7 +6127,7 @@ SQLITE_API void sqlite3_value_free(sqlite3_value*);
5852
6127
  ** allocation error occurs.
5853
6128
  **
5854
6129
  ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
5855
- ** determined by the N parameter on first successful call. Changing the
6130
+ ** determined by the N parameter on the first successful call. Changing the
5856
6131
  ** value of N in any subsequent call to sqlite3_aggregate_context() within
5857
6132
  ** the same aggregate function instance will not resize the memory
5858
6133
  ** allocation.)^ Within the xFinal callback, it is customary to set
@@ -5981,6 +6256,7 @@ SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(voi
5981
6256
  ** or a NULL pointer if there were no prior calls to
5982
6257
  ** sqlite3_set_clientdata() with the same values of D and N.
5983
6258
  ** Names are compared using strcmp() and are thus case sensitive.
6259
+ ** It returns 0 on success and SQLITE_NOMEM on allocation failure.
5984
6260
  **
5985
6261
  ** If P and X are both non-NULL, then the destructor X is invoked with
5986
6262
  ** argument P on the first of the following occurrences:
@@ -6014,7 +6290,7 @@ SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(voi
6014
6290
  **
6015
6291
  ** Security Warning: These interfaces should not be exposed in scripting
6016
6292
  ** languages or in other circumstances where it might be possible for an
6017
- ** an attacker to invoke them. Any agent that can invoke these interfaces
6293
+ ** attacker to invoke them. Any agent that can invoke these interfaces
6018
6294
  ** can probably also take control of the process.
6019
6295
  **
6020
6296
  ** Database connection client data is only available for SQLite
@@ -6128,7 +6404,7 @@ typedef void (*sqlite3_destructor_type)(void*);
6128
6404
  ** pointed to by the 2nd parameter are taken as the application-defined
6129
6405
  ** function result. If the 3rd parameter is non-negative, then it
6130
6406
  ** must be the byte offset into the string where the NUL terminator would
6131
- ** appear if the string where NUL terminated. If any NUL characters occur
6407
+ ** appear if the string were NUL terminated. If any NUL characters occur
6132
6408
  ** in the string at a byte offset that is less than the value of the 3rd
6133
6409
  ** parameter, then the resulting string will contain embedded NULs and the
6134
6410
  ** result of expressions operating on strings with embedded NULs is undefined.
@@ -6186,7 +6462,7 @@ typedef void (*sqlite3_destructor_type)(void*);
6186
6462
  ** string and preferably a string literal. The sqlite3_result_pointer()
6187
6463
  ** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
6188
6464
  **
6189
- ** If these routines are called from within the different thread
6465
+ ** If these routines are called from within a different thread
6190
6466
  ** than the one containing the application-defined function that received
6191
6467
  ** the [sqlite3_context] pointer, the results are undefined.
6192
6468
  */
@@ -6592,7 +6868,7 @@ SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
6592
6868
  ** METHOD: sqlite3
6593
6869
  **
6594
6870
  ** ^The sqlite3_db_name(D,N) interface returns a pointer to the schema name
6595
- ** for the N-th database on database connection D, or a NULL pointer of N is
6871
+ ** for the N-th database on database connection D, or a NULL pointer if N is
6596
6872
  ** out of range. An N value of 0 means the main database file. An N of 1 is
6597
6873
  ** the "temp" schema. Larger values of N correspond to various ATTACH-ed
6598
6874
  ** databases.
@@ -6687,7 +6963,7 @@ SQLITE_API int sqlite3_txn_state(sqlite3*,const char *zSchema);
6687
6963
  ** <dd>The SQLITE_TXN_READ state means that the database is currently
6688
6964
  ** in a read transaction. Content has been read from the database file
6689
6965
  ** but nothing in the database file has changed. The transaction state
6690
- ** will advanced to SQLITE_TXN_WRITE if any changes occur and there are
6966
+ ** will be advanced to SQLITE_TXN_WRITE if any changes occur and there are
6691
6967
  ** no other conflicting concurrent write transactions. The transaction
6692
6968
  ** state will revert to SQLITE_TXN_NONE following a [ROLLBACK] or
6693
6969
  ** [COMMIT].</dd>
@@ -6696,7 +6972,7 @@ SQLITE_API int sqlite3_txn_state(sqlite3*,const char *zSchema);
6696
6972
  ** <dd>The SQLITE_TXN_WRITE state means that the database is currently
6697
6973
  ** in a write transaction. Content has been written to the database file
6698
6974
  ** but has not yet committed. The transaction state will change to
6699
- ** to SQLITE_TXN_NONE at the next [ROLLBACK] or [COMMIT].</dd>
6975
+ ** SQLITE_TXN_NONE at the next [ROLLBACK] or [COMMIT].</dd>
6700
6976
  */
6701
6977
  #define SQLITE_TXN_NONE 0
6702
6978
  #define SQLITE_TXN_READ 1
@@ -6847,6 +7123,8 @@ SQLITE_API int sqlite3_autovacuum_pages(
6847
7123
  **
6848
7124
  ** ^The second argument is a pointer to the function to invoke when a
6849
7125
  ** row is updated, inserted or deleted in a rowid table.
7126
+ ** ^The update hook is disabled by invoking sqlite3_update_hook()
7127
+ ** with a NULL pointer as the second parameter.
6850
7128
  ** ^The first argument to the callback is a copy of the third argument
6851
7129
  ** to sqlite3_update_hook().
6852
7130
  ** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
@@ -6868,6 +7146,12 @@ SQLITE_API int sqlite3_autovacuum_pages(
6868
7146
  ** The exceptions defined in this paragraph might change in a future
6869
7147
  ** release of SQLite.
6870
7148
  **
7149
+ ** Whether the update hook is invoked before or after the
7150
+ ** corresponding change is currently unspecified and may differ
7151
+ ** depending on the type of change. Do not rely on the order of the
7152
+ ** hook call with regards to the final result of the operation which
7153
+ ** triggers the hook.
7154
+ **
6871
7155
  ** The update hook implementation must not do anything that will modify
6872
7156
  ** the database connection that invoked the update hook. Any actions
6873
7157
  ** to modify the database connection must be deferred until after the
@@ -6969,7 +7253,7 @@ SQLITE_API int sqlite3_db_release_memory(sqlite3*);
6969
7253
  ** CAPI3REF: Impose A Limit On Heap Size
6970
7254
  **
6971
7255
  ** These interfaces impose limits on the amount of heap memory that will be
6972
- ** by all database connections within a single process.
7256
+ ** used by all database connections within a single process.
6973
7257
  **
6974
7258
  ** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
6975
7259
  ** soft limit on the amount of heap memory that may be allocated by SQLite.
@@ -7027,7 +7311,7 @@ SQLITE_API int sqlite3_db_release_memory(sqlite3*);
7027
7311
  ** </ul>)^
7028
7312
  **
7029
7313
  ** The circumstances under which SQLite will enforce the heap limits may
7030
- ** changes in future releases of SQLite.
7314
+ ** change in future releases of SQLite.
7031
7315
  */
7032
7316
  SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
7033
7317
  SQLITE_API sqlite3_int64 sqlite3_hard_heap_limit64(sqlite3_int64 N);
@@ -7142,8 +7426,8 @@ SQLITE_API int sqlite3_table_column_metadata(
7142
7426
  ** ^The entry point is zProc.
7143
7427
  ** ^(zProc may be 0, in which case SQLite will try to come up with an
7144
7428
  ** entry point name on its own. It first tries "sqlite3_extension_init".
7145
- ** If that does not work, it constructs a name "sqlite3_X_init" where the
7146
- ** X is consists of the lower-case equivalent of all ASCII alphabetic
7429
+ ** If that does not work, it constructs a name "sqlite3_X_init" where
7430
+ ** X consists of the lower-case equivalent of all ASCII alphabetic
7147
7431
  ** characters in the filename from the last "/" to the first following
7148
7432
  ** "." and omitting any initial "lib".)^
7149
7433
  ** ^The sqlite3_load_extension() interface returns
@@ -7214,7 +7498,7 @@ SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
7214
7498
  ** ^(Even though the function prototype shows that xEntryPoint() takes
7215
7499
  ** no arguments and returns void, SQLite invokes xEntryPoint() with three
7216
7500
  ** arguments and expects an integer result as if the signature of the
7217
- ** entry point where as follows:
7501
+ ** entry point were as follows:
7218
7502
  **
7219
7503
  ** <blockquote><pre>
7220
7504
  ** &nbsp; int xEntryPoint(
@@ -7378,7 +7662,7 @@ struct sqlite3_module {
7378
7662
  ** virtual table and might not be checked again by the byte code.)^ ^(The
7379
7663
  ** aConstraintUsage[].omit flag is an optimization hint. When the omit flag
7380
7664
  ** is left in its default setting of false, the constraint will always be
7381
- ** checked separately in byte code. If the omit flag is change to true, then
7665
+ ** checked separately in byte code. If the omit flag is changed to true, then
7382
7666
  ** the constraint may or may not be checked in byte code. In other words,
7383
7667
  ** when the omit flag is true there is no guarantee that the constraint will
7384
7668
  ** not be checked again using byte code.)^
@@ -7402,9 +7686,11 @@ struct sqlite3_module {
7402
7686
  ** will be returned by the strategy.
7403
7687
  **
7404
7688
  ** The xBestIndex method may optionally populate the idxFlags field with a
7405
- ** mask of SQLITE_INDEX_SCAN_* flags. Currently there is only one such flag -
7406
- ** SQLITE_INDEX_SCAN_UNIQUE. If the xBestIndex method sets this flag, SQLite
7407
- ** assumes that the strategy may visit at most one row.
7689
+ ** mask of SQLITE_INDEX_SCAN_* flags. One such flag is
7690
+ ** [SQLITE_INDEX_SCAN_HEX], which if set causes the [EXPLAIN QUERY PLAN]
7691
+ ** output to show the idxNum as hex instead of as decimal. Another flag is
7692
+ ** SQLITE_INDEX_SCAN_UNIQUE, which if set indicates that the query plan will
7693
+ ** return at most one row.
7408
7694
  **
7409
7695
  ** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then
7410
7696
  ** SQLite also assumes that if a call to the xUpdate() method is made as
@@ -7468,7 +7754,9 @@ struct sqlite3_index_info {
7468
7754
  ** [sqlite3_index_info].idxFlags field to some combination of
7469
7755
  ** these bits.
7470
7756
  */
7471
- #define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */
7757
+ #define SQLITE_INDEX_SCAN_UNIQUE 0x00000001 /* Scan visits at most 1 row */
7758
+ #define SQLITE_INDEX_SCAN_HEX 0x00000002 /* Display idxNum as hex */
7759
+ /* in EXPLAIN QUERY PLAN */
7472
7760
 
7473
7761
  /*
7474
7762
  ** CAPI3REF: Virtual Table Constraint Operator Codes
@@ -7541,7 +7829,7 @@ struct sqlite3_index_info {
7541
7829
  ** the implementation of the [virtual table module]. ^The fourth
7542
7830
  ** parameter is an arbitrary client data pointer that is passed through
7543
7831
  ** into the [xCreate] and [xConnect] methods of the virtual table module
7544
- ** when a new virtual table is be being created or reinitialized.
7832
+ ** when a new virtual table is being created or reinitialized.
7545
7833
  **
7546
7834
  ** ^The sqlite3_create_module_v2() interface has a fifth parameter which
7547
7835
  ** is a pointer to a destructor for the pClientData. ^SQLite will
@@ -7706,7 +7994,7 @@ typedef struct sqlite3_blob sqlite3_blob;
7706
7994
  ** in *ppBlob. Otherwise an [error code] is returned and, unless the error
7707
7995
  ** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided
7708
7996
  ** the API is not misused, it is always safe to call [sqlite3_blob_close()]
7709
- ** on *ppBlob after this function it returns.
7997
+ ** on *ppBlob after this function returns.
7710
7998
  **
7711
7999
  ** This function fails with SQLITE_ERROR if any of the following are true:
7712
8000
  ** <ul>
@@ -7826,7 +8114,7 @@ SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
7826
8114
  **
7827
8115
  ** ^Returns the size in bytes of the BLOB accessible via the
7828
8116
  ** successfully opened [BLOB handle] in its only argument. ^The
7829
- ** incremental blob I/O routines can only read or overwriting existing
8117
+ ** incremental blob I/O routines can only read or overwrite existing
7830
8118
  ** blob content; they cannot change the size of a blob.
7831
8119
  **
7832
8120
  ** This routine only works on a [BLOB handle] which has been created
@@ -7976,7 +8264,7 @@ SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
7976
8264
  ** ^The sqlite3_mutex_alloc() routine allocates a new
7977
8265
  ** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc()
7978
8266
  ** routine returns NULL if it is unable to allocate the requested
7979
- ** mutex. The argument to sqlite3_mutex_alloc() must one of these
8267
+ ** mutex. The argument to sqlite3_mutex_alloc() must be one of these
7980
8268
  ** integer constants:
7981
8269
  **
7982
8270
  ** <ul>
@@ -8209,7 +8497,7 @@ SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
8209
8497
  ** CAPI3REF: Retrieve the mutex for a database connection
8210
8498
  ** METHOD: sqlite3
8211
8499
  **
8212
- ** ^This interface returns a pointer the [sqlite3_mutex] object that
8500
+ ** ^This interface returns a pointer to the [sqlite3_mutex] object that
8213
8501
  ** serializes access to the [database connection] given in the argument
8214
8502
  ** when the [threading mode] is Serialized.
8215
8503
  ** ^If the [threading mode] is Single-thread or Multi-thread then this
@@ -8305,6 +8593,7 @@ SQLITE_API int sqlite3_test_control(int op, ...);
8305
8593
  #define SQLITE_TESTCTRL_JSON_SELFCHECK 14
8306
8594
  #define SQLITE_TESTCTRL_OPTIMIZATIONS 15
8307
8595
  #define SQLITE_TESTCTRL_ISKEYWORD 16 /* NOT USED */
8596
+ #define SQLITE_TESTCTRL_GETOPT 16
8308
8597
  #define SQLITE_TESTCTRL_SCRATCHMALLOC 17 /* NOT USED */
8309
8598
  #define SQLITE_TESTCTRL_INTERNAL_FUNCTIONS 17
8310
8599
  #define SQLITE_TESTCTRL_LOCALTIME_FAULT 18
@@ -8324,21 +8613,21 @@ SQLITE_API int sqlite3_test_control(int op, ...);
8324
8613
  #define SQLITE_TESTCTRL_TRACEFLAGS 31
8325
8614
  #define SQLITE_TESTCTRL_TUNE 32
8326
8615
  #define SQLITE_TESTCTRL_LOGEST 33
8327
- #define SQLITE_TESTCTRL_USELONGDOUBLE 34
8616
+ #define SQLITE_TESTCTRL_USELONGDOUBLE 34 /* NOT USED */
8328
8617
  #define SQLITE_TESTCTRL_LAST 34 /* Largest TESTCTRL */
8329
8618
 
8330
8619
  /*
8331
8620
  ** CAPI3REF: SQL Keyword Checking
8332
8621
  **
8333
8622
  ** These routines provide access to the set of SQL language keywords
8334
- ** recognized by SQLite. Applications can uses these routines to determine
8623
+ ** recognized by SQLite. Applications can use these routines to determine
8335
8624
  ** whether or not a specific identifier needs to be escaped (for example,
8336
8625
  ** by enclosing in double-quotes) so as not to confuse the parser.
8337
8626
  **
8338
8627
  ** The sqlite3_keyword_count() interface returns the number of distinct
8339
8628
  ** keywords understood by SQLite.
8340
8629
  **
8341
- ** The sqlite3_keyword_name(N,Z,L) interface finds the N-th keyword and
8630
+ ** The sqlite3_keyword_name(N,Z,L) interface finds the 0-based N-th keyword and
8342
8631
  ** makes *Z point to that keyword expressed as UTF8 and writes the number
8343
8632
  ** of bytes in the keyword into *L. The string that *Z points to is not
8344
8633
  ** zero-terminated. The sqlite3_keyword_name(N,Z,L) routine returns
@@ -8499,7 +8788,7 @@ SQLITE_API void sqlite3_str_reset(sqlite3_str*);
8499
8788
  ** content of the dynamic string under construction in X. The value
8500
8789
  ** returned by [sqlite3_str_value(X)] is managed by the sqlite3_str object X
8501
8790
  ** and might be freed or altered by any subsequent method on the same
8502
- ** [sqlite3_str] object. Applications must not used the pointer returned
8791
+ ** [sqlite3_str] object. Applications must not use the pointer returned by
8503
8792
  ** [sqlite3_str_value(X)] after any subsequent method call on the same
8504
8793
  ** object. ^Applications may change the content of the string returned
8505
8794
  ** by [sqlite3_str_value(X)] as long as they do not write into any bytes
@@ -8585,7 +8874,7 @@ SQLITE_API int sqlite3_status64(
8585
8874
  ** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
8586
8875
  ** buffer and where forced to overflow to [sqlite3_malloc()]. The
8587
8876
  ** returned value includes allocations that overflowed because they
8588
- ** where too large (they were larger than the "sz" parameter to
8877
+ ** were too large (they were larger than the "sz" parameter to
8589
8878
  ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
8590
8879
  ** no space was left in the page cache.</dd>)^
8591
8880
  **
@@ -8644,9 +8933,18 @@ SQLITE_API int sqlite3_status64(
8644
8933
  ** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
8645
8934
  ** non-zero [error code] on failure.
8646
8935
  **
8936
+ ** ^The sqlite3_db_status64(D,O,C,H,R) routine works exactly the same
8937
+ ** way as sqlite3_db_status(D,O,C,H,R) routine except that the C and H
8938
+ ** parameters are pointer to 64-bit integers (type: sqlite3_int64) instead
8939
+ ** of pointers to 32-bit integers, which allows larger status values
8940
+ ** to be returned. If a status value exceeds 2,147,483,647 then
8941
+ ** sqlite3_db_status() will truncate the value whereas sqlite3_db_status64()
8942
+ ** will return the full value.
8943
+ **
8647
8944
  ** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
8648
8945
  */
8649
8946
  SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
8947
+ SQLITE_API int sqlite3_db_status64(sqlite3*,int,sqlite3_int64*,sqlite3_int64*,int);
8650
8948
 
8651
8949
  /*
8652
8950
  ** CAPI3REF: Status Parameters for database connections
@@ -8669,28 +8967,29 @@ SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int r
8669
8967
  ** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>
8670
8968
  ** <dd>This parameter returns the number of malloc attempts that were
8671
8969
  ** satisfied using lookaside memory. Only the high-water value is meaningful;
8672
- ** the current value is always zero.)^
8970
+ ** the current value is always zero.</dd>)^
8673
8971
  **
8674
8972
  ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]]
8675
8973
  ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>
8676
- ** <dd>This parameter returns the number malloc attempts that might have
8974
+ ** <dd>This parameter returns the number of malloc attempts that might have
8677
8975
  ** been satisfied using lookaside memory but failed due to the amount of
8678
8976
  ** memory requested being larger than the lookaside slot size.
8679
8977
  ** Only the high-water value is meaningful;
8680
- ** the current value is always zero.)^
8978
+ ** the current value is always zero.</dd>)^
8681
8979
  **
8682
8980
  ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]]
8683
8981
  ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>
8684
- ** <dd>This parameter returns the number malloc attempts that might have
8982
+ ** <dd>This parameter returns the number of malloc attempts that might have
8685
8983
  ** been satisfied using lookaside memory but failed due to all lookaside
8686
8984
  ** memory already being in use.
8687
8985
  ** Only the high-water value is meaningful;
8688
- ** the current value is always zero.)^
8986
+ ** the current value is always zero.</dd>)^
8689
8987
  **
8690
8988
  ** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
8691
8989
  ** <dd>This parameter returns the approximate number of bytes of heap
8692
8990
  ** memory used by all pager caches associated with the database connection.)^
8693
8991
  ** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
8992
+ ** </dd>
8694
8993
  **
8695
8994
  ** [[SQLITE_DBSTATUS_CACHE_USED_SHARED]]
8696
8995
  ** ^(<dt>SQLITE_DBSTATUS_CACHE_USED_SHARED</dt>
@@ -8699,10 +8998,10 @@ SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int r
8699
8998
  ** memory used by that pager cache is divided evenly between the attached
8700
8999
  ** connections.)^ In other words, if none of the pager caches associated
8701
9000
  ** with the database connection are shared, this request returns the same
8702
- ** value as DBSTATUS_CACHE_USED. Or, if one or more or the pager caches are
9001
+ ** value as DBSTATUS_CACHE_USED. Or, if one or more of the pager caches are
8703
9002
  ** shared, the value returned by this call will be smaller than that returned
8704
9003
  ** by DBSTATUS_CACHE_USED. ^The highwater mark associated with
8705
- ** SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0.
9004
+ ** SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0.</dd>
8706
9005
  **
8707
9006
  ** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
8708
9007
  ** <dd>This parameter returns the approximate number of bytes of heap
@@ -8712,6 +9011,7 @@ SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int r
8712
9011
  ** schema memory is shared with other database connections due to
8713
9012
  ** [shared cache mode] being enabled.
8714
9013
  ** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
9014
+ ** </dd>
8715
9015
  **
8716
9016
  ** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>
8717
9017
  ** <dd>This parameter returns the approximate number of bytes of heap
@@ -8741,6 +9041,10 @@ SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int r
8741
9041
  ** If an IO or other error occurs while writing a page to disk, the effect
8742
9042
  ** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The
8743
9043
  ** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
9044
+ ** <p>
9045
+ ** ^(There is overlap between the quantities measured by this parameter
9046
+ ** (SQLITE_DBSTATUS_CACHE_WRITE) and SQLITE_DBSTATUS_TEMPBUF_SPILL.
9047
+ ** Resetting one will reduce the other.)^
8744
9048
  ** </dd>
8745
9049
  **
8746
9050
  ** [[SQLITE_DBSTATUS_CACHE_SPILL]] ^(<dt>SQLITE_DBSTATUS_CACHE_SPILL</dt>
@@ -8748,7 +9052,7 @@ SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int r
8748
9052
  ** been written to disk in the middle of a transaction due to the page
8749
9053
  ** cache overflowing. Transactions are more efficient if they are written
8750
9054
  ** to disk all at once. When pages spill mid-transaction, that introduces
8751
- ** additional overhead. This parameter can be used help identify
9055
+ ** additional overhead. This parameter can be used to help identify
8752
9056
  ** inefficiencies that can be resolved by increasing the cache size.
8753
9057
  ** </dd>
8754
9058
  **
@@ -8756,6 +9060,18 @@ SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int r
8756
9060
  ** <dd>This parameter returns zero for the current value if and only if
8757
9061
  ** all foreign key constraints (deferred or immediate) have been
8758
9062
  ** resolved.)^ ^The highwater mark is always 0.
9063
+ **
9064
+ ** [[SQLITE_DBSTATUS_TEMPBUF_SPILL] ^(<dt>SQLITE_DBSTATUS_TEMPBUF_SPILL</dt>
9065
+ ** <dd>^(This parameter returns the number of bytes written to temporary
9066
+ ** files on disk that could have been kept in memory had sufficient memory
9067
+ ** been available. This value includes writes to intermediate tables that
9068
+ ** are part of complex queries, external sorts that spill to disk, and
9069
+ ** writes to TEMP tables.)^
9070
+ ** ^The highwater mark is always 0.
9071
+ ** <p>
9072
+ ** ^(There is overlap between the quantities measured by this parameter
9073
+ ** (SQLITE_DBSTATUS_TEMPBUF_SPILL) and SQLITE_DBSTATUS_CACHE_WRITE.
9074
+ ** Resetting one will reduce the other.)^
8759
9075
  ** </dd>
8760
9076
  ** </dl>
8761
9077
  */
@@ -8772,7 +9088,8 @@ SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int r
8772
9088
  #define SQLITE_DBSTATUS_DEFERRED_FKS 10
8773
9089
  #define SQLITE_DBSTATUS_CACHE_USED_SHARED 11
8774
9090
  #define SQLITE_DBSTATUS_CACHE_SPILL 12
8775
- #define SQLITE_DBSTATUS_MAX 12 /* Largest defined DBSTATUS */
9091
+ #define SQLITE_DBSTATUS_TEMPBUF_SPILL 13
9092
+ #define SQLITE_DBSTATUS_MAX 13 /* Largest defined DBSTATUS */
8776
9093
 
8777
9094
 
8778
9095
  /*
@@ -8819,13 +9136,13 @@ SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
8819
9136
  ** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt>
8820
9137
  ** <dd>^This is the number of sort operations that have occurred.
8821
9138
  ** A non-zero value in this counter may indicate an opportunity to
8822
- ** improvement performance through careful use of indices.</dd>
9139
+ ** improve performance through careful use of indices.</dd>
8823
9140
  **
8824
9141
  ** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
8825
9142
  ** <dd>^This is the number of rows inserted into transient indices that
8826
9143
  ** were created automatically in order to help joins run faster.
8827
9144
  ** A non-zero value in this counter may indicate an opportunity to
8828
- ** improvement performance by adding permanent indices that do not
9145
+ ** improve performance by adding permanent indices that do not
8829
9146
  ** need to be reinitialized each time the statement is run.</dd>
8830
9147
  **
8831
9148
  ** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt>
@@ -8834,19 +9151,19 @@ SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
8834
9151
  ** to 2147483647. The number of virtual machine operations can be
8835
9152
  ** used as a proxy for the total work done by the prepared statement.
8836
9153
  ** If the number of virtual machine operations exceeds 2147483647
8837
- ** then the value returned by this statement status code is undefined.
9154
+ ** then the value returned by this statement status code is undefined.</dd>
8838
9155
  **
8839
9156
  ** [[SQLITE_STMTSTATUS_REPREPARE]] <dt>SQLITE_STMTSTATUS_REPREPARE</dt>
8840
9157
  ** <dd>^This is the number of times that the prepare statement has been
8841
9158
  ** automatically regenerated due to schema changes or changes to
8842
- ** [bound parameters] that might affect the query plan.
9159
+ ** [bound parameters] that might affect the query plan.</dd>
8843
9160
  **
8844
9161
  ** [[SQLITE_STMTSTATUS_RUN]] <dt>SQLITE_STMTSTATUS_RUN</dt>
8845
9162
  ** <dd>^This is the number of times that the prepared statement has
8846
9163
  ** been run. A single "run" for the purposes of this counter is one
8847
9164
  ** or more calls to [sqlite3_step()] followed by a call to [sqlite3_reset()].
8848
9165
  ** The counter is incremented on the first [sqlite3_step()] call of each
8849
- ** cycle.
9166
+ ** cycle.</dd>
8850
9167
  **
8851
9168
  ** [[SQLITE_STMTSTATUS_FILTER_MISS]]
8852
9169
  ** [[SQLITE_STMTSTATUS_FILTER HIT]]
@@ -8856,7 +9173,7 @@ SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
8856
9173
  ** step was bypassed because a Bloom filter returned not-found. The
8857
9174
  ** corresponding SQLITE_STMTSTATUS_FILTER_MISS value is the number of
8858
9175
  ** times that the Bloom filter returned a find, and thus the join step
8859
- ** had to be processed as normal.
9176
+ ** had to be processed as normal.</dd>
8860
9177
  **
8861
9178
  ** [[SQLITE_STMTSTATUS_MEMUSED]] <dt>SQLITE_STMTSTATUS_MEMUSED</dt>
8862
9179
  ** <dd>^This is the approximate number of bytes of heap memory
@@ -8961,9 +9278,9 @@ struct sqlite3_pcache_page {
8961
9278
  ** SQLite will typically create one cache instance for each open database file,
8962
9279
  ** though this is not guaranteed. ^The
8963
9280
  ** first parameter, szPage, is the size in bytes of the pages that must
8964
- ** be allocated by the cache. ^szPage will always a power of two. ^The
9281
+ ** be allocated by the cache. ^szPage will always be a power of two. ^The
8965
9282
  ** second parameter szExtra is a number of bytes of extra storage
8966
- ** associated with each page cache entry. ^The szExtra parameter will
9283
+ ** associated with each page cache entry. ^The szExtra parameter will be
8967
9284
  ** a number less than 250. SQLite will use the
8968
9285
  ** extra szExtra bytes on each page to store metadata about the underlying
8969
9286
  ** database page on disk. The value passed into szExtra depends
@@ -8971,17 +9288,17 @@ struct sqlite3_pcache_page {
8971
9288
  ** ^The third argument to xCreate(), bPurgeable, is true if the cache being
8972
9289
  ** created will be used to cache database pages of a file stored on disk, or
8973
9290
  ** false if it is used for an in-memory database. The cache implementation
8974
- ** does not have to do anything special based with the value of bPurgeable;
9291
+ ** does not have to do anything special based upon the value of bPurgeable;
8975
9292
  ** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will
8976
9293
  ** never invoke xUnpin() except to deliberately delete a page.
8977
9294
  ** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
8978
9295
  ** false will always have the "discard" flag set to true.
8979
- ** ^Hence, a cache created with bPurgeable false will
9296
+ ** ^Hence, a cache created with bPurgeable set to false will
8980
9297
  ** never contain any unpinned pages.
8981
9298
  **
8982
9299
  ** [[the xCachesize() page cache method]]
8983
9300
  ** ^(The xCachesize() method may be called at any time by SQLite to set the
8984
- ** suggested maximum cache-size (number of pages stored by) the cache
9301
+ ** suggested maximum cache-size (number of pages stored) for the cache
8985
9302
  ** instance passed as the first argument. This is the value configured using
8986
9303
  ** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable
8987
9304
  ** parameter, the implementation is not required to do anything with this
@@ -9008,12 +9325,12 @@ struct sqlite3_pcache_page {
9008
9325
  ** implementation must return a pointer to the page buffer with its content
9009
9326
  ** intact. If the requested page is not already in the cache, then the
9010
9327
  ** cache implementation should use the value of the createFlag
9011
- ** parameter to help it determined what action to take:
9328
+ ** parameter to help it determine what action to take:
9012
9329
  **
9013
9330
  ** <table border=1 width=85% align=center>
9014
9331
  ** <tr><th> createFlag <th> Behavior when page is not already in cache
9015
9332
  ** <tr><td> 0 <td> Do not allocate a new page. Return NULL.
9016
- ** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.
9333
+ ** <tr><td> 1 <td> Allocate a new page if it is easy and convenient to do so.
9017
9334
  ** Otherwise return NULL.
9018
9335
  ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return
9019
9336
  ** NULL if allocating a new page is effectively impossible.
@@ -9030,7 +9347,7 @@ struct sqlite3_pcache_page {
9030
9347
  ** as its second argument. If the third parameter, discard, is non-zero,
9031
9348
  ** then the page must be evicted from the cache.
9032
9349
  ** ^If the discard parameter is
9033
- ** zero, then the page may be discarded or retained at the discretion of
9350
+ ** zero, then the page may be discarded or retained at the discretion of the
9034
9351
  ** page cache implementation. ^The page cache implementation
9035
9352
  ** may choose to evict unpinned pages at any time.
9036
9353
  **
@@ -9048,7 +9365,7 @@ struct sqlite3_pcache_page {
9048
9365
  ** When SQLite calls the xTruncate() method, the cache must discard all
9049
9366
  ** existing cache entries with page numbers (keys) greater than or equal
9050
9367
  ** to the value of the iLimit parameter passed to xTruncate(). If any
9051
- ** of these pages are pinned, they are implicitly unpinned, meaning that
9368
+ ** of these pages are pinned, they become implicitly unpinned, meaning that
9052
9369
  ** they can be safely discarded.
9053
9370
  **
9054
9371
  ** [[the xDestroy() page cache method]]
@@ -9228,7 +9545,7 @@ typedef struct sqlite3_backup sqlite3_backup;
9228
9545
  ** external process or via a database connection other than the one being
9229
9546
  ** used by the backup operation, then the backup will be automatically
9230
9547
  ** restarted by the next call to sqlite3_backup_step(). ^If the source
9231
- ** database is modified by the using the same database connection as is used
9548
+ ** database is modified by using the same database connection as is used
9232
9549
  ** by the backup operation, then the backup database is automatically
9233
9550
  ** updated at the same time.
9234
9551
  **
@@ -9245,7 +9562,7 @@ typedef struct sqlite3_backup sqlite3_backup;
9245
9562
  ** and may not be used following a call to sqlite3_backup_finish().
9246
9563
  **
9247
9564
  ** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no
9248
- ** sqlite3_backup_step() errors occurred, regardless or whether or not
9565
+ ** sqlite3_backup_step() errors occurred, regardless of whether or not
9249
9566
  ** sqlite3_backup_step() completed.
9250
9567
  ** ^If an out-of-memory condition or IO error occurred during any prior
9251
9568
  ** sqlite3_backup_step() call on the same [sqlite3_backup] object, then
@@ -9300,6 +9617,16 @@ typedef struct sqlite3_backup sqlite3_backup;
9300
9617
  ** APIs are not strictly speaking threadsafe. If they are invoked at the
9301
9618
  ** same time as another thread is invoking sqlite3_backup_step() it is
9302
9619
  ** possible that they return invalid values.
9620
+ **
9621
+ ** <b>Alternatives To Using The Backup API</b>
9622
+ **
9623
+ ** Other techniques for safely creating a consistent backup of an SQLite
9624
+ ** database include:
9625
+ **
9626
+ ** <ul>
9627
+ ** <li> The [VACUUM INTO] command.
9628
+ ** <li> The [sqlite3_rsync] utility program.
9629
+ ** </ul>
9303
9630
  */
9304
9631
  SQLITE_API sqlite3_backup *sqlite3_backup_init(
9305
9632
  sqlite3 *pDest, /* Destination database handle */
@@ -9337,7 +9664,7 @@ SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p);
9337
9664
  ** application receives an SQLITE_LOCKED error, it may call the
9338
9665
  ** sqlite3_unlock_notify() method with the blocked connection handle as
9339
9666
  ** the first argument to register for a callback that will be invoked
9340
- ** when the blocking connections current transaction is concluded. ^The
9667
+ ** when the blocking connection's current transaction is concluded. ^The
9341
9668
  ** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
9342
9669
  ** call that concludes the blocking connection's transaction.
9343
9670
  **
@@ -9357,7 +9684,7 @@ SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p);
9357
9684
  ** blocked connection already has a registered unlock-notify callback,
9358
9685
  ** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is
9359
9686
  ** called with a NULL pointer as its second argument, then any existing
9360
- ** unlock-notify callback is canceled. ^The blocked connections
9687
+ ** unlock-notify callback is canceled. ^The blocked connection's
9361
9688
  ** unlock-notify callback may also be canceled by closing the blocked
9362
9689
  ** connection using [sqlite3_close()].
9363
9690
  **
@@ -9527,7 +9854,7 @@ SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...);
9527
9854
  ** is the number of pages currently in the write-ahead log file,
9528
9855
  ** including those that were just committed.
9529
9856
  **
9530
- ** The callback function should normally return [SQLITE_OK]. ^If an error
9857
+ ** ^The callback function should normally return [SQLITE_OK]. ^If an error
9531
9858
  ** code is returned, that error will propagate back up through the
9532
9859
  ** SQLite code base to cause the statement that provoked the callback
9533
9860
  ** to report an error, though the commit will have still occurred. If the
@@ -9535,13 +9862,26 @@ SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...);
9535
9862
  ** that does not correspond to any valid SQLite error code, the results
9536
9863
  ** are undefined.
9537
9864
  **
9538
- ** A single database handle may have at most a single write-ahead log callback
9539
- ** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any
9540
- ** previously registered write-ahead log callback. ^The return value is
9541
- ** a copy of the third parameter from the previous call, if any, or 0.
9542
- ** ^Note that the [sqlite3_wal_autocheckpoint()] interface and the
9543
- ** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will
9544
- ** overwrite any prior [sqlite3_wal_hook()] settings.
9865
+ ** ^A single database handle may have at most a single write-ahead log
9866
+ ** callback registered at one time. ^Calling [sqlite3_wal_hook()]
9867
+ ** replaces the default behavior or previously registered write-ahead
9868
+ ** log callback.
9869
+ **
9870
+ ** ^The return value is a copy of the third parameter from the
9871
+ ** previous call, if any, or 0.
9872
+ **
9873
+ ** ^The [sqlite3_wal_autocheckpoint()] interface and the
9874
+ ** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and
9875
+ ** will overwrite any prior [sqlite3_wal_hook()] settings.
9876
+ **
9877
+ ** ^If a write-ahead log callback is set using this function then
9878
+ ** [sqlite3_wal_checkpoint_v2()] or [PRAGMA wal_checkpoint]
9879
+ ** should be invoked periodically to keep the write-ahead log file
9880
+ ** from growing without bound.
9881
+ **
9882
+ ** ^Passing a NULL pointer for the callback disables automatic
9883
+ ** checkpointing entirely. To re-enable the default behavior, call
9884
+ ** sqlite3_wal_autocheckpoint(db,1000) or use [PRAGMA wal_checkpoint].
9545
9885
  */
9546
9886
  SQLITE_API void *sqlite3_wal_hook(
9547
9887
  sqlite3*,
@@ -9558,7 +9898,7 @@ SQLITE_API void *sqlite3_wal_hook(
9558
9898
  ** to automatically [checkpoint]
9559
9899
  ** after committing a transaction if there are N or
9560
9900
  ** more frames in the [write-ahead log] file. ^Passing zero or
9561
- ** a negative value as the nFrame parameter disables automatic
9901
+ ** a negative value as the N parameter disables automatic
9562
9902
  ** checkpoints entirely.
9563
9903
  **
9564
9904
  ** ^The callback registered by this function replaces any existing callback
@@ -9574,9 +9914,10 @@ SQLITE_API void *sqlite3_wal_hook(
9574
9914
  **
9575
9915
  ** ^Every new [database connection] defaults to having the auto-checkpoint
9576
9916
  ** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT]
9577
- ** pages. The use of this interface
9578
- ** is only necessary if the default setting is found to be suboptimal
9579
- ** for a particular application.
9917
+ ** pages.
9918
+ **
9919
+ ** ^The use of this interface is only necessary if the default setting
9920
+ ** is found to be suboptimal for a particular application.
9580
9921
  */
9581
9922
  SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);
9582
9923
 
@@ -9641,6 +9982,11 @@ SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);
9641
9982
  ** ^This mode works the same way as SQLITE_CHECKPOINT_RESTART with the
9642
9983
  ** addition that it also truncates the log file to zero bytes just prior
9643
9984
  ** to a successful return.
9985
+ **
9986
+ ** <dt>SQLITE_CHECKPOINT_NOOP<dd>
9987
+ ** ^This mode always checkpoints zero frames. The only reason to invoke
9988
+ ** a NOOP checkpoint is to access the values returned by
9989
+ ** sqlite3_wal_checkpoint_v2() via output parameters *pnLog and *pnCkpt.
9644
9990
  ** </dl>
9645
9991
  **
9646
9992
  ** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in
@@ -9711,6 +10057,7 @@ SQLITE_API int sqlite3_wal_checkpoint_v2(
9711
10057
  ** See the [sqlite3_wal_checkpoint_v2()] documentation for details on the
9712
10058
  ** meaning of each of these checkpoint modes.
9713
10059
  */
10060
+ #define SQLITE_CHECKPOINT_NOOP -1 /* Do no work at all */
9714
10061
  #define SQLITE_CHECKPOINT_PASSIVE 0 /* Do as much as possible w/o blocking */
9715
10062
  #define SQLITE_CHECKPOINT_FULL 1 /* Wait for writers, then checkpoint */
9716
10063
  #define SQLITE_CHECKPOINT_RESTART 2 /* Like FULL but wait for readers */
@@ -9755,7 +10102,7 @@ SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...);
9755
10102
  ** support constraints. In this configuration (which is the default) if
9756
10103
  ** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire
9757
10104
  ** statement is rolled back as if [ON CONFLICT | OR ABORT] had been
9758
- ** specified as part of the users SQL statement, regardless of the actual
10105
+ ** specified as part of the user's SQL statement, regardless of the actual
9759
10106
  ** ON CONFLICT mode specified.
9760
10107
  **
9761
10108
  ** If X is non-zero, then the virtual table implementation guarantees
@@ -9789,7 +10136,7 @@ SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...);
9789
10136
  ** [[SQLITE_VTAB_INNOCUOUS]]<dt>SQLITE_VTAB_INNOCUOUS</dt>
9790
10137
  ** <dd>Calls of the form
9791
10138
  ** [sqlite3_vtab_config](db,SQLITE_VTAB_INNOCUOUS) from within the
9792
- ** the [xConnect] or [xCreate] methods of a [virtual table] implementation
10139
+ ** [xConnect] or [xCreate] methods of a [virtual table] implementation
9793
10140
  ** identify that virtual table as being safe to use from within triggers
9794
10141
  ** and views. Conceptually, the SQLITE_VTAB_INNOCUOUS tag means that the
9795
10142
  ** virtual table can do no serious harm even if it is controlled by a
@@ -9917,26 +10264,47 @@ SQLITE_API const char *sqlite3_vtab_collation(sqlite3_index_info*,int);
9917
10264
  ** <li value="2"><p>
9918
10265
  ** ^(If the sqlite3_vtab_distinct() interface returns 2, that means
9919
10266
  ** that the query planner does not need the rows returned in any particular
9920
- ** order, as long as rows with the same values in all "aOrderBy" columns
9921
- ** are adjacent.)^ ^(Furthermore, only a single row for each particular
9922
- ** combination of values in the columns identified by the "aOrderBy" field
9923
- ** needs to be returned.)^ ^It is always ok for two or more rows with the same
9924
- ** values in all "aOrderBy" columns to be returned, as long as all such rows
9925
- ** are adjacent. ^The virtual table may, if it chooses, omit extra rows
9926
- ** that have the same value for all columns identified by "aOrderBy".
9927
- ** ^However omitting the extra rows is optional.
10267
+ ** order, as long as rows with the same values in all columns identified
10268
+ ** by "aOrderBy" are adjacent.)^ ^(Furthermore, when two or more rows
10269
+ ** contain the same values for all columns identified by "colUsed", all but
10270
+ ** one such row may optionally be omitted from the result.)^
10271
+ ** The virtual table is not required to omit rows that are duplicates
10272
+ ** over the "colUsed" columns, but if the virtual table can do that without
10273
+ ** too much extra effort, it could potentially help the query to run faster.
9928
10274
  ** This mode is used for a DISTINCT query.
9929
10275
  ** <li value="3"><p>
9930
- ** ^(If the sqlite3_vtab_distinct() interface returns 3, that means
9931
- ** that the query planner needs only distinct rows but it does need the
9932
- ** rows to be sorted.)^ ^The virtual table implementation is free to omit
9933
- ** rows that are identical in all aOrderBy columns, if it wants to, but
9934
- ** it is not required to omit any rows. This mode is used for queries
10276
+ ** ^(If the sqlite3_vtab_distinct() interface returns 3, that means the
10277
+ ** virtual table must return rows in the order defined by "aOrderBy" as
10278
+ ** if the sqlite3_vtab_distinct() interface had returned 0. However if
10279
+ ** two or more rows in the result have the same values for all columns
10280
+ ** identified by "colUsed", then all but one such row may optionally be
10281
+ ** omitted.)^ Like when the return value is 2, the virtual table
10282
+ ** is not required to omit rows that are duplicates over the "colUsed"
10283
+ ** columns, but if the virtual table can do that without
10284
+ ** too much extra effort, it could potentially help the query to run faster.
10285
+ ** This mode is used for queries
9935
10286
  ** that have both DISTINCT and ORDER BY clauses.
9936
10287
  ** </ol>
9937
10288
  **
10289
+ ** <p>The following table summarizes the conditions under which the
10290
+ ** virtual table is allowed to set the "orderByConsumed" flag based on
10291
+ ** the value returned by sqlite3_vtab_distinct(). This table is a
10292
+ ** restatement of the previous four paragraphs:
10293
+ **
10294
+ ** <table border=1 cellspacing=0 cellpadding=10 width="90%">
10295
+ ** <tr>
10296
+ ** <td valign="top">sqlite3_vtab_distinct() return value
10297
+ ** <td valign="top">Rows are returned in aOrderBy order
10298
+ ** <td valign="top">Rows with the same value in all aOrderBy columns are adjacent
10299
+ ** <td valign="top">Duplicates over all colUsed columns may be omitted
10300
+ ** <tr><td>0<td>yes<td>yes<td>no
10301
+ ** <tr><td>1<td>no<td>yes<td>no
10302
+ ** <tr><td>2<td>no<td>yes<td>yes
10303
+ ** <tr><td>3<td>yes<td>yes<td>yes
10304
+ ** </table>
10305
+ **
9938
10306
  ** ^For the purposes of comparing virtual table output values to see if the
9939
- ** values are same value for sorting purposes, two NULL values are considered
10307
+ ** values are the same value for sorting purposes, two NULL values are considered
9940
10308
  ** to be the same. In other words, the comparison operator is "IS"
9941
10309
  ** (or "IS NOT DISTINCT FROM") and not "==".
9942
10310
  **
@@ -9946,7 +10314,7 @@ SQLITE_API const char *sqlite3_vtab_collation(sqlite3_index_info*,int);
9946
10314
  **
9947
10315
  ** ^A virtual table implementation is always free to return rows in any order
9948
10316
  ** it wants, as long as the "orderByConsumed" flag is not set. ^When the
9949
- ** the "orderByConsumed" flag is unset, the query planner will add extra
10317
+ ** "orderByConsumed" flag is unset, the query planner will add extra
9950
10318
  ** [bytecode] to ensure that the final results returned by the SQL query are
9951
10319
  ** ordered correctly. The use of the "orderByConsumed" flag and the
9952
10320
  ** sqlite3_vtab_distinct() interface is merely an optimization. ^Careful
@@ -10043,7 +10411,7 @@ SQLITE_API int sqlite3_vtab_in(sqlite3_index_info*, int iCons, int bHandle);
10043
10411
  ** sqlite3_vtab_in_next(X,P) should be one of the parameters to the
10044
10412
  ** xFilter method which invokes these routines, and specifically
10045
10413
  ** a parameter that was previously selected for all-at-once IN constraint
10046
- ** processing use the [sqlite3_vtab_in()] interface in the
10414
+ ** processing using the [sqlite3_vtab_in()] interface in the
10047
10415
  ** [xBestIndex|xBestIndex method]. ^(If the X parameter is not
10048
10416
  ** an xFilter argument that was selected for all-at-once IN constraint
10049
10417
  ** processing, then these routines return [SQLITE_ERROR].)^
@@ -10098,7 +10466,7 @@ SQLITE_API int sqlite3_vtab_in_next(sqlite3_value *pVal, sqlite3_value **ppOut);
10098
10466
  ** and only if *V is set to a value. ^The sqlite3_vtab_rhs_value(P,J,V)
10099
10467
  ** inteface returns SQLITE_NOTFOUND if the right-hand side of the J-th
10100
10468
  ** constraint is not available. ^The sqlite3_vtab_rhs_value() interface
10101
- ** can return an result code other than SQLITE_OK or SQLITE_NOTFOUND if
10469
+ ** can return a result code other than SQLITE_OK or SQLITE_NOTFOUND if
10102
10470
  ** something goes wrong.
10103
10471
  **
10104
10472
  ** The sqlite3_vtab_rhs_value() interface is usually only successful if
@@ -10126,8 +10494,8 @@ SQLITE_API int sqlite3_vtab_rhs_value(sqlite3_index_info*, int, sqlite3_value **
10126
10494
  ** KEYWORDS: {conflict resolution mode}
10127
10495
  **
10128
10496
  ** These constants are returned by [sqlite3_vtab_on_conflict()] to
10129
- ** inform a [virtual table] implementation what the [ON CONFLICT] mode
10130
- ** is for the SQL statement being evaluated.
10497
+ ** inform a [virtual table] implementation of the [ON CONFLICT] mode
10498
+ ** for the SQL statement being evaluated.
10131
10499
  **
10132
10500
  ** Note that the [SQLITE_IGNORE] constant is also used as a potential
10133
10501
  ** return value from the [sqlite3_set_authorizer()] callback and that
@@ -10167,39 +10535,39 @@ SQLITE_API int sqlite3_vtab_rhs_value(sqlite3_index_info*, int, sqlite3_value **
10167
10535
  ** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt>
10168
10536
  ** <dd>^The "double" variable pointed to by the V parameter will be set to the
10169
10537
  ** query planner's estimate for the average number of rows output from each
10170
- ** iteration of the X-th loop. If the query planner's estimates was accurate,
10538
+ ** iteration of the X-th loop. If the query planner's estimate was accurate,
10171
10539
  ** then this value will approximate the quotient NVISIT/NLOOP and the
10172
10540
  ** product of this value for all prior loops with the same SELECTID will
10173
- ** be the NLOOP value for the current loop.
10541
+ ** be the NLOOP value for the current loop.</dd>
10174
10542
  **
10175
10543
  ** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt>
10176
10544
  ** <dd>^The "const char *" variable pointed to by the V parameter will be set
10177
10545
  ** to a zero-terminated UTF-8 string containing the name of the index or table
10178
- ** used for the X-th loop.
10546
+ ** used for the X-th loop.</dd>
10179
10547
  **
10180
10548
  ** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt>
10181
10549
  ** <dd>^The "const char *" variable pointed to by the V parameter will be set
10182
10550
  ** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN]
10183
- ** description for the X-th loop.
10551
+ ** description for the X-th loop.</dd>
10184
10552
  **
10185
10553
  ** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECTID</dt>
10186
10554
  ** <dd>^The "int" variable pointed to by the V parameter will be set to the
10187
10555
  ** id for the X-th query plan element. The id value is unique within the
10188
10556
  ** statement. The select-id is the same value as is output in the first
10189
- ** column of an [EXPLAIN QUERY PLAN] query.
10557
+ ** column of an [EXPLAIN QUERY PLAN] query.</dd>
10190
10558
  **
10191
10559
  ** [[SQLITE_SCANSTAT_PARENTID]] <dt>SQLITE_SCANSTAT_PARENTID</dt>
10192
10560
  ** <dd>The "int" variable pointed to by the V parameter will be set to the
10193
- ** the id of the parent of the current query element, if applicable, or
10561
+ ** id of the parent of the current query element, if applicable, or
10194
10562
  ** to zero if the query element has no parent. This is the same value as
10195
- ** returned in the second column of an [EXPLAIN QUERY PLAN] query.
10563
+ ** returned in the second column of an [EXPLAIN QUERY PLAN] query.</dd>
10196
10564
  **
10197
10565
  ** [[SQLITE_SCANSTAT_NCYCLE]] <dt>SQLITE_SCANSTAT_NCYCLE</dt>
10198
10566
  ** <dd>The sqlite3_int64 output value is set to the number of cycles,
10199
10567
  ** according to the processor time-stamp counter, that elapsed while the
10200
10568
  ** query element was being processed. This value is not available for
10201
10569
  ** all query elements - if it is unavailable the output variable is
10202
- ** set to -1.
10570
+ ** set to -1.</dd>
10203
10571
  ** </dl>
10204
10572
  */
10205
10573
  #define SQLITE_SCANSTAT_NLOOP 0
@@ -10240,8 +10608,8 @@ SQLITE_API int sqlite3_vtab_rhs_value(sqlite3_index_info*, int, sqlite3_value **
10240
10608
  ** sqlite3_stmt_scanstatus_v2() with a zeroed flags parameter.
10241
10609
  **
10242
10610
  ** Parameter "idx" identifies the specific query element to retrieve statistics
10243
- ** for. Query elements are numbered starting from zero. A value of -1 may be
10244
- ** to query for statistics regarding the entire query. ^If idx is out of range
10611
+ ** for. Query elements are numbered starting from zero. A value of -1 may
10612
+ ** retrieve statistics for the entire query. ^If idx is out of range
10245
10613
  ** - less than -1 or greater than or equal to the total number of query
10246
10614
  ** elements used to implement the statement - a non-zero value is returned and
10247
10615
  ** the variable that pOut points to is unchanged.
@@ -10284,7 +10652,7 @@ SQLITE_API void sqlite3_stmt_scanstatus_reset(sqlite3_stmt*);
10284
10652
  ** METHOD: sqlite3
10285
10653
  **
10286
10654
  ** ^If a write-transaction is open on [database connection] D when the
10287
- ** [sqlite3_db_cacheflush(D)] interface invoked, any dirty
10655
+ ** [sqlite3_db_cacheflush(D)] interface is invoked, any dirty
10288
10656
  ** pages in the pager-cache that are not currently in use are written out
10289
10657
  ** to disk. A dirty page may be in use if a database cursor created by an
10290
10658
  ** active SQL statement is reading from it, or if it is page 1 of a database
@@ -10398,8 +10766,8 @@ SQLITE_API int sqlite3_db_cacheflush(sqlite3*);
10398
10766
  ** triggers; and so forth.
10399
10767
  **
10400
10768
  ** When the [sqlite3_blob_write()] API is used to update a blob column,
10401
- ** the pre-update hook is invoked with SQLITE_DELETE. This is because the
10402
- ** in this case the new values are not available. In this case, when a
10769
+ ** the pre-update hook is invoked with SQLITE_DELETE, because
10770
+ ** the new values are not yet available. In this case, when a
10403
10771
  ** callback made with op==SQLITE_DELETE is actually a write using the
10404
10772
  ** sqlite3_blob_write() API, the [sqlite3_preupdate_blobwrite()] returns
10405
10773
  ** the index of the column being written. In other cases, where the
@@ -10478,6 +10846,14 @@ typedef struct sqlite3_snapshot {
10478
10846
  ** If there is not already a read-transaction open on schema S when
10479
10847
  ** this function is called, one is opened automatically.
10480
10848
  **
10849
+ ** If a read-transaction is opened by this function, then it is guaranteed
10850
+ ** that the returned snapshot object may not be invalidated by a database
10851
+ ** writer or checkpointer until after the read-transaction is closed. This
10852
+ ** is not guaranteed if a read-transaction is already open when this
10853
+ ** function is called. In that case, any subsequent write or checkpoint
10854
+ ** operation on the database may invalidate the returned snapshot handle,
10855
+ ** even while the read-transaction remains open.
10856
+ **
10481
10857
  ** The following must be true for this function to succeed. If any of
10482
10858
  ** the following statements are false when sqlite3_snapshot_get() is
10483
10859
  ** called, SQLITE_ERROR is returned. The final value of *P is undefined
@@ -10509,7 +10885,7 @@ typedef struct sqlite3_snapshot {
10509
10885
  ** The [sqlite3_snapshot_get()] interface is only available when the
10510
10886
  ** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.
10511
10887
  */
10512
- SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_get(
10888
+ SQLITE_API int sqlite3_snapshot_get(
10513
10889
  sqlite3 *db,
10514
10890
  const char *zSchema,
10515
10891
  sqlite3_snapshot **ppSnapshot
@@ -10558,7 +10934,7 @@ SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_get(
10558
10934
  ** The [sqlite3_snapshot_open()] interface is only available when the
10559
10935
  ** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.
10560
10936
  */
10561
- SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_open(
10937
+ SQLITE_API int sqlite3_snapshot_open(
10562
10938
  sqlite3 *db,
10563
10939
  const char *zSchema,
10564
10940
  sqlite3_snapshot *pSnapshot
@@ -10575,7 +10951,7 @@ SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_open(
10575
10951
  ** The [sqlite3_snapshot_free()] interface is only available when the
10576
10952
  ** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.
10577
10953
  */
10578
- SQLITE_API SQLITE_EXPERIMENTAL void sqlite3_snapshot_free(sqlite3_snapshot*);
10954
+ SQLITE_API void sqlite3_snapshot_free(sqlite3_snapshot*);
10579
10955
 
10580
10956
  /*
10581
10957
  ** CAPI3REF: Compare the ages of two snapshot handles.
@@ -10602,7 +10978,7 @@ SQLITE_API SQLITE_EXPERIMENTAL void sqlite3_snapshot_free(sqlite3_snapshot*);
10602
10978
  ** This interface is only available if SQLite is compiled with the
10603
10979
  ** [SQLITE_ENABLE_SNAPSHOT] option.
10604
10980
  */
10605
- SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_cmp(
10981
+ SQLITE_API int sqlite3_snapshot_cmp(
10606
10982
  sqlite3_snapshot *p1,
10607
10983
  sqlite3_snapshot *p2
10608
10984
  );
@@ -10630,20 +11006,21 @@ SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_cmp(
10630
11006
  ** This interface is only available if SQLite is compiled with the
10631
11007
  ** [SQLITE_ENABLE_SNAPSHOT] option.
10632
11008
  */
10633
- SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb);
11009
+ SQLITE_API int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb);
10634
11010
 
10635
11011
  /*
10636
11012
  ** CAPI3REF: Serialize a database
10637
11013
  **
10638
- ** The sqlite3_serialize(D,S,P,F) interface returns a pointer to memory
10639
- ** that is a serialization of the S database on [database connection] D.
11014
+ ** The sqlite3_serialize(D,S,P,F) interface returns a pointer to
11015
+ ** memory that is a serialization of the S database on
11016
+ ** [database connection] D. If S is a NULL pointer, the main database is used.
10640
11017
  ** If P is not a NULL pointer, then the size of the database in bytes
10641
11018
  ** is written into *P.
10642
11019
  **
10643
11020
  ** For an ordinary on-disk database file, the serialization is just a
10644
11021
  ** copy of the disk file. For an in-memory database or a "TEMP" database,
10645
11022
  ** the serialization is the same sequence of bytes which would be written
10646
- ** to disk if that database where backed up to disk.
11023
+ ** to disk if that database were backed up to disk.
10647
11024
  **
10648
11025
  ** The usual case is that sqlite3_serialize() copies the serialization of
10649
11026
  ** the database into memory obtained from [sqlite3_malloc64()] and returns
@@ -10652,7 +11029,7 @@ SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_recover(sqlite3 *db, const c
10652
11029
  ** contains the SQLITE_SERIALIZE_NOCOPY bit, then no memory allocations
10653
11030
  ** are made, and the sqlite3_serialize() function will return a pointer
10654
11031
  ** to the contiguous memory representation of the database that SQLite
10655
- ** is currently using for that database, or NULL if the no such contiguous
11032
+ ** is currently using for that database, or NULL if no such contiguous
10656
11033
  ** memory representation of the database exists. A contiguous memory
10657
11034
  ** representation of the database will usually only exist if there has
10658
11035
  ** been a prior call to [sqlite3_deserialize(D,S,...)] with the same
@@ -10703,12 +11080,13 @@ SQLITE_API unsigned char *sqlite3_serialize(
10703
11080
  **
10704
11081
  ** The sqlite3_deserialize(D,S,P,N,M,F) interface causes the
10705
11082
  ** [database connection] D to disconnect from database S and then
10706
- ** reopen S as an in-memory database based on the serialization contained
10707
- ** in P. The serialized database P is N bytes in size. M is the size of
10708
- ** the buffer P, which might be larger than N. If M is larger than N, and
10709
- ** the SQLITE_DESERIALIZE_READONLY bit is not set in F, then SQLite is
10710
- ** permitted to add content to the in-memory database as long as the total
10711
- ** size does not exceed M bytes.
11083
+ ** reopen S as an in-memory database based on the serialization
11084
+ ** contained in P. If S is a NULL pointer, the main database is
11085
+ ** used. The serialized database P is N bytes in size. M is the size
11086
+ ** of the buffer P, which might be larger than N. If M is larger than
11087
+ ** N, and the SQLITE_DESERIALIZE_READONLY bit is not set in F, then
11088
+ ** SQLite is permitted to add content to the in-memory database as
11089
+ ** long as the total size does not exceed M bytes.
10712
11090
  **
10713
11091
  ** If the SQLITE_DESERIALIZE_FREEONCLOSE bit is set in F, then SQLite will
10714
11092
  ** invoke sqlite3_free() on the serialization buffer when the database
@@ -10723,7 +11101,7 @@ SQLITE_API unsigned char *sqlite3_serialize(
10723
11101
  ** database is currently in a read transaction or is involved in a backup
10724
11102
  ** operation.
10725
11103
  **
10726
- ** It is not possible to deserialized into the TEMP database. If the
11104
+ ** It is not possible to deserialize into the TEMP database. If the
10727
11105
  ** S argument to sqlite3_deserialize(D,S,P,N,M,F) is "temp" then the
10728
11106
  ** function returns SQLITE_ERROR.
10729
11107
  **
@@ -10745,7 +11123,7 @@ SQLITE_API int sqlite3_deserialize(
10745
11123
  sqlite3 *db, /* The database connection */
10746
11124
  const char *zSchema, /* Which DB to reopen with the deserialization */
10747
11125
  unsigned char *pData, /* The serialized database content */
10748
- sqlite3_int64 szDb, /* Number bytes in the deserialization */
11126
+ sqlite3_int64 szDb, /* Number of bytes in the deserialization */
10749
11127
  sqlite3_int64 szBuf, /* Total size of buffer pData[] */
10750
11128
  unsigned mFlags /* Zero or more SQLITE_DESERIALIZE_* flags */
10751
11129
  );
@@ -10753,7 +11131,7 @@ SQLITE_API int sqlite3_deserialize(
10753
11131
  /*
10754
11132
  ** CAPI3REF: Flags for sqlite3_deserialize()
10755
11133
  **
10756
- ** The following are allowed values for 6th argument (the F argument) to
11134
+ ** The following are allowed values for the 6th argument (the F argument) to
10757
11135
  ** the [sqlite3_deserialize(D,S,P,N,M,F)] interface.
10758
11136
  **
10759
11137
  ** The SQLITE_DESERIALIZE_FREEONCLOSE means that the database serialization
@@ -10775,6 +11153,54 @@ SQLITE_API int sqlite3_deserialize(
10775
11153
  #define SQLITE_DESERIALIZE_RESIZEABLE 2 /* Resize using sqlite3_realloc64() */
10776
11154
  #define SQLITE_DESERIALIZE_READONLY 4 /* Database is read-only */
10777
11155
 
11156
+ /*
11157
+ ** CAPI3REF: Bind array values to the CARRAY table-valued function
11158
+ **
11159
+ ** The sqlite3_carray_bind(S,I,P,N,F,X) interface binds an array value to
11160
+ ** one of the first argument of the [carray() table-valued function]. The
11161
+ ** S parameter is a pointer to the [prepared statement] that uses the carray()
11162
+ ** functions. I is the parameter index to be bound. P is a pointer to the
11163
+ ** array to be bound, and N is the number of eements in the array. The
11164
+ ** F argument is one of constants [SQLITE_CARRAY_INT32], [SQLITE_CARRAY_INT64],
11165
+ ** [SQLITE_CARRAY_DOUBLE], [SQLITE_CARRAY_TEXT], or [SQLITE_CARRAY_BLOB] to
11166
+ ** indicate the datatype of the array being bound. The X argument is not a
11167
+ ** NULL pointer, then SQLite will invoke the function X on the P parameter
11168
+ ** after it has finished using P, even if the call to
11169
+ ** sqlite3_carray_bind() fails. The special-case finalizer
11170
+ ** SQLITE_TRANSIENT has no effect here.
11171
+ */
11172
+ SQLITE_API int sqlite3_carray_bind(
11173
+ sqlite3_stmt *pStmt, /* Statement to be bound */
11174
+ int i, /* Parameter index */
11175
+ void *aData, /* Pointer to array data */
11176
+ int nData, /* Number of data elements */
11177
+ int mFlags, /* CARRAY flags */
11178
+ void (*xDel)(void*) /* Destructor for aData */
11179
+ );
11180
+
11181
+ /*
11182
+ ** CAPI3REF: Datatypes for the CARRAY table-valued function
11183
+ **
11184
+ ** The fifth argument to the [sqlite3_carray_bind()] interface musts be
11185
+ ** one of the following constants, to specify the datatype of the array
11186
+ ** that is being bound into the [carray table-valued function].
11187
+ */
11188
+ #define SQLITE_CARRAY_INT32 0 /* Data is 32-bit signed integers */
11189
+ #define SQLITE_CARRAY_INT64 1 /* Data is 64-bit signed integers */
11190
+ #define SQLITE_CARRAY_DOUBLE 2 /* Data is doubles */
11191
+ #define SQLITE_CARRAY_TEXT 3 /* Data is char* */
11192
+ #define SQLITE_CARRAY_BLOB 4 /* Data is struct iovec */
11193
+
11194
+ /*
11195
+ ** Versions of the above #defines that omit the initial SQLITE_, for
11196
+ ** legacy compatibility.
11197
+ */
11198
+ #define CARRAY_INT32 0 /* Data is 32-bit signed integers */
11199
+ #define CARRAY_INT64 1 /* Data is 64-bit signed integers */
11200
+ #define CARRAY_DOUBLE 2 /* Data is doubles */
11201
+ #define CARRAY_TEXT 3 /* Data is char* */
11202
+ #define CARRAY_BLOB 4 /* Data is struct iovec */
11203
+
10778
11204
  /*
10779
11205
  ** Undo the hack that converts floating point types to integer for
10780
11206
  ** builds on processors without floating point support.
@@ -10786,8 +11212,6 @@ SQLITE_API int sqlite3_deserialize(
10786
11212
  #if defined(__wasi__)
10787
11213
  # undef SQLITE_WASI
10788
11214
  # define SQLITE_WASI 1
10789
- # undef SQLITE_OMIT_WAL
10790
- # define SQLITE_OMIT_WAL 1/* because it requires shared memory APIs */
10791
11215
  # ifndef SQLITE_OMIT_LOAD_EXTENSION
10792
11216
  # define SQLITE_OMIT_LOAD_EXTENSION
10793
11217
  # endif
@@ -10799,7 +11223,7 @@ SQLITE_API int sqlite3_deserialize(
10799
11223
  #ifdef __cplusplus
10800
11224
  } /* End of the 'extern "C"' block */
10801
11225
  #endif
10802
- #endif /* SQLITE3_H */
11226
+ /* #endif for SQLITE3_H will be added by mksqlite3.tcl */
10803
11227
 
10804
11228
  /******** Begin file sqlite3rtree.h *********/
10805
11229
  /*
@@ -11280,9 +11704,10 @@ SQLITE_API void sqlite3session_table_filter(
11280
11704
  ** is inserted while a session object is enabled, then later deleted while
11281
11705
  ** the same session object is disabled, no INSERT record will appear in the
11282
11706
  ** changeset, even though the delete took place while the session was disabled.
11283
- ** Or, if one field of a row is updated while a session is disabled, and
11284
- ** another field of the same row is updated while the session is enabled, the
11285
- ** resulting changeset will contain an UPDATE change that updates both fields.
11707
+ ** Or, if one field of a row is updated while a session is enabled, and
11708
+ ** then another field of the same row is updated while the session is disabled,
11709
+ ** the resulting changeset will contain an UPDATE change that updates both
11710
+ ** fields.
11286
11711
  */
11287
11712
  SQLITE_API int sqlite3session_changeset(
11288
11713
  sqlite3_session *pSession, /* Session object */
@@ -11354,8 +11779,9 @@ SQLITE_API sqlite3_int64 sqlite3session_changeset_size(sqlite3_session *pSession
11354
11779
  ** database zFrom the contents of the two compatible tables would be
11355
11780
  ** identical.
11356
11781
  **
11357
- ** It an error if database zFrom does not exist or does not contain the
11358
- ** required compatible table.
11782
+ ** Unless the call to this function is a no-op as described above, it is an
11783
+ ** error if database zFrom does not exist or does not contain the required
11784
+ ** compatible table.
11359
11785
  **
11360
11786
  ** If the operation is successful, SQLITE_OK is returned. Otherwise, an SQLite
11361
11787
  ** error code. In this case, if argument pzErrMsg is not NULL, *pzErrMsg
@@ -11490,7 +11916,7 @@ SQLITE_API int sqlite3changeset_start_v2(
11490
11916
  ** The following flags may passed via the 4th parameter to
11491
11917
  ** [sqlite3changeset_start_v2] and [sqlite3changeset_start_v2_strm]:
11492
11918
  **
11493
- ** <dt>SQLITE_CHANGESETAPPLY_INVERT <dd>
11919
+ ** <dt>SQLITE_CHANGESETSTART_INVERT <dd>
11494
11920
  ** Invert the changeset while iterating through it. This is equivalent to
11495
11921
  ** inverting a changeset using sqlite3changeset_invert() before applying it.
11496
11922
  ** It is an error to specify this flag with a patchset.
@@ -11805,19 +12231,6 @@ SQLITE_API int sqlite3changeset_concat(
11805
12231
  void **ppOut /* OUT: Buffer containing output changeset */
11806
12232
  );
11807
12233
 
11808
-
11809
- /*
11810
- ** CAPI3REF: Upgrade the Schema of a Changeset/Patchset
11811
- */
11812
- SQLITE_API int sqlite3changeset_upgrade(
11813
- sqlite3 *db,
11814
- const char *zDb,
11815
- int nIn, const void *pIn, /* Input changeset */
11816
- int *pnOut, void **ppOut /* OUT: Inverse of input */
11817
- );
11818
-
11819
-
11820
-
11821
12234
  /*
11822
12235
  ** CAPI3REF: Changegroup Handle
11823
12236
  **
@@ -11979,6 +12392,30 @@ SQLITE_API int sqlite3changegroup_schema(sqlite3_changegroup*, sqlite3*, const c
11979
12392
  */
11980
12393
  SQLITE_API int sqlite3changegroup_add(sqlite3_changegroup*, int nData, void *pData);
11981
12394
 
12395
+ /*
12396
+ ** CAPI3REF: Add A Single Change To A Changegroup
12397
+ ** METHOD: sqlite3_changegroup
12398
+ **
12399
+ ** This function adds the single change currently indicated by the iterator
12400
+ ** passed as the second argument to the changegroup object. The rules for
12401
+ ** adding the change are just as described for [sqlite3changegroup_add()].
12402
+ **
12403
+ ** If the change is successfully added to the changegroup, SQLITE_OK is
12404
+ ** returned. Otherwise, an SQLite error code is returned.
12405
+ **
12406
+ ** The iterator must point to a valid entry when this function is called.
12407
+ ** If it does not, SQLITE_ERROR is returned and no change is added to the
12408
+ ** changegroup. Additionally, the iterator must not have been opened with
12409
+ ** the SQLITE_CHANGESETAPPLY_INVERT flag. In this case SQLITE_ERROR is also
12410
+ ** returned.
12411
+ */
12412
+ SQLITE_API int sqlite3changegroup_add_change(
12413
+ sqlite3_changegroup*,
12414
+ sqlite3_changeset_iter*
12415
+ );
12416
+
12417
+
12418
+
11982
12419
  /*
11983
12420
  ** CAPI3REF: Obtain A Composite Changeset From A Changegroup
11984
12421
  ** METHOD: sqlite3_changegroup
@@ -12023,14 +12460,32 @@ SQLITE_API void sqlite3changegroup_delete(sqlite3_changegroup*);
12023
12460
  ** update the "main" database attached to handle db with the changes found in
12024
12461
  ** the changeset passed via the second and third arguments.
12025
12462
  **
12463
+ ** All changes made by these functions are enclosed in a savepoint transaction.
12464
+ ** If any other error (aside from a constraint failure when attempting to
12465
+ ** write to the target database) occurs, then the savepoint transaction is
12466
+ ** rolled back, restoring the target database to its original state, and an
12467
+ ** SQLite error code returned. Additionally, starting with version 3.51.0,
12468
+ ** an error code and error message that may be accessed using the
12469
+ ** [sqlite3_errcode()] and [sqlite3_errmsg()] APIs are left in the database
12470
+ ** handle.
12471
+ **
12026
12472
  ** The fourth argument (xFilter) passed to these functions is the "filter
12027
- ** callback". If it is not NULL, then for each table affected by at least one
12028
- ** change in the changeset, the filter callback is invoked with
12029
- ** the table name as the second argument, and a copy of the context pointer
12030
- ** passed as the sixth argument as the first. If the "filter callback"
12031
- ** returns zero, then no attempt is made to apply any changes to the table.
12032
- ** Otherwise, if the return value is non-zero or the xFilter argument to
12033
- ** is NULL, all changes related to the table are attempted.
12473
+ ** callback". This may be passed NULL, in which case all changes in the
12474
+ ** changeset are applied to the database. For sqlite3changeset_apply() and
12475
+ ** sqlite3_changeset_apply_v2(), if it is not NULL, then it is invoked once
12476
+ ** for each table affected by at least one change in the changeset. In this
12477
+ ** case the table name is passed as the second argument, and a copy of
12478
+ ** the context pointer passed as the sixth argument to apply() or apply_v2()
12479
+ ** as the first. If the "filter callback" returns zero, then no attempt is
12480
+ ** made to apply any changes to the table. Otherwise, if the return value is
12481
+ ** non-zero, all changes related to the table are attempted.
12482
+ **
12483
+ ** For sqlite3_changeset_apply_v3(), the xFilter callback is invoked once
12484
+ ** per change. The second argument in this case is an sqlite3_changeset_iter
12485
+ ** that may be queried using the usual APIs for the details of the current
12486
+ ** change. If the "filter callback" returns zero in this case, then no attempt
12487
+ ** is made to apply the current change. If it returns non-zero, the change
12488
+ ** is applied.
12034
12489
  **
12035
12490
  ** For each table that is not excluded by the filter callback, this function
12036
12491
  ** tests that the target database contains a compatible table. A table is
@@ -12051,11 +12506,11 @@ SQLITE_API void sqlite3changegroup_delete(sqlite3_changegroup*);
12051
12506
  ** one such warning is issued for each table in the changeset.
12052
12507
  **
12053
12508
  ** For each change for which there is a compatible table, an attempt is made
12054
- ** to modify the table contents according to the UPDATE, INSERT or DELETE
12055
- ** change. If a change cannot be applied cleanly, the conflict handler
12056
- ** function passed as the fifth argument to sqlite3changeset_apply() may be
12057
- ** invoked. A description of exactly when the conflict handler is invoked for
12058
- ** each type of change is below.
12509
+ ** to modify the table contents according to each UPDATE, INSERT or DELETE
12510
+ ** change that is not excluded by a filter callback. If a change cannot be
12511
+ ** applied cleanly, the conflict handler function passed as the fifth argument
12512
+ ** to sqlite3changeset_apply() may be invoked. A description of exactly when
12513
+ ** the conflict handler is invoked for each type of change is below.
12059
12514
  **
12060
12515
  ** Unlike the xFilter argument, xConflict may not be passed NULL. The results
12061
12516
  ** of passing anything other than a valid function pointer as the xConflict
@@ -12151,12 +12606,6 @@ SQLITE_API void sqlite3changegroup_delete(sqlite3_changegroup*);
12151
12606
  ** This can be used to further customize the application's conflict
12152
12607
  ** resolution strategy.
12153
12608
  **
12154
- ** All changes made by these functions are enclosed in a savepoint transaction.
12155
- ** If any other error (aside from a constraint failure when attempting to
12156
- ** write to the target database) occurs, then the savepoint transaction is
12157
- ** rolled back, restoring the target database to its original state, and an
12158
- ** SQLite error code returned.
12159
- **
12160
12609
  ** If the output parameters (ppRebase) and (pnRebase) are non-NULL and
12161
12610
  ** the input is a changeset (not a patchset), then sqlite3changeset_apply_v2()
12162
12611
  ** may set (*ppRebase) to point to a "rebase" that may be used with the
@@ -12206,6 +12655,23 @@ SQLITE_API int sqlite3changeset_apply_v2(
12206
12655
  void **ppRebase, int *pnRebase, /* OUT: Rebase data */
12207
12656
  int flags /* SESSION_CHANGESETAPPLY_* flags */
12208
12657
  );
12658
+ SQLITE_API int sqlite3changeset_apply_v3(
12659
+ sqlite3 *db, /* Apply change to "main" db of this handle */
12660
+ int nChangeset, /* Size of changeset in bytes */
12661
+ void *pChangeset, /* Changeset blob */
12662
+ int(*xFilter)(
12663
+ void *pCtx, /* Copy of sixth arg to _apply() */
12664
+ sqlite3_changeset_iter *p /* Handle describing change */
12665
+ ),
12666
+ int(*xConflict)(
12667
+ void *pCtx, /* Copy of sixth arg to _apply() */
12668
+ int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
12669
+ sqlite3_changeset_iter *p /* Handle describing change and conflict */
12670
+ ),
12671
+ void *pCtx, /* First argument passed to xConflict */
12672
+ void **ppRebase, int *pnRebase, /* OUT: Rebase data */
12673
+ int flags /* SESSION_CHANGESETAPPLY_* flags */
12674
+ );
12209
12675
 
12210
12676
  /*
12211
12677
  ** CAPI3REF: Flags for sqlite3changeset_apply_v2
@@ -12625,6 +13091,23 @@ SQLITE_API int sqlite3changeset_apply_v2_strm(
12625
13091
  void **ppRebase, int *pnRebase,
12626
13092
  int flags
12627
13093
  );
13094
+ SQLITE_API int sqlite3changeset_apply_v3_strm(
13095
+ sqlite3 *db, /* Apply change to "main" db of this handle */
13096
+ int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */
13097
+ void *pIn, /* First arg for xInput */
13098
+ int(*xFilter)(
13099
+ void *pCtx, /* Copy of sixth arg to _apply() */
13100
+ sqlite3_changeset_iter *p
13101
+ ),
13102
+ int(*xConflict)(
13103
+ void *pCtx, /* Copy of sixth arg to _apply() */
13104
+ int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
13105
+ sqlite3_changeset_iter *p /* Handle describing change and conflict */
13106
+ ),
13107
+ void *pCtx, /* First argument passed to xConflict */
13108
+ void **ppRebase, int *pnRebase,
13109
+ int flags
13110
+ );
12628
13111
  SQLITE_API int sqlite3changeset_concat_strm(
12629
13112
  int (*xInputA)(void *pIn, void *pData, int *pnData),
12630
13113
  void *pInA,
@@ -12783,8 +13266,8 @@ struct Fts5PhraseIter {
12783
13266
  ** EXTENSION API FUNCTIONS
12784
13267
  **
12785
13268
  ** xUserData(pFts):
12786
- ** Return a copy of the context pointer the extension function was
12787
- ** registered with.
13269
+ ** Return a copy of the pUserData pointer passed to the xCreateFunction()
13270
+ ** API when the extension function was registered.
12788
13271
  **
12789
13272
  ** xColumnTotalSize(pFts, iCol, pnToken):
12790
13273
  ** If parameter iCol is less than zero, set output variable *pnToken
@@ -12966,6 +13449,10 @@ struct Fts5PhraseIter {
12966
13449
  ** (i.e. if it is a contentless table), then this API always iterates
12967
13450
  ** through an empty set (all calls to xPhraseFirst() set iCol to -1).
12968
13451
  **
13452
+ ** In all cases, matches are visited in (column ASC, offset ASC) order.
13453
+ ** i.e. all those in column 0, sorted by offset, followed by those in
13454
+ ** column 1, etc.
13455
+ **
12969
13456
  ** xPhraseNext()
12970
13457
  ** See xPhraseFirst above.
12971
13458
  **
@@ -13022,19 +13509,57 @@ struct Fts5PhraseIter {
13022
13509
  ** value returned by xInstCount(), SQLITE_RANGE is returned. Otherwise,
13023
13510
  ** output variable (*ppToken) is set to point to a buffer containing the
13024
13511
  ** matching document token, and (*pnToken) to the size of that buffer in
13025
- ** bytes. This API is not available if the specified token matches a
13026
- ** prefix query term. In that case both output variables are always set
13027
- ** to 0.
13512
+ ** bytes.
13028
13513
  **
13029
13514
  ** The output text is not a copy of the document text that was tokenized.
13030
13515
  ** It is the output of the tokenizer module. For tokendata=1 tables, this
13031
13516
  ** includes any embedded 0x00 and trailing data.
13032
13517
  **
13518
+ ** This API may be slow in some cases if the token identified by parameters
13519
+ ** iIdx and iToken matched a prefix token in the query. In most cases, the
13520
+ ** first call to this API for each prefix token in the query is forced
13521
+ ** to scan the portion of the full-text index that matches the prefix
13522
+ ** token to collect the extra data required by this API. If the prefix
13523
+ ** token matches a large number of token instances in the document set,
13524
+ ** this may be a performance problem.
13525
+ **
13526
+ ** If the user knows in advance that a query may use this API for a
13527
+ ** prefix token, FTS5 may be configured to collect all required data as part
13528
+ ** of the initial querying of the full-text index, avoiding the second scan
13529
+ ** entirely. This also causes prefix queries that do not use this API to
13530
+ ** run more slowly and use more memory. FTS5 may be configured in this way
13531
+ ** either on a per-table basis using the [FTS5 insttoken | 'insttoken']
13532
+ ** option, or on a per-query basis using the
13533
+ ** [fts5_insttoken | fts5_insttoken()] user function.
13534
+ **
13033
13535
  ** This API can be quite slow if used with an FTS5 table created with the
13034
13536
  ** "detail=none" or "detail=column" option.
13537
+ **
13538
+ ** xColumnLocale(pFts5, iIdx, pzLocale, pnLocale)
13539
+ ** If parameter iCol is less than zero, or greater than or equal to the
13540
+ ** number of columns in the table, SQLITE_RANGE is returned.
13541
+ **
13542
+ ** Otherwise, this function attempts to retrieve the locale associated
13543
+ ** with column iCol of the current row. Usually, there is no associated
13544
+ ** locale, and output parameters (*pzLocale) and (*pnLocale) are set
13545
+ ** to NULL and 0, respectively. However, if the fts5_locale() function
13546
+ ** was used to associate a locale with the value when it was inserted
13547
+ ** into the fts5 table, then (*pzLocale) is set to point to a nul-terminated
13548
+ ** buffer containing the name of the locale in utf-8 encoding. (*pnLocale)
13549
+ ** is set to the size in bytes of the buffer, not including the
13550
+ ** nul-terminator.
13551
+ **
13552
+ ** If successful, SQLITE_OK is returned. Or, if an error occurs, an
13553
+ ** SQLite error code is returned. The final value of the output parameters
13554
+ ** is undefined in this case.
13555
+ **
13556
+ ** xTokenize_v2:
13557
+ ** Tokenize text using the tokenizer belonging to the FTS5 table. This
13558
+ ** API is the same as the xTokenize() API, except that it allows a tokenizer
13559
+ ** locale to be specified.
13035
13560
  */
13036
13561
  struct Fts5ExtensionApi {
13037
- int iVersion; /* Currently always set to 3 */
13562
+ int iVersion; /* Currently always set to 4 */
13038
13563
 
13039
13564
  void *(*xUserData)(Fts5Context*);
13040
13565
 
@@ -13076,6 +13601,15 @@ struct Fts5ExtensionApi {
13076
13601
  const char **ppToken, int *pnToken
13077
13602
  );
13078
13603
  int (*xInstToken)(Fts5Context*, int iIdx, int iToken, const char**, int*);
13604
+
13605
+ /* Below this point are iVersion>=4 only */
13606
+ int (*xColumnLocale)(Fts5Context*, int iCol, const char **pz, int *pn);
13607
+ int (*xTokenize_v2)(Fts5Context*,
13608
+ const char *pText, int nText, /* Text to tokenize */
13609
+ const char *pLocale, int nLocale, /* Locale to pass to tokenizer */
13610
+ void *pCtx, /* Context passed to xToken() */
13611
+ int (*xToken)(void*, int, const char*, int, int, int) /* Callback */
13612
+ );
13079
13613
  };
13080
13614
 
13081
13615
  /*
@@ -13096,7 +13630,7 @@ struct Fts5ExtensionApi {
13096
13630
  ** A tokenizer instance is required to actually tokenize text.
13097
13631
  **
13098
13632
  ** The first argument passed to this function is a copy of the (void*)
13099
- ** pointer provided by the application when the fts5_tokenizer object
13633
+ ** pointer provided by the application when the fts5_tokenizer_v2 object
13100
13634
  ** was registered with FTS5 (the third argument to xCreateTokenizer()).
13101
13635
  ** The second and third arguments are an array of nul-terminated strings
13102
13636
  ** containing the tokenizer arguments, if any, specified following the
@@ -13120,7 +13654,7 @@ struct Fts5ExtensionApi {
13120
13654
  ** argument passed to this function is a pointer to an Fts5Tokenizer object
13121
13655
  ** returned by an earlier call to xCreate().
13122
13656
  **
13123
- ** The second argument indicates the reason that FTS5 is requesting
13657
+ ** The third argument indicates the reason that FTS5 is requesting
13124
13658
  ** tokenization of the supplied text. This is always one of the following
13125
13659
  ** four values:
13126
13660
  **
@@ -13144,6 +13678,13 @@ struct Fts5ExtensionApi {
13144
13678
  ** on a columnsize=0 database.
13145
13679
  ** </ul>
13146
13680
  **
13681
+ ** The sixth and seventh arguments passed to xTokenize() - pLocale and
13682
+ ** nLocale - are a pointer to a buffer containing the locale to use for
13683
+ ** tokenization (e.g. "en_US") and its size in bytes, respectively. The
13684
+ ** pLocale buffer is not nul-terminated. pLocale may be passed NULL (in
13685
+ ** which case nLocale is always 0) to indicate that the tokenizer should
13686
+ ** use its default locale.
13687
+ **
13147
13688
  ** For each token in the input string, the supplied callback xToken() must
13148
13689
  ** be invoked. The first argument to it should be a copy of the pointer
13149
13690
  ** passed as the second argument to xTokenize(). The third and fourth
@@ -13167,6 +13708,30 @@ struct Fts5ExtensionApi {
13167
13708
  ** may abandon the tokenization and return any error code other than
13168
13709
  ** SQLITE_OK or SQLITE_DONE.
13169
13710
  **
13711
+ ** If the tokenizer is registered using an fts5_tokenizer_v2 object,
13712
+ ** then the xTokenize() method has two additional arguments - pLocale
13713
+ ** and nLocale. These specify the locale that the tokenizer should use
13714
+ ** for the current request. If pLocale and nLocale are both 0, then the
13715
+ ** tokenizer should use its default locale. Otherwise, pLocale points to
13716
+ ** an nLocale byte buffer containing the name of the locale to use as utf-8
13717
+ ** text. pLocale is not nul-terminated.
13718
+ **
13719
+ ** FTS5_TOKENIZER
13720
+ **
13721
+ ** There is also an fts5_tokenizer object. This is an older, deprecated,
13722
+ ** version of fts5_tokenizer_v2. It is similar except that:
13723
+ **
13724
+ ** <ul>
13725
+ ** <li> There is no "iVersion" field, and
13726
+ ** <li> The xTokenize() method does not take a locale argument.
13727
+ ** </ul>
13728
+ **
13729
+ ** Legacy fts5_tokenizer tokenizers must be registered using the
13730
+ ** legacy xCreateTokenizer() function, instead of xCreateTokenizer_v2().
13731
+ **
13732
+ ** Tokenizer implementations registered using either API may be retrieved
13733
+ ** using both xFindTokenizer() and xFindTokenizer_v2().
13734
+ **
13170
13735
  ** SYNONYM SUPPORT
13171
13736
  **
13172
13737
  ** Custom tokenizers may also support synonyms. Consider a case in which a
@@ -13275,6 +13840,33 @@ struct Fts5ExtensionApi {
13275
13840
  ** inefficient.
13276
13841
  */
13277
13842
  typedef struct Fts5Tokenizer Fts5Tokenizer;
13843
+ typedef struct fts5_tokenizer_v2 fts5_tokenizer_v2;
13844
+ struct fts5_tokenizer_v2 {
13845
+ int iVersion; /* Currently always 2 */
13846
+
13847
+ int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut);
13848
+ void (*xDelete)(Fts5Tokenizer*);
13849
+ int (*xTokenize)(Fts5Tokenizer*,
13850
+ void *pCtx,
13851
+ int flags, /* Mask of FTS5_TOKENIZE_* flags */
13852
+ const char *pText, int nText,
13853
+ const char *pLocale, int nLocale,
13854
+ int (*xToken)(
13855
+ void *pCtx, /* Copy of 2nd argument to xTokenize() */
13856
+ int tflags, /* Mask of FTS5_TOKEN_* flags */
13857
+ const char *pToken, /* Pointer to buffer containing token */
13858
+ int nToken, /* Size of token in bytes */
13859
+ int iStart, /* Byte offset of token within input text */
13860
+ int iEnd /* Byte offset of end of token within input text */
13861
+ )
13862
+ );
13863
+ };
13864
+
13865
+ /*
13866
+ ** New code should use the fts5_tokenizer_v2 type to define tokenizer
13867
+ ** implementations. The following type is included for legacy applications
13868
+ ** that still use it.
13869
+ */
13278
13870
  typedef struct fts5_tokenizer fts5_tokenizer;
13279
13871
  struct fts5_tokenizer {
13280
13872
  int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut);
@@ -13294,6 +13886,7 @@ struct fts5_tokenizer {
13294
13886
  );
13295
13887
  };
13296
13888
 
13889
+
13297
13890
  /* Flags that may be passed as the third argument to xTokenize() */
13298
13891
  #define FTS5_TOKENIZE_QUERY 0x0001
13299
13892
  #define FTS5_TOKENIZE_PREFIX 0x0002
@@ -13313,7 +13906,7 @@ struct fts5_tokenizer {
13313
13906
  */
13314
13907
  typedef struct fts5_api fts5_api;
13315
13908
  struct fts5_api {
13316
- int iVersion; /* Currently always set to 2 */
13909
+ int iVersion; /* Currently always set to 3 */
13317
13910
 
13318
13911
  /* Create a new tokenizer */
13319
13912
  int (*xCreateTokenizer)(
@@ -13340,6 +13933,25 @@ struct fts5_api {
13340
13933
  fts5_extension_function xFunction,
13341
13934
  void (*xDestroy)(void*)
13342
13935
  );
13936
+
13937
+ /* APIs below this point are only available if iVersion>=3 */
13938
+
13939
+ /* Create a new tokenizer */
13940
+ int (*xCreateTokenizer_v2)(
13941
+ fts5_api *pApi,
13942
+ const char *zName,
13943
+ void *pUserData,
13944
+ fts5_tokenizer_v2 *pTokenizer,
13945
+ void (*xDestroy)(void*)
13946
+ );
13947
+
13948
+ /* Find an existing tokenizer */
13949
+ int (*xFindTokenizer_v2)(
13950
+ fts5_api *pApi,
13951
+ const char *zName,
13952
+ void **ppUserData,
13953
+ fts5_tokenizer_v2 **ppTokenizer
13954
+ );
13343
13955
  };
13344
13956
 
13345
13957
  /*
@@ -13353,3 +13965,4 @@ struct fts5_api {
13353
13965
  #endif /* _FTS5_H */
13354
13966
 
13355
13967
  /******** End of fts5.h *********/
13968
+ #endif /* SQLITE3_H */