标准文件控制操作码

Small. Fast. Reliable.
Choose any three.

SQLite C接口

标准文件控制操作码

＃定义SQLITE_FCNTL_LOCKSTATE 1
＃定义SQLITE_FCNTL_GET_LOCKPROXYFILE 2
＃定义SQLITE_FCNTL_SET_LOCKPROXYFILE 3
＃定义SQLITE_FCNTL_LAST_ERRNO 4
＃定义SQLITE_FCNTL_SIZE_HINT 5
＃定义SQLITE_FCNTL_CHUNK_SIZE 6
＃定义SQLITE_FCNTL_FILE_POINTER 7
＃定义SQLITE_FCNTL_SYNC_OMITTED 8
＃定义SQLITE_FCNTL_WIN32_AV_RETRY 9
＃定义SQLITE_FCNTL_PERSIST_WAL 10
＃定义SQLITE_FCNTL_OVERWRITE 11
＃定义SQLITE_FCNTL_VFSNAME 12
＃定义SQLITE_FCNTL_POWERSAFE_OVERWRITE 13
＃定义SQLITE_FCNTL_PRAGMA 14
＃定义SQLITE_FCNTL_BUSYHANDLER 15
＃定义SQLITE_FCNTL_TEMPFILENAME 16
＃定义SQLITE_FCNTL_MMAP_SIZE 18
＃定义SQLITE_FCNTL_TRACE 19
＃定义SQLITE_FCNTL_HAS_MOVED 20
＃定义SQLITE_FCNTL_SYNC 21
＃定义SQLITE_FCNTL_COMMIT_PHASETWO 22
＃定义SQLITE_FCNTL_WIN32_SET_HANDLE 23
＃定义SQLITE_FCNTL_WAL_BLOCK 24
＃定义SQLITE_FCNTL_ZIPVFS 25
＃定义SQLITE_FCNTL_RBU 26
＃定义SQLITE_FCNTL_VFS_POINTER 27
＃定义SQLITE_FCNTL_JOURNAL_POINTER 28
＃定义SQLITE_FCNTL_WIN32_GET_HANDLE 29
＃定义SQLITE_FCNTL_PDB 30
＃定义SQLITE_FCNTL_BEGIN_ATOMIC_WRITE 31
＃定义SQLITE_FCNTL_COMMIT_ATOMIC_WRITE 32
＃定义SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE 33
＃定义SQLITE_FCNTL_LOCK_TIMEOUT 34
＃定义SQLITE_FCNTL_DATA_VERSION 35
＃定义SQLITE_FCNTL_SIZE_LIMIT 36
＃定义SQLITE_FCNTL_CKPT_DONE 37
＃定义SQLITE_FCNTL_RESERVE_BYTES 38
＃定义SQLITE_FCNTL_CKPT_START 39

这些整数常量是sqlite3_io_methods对象的xFileControl方法和sqlite3_file_control（）接口的操作码。

该SQLITE_FCNTL_LOCKSTATE操作码用于调试。此操作码使xFileControl方法将锁的当前状态（SQLITE_LOCK_NONE，SQLITE_LOCK_SHARED， SQLITE_LOCK_RESERVED，SQLITE_LOCK_PENDING或SQLITE_LOCK_EXCLUSIVE之一）写入pArg参数指向的整数。此功能在测试期间使用，仅在使用SQLITE_TEST编译时选项时可用。
该SQLITE_FCNTL_SIZE_HINT操作码使用的SQLite给予VFS层的数据库文件将如何大发展是当前交易中的提示。此提示不能保证准确，但通常很接近。底层的VFS可能会基于此提示选择预分配数据库文件空间，以帮助更快地写入数据库文件。
所述SQLITE_FCNTL_SIZE_LIMIT操作码所使用的内存VFS实现sqlite3_deserialize（）来设置上界内存数据库的大小。该参数是一个指向sqlite3_int64的指针。如果所指向的整数是负数，则将其填充为当前限制。否则，将限制设置为所指向的整数的值和当前数据库大小中的较大者。指向的整数设置为新的限制。
所述SQLITE_FCNTL_CHUNK_SIZE操作码被用来请求该VFS延伸并截断在由用户指定的尺寸的块中的数据库文件。sqlite3_file_control（）的第四个参数应指向一个整数（类型为int），该整数包含要用于提名数据库的新块大小。大量分配数据库文件空间（例如一次分配1MB）可以减少文件系统的碎片并提高某些系统上的性能。
所述SQLITE_FCNTL_FILE_POINTER操作码被用来获得一个指针sqlite3_file与特定的数据库连接相关联的对象。另请参见SQLITE_FCNTL_JOURNAL_POINTER。
所述SQLITE_FCNTL_JOURNAL_POINTER操作码被用来获得一个指针sqlite3_file与轴颈文件（或者相关联的对象回滚日志或预写日志特定数据库连接）。另请参见SQLITE_FCNTL_FILE_POINTER。
不再使用。
所述SQLITE_FCNTL_SYNC操作码SQLite内部产生并立即XSYNC方法上的数据库文件描述符调用之前发送到VFS。或者，如果未调用xSync方法，因为用户已使用PRAGMAynchronous = OFF配置了SQLite，则它将代替xSync方法被调用。在大多数情况下，与此文件控件一起传递的指针参数为NULL。但是，如果数据库文件作为多数据库提交的一部分进行同步，则该参数指向一个以nul终止的字符串，其中包含事务超级日志文件名。不需要此信号的VFS应静默忽略此操作码。应用程序不应调用sqlite3_file_control（）这样做可能会破坏确实需要它的专用VFS的运行。
该SQLITE_FCNTL_COMMIT_PHASETWO操作码SQLite内部生成并发送至VFS之后事务已立即提交，但数据库被解锁之前。不需要此信号的VFS应静默忽略此操作码。应用程序不应使用此操作码调用 sqlite3_file_control（），因为这样做可能会破坏需要它的专用VFS的运行。
该SQLITE_FCNTL_WIN32_AV_RETRY操作码用于配置某些磁盘自动重试次数和时间间隔为Windows I / O操作VFS为了在存在防病毒程序的情况下提供强大的功能。默认情况下，Windows VFS将重试文件读取，文件写入和文件删除操作最多10次，第一次重试之前的延迟为25毫秒，并且每次后续重试的延迟都会增加25毫秒。此操作码允许调整这两个值（10次重试和25毫秒的延迟）。在同一过程中，所有数据库连接的值都会更改。参数是一个指向两个整数的数组的指针，其中第一个整数是新的重试计数，第二个整数是延迟。如果任一整数为负，则不更改设置，而是将该设置的先前值写入数组条目，从而可以查询当前的重试设置。
该SQLITE_FCNTL_PERSIST_WAL操作码是用来设置或查询持续预写日志设置。默认情况下，与数据库的最新连接关闭时，将自动删除用于事务控制的辅助预写日志（WAL文件）和共享内存文件。设置持久性WAL模式会导致这些文件在关闭后仍然存在。当对包含数据库文件的目录没有写权限的其他进程希望读取数据库文件时，持久保留文件非常有用，因为必须存在WAL和共享内存文件才能使数据库可读。sqlite3_file_control（）的第四个参数这个操作码应该是一个指向整数的指针。该整数是0以禁用持久性WAL模式或1以启用持久性WAL模式。如果整数为-1，则将使用当前的WAL持久性设置覆盖它。
该SQLITE_FCNTL_POWERSAFE_OVERWRITE操作码是用来设置或查询老大难“powersafe重写”或“PSOW”设置。PSOW设置确定xDeviceCharacteristics方法的SQLITE_IOCAP_POWERSAFE_OVERWRITE位。此操作码的sqlite3_file_control（）的第四个参数应为指向整数的指针。该整数是0以禁用零损坏模式，或为1以启用零损坏模式。如果整数为-1，则将使用当前的零损坏模式设置覆盖它。
该SQLITE_FCNTL_OVERWRITE操作码被打开的SQLite写事务，以表明，除非它被回退由于某些原因后调用，整个数据库文件将被覆盖当前事务。VACUUM操作使用它。
该SQLITE_FCNTL_VFSNAME操作码可用于获取所有的名字VFSes在VFS栈。名称是所有VFS填充的名称，最终的底层VFS将写入从sqlite3_malloc（）获得的内存中，并将结果存储在sqlite3_file_control（）的第四个参数指向的char *变量中。完成后，调用方负责释放内存。与所有文件控制操作一样，不能保证此操作实际上会做任何事情。如果未实现此文件控件，则调用者应将char *变量初始化为NULL指针。此文件控件仅用于诊断用途。
该SQLITE_FCNTL_VFS_POINTER操作码找到一个指向顶层 VFSes当前正在使用。sqlite3_file_control（db，SQLITE_FCNTL_VFS_POINTER，X）中的参数X必须为“ sqlite3_vfs **”类型。该操作码会将* X设置为指向顶级VFS的指针。当堆栈中有多个VFS垫片时，此操作码仅查找最上方的垫片。
每当解析PRAGMA语句时，都会将SQLITE_FCNTL_PRAGMA 文件控件发送到与pragma语句所引用的数据库文件相对应的打开的sqlite3_file对象。SQLITE_FCNTL_PRAGMA文件控件的参数是一个指向字符串（char **）的指针的数组，其中数组的第二个元素是编译指示的名称，第三个元素是编译指示的参数；如果该编译指示没有，则为NULL争论。SQLITE_FCNTL_PRAGMA文件控件的处理程序可以选择使char **参数的第一个元素指向从sqlite3_mprintf（）获得的字符串。或等效项，并且如果该编译指示失败，则该字符串将成为该编译指示或错误消息的结果。如果 SQLITE_FCNTL_PRAGMA文件控件返回SQLITE_NOTFOUND，则正常的 PRAGMA处理将继续。如果SQLITE_FCNTL_PRAGMA 文件控件返回SQLITE_OK，则解析器假定VFS已经处理了PRAGMA本身，并且如果结果字符串为NULL，则解析器将生成无操作准备好的语句；如果该字符串为非，则解析器将返回结果字符串的副本。 -空值。如果SQLITE_FCNTL_PRAGMA文件控件返回SQLITE_OK或SQLITE_NOTFOUND以外的任何结果代码，这意味着VFS在处理PRAGMA时遇到错误，并且PRAGMA的编译失败并显示错误。该SQLITE_FCNTL_PRAGMA 文件控制发生在编译报表分析的开始，所以它能够覆盖内置PRAGMA语句。
该SQLITE_FCNTL_BUSYHANDLER 文件控制可通过SQLite的它是为了提供一个自定义的VFS能够访问连接繁忙的处理程序回调打开后不久，数据库文件句柄调用。参数的类型为（void **）-两个（void *）值的数组。第一个（void *）实际上指向类型为（int（*）（void *））的函数。为了调用连接的busy-handler，应使用数组中的第二个（void *）作为唯一参数来调用此函数。如果返回非零值，则应重试该操作。如果返回零，则自定义VFS应该放弃当前操作。
应用程序可以调用SQLITE_FCNTL_TEMPFILENAME文件控件，以使SQLite使用与生成TEMP表和其他内部使用的临时文件名相同的算法来生成临时文件名。参数应为char **，其中将填充从sqlite3_malloc（）获得的写入内存的文件名。调用方应在结果上调用sqlite3_free（）以避免内存泄漏。
所述SQLITE_FCNTL_MMAP_SIZE文件控制用于查询或设置将被用于的最大字节数目的存储器映射I / O。该参数是一个指向sqlite3_int64类型的值的指针，该值是文件到内存映射中建议的最大字节数。指针将被旧值覆盖。如果最初指向的值是负数，则不会更改该限制，因此可以通过传递一个指向负数的指针来查询当前限制。此文件控件在内部用于实现PRAGMA mmap_size。
该SQLITE_FCNTL_TRACE文件控制提供咨询信息，以什么SQLite的栈的高层正在做的VFS。一些VFS活动跟踪补片使用此文件控件。参数是一个以零结尾的字符串。如果启用了SQLITE_USE_FCNTL_TRACE编译时选项，则SQLite堆栈中的较高层可能会生成此文件控件的实例。
所述SQLITE_FCNTL_HAS_MOVED文件控制解释它的参数的指针为一个整数，并将其写入一个布尔值到根据文件是否不是整数已被重命名，移动或删除，因为它第一次打开。
所述SQLITE_FCNTL_WIN32_GET_HANDLE操作码可被用于获得与文件句柄相关联的底层本地文件句柄。此文件控件将其参数解释为指向本机文件句柄的指针，并将结果值写入该文件句柄。
该SQLITE_FCNTL_WIN32_SET_HANDLE操作码用于调试。此操作码使xFileControl方法将文件句柄与pArg参数指向的文件句柄交换。此功能在测试期间使用，仅在定义SQLITE_TEST时才需要支持。
所述SQLITE_FCNTL_WAL_BLOCK是一个信号到VFS层，如果锁不是立即可用，可能有利的是在下一WAL锁块。WAL子系统在极少数情况下会发出此信号，以解决优先级反转的问题。应用程序应该不使用此文件控制。
该SQLITE_FCNTL_ZIPVFS操作码仅由zipvfs实现。所有其他VFS都应为此操作码返回SQLITE_NOTFOUND。
该SQLITE_FCNTL_RBU操作码是由只有RBU扩展使用了特殊的VFS实现。所有其他VFS都应为此操作码返回SQLITE_NOTFOUND。
如果SQLITE_FCNTL_BEGIN_ATOMIC_WRITE操作码返回SQLITE_OK，则文件描述符将置于“批量写入模式”，这意味着所有后续写入操作都将在下一个SQLITE_FCNTL_COMMIT_ATOMIC_WRITE上进行自动推迟。不支持批量原子写入的系统将返回SQLITE_NOTFOUND。成功执行SQLITE_FCNTL_BEGIN_ATOMIC_WRITE之后，在关闭SQLITE_FCNTL_COMMIT_ATOMIC_WRITE或 SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE之前，SQLite不会在同一sqlite3_file文件描述符上进行任何VFS接口调用，除了使用SQLITE_FHITE_ZET_ZET_SIZE的SQLF_HINT_ZET_SIZE函数使用SQLITE_FHITE_ZETSIZE。
该SQLITE_FCNTL_COMMIT_ATOMIC_WRITE操作码会导致所有的写操作，因为以前的成功调用 SQLITE_FCNTL_BEGIN_ATOMIC_WRITE以原子执行。当且仅当所有写入均已成功执行并且已提交到持久性存储中时，此文件控件才返回SQLITE_OK。无论是否成功，此文件控件都会使文件描述符脱离批写模式，以便所有后续写操作都是独立的。如果没有事先成功调用SQLITE_FCNTL_BEGIN_ATOMIC_WRITE，SQLite将永远不会调用SQLITE_FCNTL_COMMIT_ATOMIC_WRITE。
该SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE操作码会导致所有的写操作，因为以前的成功调用 SQLITE_FCNTL_BEGIN_ATOMIC_WRITE回滚。此文件控件使文件描述符脱离批写模式，因此所有后续写操作都是独立的。没有事先成功调用SQLITE_FCNTL_BEGIN_ATOMIC_WRITE，SQLite将永远不会调用SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE。
所述SQLITE_FCNTL_LOCK_TIMEOUT操作码用于配置一个VFS到块多达M个毫秒试图获得使用VFS的XLOCK或xShmLock方法文件锁时失效之前。该参数是一个指向32位带符号整数的指针，该整数包含M的设置值。返回之前，32位带符号整数将被先前的M值覆盖。
该SQLITE_FCNTL_DATA_VERSION操作码用以检测更改的数据库文件。该参数是指向32位无符号整数的指针。寻呼机的“数据版本”被写入指针。每当对相应的数据库文件进行任何更改时，“数据版本”都会更改，或者通过同一数据库连接上的SQL语句，或者通过可能在其他进程中由单独的数据库连接提交的事务来更改。该sqlite3_total_changes（）接口，可用于查找如果连接上的任何数据库已更改，但是该接口响应在TEMP变化以及主并没有提供一种机制来检测对仅MAIN。另外， sqlite3_total_changes（）接口仅响应内部更改，而忽略其他数据库连接所做的更改。的 PRAGMA data_version命令提供了一种机制来检测变化的发生是由于其他数据库连接的单个附加的数据库，但是省略通过改变在其上它被称为数据库连接实现。此文件控件是检测内部或外部发生的更改以及与特定附加数据库关联的更改的唯一机制。
该SQLITE_FCNTL_CKPT_START客户端开始从沃尔玛文件到数据库文件复制页面之前操作码是从沃尔玛模式关卡中调用。
该SQLITE_FCNTL_CKPT_DONE操作码是从沃尔玛模式检查点的客户端从沃尔玛文件到数据库文件复制完成后的页面中调用，但* -shm文件被更新，以记录的网页已设置检查点的事实面前。

另请参见对象，常量和函数的列表。