非常教程

Sqlite参考手册

C界面 | C Interface

Online Backup API

在线备份 API。

sqlite3_backup *sqlite3_backup_init(
  sqlite3 *pDest,                        /* Destination database handle */
  const char *zDestName,                 /* Destination database name */
  sqlite3 *pSource,                      /* Source database handle */
  const char *zSourceName                /* Source database name */
);
int sqlite3_backup_step(sqlite3_backup *p, int nPage);
int sqlite3_backup_finish(sqlite3_backup *p);
int sqlite3_backup_remaining(sqlite3_backup *p);
int sqlite3_backup_pagecount(sqlite3_backup *p);

备份 API 将一个数据库的内容复制到另一个数据库中。这对创建数据库备份或将内存数据库复制到永久文件或从永久文件复制非常有用。

另请参阅:使用 SQLite 联机备份 API

在备份操作期间,SQLite 会在目标数据库文件上保留一个写事务。源数据库仅在读取时被读锁定; 它不会为整个备份操作连续锁定。因此,可以在活动源数据库上执行备份,而不会阻止其他数据库连接在备份正在进行时读取或写入源数据库。

要执行备份操作:

  • sqlite3_backup_init()被调用一次来初始化备份,
  • sqlite3_backup_step()被调用一次或多次以在两个数据库之间传输数据,最后
  • 调用 sqlite3_backup_finish()以释放与备份操作关联的所有资源。

每次成功调用 sqlite3_backup_init()时,应该只有一次调用 sqlite3_backup_finish()。

sqlite3_backup_init()

sqlite3_backup_init(D,N,S,M)的 D 和 N 参数分别是与目标数据库和数据库名称关联的数据库连接。主数据库的数据库名称为 “main”,临时数据库为 “temp”,或者在附加数据库的 ATTACH 语句中的 AS 关键字之后指定的名称。传递给 sqlite3_backup_init(D,N,S,M)的 S 和 M 参数分别标识源数据库的数据库连接和数据库名称。源数据库和目标数据库连接(参数S和D)必须不同,否则 sqlite3_backup_init(D,N,S,M)将失败并显示错误。

如果在目标数据库上已经有读取或读写事务打开,则调用 sqlite3_backup_init()将失败,返回 NULL。

如果在 sqlite3_backup_init(D,N,S,M)中发生错误,则返回 NULL,并将错误代码和错误消息存储在目标数据库连接D中。调用 sqlite3_backup_init()失败的错误代码和消息可以可以使用 sqlite3_errcode(),sqlite3_errmsg()和/或 sqlite3_errmsg16()函数进行检索。成功调用 sqlite3_backup_init()会返回一个指向 sqlite3_backup 对象的指针。sqlite3_backup 对象可以与 sqlite3_backup_step()和 sqlite3_backup_finish()函数一起使用来执行指定的备份操作。

sqlite3_backup_step()

函数 sqlite3_backup_step(B,N)将在 sqlite3_backup 对象 B 指定的源数据库和目标数据库之间复制多达 N 个页面。如果 N 为负数,则会复制所有剩余的源页面。如果 sqlite3_backup_step(B,N)成功复制了 N 个页面,并且还有更多页面需要复制,则函数返回 SQLITE_OK。如果 sqlite3_backup_step(B,N)成功完成将所有页面从源文件复制到目标文件,则返回 SQLITE_DONE。如果在运行 sqlite3_backup_step(B,N)时发生错误,则返回错误代码。除了 SQLITE_OK和SQLITE_DONE,对 sqlite3_backup_step()的调用可能会返回 SQLITE_READONLY,SQLITE_NOMEM,SQLITE_BUSY,SQLITE_LOCKED 或 SQLITE_IOERR_XXX 扩展错误代码。

如果,sqlite3_backup_step()可能会返回 SQLITE_READONLY

  • 目标数据库以只读方式打开,或者
  • 目标数据库正在使用写预先日志日记功能,并且目标和源页面大小不同,或者
  • 目标数据库是内存数据库,目标和源页面大小不同。

如果 sqlite3_backup_step()无法获得所需的文件系统锁定,则调用 busy-handler函数(如果指定了)。如果 busy-handler在锁可用之前返回非零值,则 SQLITE_BUSY 返回给调用者。在这种情况下,可以稍后重试对 sqlite3_backup_step()的调用。如果在调用 sqlite3_backup_step()时使用源数据库连接写入源数据库,则立即返回 SQLITE_LOCKED。在这种情况下,再次调用 sqlite3_backup_step()可以重试。如果返回 SQLITE_IOERR_XXX,SQLITE_NOMEM 或 SQLITE_READONLY,那么重试对 sqlite3_backup_step()的调用没有意义。这些错误被认为是致命的。

第一次调用 sqlite3_backup_step()会获取目标文件的排它锁。直到调用 sqlite3_backup_finish()或备份操作完成并且 sqlite3_backup_step()返回 SQLITE_DONE,才会释放排它锁。每次调用 sqlite3_backup_step()都会在源数据库上获得一个持续 sqlite3_backup_step()调用持续时间的共享锁。由于源数据库在 sqlite3_backup_step()的调用之间没有锁定,源数据库可能会在备份过程的中途进行修改。如果源数据库被外部进程修改或通过除备份操作使用的数据库连接以外的数据库连接修改,则备份将在下次调用 sqlite3_backup_step()时自动重新启动。

sqlite3_backup_finish()

当 sqlite3_backup_step()返回 SQLITE_DONE 时,或者应用程序希望放弃备份操作时,应用程序应通过将 sqlite3_backup 传递给 sqlite3_backup_finish()来销毁 sqlite3_backup。sqlite3_backup_finish() 接口释放与 sqlite3_backup 对象关联的所有资源。如果 sqlite3_backup_step()尚未返回 SQLITE_DONE,则回滚目标数据库上的任何活动写入事务。sqlite3_backup 对象无效,可能在调用 sqlite3_backup_finish()后不能使用。

无论 sqlite3_backup_step()是否完成,如果没有发生 sqlite3_backup_step()错误,sqlite3_backup_finish 返回的值为 SQLITE_OK。如果在同一 sqlite3_backup 对象上的任何以前的 sqlite3_backup_step()调用期间发生内存不足或IO错误,则 sqlite3_backup_finish()将返回相应的错误代码。

从 sqlite3_backup_step()返回的 SQLITE_BUSY 或 SQLITE_LOCKED 不是一个永久性错误,也不会影响 sqlite3_backup_finish()的返回值。

sqlite3_backup_remaining()和 sqlite3_backup_pagecount()

sqlite3_backup_remaining()例程返回最近sqlite3_backup_step()结束时仍要备份的页数。sqlite3_backup_pagecount()例程在最近的sqlite3_backup_step()结束时返回源数据库中的页面总数。这些函数返回的值只能由 sqlite3_backup_step()更新。如果以更改源数据库大小或剩余页面数的方式修改源数据库,则这些更改不会反映在 sqlite3_backup_pagecount()和 sqlite3_backup_remaining()的输出中,直到下一个 sqlite3_backup_step()为止。

数据库句柄的并发使用

当备份操作正在进行或正在初始化时,源数据库连接可能会被应用程序用于其他目的。如果将 SQLite 编译并配置为支持线程安全数据库连接,则可以从其他线程中并发使用源数据库连接。

但是,应用程序必须保证在调用 sqlite3_backup_init()之后并且在对 sqlite3_backup_finish()的相应调用之前,目标数据库连接不会传递给任何其他 API(由任何线程)。SQLite 当前不检查应用程序是否错误地访问了目标数据库连接,因此没有报告错误代码,但操作可能会出现故障。正在进行备份时使用目标数据库连接也可能导致互斥锁死锁。

如果以共享缓存模式运行,应用程序必须保证在备份运行时不会访问目标数据库使用的共享缓存。在实践中,这意味着应用程序必须保证被备份的磁盘文件不被进程内的任何连接访问,而不仅仅是传递给 sqlite3_backup_init()的特定连接。

sqlite3_backup 对象本身部分是线程安全的。多个线程可以安全地对 sqlite3_backup_step()进行多个并发调用。但是,sqlite3_backup_remaining() 和 sqlite3_backup_pagecount()API 严格来说不是线程安全的。如果在另一个线程调用 sqlite3_backup_step()的同时调用它们,则可能返回无效值。

C界面 | C Interface相关

1.64-Bit Integer Types
2.A Handle To An Open BLOB
3.An Introduction To The SQLite C/C++ Interface
4.Application Defined Page Cache
5.Attempt To Free Heap Memory
6.Authorizer Action Codes
7.Authorizer Return Codes
8.Automatically Load Statically Linked Extensions
9.Binding Values To Prepared Statements
10.C/C++ Interface For SQLite Version 3
11.C/C++ Interface For SQLite Version 3 (old)
12.Cancel Automatic Extension Loading
13.Checkpoint a database
14.Checkpoint Mode Values
15.Close A BLOB Handle
16.Closing A Database Connection
17.Collation Needed Callbacks
18.Column Names In A Result Set
19.Commit And Rollback Notification Callbacks
20.Compare the ages of two snapshot handles
21.Compile-Time Authorization Callbacks
22.Compile-Time Library Version Numbers
23.Compiling An SQL Statement
24.Configuration Options
25.Configure an auto-checkpoint
26.Configure database connections
27.Configuring The SQLite Library
28.Conflict resolution modes
29.Constants Defining Special Destructor Behavior
30.Convenience Routines For Running Queries
31.Copy And Free SQL Values
32.Count The Number Of Rows Modified
33.Create Or Redefine SQL Functions
34.Custom Page Cache Object
35.Data Change Notification Callbacks
36.Database Connection Configuration Options
37.Database Connection For Functions
38.Database Connection Handle
39.Database Connection Status
40.Database Snapshot
41.Declare The Schema Of A Virtual Table
42.Declared Datatype Of A Query Result
43.Define New Collating Sequences
44.Deprecated Functions
45.Deprecated Soft Heap Limit Interface
46.Destroy A Prepared Statement Object
47.Destroy a snapshot
48.Determine if a database is read-only
49.Determine If A Prepared Statement Has Been Reset
50.Determine If An SQL Statement Is Complete
51.Determine If An SQL Statement Writes The Database
52.Determine The Virtual Table Conflict Policy
53.Device Characteristics
54.Dynamically Typed Value Object
55.Enable Or Disable Extended Result Codes
56.Enable Or Disable Extension Loading
57.Enable Or Disable Shared Pager Cache
58.Error Codes And Messages
59.Error Logging Interface
60.Evaluate An SQL Statement
61.Experimental Interfaces
62.Extended Result Codes
63.Extract Metadata About A Column Of A Table
64.File Locking Levels
65.Find The Database Handle Of A Prepared Statement
66.Find the next prepared statement
67.Finding The Subtype Of SQL Values
68.Flags For File Open Operations
69.Flags for the xAccess VFS method
70.Flags for the xShmLock VFS method
71.Flush caches to disk mid-transaction
72.Formatted String Printing Functions
73.Free Memory Used By A Database Connection
74.Function Auxiliary Data
75.Function Flags
76.Fundamental Datatypes
77.Impose A Limit On Heap Size
78.Index Of A Parameter With A Given Name
79.Initialize The SQLite Library
80.Interrupt A Long-Running Query
81.Introduction
82.Last Insert Rowid
83.List Of SQLite Constants
84.List Of SQLite Functions
85.List Of SQLite Objects
86.Load An Extension
87.Loadable Extension Thunk
88.Low-Level Control Of Database Files
89.Low-level system error code
90.Maximum xShmLock index
91.Memory Allocation Routines
92.Memory Allocation Subsystem
93.Memory Allocator Statistics
94.Move a BLOB Handle to a New Row
95.Mutex Handle
96.Mutex Methods Object
97.Mutex Types
98.Mutex Verification Routines
99.Mutexes
100.Name Of A Host Parameter
Sqlite

SQLite,是一款轻型的数据库,是遵守ACID的关系型数据库管理系统,它包含在一个相对小的C库中。它是D.RichardHipp建立的公有领域项目。它的设计目标是嵌入式的,而且目前已经在很多嵌入式产品中使用了它,它占用资源非常的低,在嵌入式设备中,可能只需要几百K的内存就够了。它能够支持Windows/Linux/Unix等等主流的操作系统,同时能够跟很多程序语言相结合,比如 Tcl、C#、PHP、Java等,还有ODBC接口,同样比起Mysql、PostgreSQL这两款开源的世界著名数据库管理系统来

主页 https://sqlite.org/
源码 https://www.sqlite.org/src/
发布版本 3.21.0

Sqlite目录

1.C界面 | C Interface
2.C Interface: Session Module
3.CLI
4.数据库文件表 | Database File Format
5.数据类 | Datatypes
6.动态内存分配 | Dynamic Memory Allocation
7.外键约束 | Foreign Key Constraints
8.全文索引 | Full-Text Search
9.损坏方式 | How To Corrupt
10.JSON
11.语言 | Language
12.局限性 | Limits
13.锁定和并发 | Locking and Concurrency
14.其他 | Miscellaneous
15.PRAGMA Statements
16.查询计划程序 | Query Planner
17.R*Tree Module
18.RBU Extension
19.语法图 | Syntax Diagrams
20.Tcl Interface
21.虚拟表机制 | Virtual Table Mechanism
22.预写日志 | Write-Ahead Logging
23.SQL 教程
24.SQL 简介
25.SQL 语法
26.SQL DELETE 语句
27.SQL UPDATE 语句
28.SQL NOT NULL 约束
29.SQL 约束
30.SQL CREATE TABLE 语句
31.SQL CREATE DATABASE 语句
32.SQL INSERT INTO SELECT 语句
33.SQL SELECT INTO 语句
34.SQL CREATE VIEW、REPLACE VIEW、 DROP VIEW 语句
35.SQL AUTO INCREMENT 字段
36.SQL ALTER TABLE 语句
37.SQL 撤销索引、表以及数据库
38.SQL CREATE INDEX 语句
39.SQL DEFAULT 约束
40.SQL CHECK 约束
41.SQL FOREIGN KEY 约束
42.SQL PRIMARY KEY 约束
43.SQL UNIQUE 约束
44.SQL 通用数据类型
45.SQL ISNULL()、NVL()、IFNULL() 和 COALESCE() 函数
46.SQL NULL 值 – IS NULL 和 IS NOT NULL
47.SQL Server 和 MySQL 中的 Date 函数
48.SQL MS Access、MySQL 和 SQL Server 数据类型
49.SQL 函数
50.SQL 总结
51.SQL 主机
52.SQL 快速参考
53.SQL ROUND() 函数
54.SQL Server GETDATE() 函数
55.MySQL DATE_FORMAT() 函数
56.MySQL DATEDIFF() 函数
57.MySQL DATE_SUB() 函数
58.MySQL DATE_ADD() 函数
59.MySQL EXTRACT() 函数
60.MySQL DATE() 函数
61.MySQL CURTIME() 函数
62.MySQL CURDATE() 函数
63.MySQL NOW() 函数
64.SQL Server CONVERT() 函数
65.SQL Server DATEDIFF() 函数
66.SQL Server DATEADD() 函数
67.SQL Server DATEPART() 函数
68.SQLite 命令
69.SQLite 安装
70.SQLite 简介
71.SQLite 运算符
72.SQLite Select 语句
73.SQLite 删除表
74.SQLite 创建表
75.SQLite Insert 语句
76.SQLite 分离数据库
77.SQLite 附加数据库
78.SQLite 创建数据库
79.SQLite 数据类型
80.SQLite 语法
81.SQLite Order By
82.SQLite Limit 子句
83.SQLite Glob 子句
84.SQLite Like 子句
85.SQLite Delete 语句
86.SQLite Update 语句
87.SQLite AND/OR 运算符
88.SQLite Where 子句
89.SQLite 表达式
90.SQLite Distinct 关键字
91.SQLite Having 子句
92.SQLite Group By
93.SQLite Join
94.SQLite 约束
95.SQLite PRAGMA
96.SQLite 事务
97.SQLite 视图
98.SQLite Truncate Table
99.SQLite Alter 命令
100.SQLite Indexed By