Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src/external/public-domain/sqlite/man Regenerate man pages
details: https://anonhg.NetBSD.org/src/rev/2339e14c0977
branches: trunk
changeset: 346250:2339e14c0977
user: abhinav <abhinav%NetBSD.org@localhost>
date: Sun Jul 03 16:43:00 2016 +0000
description:
Regenerate man pages
diffstat:
external/public-domain/sqlite/man/SQLITE_CHECKPOINT_PASSIVE.3 | 13 +-
external/public-domain/sqlite/man/SQLITE_CONFIG_SINGLETHREAD.3 | 199 ++++++---
external/public-domain/sqlite/man/SQLITE_DBCONFIG_LOOKASIDE.3 | 41 +-
external/public-domain/sqlite/man/SQLITE_DBSTATUS_LOOKASIDE_USED.3 | 6 +-
external/public-domain/sqlite/man/SQLITE_DENY.3 | 9 +-
external/public-domain/sqlite/man/SQLITE_FCNTL_LOCKSTATE.3 | 78 +++-
external/public-domain/sqlite/man/SQLITE_INDEX_CONSTRAINT_EQ.3 | 8 +-
external/public-domain/sqlite/man/SQLITE_IOCAP_ATOMIC.3 | 6 +-
external/public-domain/sqlite/man/SQLITE_IOERR_READ.3 | 31 +-
external/public-domain/sqlite/man/SQLITE_LIMIT_LENGTH.3 | 8 +-
external/public-domain/sqlite/man/SQLITE_MUTEX_FAST.3 | 14 +-
external/public-domain/sqlite/man/SQLITE_OK.3 | 4 +-
external/public-domain/sqlite/man/SQLITE_ROLLBACK.3 | 1 -
external/public-domain/sqlite/man/SQLITE_SHM_UNLOCK.3 | 2 +-
external/public-domain/sqlite/man/SQLITE_STATUS_MEMORY_USED.3 | 6 +-
external/public-domain/sqlite/man/SQLITE_TESTCTRL_FIRST.3 | 10 +
external/public-domain/sqlite/man/sqlite3_aggregate_context.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_aggregate_count.3 | 16 +-
external/public-domain/sqlite/man/sqlite3_auto_extension.3 | 3 +-
external/public-domain/sqlite/man/sqlite3_backup_init.3 | 32 +-
external/public-domain/sqlite/man/sqlite3_bind_blob.3 | 78 ++-
external/public-domain/sqlite/man/sqlite3_bind_parameter_count.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_bind_parameter_index.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_bind_parameter_name.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_blob_bytes.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_blob_close.3 | 32 +-
external/public-domain/sqlite/man/sqlite3_blob_open.3 | 76 ++-
external/public-domain/sqlite/man/sqlite3_blob_read.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_blob_reopen.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_blob_write.3 | 21 +-
external/public-domain/sqlite/man/sqlite3_busy_handler.3 | 53 +-
external/public-domain/sqlite/man/sqlite3_busy_timeout.3 | 11 +-
external/public-domain/sqlite/man/sqlite3_cancel_auto_extension.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_changes.3 | 84 +--
external/public-domain/sqlite/man/sqlite3_clear_bindings.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_close.3 | 14 +-
external/public-domain/sqlite/man/sqlite3_collation_needed.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_column_blob.3 | 42 +-
external/public-domain/sqlite/man/sqlite3_column_count.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_column_database_name.3 | 12 +-
external/public-domain/sqlite/man/sqlite3_column_decltype.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_column_name.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_commit_hook.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_compileoption_used.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_complete.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_config.3 | 12 +-
external/public-domain/sqlite/man/sqlite3_context_db_handle.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_create_collation.3 | 6 +-
external/public-domain/sqlite/man/sqlite3_create_function.3 | 6 +-
external/public-domain/sqlite/man/sqlite3_create_module.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_data_count.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_db_config.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_db_filename.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_db_handle.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_db_mutex.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_db_readonly.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_db_release_memory.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_db_status.3 | 3 +-
external/public-domain/sqlite/man/sqlite3_declare_vtab.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_enable_load_extension.3 | 18 +-
external/public-domain/sqlite/man/sqlite3_enable_shared_cache.3 | 11 +-
external/public-domain/sqlite/man/sqlite3_errcode.3 | 23 +-
external/public-domain/sqlite/man/sqlite3_exec.3 | 6 +-
external/public-domain/sqlite/man/sqlite3_extended_result_codes.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_file_control.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_finalize.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_get_autocommit.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_get_auxdata.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_get_table.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_index_info.3 | 31 +
external/public-domain/sqlite/man/sqlite3_initialize.3 | 9 +-
external/public-domain/sqlite/man/sqlite3_interrupt.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_io_methods.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_last_insert_rowid.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_limit.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_load_extension.3 | 13 +-
external/public-domain/sqlite/man/sqlite3_log.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_malloc.3 | 75 ++-
external/public-domain/sqlite/man/sqlite3_memory_used.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_mprintf.3 | 20 +-
external/public-domain/sqlite/man/sqlite3_mutex_alloc.3 | 49 +-
external/public-domain/sqlite/man/sqlite3_mutex_held.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_mutex_methods.3 | 6 +-
external/public-domain/sqlite/man/sqlite3_next_stmt.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_open.3 | 44 +-
external/public-domain/sqlite/man/sqlite3_overload_function.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_prepare.3 | 28 +-
external/public-domain/sqlite/man/sqlite3_progress_handler.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_randomness.3 | 15 +-
external/public-domain/sqlite/man/sqlite3_release_memory.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_reset.3 | 3 +-
external/public-domain/sqlite/man/sqlite3_reset_auto_extension.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_result_blob.3 | 71 ++-
external/public-domain/sqlite/man/sqlite3_set_authorizer.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_sleep.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_soft_heap_limit.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_soft_heap_limit64.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_sql.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_status.3 | 29 +-
external/public-domain/sqlite/man/sqlite3_step.3 | 5 +-
external/public-domain/sqlite/man/sqlite3_stmt.3 | 27 +-
external/public-domain/sqlite/man/sqlite3_stmt_busy.3 | 8 +-
external/public-domain/sqlite/man/sqlite3_stmt_readonly.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_stmt_status.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_strglob.3 | 5 +-
external/public-domain/sqlite/man/sqlite3_stricmp.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_table_column_metadata.3 | 43 +-
external/public-domain/sqlite/man/sqlite3_temp_directory.3 | 13 +
external/public-domain/sqlite/man/sqlite3_test_control.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_threadsafe.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_total_changes.3 | 31 +-
external/public-domain/sqlite/man/sqlite3_trace.3 | 4 +-
external/public-domain/sqlite/man/sqlite3_unlock_notify.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_update_hook.3 | 7 +-
external/public-domain/sqlite/man/sqlite3_uri_parameter.3 | 6 +-
external/public-domain/sqlite/man/sqlite3_user_data.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_value.3 | 3 +
external/public-domain/sqlite/man/sqlite3_value_blob.3 | 28 +-
external/public-domain/sqlite/man/sqlite3_version.3 | 8 +-
external/public-domain/sqlite/man/sqlite3_vfs_find.3 | 6 +-
external/public-domain/sqlite/man/sqlite3_vtab_config.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_vtab_on_conflict.3 | 2 +-
external/public-domain/sqlite/man/sqlite3_wal_autocheckpoint.3 | 5 +-
external/public-domain/sqlite/man/sqlite3_wal_checkpoint.3 | 32 +-
external/public-domain/sqlite/man/sqlite3_wal_checkpoint_v2.3 | 88 ++-
external/public-domain/sqlite/man/sqlite3_wal_hook.3 | 11 +-
126 files changed, 1130 insertions(+), 738 deletions(-)
diffs (truncated from 4649 to 300 lines):
diff -r 6e274776852f -r 2339e14c0977 external/public-domain/sqlite/man/SQLITE_CHECKPOINT_PASSIVE.3
--- a/external/public-domain/sqlite/man/SQLITE_CHECKPOINT_PASSIVE.3 Sun Jul 03 14:26:47 2016 +0000
+++ b/external/public-domain/sqlite/man/SQLITE_CHECKPOINT_PASSIVE.3 Sun Jul 03 16:43:00 2016 +0000
@@ -4,16 +4,19 @@
.Sh NAME
.Nm SQLITE_CHECKPOINT_PASSIVE ,
.Nm SQLITE_CHECKPOINT_FULL ,
-.Nm SQLITE_CHECKPOINT_RESTART
-.Nd Checkpoint operation parameters
+.Nm SQLITE_CHECKPOINT_RESTART ,
+.Nm SQLITE_CHECKPOINT_TRUNCATE
+.Nd Checkpoint Mode Values
.Sh SYNOPSIS
.Fd #define SQLITE_CHECKPOINT_PASSIVE
.Fd #define SQLITE_CHECKPOINT_FULL
.Fd #define SQLITE_CHECKPOINT_RESTART
+.Fd #define SQLITE_CHECKPOINT_TRUNCATE
.Sh DESCRIPTION
-These constants can be used as the 3rd parameter to sqlite3_wal_checkpoint_v2().
+These constants define all valid values for the "checkpoint mode" passed
+as the third parameter to the sqlite3_wal_checkpoint_v2()
+interface.
See the sqlite3_wal_checkpoint_v2() documentation
-for additional information about the meaning and use of each of these
-values.
+for details on the meaning of each of these checkpoint modes.
.Sh SEE ALSO
.Xr sqlite3_wal_checkpoint_v2 3
diff -r 6e274776852f -r 2339e14c0977 external/public-domain/sqlite/man/SQLITE_CONFIG_SINGLETHREAD.3
--- a/external/public-domain/sqlite/man/SQLITE_CONFIG_SINGLETHREAD.3 Sun Jul 03 14:26:47 2016 +0000
+++ b/external/public-domain/sqlite/man/SQLITE_CONFIG_SINGLETHREAD.3 Sun Jul 03 16:43:00 2016 +0000
@@ -23,7 +23,10 @@
.Nm SQLITE_CONFIG_COVERING_INDEX_SCAN ,
.Nm SQLITE_CONFIG_SQLLOG ,
.Nm SQLITE_CONFIG_MMAP_SIZE ,
-.Nm SQLITE_CONFIG_WIN32_HEAPSIZE
+.Nm SQLITE_CONFIG_WIN32_HEAPSIZE ,
+.Nm SQLITE_CONFIG_PCACHE_HDRSZ ,
+.Nm SQLITE_CONFIG_PMASZ ,
+.Nm SQLITE_CONFIG_STMTJRNL_SPILL
.Nd Configuration Options
.Sh SYNOPSIS
.Fd #define SQLITE_CONFIG_SINGLETHREAD
@@ -48,6 +51,9 @@
.Fd #define SQLITE_CONFIG_SQLLOG
.Fd #define SQLITE_CONFIG_MMAP_SIZE
.Fd #define SQLITE_CONFIG_WIN32_HEAPSIZE
+.Fd #define SQLITE_CONFIG_PCACHE_HDRSZ
+.Fd #define SQLITE_CONFIG_PMASZ
+.Fd #define SQLITE_CONFIG_STMTJRNL_SPILL
.Sh DESCRIPTION
These constants are the available integer configuration options that
can be passed as the first argument to the sqlite3_config()
@@ -103,23 +109,26 @@
and sqlite3_config() will return SQLITE_ERROR
if called with the SQLITE_CONFIG_SERIALIZED configuration option.
.It SQLITE_CONFIG_MALLOC
-This option takes a single argument which is a pointer to an instance
-of the sqlite3_mem_methods structure.
+The SQLITE_CONFIG_MALLOC option takes a single argument which is a
+pointer to an instance of the sqlite3_mem_methods
+structure.
The argument specifies alternative low-level memory allocation routines
to be used in place of the memory allocation routines built into SQLite.
SQLite makes its own private copy of the content of the sqlite3_mem_methods
structure before the sqlite3_config() call returns.
.It SQLITE_CONFIG_GETMALLOC
-This option takes a single argument which is a pointer to an instance
-of the sqlite3_mem_methods structure.
+The SQLITE_CONFIG_GETMALLOC option takes a single argument which is
+a pointer to an instance of the sqlite3_mem_methods
+structure.
The sqlite3_mem_methods structure is filled with
the currently defined memory allocation routines.
This option can be used to overload the default memory allocation routines
with a wrapper that simulations memory allocation failure or tracks
memory usage, for example.
.It SQLITE_CONFIG_MEMSTATUS
-This option takes single argument of type int, interpreted as a boolean,
-which enables or disables the collection of memory allocation statistics.
+The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int,
+interpreted as a boolean, which enables or disables the collection
+of memory allocation statistics.
When memory allocation statistics are disabled, the following SQLite
interfaces become non-operational:
.Bl -bullet
@@ -130,74 +139,84 @@
.It
sqlite3_soft_heap_limit64()
.It
-sqlite3_status()
+sqlite3_status64()
.El
.Pp
Memory allocation statistics are enabled by default unless SQLite is
compiled with SQLITE_DEFAULT_MEMSTATUS=0 in
which case memory allocation statistics are disabled by default.
.It SQLITE_CONFIG_SCRATCH
-This option specifies a static memory buffer that SQLite can use for
-scratch memory.
-There are three arguments: A pointer an 8-byte aligned memory buffer
-from which the scratch allocations will be drawn, the size of each
-scratch allocation (sz), and the maximum number of scratch allocations
-(N).
-The sz argument must be a multiple of 16.
+The SQLITE_CONFIG_SCRATCH option specifies a static memory buffer that
+SQLite can use for scratch memory.
+There are three arguments to SQLITE_CONFIG_SCRATCH: A pointer an 8-byte
+aligned memory buffer from which the scratch allocations will be drawn,
+the size of each scratch allocation (sz), and the maximum number of
+scratch allocations (N).
The first argument must be a pointer to an 8-byte aligned buffer of
at least sz*N bytes of memory.
-SQLite will use no more than two scratch buffers per thread.
-So N should be set to twice the expected maximum number of threads.
-SQLite will never require a scratch buffer that is more than 6 times
+SQLite will not use more than one scratch buffers per thread.
+SQLite will never request a scratch buffer that is more than 6 times
the database page size.
If SQLite needs needs additional scratch memory beyond what is provided
by this configuration option, then sqlite3_malloc()
-will be used to obtain the memory needed.
+will be used to obtain the memory needed.<p> When the application
+provides any amount of scratch memory using SQLITE_CONFIG_SCRATCH,
+SQLite avoids unnecessary large heap allocations.
+This can help prevent memory allocation failures
+due to heap fragmentation in low-memory embedded systems.
.It SQLITE_CONFIG_PAGECACHE
-This option specifies a static memory buffer that SQLite can use for
-the database page cache with the default page cache implementation.
-This configuration should not be used if an application-define page
-cache implementation is loaded using the SQLITE_CONFIG_PCACHE2 option.
-There are three arguments to this option: A pointer to 8-byte aligned
-memory, the size of each page buffer (sz), and the number of pages
-(N).
+The SQLITE_CONFIG_PAGECACHE option specifies a memory pool that SQLite
+can use for the database page cache with the default page cache implementation.
+This configuration option is a no-op if an application-define page
+cache implementation is loaded using the SQLITE_CONFIG_PCACHE2.
+There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to
+8-byte aligned memory (pMem), the size of each page cache line (sz),
+and the number of cache lines (N).
The sz argument should be the size of the largest database page (a
-power of two between 512 and 32768) plus a little extra for each page
-header.
-The page header size is 20 to 40 bytes depending on the host architecture.
-It is harmless, apart from the wasted memory, to make sz a little too
-large.
-The first argument should point to an allocation of at least sz*N bytes
-of memory.
-SQLite will use the memory provided by the first argument to satisfy
-its memory needs for the first N pages that it adds to cache.
+power of two between 512 and 65536) plus some extra bytes for each
+page header.
+The number of extra bytes needed by the page header can be determined
+using SQLITE_CONFIG_PCACHE_HDRSZ.
+It is harmless, apart from the wasted memory, for the sz parameter
+to be larger than necessary.
+The pMem argument must be either a NULL pointer or a pointer to an
+8-byte aligned block of memory of at least sz*N bytes, otherwise subsequent
+behavior is undefined.
+When pMem is not NULL, SQLite will strive to use the memory provided
+to satisfy page cache needs, falling back to sqlite3_malloc()
+if a page cache line is larger than sz bytes or if all of the pMem
+buffer is exhausted.
+If pMem is NULL and N is non-zero, then each database connection does
+an initial bulk allocation for page cache memory from sqlite3_malloc()
+sufficient for N cache lines if N is positive or of -1024*N bytes if
+N is negative, .
If additional page cache memory is needed beyond what is provided by
-this option, then SQLite goes to sqlite3_malloc() for
-the additional storage space.
-The pointer in the first argument must be aligned to an 8-byte boundary
-or subsequent behavior of SQLite will be undefined.
+the initial allocation, then SQLite goes to sqlite3_malloc()
+separately for each additional cache line.
.It SQLITE_CONFIG_HEAP
-This option specifies a static memory buffer that SQLite will use for
-all of its dynamic memory allocation needs beyond those provided for
-by SQLITE_CONFIG_SCRATCH and SQLITE_CONFIG_PAGECACHE.
-There are three arguments: An 8-byte aligned pointer to the memory,
-the number of bytes in the memory buffer, and the minimum allocation
-size.
+The SQLITE_CONFIG_HEAP option specifies a static memory buffer that
+SQLite will use for all of its dynamic memory allocation needs beyond
+those provided for by SQLITE_CONFIG_SCRATCH and
+SQLITE_CONFIG_PAGECACHE.
+The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled
+with either SQLITE_ENABLE_MEMSYS3 or SQLITE_ENABLE_MEMSYS5
+and returns SQLITE_ERROR if invoked otherwise.
+There are three arguments to SQLITE_CONFIG_HEAP: An 8-byte aligned
+pointer to the memory, the number of bytes in the memory buffer, and
+the minimum allocation size.
If the first pointer (the memory pointer) is NULL, then SQLite reverts
to using its default memory allocator (the system malloc() implementation),
undoing any prior invocation of SQLITE_CONFIG_MALLOC.
-If the memory pointer is not NULL and either SQLITE_ENABLE_MEMSYS3
-or SQLITE_ENABLE_MEMSYS5 are defined, then the
-alternative memory allocator is engaged to handle all of SQLites memory
-allocation needs.
+If the memory pointer is not NULL then the alternative memory allocator
+is engaged to handle all of SQLites memory allocation needs.
The first pointer (the memory pointer) must be aligned to an 8-byte
boundary or subsequent behavior of SQLite will be undefined.
The minimum allocation size is capped at 2**12.
Reasonable values for the minimum allocation size are 2**5 through
2**8.
.It SQLITE_CONFIG_MUTEX
-This option takes a single argument which is a pointer to an instance
-of the sqlite3_mutex_methods structure.
+The SQLITE_CONFIG_MUTEX option takes a single argument which is a pointer
+to an instance of the sqlite3_mutex_methods structure.
The argument specifies alternative low-level mutex routines to be used
in place the mutex routines built into SQLite.
SQLite makes a copy of the content of the sqlite3_mutex_methods
@@ -207,8 +226,9 @@
the build and hence calls to sqlite3_config() with
the SQLITE_CONFIG_MUTEX configuration option will return SQLITE_ERROR.
.It SQLITE_CONFIG_GETMUTEX
-This option takes a single argument which is a pointer to an instance
-of the sqlite3_mutex_methods structure.
+The SQLITE_CONFIG_GETMUTEX option takes a single argument which is
+a pointer to an instance of the sqlite3_mutex_methods
+structure.
The sqlite3_mutex_methods structure is filled
with the currently defined mutex routines.
This option can be used to overload the default mutex allocation routines
@@ -219,22 +239,22 @@
the build and hence calls to sqlite3_config() with
the SQLITE_CONFIG_GETMUTEX configuration option will return SQLITE_ERROR.
.It SQLITE_CONFIG_LOOKASIDE
-This option takes two arguments that determine the default memory allocation
-for the lookaside memory allocator on each database connection.
+The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine
+the default size of lookaside memory on each database connection.
The first argument is the size of each lookaside buffer slot and the
second is the number of slots allocated to each database connection.
-This option sets the <i>default</i> lookaside size.
-The SQLITE_DBCONFIG_LOOKASIDE verb to sqlite3_db_config()
+SQLITE_CONFIG_LOOKASIDE sets the <i>default</i> lookaside size.
+The SQLITE_DBCONFIG_LOOKASIDE option to sqlite3_db_config()
can be used to change the lookaside configuration on individual connections.
.It SQLITE_CONFIG_PCACHE2
-This option takes a single argument which is a pointer to an sqlite3_pcache_methods2
-object.
+The SQLITE_CONFIG_PCACHE2 option takes a single argument which is a
+pointer to an sqlite3_pcache_methods2 object.
This object specifies the interface to a custom page cache implementation.
-SQLite makes a copy of the object and uses it for page cache memory
-allocations.
+SQLite makes a copy of the sqlite3_pcache_methods2
+object.
.It SQLITE_CONFIG_GETPCACHE2
-This option takes a single argument which is a pointer to an sqlite3_pcache_methods2
-object.
+The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which is
+a pointer to an sqlite3_pcache_methods2 object.
SQLite copies of the current page cache implementation into that object.
.It SQLITE_CONFIG_LOG
The SQLITE_CONFIG_LOG option is used to configure the SQLite global
@@ -258,7 +278,8 @@
supplied by the application must not invoke any SQLite interface.
In a multi-threaded application, the application-defined logger function
must be threadsafe.
-.It SQLITE_CONFIG_URI This option takes a single argument of type int.
+.It SQLITE_CONFIG_URI The SQLITE_CONFIG_URI option takes a single argument
+of type int.
If non-zero, then URI handling is globally enabled.
If the parameter is zero, then URI handling is globally disabled.
If URI handling is globally enabled, all filenames passed to sqlite3_open(),
@@ -272,9 +293,10 @@
By default, URI handling is globally disabled.
The default value may be changed by compiling with the SQLITE_USE_URI
symbol defined.
-.It SQLITE_CONFIG_COVERING_INDEX_SCAN This option takes a single integer
-argument which is interpreted as a boolean in order to enable or disable
-the use of covering indices for full table scans in the query optimizer.
+.It SQLITE_CONFIG_COVERING_INDEX_SCAN The SQLITE_CONFIG_COVERING_INDEX_SCAN
+option takes a single integer argument which is interpreted as a boolean
+in order to enable or disable the use of covering indices for full
+table scans in the query optimizer.
The default setting is determined by the SQLITE_ALLOW_COVERING_INDEX_SCAN
compile-time option, or is "on" if that compile-time option is omitted.
The ability to disable the use of covering indices for full table scans
@@ -312,25 +334,50 @@
The default setting can be overridden by each database connection using
either the PRAGMA mmap_size command, or by using the
SQLITE_FCNTL_MMAP_SIZE file control.
-The maximum allowed mmap size cannot be changed at run-time.
-Nor may the maximum allowed mmap size exceed the compile-time maximum
-mmap size set by the SQLITE_MAX_MMAP_SIZE compile-time
-option.
+The maximum allowed mmap size will be silently truncated if necessary
+so that it does not exceed the compile-time maximum mmap size set by
+the SQLITE_MAX_MMAP_SIZE compile-time option.
If either argument to this option is negative, then that argument is
changed to its compile-time default.
-.It SQLITE_CONFIG_WIN32_HEAPSIZE This option is only available if SQLite
-is compiled for Windows with the SQLITE_WIN32_MALLOC
+.It SQLITE_CONFIG_WIN32_HEAPSIZE The SQLITE_CONFIG_WIN32_HEAPSIZE option
Home |
Main Index |
Thread Index |
Old Index