Library Reference

version 2.110.0

Internal API

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page.Requires a signed-in GitHub account. This works well for small changes.If you'd like to make larger changes you may want to consider usinga local clone.

etc.c.sqlite3

enum stringSQLITE_VERSION; enum intSQLITE_VERSION_NUMBER; enum stringSQLITE_SOURCE_ID;

CAPI3REFCompile-Time Library Version Numbers

immutable(char)*sqlite3_version; nothrow immutable(char)*sqlite3_libversion(); nothrow immutable(char)*sqlite3_sourceid(); nothrow intsqlite3_libversion_number();

CAPI3REFRun-Time Library Version Numbers

nothrow intsqlite3_compileoption_used(const char*zOptName); nothrow immutable(char)*sqlite3_compileoption_get(intN);

CAPI3REFRun-Time Library Compilation Options Diagnostics

nothrow intsqlite3_threadsafe();

CAPI3REFTest To See If The Library Is Threadsafe

structsqlite3;

CAPI3REFDatabase Connection Handle

aliassqlite3_int64 = long;

aliassqlite3_uint64 = ulong;

nothrow intsqlite3_close(sqlite3*);

CAPI3REFClosing A Database Connection

aliassqlite3_callback = extern (C) int function(void*, int, char**, char**) nothrow;

The type for a callback function. This is legacy and deprecated. It is included for historical compatibility and is not documented.

nothrow intsqlite3_exec(sqlite3*, const(char)*sql, int function(void*, int, char**, char**)callback, void*, char**errmsg);

CAPI3REFOne-Step Query Execution Interface

SQLITE_OK

Successful result

SQLITE_ERROR

Ditto

Generic error

SQLITE_INTERNAL

Internal logic error in SQLite

SQLITE_PERM

Access permission denied

SQLITE_ABORT

Callback routine requested an abort

SQLITE_BUSY

The database file is locked

SQLITE_LOCKED

A table in the database is locked

SQLITE_NOMEM

A malloc() failed

SQLITE_READONLY

Attempt to write a readonly database

SQLITE_INTERRUPT

Operation terminated by sqlite3_interrupt()

SQLITE_IOERR

Some kind of disk I/O error occurred

SQLITE_CORRUPT

The database disk image is malformed

SQLITE_NOTFOUND

Unknown opcode in sqlite3_file_control()

SQLITE_FULL

Insertion failed because database is full

SQLITE_CANTOPEN

Unable to open the database file

SQLITE_PROTOCOL

Database lock protocol error

SQLITE_EMPTY

Internal use only

SQLITE_SCHEMA

The database schema changed

SQLITE_TOOBIG

String or BLOB exceeds size limit

SQLITE_CONSTRAINT

Abort due to constraint violation

SQLITE_MISMATCH

Data type mismatch

SQLITE_MISUSE

Library used incorrectly

SQLITE_NOLFS

Uses OS features not supported on host

SQLITE_AUTH

Authorization denied

SQLITE_FORMAT

Not used

SQLITE_RANGE

2nd parameter to sqlite3_bind out of range

SQLITE_NOTADB

File opened that is not a database file

SQLITE_ROW

sqlite3_step() has another row ready

SQLITE_DONE

sqlite3_step() has finished executing

SQLITE_OPEN_READONLY

Ok for sqlite3_open_v2()

SQLITE_OPEN_READWRITE

Ok for sqlite3_open_v2()

SQLITE_OPEN_CREATE

Ok for sqlite3_open_v2()

SQLITE_OPEN_DELETEONCLOSE

VFS only

SQLITE_OPEN_EXCLUSIVE

VFS only

SQLITE_OPEN_AUTOPROXY

VFS only

SQLITE_OPEN_URI

Ok for sqlite3_open_v2()

SQLITE_OPEN_MEMORY

Ok for sqlite3_open_v2()

SQLITE_OPEN_MAIN_DB

VFS only

SQLITE_OPEN_TEMP_DB

VFS only

SQLITE_OPEN_TRANSIENT_DB

VFS only

SQLITE_OPEN_MAIN_JOURNAL

VFS only

SQLITE_OPEN_TEMP_JOURNAL

VFS only

SQLITE_OPEN_SUBJOURNAL

VFS only

SQLITE_OPEN_SUPER_JOURNAL

VFS only

SQLITE_OPEN_NOMUTEX

Ok for sqlite3_open_v2()

SQLITE_OPEN_FULLMUTEX

Ok for sqlite3_open_v2()

SQLITE_OPEN_SHAREDCACHE

Ok for sqlite3_open_v2()

SQLITE_OPEN_PRIVATECACHE

Ok for sqlite3_open_v2()

SQLITE_OPEN_WAL

VFS only

SQLITE_OPEN_NOFOLLOW

Ok for sqlite3_open_v2()

deprecated aliasSQLITE_OPEN_MASTER_JOURNAL = SQLITE_OPEN_SUPER_JOURNAL;

VFS only

structsqlite3_file;

CAPI3REFOS Interface Open File Handle

structsqlite3_io_methods;

CAPI3REFOS Interface File Virtual Methods Object

structsqlite3_mutex;

CAPI3REFMutex Handle

structsqlite3_api_routines;

CAPI3REFLoadable Extension Thunk

aliasxDlSymReturn = extern (C) void* function() nothrow; aliassqlite3_syscall_ptr = extern (C) void function() nothrow;

CAPI3REFOS Interface Object

SQLITE_ACCESS_READWRITE

Used by PRAGMA temp_store_directory

SQLITE_ACCESS_READ

Unused

enum intSQLITE_SHM_NLOCK;

CAPI3REFMaximum xShmLock index

nothrow intsqlite3_initialize(); nothrow intsqlite3_shutdown(); nothrow intsqlite3_os_init(); nothrow intsqlite3_os_end();

CAPI3REFInitialize The SQLite Library

nothrow intsqlite3_config(int, ...);

CAPI3REFConfiguring The SQLite Library

nothrow intsqlite3_db_config(sqlite3*, intop, ...);

CAPI3REFConfigure database connections

structsqlite3_mem_methods;

CAPI3REFMemory Allocation Routines

void* function(int)xMalloc;: Memory allocation function
void function(void*)xFree;: Free a prior allocation
void* function(void*, int)xRealloc;: Resize an allocation
int function(void*)xSize;: Return the size of an allocation
int function(int)xRoundup;: Round up request size to allocation size
int function(void*)xInit;: Initialize the memory allocator
void function(void*)xShutdown;: Deinitialize the memory allocator
void*pAppData;: Argument to xInit() and xShutdown()

SQLITE_CONFIG_SINGLETHREAD

nil

SQLITE_CONFIG_MULTITHREAD

nil

SQLITE_CONFIG_SERIALIZED

nil

SQLITE_CONFIG_MALLOC

sqlite3_mem_methods*

SQLITE_CONFIG_GETMALLOC

sqlite3_mem_methods*

SQLITE_CONFIG_SCRATCH

No longer used

SQLITE_CONFIG_PAGECACHE

void*, int sz, int N

SQLITE_CONFIG_HEAP

void*, int nByte, int min

SQLITE_CONFIG_MEMSTATUS

boolean

SQLITE_CONFIG_MUTEX

sqlite3_mutex_methods*

SQLITE_CONFIG_GETMUTEX

sqlite3_mutex_methods*

SQLITE_CONFIG_LOOKASIDE

int int

SQLITE_CONFIG_PCACHE

no-op

SQLITE_CONFIG_GETPCACHE

no-op

SQLITE_CONFIG_LOG

xFunc, void*

SQLITE_CONFIG_URI

int

SQLITE_CONFIG_PCACHE2

sqlite3_pcache_methods2*

SQLITE_CONFIG_GETPCACHE2

sqlite3_pcache_methods2*

SQLITE_CONFIG_COVERING_INDEX_SCAN

int

SQLITE_CONFIG_SQLLOG

xSqllog, void*

SQLITE_CONFIG_MMAP_SIZE

sqlite3_int64, sqlite3_int64

SQLITE_CONFIG_WIN32_HEAPSIZE

int nByte

SQLITE_CONFIG_PCACHE_HDRSZ

int *psz

SQLITE_CONFIG_PMASZ

unsigned int szPma

SQLITE_CONFIG_STMTJRNL_SPILL

int nByte

SQLITE_CONFIG_SMALL_MALLOC

boolean

SQLITE_CONFIG_SORTERREF_SIZE

int nByte

SQLITE_CONFIG_MEMDB_MAXSIZE

sqlite3_int64

SQLITE_DBCONFIG_MAINDBNAME

const char*

SQLITE_DBCONFIG_LOOKASIDE

void* int int

SQLITE_DBCONFIG_ENABLE_FKEY

int int*

SQLITE_DBCONFIG_ENABLE_TRIGGER

int int*

SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER

int int*

SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION

int int*

SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE

int int*

SQLITE_DBCONFIG_ENABLE_QPSG

int int*

SQLITE_DBCONFIG_TRIGGER_EQP

int int*

SQLITE_DBCONFIG_RESET_DATABASE

int int*

SQLITE_DBCONFIG_DEFENSIVE

int int*

SQLITE_DBCONFIG_WRITABLE_SCHEMA

int int*

SQLITE_DBCONFIG_LEGACY_ALTER_TABLE

int int*

SQLITE_DBCONFIG_DQS_DML

int int*

SQLITE_DBCONFIG_DQS_DDL

int int*

SQLITE_DBCONFIG_ENABLE_VIEW

int int*

SQLITE_DBCONFIG_LEGACY_FILE_FORMAT

int int*

SQLITE_DBCONFIG_TRUSTED_SCHEMA

int int*

SQLITE_DBCONFIG_MAX

Largest DBCONFIG

nothrow intsqlite3_extended_result_codes(sqlite3*, intonoff);

CAPI3REFEnable Or Disable Extended Result Codes

nothrow sqlite3_int64sqlite3_last_insert_rowid(sqlite3*);

CAPI3REFLast Insert Rowid

nothrow voidsqlite3_set_last_insert_rowid(sqlite3*, sqlite3_int64);

CAPI3REFSet the Last Insert Rowid value

nothrow intsqlite3_changes(sqlite3*);

CAPI3REFCount The Number Of Rows Modified

nothrow intsqlite3_total_changes(sqlite3*);

CAPI3REFTotal Number Of Rows Modified

nothrow voidsqlite3_interrupt(sqlite3*);

CAPI3REFInterrupt A Long-Running Query

nothrow intsqlite3_complete(const char*sql); nothrow intsqlite3_complete16(const void*sql);

CAPI3REFDetermine If An SQL Statement Is Complete

nothrow intsqlite3_busy_handler(sqlite3*, int function(void*, int), void*);

CAPI3REFRegister A Callback To Handle SQLITE_BUSY Errors

nothrow intsqlite3_busy_timeout(sqlite3*, intms);

CAPI3REFSet A Busy Timeout

nothrow intsqlite3_get_table(sqlite3*db, const(char)*zSql, char***pazResult, int*pnRow, int*pnColumn, char**pzErrmsg);

CAPI3REFConvenience Routines For Running Queries

nothrow voidsqlite3_free_table(char**result);

nothrow char*sqlite3_mprintf(const char*, ...);

CAPI3REFFormatted String Printing Functions

nothrow void*sqlite3_malloc(int); nothrow void*sqlite3_malloc64(sqlite3_uint64); nothrow void*sqlite3_realloc(void*, int); nothrow void*sqlite3_realloc64(void*, sqlite3_uint64); nothrow voidsqlite3_free(void*); nothrow sqlite3_uint64sqlite3_msize(void*);

CAPI3REFMemory Allocation Subsystem

nothrow sqlite3_int64sqlite3_memory_used();

CAPI3REFMemory Allocator Statistics

nothrow voidsqlite3_randomness(intN, void*P);

CAPI3REFPseudo-Random Number Generator

nothrow intsqlite3_set_authorizer(sqlite3*, int function(void*, int, const char*, const char*, const char*, const char*)xAuth, void*pUserData);

CAPI3REFCompile-Time Authorization Callbacks

SQLITE_DENY

Abort the SQL statement with an error

SQLITE_IGNORE

Don't allow access, but don't generate an error

SQLITE_CREATE_INDEX

Index Name Table Name

SQLITE_CREATE_TABLE

Table Name NULL

SQLITE_CREATE_TEMP_INDEX

Index Name Table Name

SQLITE_CREATE_TEMP_TABLE

Table Name NULL

SQLITE_CREATE_TEMP_TRIGGER

Trigger Name Table Name

SQLITE_CREATE_TEMP_VIEW

View Name NULL

SQLITE_CREATE_TRIGGER

Trigger Name Table Name

SQLITE_CREATE_VIEW

View Name NULL

SQLITE_DELETE

Table Name NULL

SQLITE_DROP_INDEX

Index Name Table Name

SQLITE_DROP_TABLE

Table Name NULL

SQLITE_DROP_TEMP_INDEX

Index Name Table Name

SQLITE_DROP_TEMP_TABLE

Table Name NULL

SQLITE_DROP_TEMP_TRIGGER

Trigger Name Table Name

SQLITE_DROP_TEMP_VIEW

View Name NULL

SQLITE_DROP_TRIGGER

Trigger Name Table Name

SQLITE_DROP_VIEW

View Name NULL

SQLITE_INSERT

Table Name NULL

SQLITE_PRAGMA

Pragma Name 1st arg or NULL

SQLITE_READ

Table Name Column Name

SQLITE_SELECT

NULL NULL

SQLITE_TRANSACTION

Operation NULL

SQLITE_UPDATE

Table Name Column Name

SQLITE_ATTACH

Filename NULL

SQLITE_DETACH

Database Name NULL

SQLITE_ALTER_TABLE

Database Name Table Name

SQLITE_REINDEX

Index Name NULL

SQLITE_ANALYZE

Table Name NULL

SQLITE_CREATE_VTABLE

Table Name Module Name

SQLITE_DROP_VTABLE

Table Name Module Name

SQLITE_FUNCTION

NULL Function Name

SQLITE_SAVEPOINT

Operation Savepoint Name

SQLITE_COPY

No longer used

SQLITE_RECURSIVE

NULL NULL

deprecated nothrow void*sqlite3_trace(sqlite3*, void function(void*, const char*)xTrace, void*); deprecated nothrow void*sqlite3_profile(sqlite3*, void function(void*, const char*, sqlite3_uint64)xProfile, void*);

CAPI3REFTracing And Profiling Functions

nothrow intsqlite3_trace_v2(sqlite3*, uintuMask, int function(uint, void*, void*, void*)xCallback, void*pCtx);

CAPI3REFSQL Trace Hook

nothrow voidsqlite3_progress_handler(sqlite3*, int, int function(void*), void*);

CAPI3REFQuery Progress Callbacks

nothrow intsqlite3_open(const(char)*filename, sqlite3**ppDb);

nothrow intsqlite3_open16(const(void)*filename, sqlite3**ppDb);

nothrow intsqlite3_open_v2(const(char)*filename, sqlite3**ppDb, intflags, const(char)*zVfs);

nothrow intsqlite3_uri_boolean(const(char)*zFile, const(char)*zParam, intbDefault);

nothrow sqlite3_int64sqlite3_uri_int64(const char*, const char*, sqlite3_int64);

nothrow const(char)*sqlite3_uri_key(const(char)*zFilename, intN);

nothrow const(char)*sqlite3_filename_journal(const(char)*);

nothrow const(char)*sqlite3_filename_wal(const(char)*);

nothrow voidsqlite3_free_filename(char*);

CAPI3REFOpening A New Database Connection

nothrow intsqlite3_errcode(sqlite3*db); nothrow intsqlite3_extended_errcode(sqlite3*db); nothrow const(char)*sqlite3_errmsg(sqlite3*); nothrow const(void)*sqlite3_errmsg16(sqlite3*); nothrow const(char)*sqlite3_errstr(int);

CAPI3REFError Codes And Messages

structsqlite3_stmt;

CAPI3REFSQL Statement Object

nothrow intsqlite3_limit(sqlite3*, intid, intnewVal);

CAPI3REFRun-time Limits

nothrow intsqlite3_prepare(sqlite3*db, const(char)*zSql, intnByte, sqlite3_stmt**ppStmt, const(char*)*pzTail);

nothrow intsqlite3_prepare_v2(sqlite3*db, const(char)*zSql, intnByte, sqlite3_stmt**ppStmt, const(char*)*pzTail);

nothrow intsqlite3_prepare_v3(sqlite3*db, const(char)*zSql, intnByte, uintprepFlags, sqlite3_stmt**ppStmt, const(char*)*pzTail);

nothrow intsqlite3_prepare16(sqlite3*db, const(void)*zSql, intnByte, sqlite3_stmt**ppStmt, const(void*)*pzTail);

nothrow intsqlite3_prepare16_v2(sqlite3*db, const(void)*zSql, intnByte, sqlite3_stmt**ppStmt, const(void*)*pzTail);

nothrow intsqlite3_prepare16_v3(sqlite3*db, const(void)*zSql, intnByte, uintprepFlags, sqlite3_stmt**ppStmt, const(void*)*pzTail);

CAPI3REFCompiling An SQL Statement

nothrow const(char)*sqlite3_sql(sqlite3_stmt*pStmt); nothrow char*sqlite3_expanded_sql(sqlite3_stmt*pStmt);

CAPI3REFRetrieving Statement SQL

nothrow intsqlite3_stmt_busy(sqlite3_stmt*);

CAPI3REFDetermine If A Prepared Statement Has Been Reset

structsqlite3_value;

CAPI3REFDynamically Typed Value Object

structsqlite3_context;

CAPI3REFSQL Function Context Object

nothrow intsqlite3_bind_blob(sqlite3_stmt*, int, const void*, intn, void function(void*)); nothrow intsqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64, void function(void*)); nothrow intsqlite3_bind_double(sqlite3_stmt*, int, double); nothrow intsqlite3_bind_int(sqlite3_stmt*, int, int); nothrow intsqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); nothrow intsqlite3_bind_null(sqlite3_stmt*, int); nothrow intsqlite3_bind_text(sqlite3_stmt*, int, const char*, intn, void function(void*)); nothrow intsqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void function(void*)); nothrow intsqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64, void function(void*), ubyteencoding); nothrow intsqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); nothrow intsqlite3_bind_zeroblob(sqlite3_stmt*, int, intn); nothrow intsqlite3_bind_zeroblob64(sqlite3_stmt*, int, sqlite3_uint64n);

CAPI3REFBinding Values To Prepared Statements

nothrow intsqlite3_bind_parameter_count(sqlite3_stmt*);

CAPI3REFNumber Of SQL Parameters

nothrow const(char)*sqlite3_bind_parameter_name(sqlite3_stmt*, int);

CAPI3REFName Of A Host Parameter

nothrow intsqlite3_bind_parameter_index(sqlite3_stmt*, const char*zName);

CAPI3REFIndex Of A Parameter With A Given Name

nothrow intsqlite3_clear_bindings(sqlite3_stmt*);

CAPI3REFReset All Bindings On A Prepared Statement

nothrow intsqlite3_column_count(sqlite3_stmt*pStmt);

CAPI3REFNumber Of Columns In A Result Set

nothrow const(char)*sqlite3_column_name(sqlite3_stmt*, intN); nothrow const(void)*sqlite3_column_name16(sqlite3_stmt*, intN);

CAPI3REFColumn Names In A Result Set

nothrow const(char)*sqlite3_column_database_name(sqlite3_stmt*, int); nothrow const(void)*sqlite3_column_database_name16(sqlite3_stmt*, int); nothrow const(char)*sqlite3_column_table_name(sqlite3_stmt*, int); nothrow const(void)*sqlite3_column_table_name16(sqlite3_stmt*, int); nothrow const(char)*sqlite3_column_origin_name(sqlite3_stmt*, int); nothrow const(void)*sqlite3_column_origin_name16(sqlite3_stmt*, int);

CAPI3REFSource Of Data In A Query Result

nothrow const(char)*sqlite3_column_decltype(sqlite3_stmt*, int); nothrow const(void)*sqlite3_column_decltype16(sqlite3_stmt*, int);

CAPI3REFDeclared Datatype Of A Query Result

nothrow intsqlite3_step(sqlite3_stmt*);

CAPI3REFEvaluate An SQL Statement

nothrow intsqlite3_data_count(sqlite3_stmt*pStmt);

CAPI3REFNumber of columns in a result set

nothrow const(void)*sqlite3_column_blob(sqlite3_stmt*, intiCol); nothrow doublesqlite3_column_double(sqlite3_stmt*, intiCol); nothrow intsqlite3_column_int(sqlite3_stmt*, intiCol); nothrow sqlite3_int64sqlite3_column_int64(sqlite3_stmt*, intiCol); nothrow const(char)*sqlite3_column_text(sqlite3_stmt*, intiCol); nothrow const(void)*sqlite3_column_text16(sqlite3_stmt*, intiCol); nothrow sqlite3_value*sqlite3_column_value(sqlite3_stmt*, intiCol); nothrow intsqlite3_column_bytes(sqlite3_stmt*, intiCol); nothrow intsqlite3_column_bytes16(sqlite3_stmt*, intiCol); nothrow intsqlite3_column_type(sqlite3_stmt*, intiCol);

CAPI3REFResult Values From A Query

nothrow intsqlite3_finalize(sqlite3_stmt*pStmt);

CAPI3REFDestroy A Prepared Statement Object

nothrow intsqlite3_reset(sqlite3_stmt*pStmt);

CAPI3REFReset A Prepared Statement Object

nothrow intsqlite3_create_function(sqlite3*db, const(char)*zFunctionName, intnArg, inteTextRep, void*pApp, void function(sqlite3_context*, int, sqlite3_value**)xFunc, void function(sqlite3_context*, int, sqlite3_value**)xStep, void function(sqlite3_context*)xFinal);

nothrow intsqlite3_create_function16(sqlite3*db, const(void)*zFunctionName, intnArg, inteTextRep, void*pApp, void function(sqlite3_context*, int, sqlite3_value**)xFunc, void function(sqlite3_context*, int, sqlite3_value**)xStep, void function(sqlite3_context*)xFinal);

nothrow intsqlite3_create_function_v2(sqlite3*db, const(char)*zFunctionName, intnArg, inteTextRep, void*pApp, void function(sqlite3_context*, int, sqlite3_value**)xFunc, void function(sqlite3_context*, int, sqlite3_value**)xStep, void function(sqlite3_context*)xFinal, void function(void*)xDestroy);

nothrow intsqlite3_create_window_function(sqlite3*db, const(char)*zFunctionName, intnArg, inteTextRep, void*pApp, void function(sqlite3_context*, int, sqlite3_value**)xStep, void function(sqlite3_context*)xFinal, void function(sqlite3_context*)xValue, void function(sqlite3_context*, int, sqlite3_value**)xInverse, void function(void*)xDestroy);

CAPI3REFCreate Or Redefine SQL Functions

SQLITE_UTF8

IMPR-37514-35566

SQLITE_UTF16LE

IMPR-03371-37637

SQLITE_UTF16BE

IMPR-51971-34154

SQLITE_UTF16

Use native byte order

SQLITE_ANY

sqlite3_create_function only

SQLITE_UTF16_ALIGNED

sqlite3_create_collation only

enum intSQLITE_DETERMINISTIC;

CAPI3REFFunction Flags

deprecated nothrow intsqlite3_aggregate_count(sqlite3_context*);

CAPI3REFDeprecated Functions

nothrow const(void)*sqlite3_value_blob(sqlite3_value*); nothrow intsqlite3_value_bytes(sqlite3_value*); nothrow intsqlite3_value_bytes16(sqlite3_value*); nothrow doublesqlite3_value_double(sqlite3_value*); nothrow intsqlite3_value_int(sqlite3_value*); nothrow sqlite3_int64sqlite3_value_int64(sqlite3_value*); nothrow const(char)*sqlite3_value_text(sqlite3_value*); nothrow const(void)*sqlite3_value_text16(sqlite3_value*); nothrow const(void)*sqlite3_value_text16le(sqlite3_value*); nothrow const(void)*sqlite3_value_text16be(sqlite3_value*); nothrow intsqlite3_value_type(sqlite3_value*); nothrow intsqlite3_value_numeric_type(sqlite3_value*); nothrow intsqlite3_value_nochange(sqlite3_value*); nothrow intsqlite3_value_frombind(sqlite3_value*);

CAPI3REFObtaining SQL Function Parameter Values

nothrow void*sqlite3_aggregate_context(sqlite3_context*, intnBytes);

CAPI3REFObtain Aggregate Function Context

nothrow void*sqlite3_user_data(sqlite3_context*);

CAPI3REFUser Data For Functions

nothrow sqlite3*sqlite3_context_db_handle(sqlite3_context*);

CAPI3REFDatabase Connection For Functions

nothrow void*sqlite3_get_auxdata(sqlite3_context*, intN); nothrow voidsqlite3_set_auxdata(sqlite3_context*, intN, void*, void function(void*));

CAPI3REFFunction Auxiliary Data

aliassqlite3_destructor_type = extern (C) void function(void*) nothrow;

CAPI3REFConstants Defining Special Destructor Behavior

nothrow voidsqlite3_result_blob(sqlite3_context*, const void*, int, void function(void*)); nothrow voidsqlite3_result_blob64(sqlite3_context*, const void*, sqlite3_uint64, void function(void*)); nothrow voidsqlite3_result_double(sqlite3_context*, double); nothrow voidsqlite3_result_error(sqlite3_context*, const char*, int); nothrow voidsqlite3_result_error16(sqlite3_context*, const void*, int); nothrow voidsqlite3_result_error_toobig(sqlite3_context*); nothrow voidsqlite3_result_error_nomem(sqlite3_context*); nothrow voidsqlite3_result_error_code(sqlite3_context*, int); nothrow voidsqlite3_result_int(sqlite3_context*, int); nothrow voidsqlite3_result_int64(sqlite3_context*, sqlite3_int64); nothrow voidsqlite3_result_null(sqlite3_context*); nothrow voidsqlite3_result_text(sqlite3_context*, const char*, int, void function(void*)); nothrow voidsqlite3_result_text64(sqlite3_context*, const char*, sqlite3_uint64, void function(void*), ubyteencoding); nothrow voidsqlite3_result_text16(sqlite3_context*, const void*, int, void function(void*)); nothrow voidsqlite3_result_text16le(sqlite3_context*, const void*, int, void function(void*)); nothrow voidsqlite3_result_text16be(sqlite3_context*, const void*, int, void function(void*)); nothrow voidsqlite3_result_value(sqlite3_context*, sqlite3_value*); nothrow voidsqlite3_result_zeroblob(sqlite3_context*, intn); nothrow intsqlite3_result_zeroblob64(sqlite3_context*, sqlite3_uint64n);

CAPI3REFSetting The Result Of An SQL Function

nothrow intsqlite3_create_collation(sqlite3*, const(char)*zName, inteTextRep, void*pArg, int function(void*, int, const void*, int, const void*)xCompare); nothrow intsqlite3_create_collation_v2(sqlite3*, const(char)*zName, inteTextRep, void*pArg, int function(void*, int, const void*, int, const void*)xCompare, void function(void*)xDestroy); nothrow intsqlite3_create_collation16(sqlite3*, const(void)*zName, inteTextRep, void*pArg, int function(void*, int, const void*, int, const void*)xCompare);

CAPI3REFDefine New Collating Sequences

nothrow intsqlite3_collation_needed(sqlite3*, void*, void function(void*, sqlite3*, int eTextRep, const char*)); nothrow intsqlite3_collation_needed16(sqlite3*, void*, void function(void*, sqlite3*, int eTextRep, const void*));

CAPI3REFCollation Needed Callbacks

nothrow voidsqlite3_activate_cerod(const(char)*zPassPhrase);

Specify the activation key for a CEROD database. Unless activated, none of the CEROD routines will work.

nothrow intsqlite3_sleep(int);

CAPI3REFSuspend Execution For A Short Time

char*sqlite3_temp_directory;

CAPI3REFName Of The Folder Holding Temporary Files

char*sqlite3_data_directory;

CAPI3REFName Of The Folder Holding Database Files

nothrow intsqlite3_win32_set_directory(c_ulongtype, void*zValue); nothrow intsqlite3_win32_set_directory8(c_ulongtype, void*zValue); nothrow intsqlite3_win32_set_directory16(c_ulongtype, void*zValue);

CAPI3REFWin32 Specific Interface

nothrow intsqlite3_get_autocommit(sqlite3*);

CAPI3REFTest For Auto-Commit Mode

nothrow sqlite3*sqlite3_db_handle(sqlite3_stmt*);

CAPI3REFFind The Database Handle Of A Prepared Statement

nothrow const(char)*sqlite3_db_filename(sqlite3*db, const char*zDbName);

CAPI3REFReturn The Filename For A Database Connection

nothrow intsqlite3_db_readonly(sqlite3*db, const char*zDbName);

CAPI3REFDetermine if a database is read-only

nothrow void*sqlite3_commit_hook(sqlite3*, int function(void*), void*); nothrow void*sqlite3_rollback_hook(sqlite3*, void function(void*), void*);

CAPI3REFCommit And Rollback Notification Callbacks

nothrow void*sqlite3_update_hook(sqlite3*, void function(void*, int, char*, char*, sqlite3_int64), void*);

CAPI3REFData Change Notification Callbacks

nothrow intsqlite3_enable_shared_cache(int);

CAPI3REFEnable Or Disable Shared Pager Cache

nothrow intsqlite3_release_memory(int);

CAPI3REFAttempt To Free Heap Memory

nothrow intsqlite3_db_release_memory(sqlite3*);

CAPI3REFFree Memory Used By A Database Connection

deprecated nothrow voidsqlite3_soft_heap_limit(intN);

CAPI3REFDeprecated Soft Heap Limit Interface

nothrow intsqlite3_table_column_metadata(sqlite3*db, const(char)*zDbName, const(char)*zTableName, const(char)*zColumnName, char**pzDataType, char**pzCollSeq, int*pNotNull, int*pPrimaryKey, int*pAutoinc);

CAPI3REFExtract Metadata About A Column Of A Table

nothrow intsqlite3_load_extension(sqlite3*db, const(char)*zFile, const(char)*zProc, char**pzErrMsg);

CAPI3REFLoad An Extension

nothrow intsqlite3_enable_load_extension(sqlite3*db, intonoff);

CAPI3REFEnable Or Disable Extension Loading

nothrow intsqlite3_auto_extension(void function()xEntryPoint);

CAPI3REFAutomatically Load Statically Linked Extensions

nothrow intsqlite3_cancel_auto_extension(void function()xEntryPoint);

CAPI3REFCancel Automatic Extension Loading

nothrow voidsqlite3_reset_auto_extension();

CAPI3REFReset Automatic Extension Loading

aliasmapFunction = extern (C) void function(sqlite3_context*, int, sqlite3_value**) nothrow;

structsqlite3_module;

The interface to the virtual-table mechanism is currently considered to be experimental. The interface might change in incompatible ways. If this is a problem for you, do not use the interface at this time.

When the virtual-table mechanism stabilizes, we will declare the interface fixed, support it indefinitely, and remove this comment.

CAPI3REFVirtual Table Object

structsqlite3_index_info;

CAPI3REFVirtual Table Indexing Information

intnConstraint;: Number of entries in aConstraint
sqlite3_index_constraint*aConstraint;: Table of WHERE clause constraints
intnOrderBy;: Number of terms in the ORDER BY clause
sqlite3_index_orderby*aOrderBy;: The ORDER BY clause
intidxNum;: Number used to identify the index
char*idxStr;: String, possibly obtained from sqlite3_malloc
intneedToFreeIdxStr;: Free idxStr using sqlite3_free() if true
intorderByConsumed;: True if output is already ordered
doubleestimatedCost;: Estimated cost of using this index

nothrow intsqlite3_create_module(sqlite3*db, const(char)*zName, const(sqlite3_module)*p, void*pClientData); nothrow intsqlite3_create_module_v2(sqlite3*db, const(char)*zName, const(sqlite3_module)*p, void*pClientData, void function(void*)xDestroy);

CAPI3REFRegister A Virtual Table Implementation

nothrow intsqlite3_drop_modules(sqlite3*db, const(char*)*azKeep);

CAPI3REFRemove Unnecessary Virtual Table Implementations

structsqlite3_vtab;

CAPI3REFVirtual Table Instance Object

const(sqlite3_module)*pModule;: The module for this virtual table
intnRef;: NO LONGER USED
char*zErrMsg;: Error message from sqlite3_mprintf()

structsqlite3_vtab_cursor;

CAPI3REFVirtual Table Cursor Object

sqlite3_vtab*pVtab;: Virtual table of this cursor

nothrow intsqlite3_declare_vtab(sqlite3*, const char*zSQL);

CAPI3REFDeclare The Schema Of A Virtual Table

nothrow intsqlite3_overload_function(sqlite3*, const char*zFuncName, intnArg);

CAPI3REFOverload A Function For A Virtual Table

structsqlite3_blob;

The interface to the virtual-table mechanism defined above (back up to a comment remarkably similar to this one) is currently considered to be experimental. The interface might change in incompatible ways. If this is a problem for you, do not use the interface at this time.

When the virtual-table mechanism stabilizes, we will declare the interface fixed, support it indefinitely, and remove this comment.

nothrow intsqlite3_blob_open(sqlite3*, const(char)*zDb, const(char)*zTable, const(char)*zColumn, sqlite3_int64iRow, intflags, sqlite3_blob**ppBlob);

CAPI3REFOpen A BLOB For Incremental I/O

nothrow intsqlite3_blob_reopen(sqlite3_blob*, sqlite3_int64);

CAPI3REFMove a BLOB Handle to a New Row

nothrow intsqlite3_blob_close(sqlite3_blob*);

CAPI3REFClose A BLOB Handle

nothrow intsqlite3_blob_bytes(sqlite3_blob*);

CAPI3REFReturn The Size Of An Open BLOB

nothrow intsqlite3_blob_read(sqlite3_blob*, void*Z, intN, intiOffset);

CAPI3REFRead Data From A BLOB Incrementally

nothrow intsqlite3_blob_write(sqlite3_blob*, const void*z, intn, intiOffset);

CAPI3REFWrite Data Into A BLOB Incrementally

nothrow sqlite3_vfs*sqlite3_vfs_find(const char*zVfsName); nothrow intsqlite3_vfs_register(sqlite3_vfs*, intmakeDflt); nothrow intsqlite3_vfs_unregister(sqlite3_vfs*);

CAPI3REFVirtual File System Objects

nothrow sqlite3_mutex*sqlite3_mutex_alloc(int); nothrow voidsqlite3_mutex_free(sqlite3_mutex*); nothrow voidsqlite3_mutex_enter(sqlite3_mutex*); nothrow intsqlite3_mutex_try(sqlite3_mutex*); nothrow voidsqlite3_mutex_leave(sqlite3_mutex*);

CAPI3REFMutexes

structsqlite3_mutex_methods;

CAPI3REFMutex Methods Object

nothrow intsqlite3_mutex_held(sqlite3_mutex*); nothrow intsqlite3_mutex_notheld(sqlite3_mutex*);

CAPI3REFMutex Verification Routines

SQLITE_MUTEX_STATIC_MEM

sqlite3_malloc()

SQLITE_MUTEX_STATIC_MEM2

NOT USED

SQLITE_MUTEX_STATIC_OPEN

sqlite3BtreeOpen()

SQLITE_MUTEX_STATIC_PRNG

sqlite3_randomness()

SQLITE_MUTEX_STATIC_LRU

lru page list

SQLITE_MUTEX_STATIC_LRU2

NOT USED

SQLITE_MUTEX_STATIC_PMEM

sqlite3PageMalloc()

SQLITE_MUTEX_STATIC_APP1

For use by application

SQLITE_MUTEX_STATIC_APP2

For use by application

SQLITE_MUTEX_STATIC_APP3

For use by application

SQLITE_MUTEX_STATIC_VFS1

For use by built-in VFS

SQLITE_MUTEX_STATIC_VFS2

For use by extension VFS

SQLITE_MUTEX_STATIC_VFS3

For use by application VFS

nothrow sqlite3_mutex*sqlite3_db_mutex(sqlite3*);

CAPI3REFRetrieve the mutex for a database connection

nothrow intsqlite3_file_control(sqlite3*, const char*zDbName, intop, void*);

CAPI3REFLow-Level Control Of Database Files

nothrow intsqlite3_test_control(intop, ...);

CAPI3REFTesting Interface

SQLITE_TESTCTRL_PRNG_RESET

NOT USED

SQLITE_TESTCTRL_RESERVE

NOT USED

SQLITE_TESTCTRL_ISKEYWORD

NOT USED

SQLITE_TESTCTRL_SCRATCHMALLOC

NOT USED

SQLITE_TESTCTRL_EXPLAIN_STMT

NOT USED

SQLITE_TESTCTRL_LAST

Largest TESTCTRL

nothrow intsqlite3_keyword_count(); nothrow intsqlite3_keyword_name(int, const(char*)*, int*); nothrow intsqlite3_keyword_check(const(char)*, int);

CAPI3REFSQL Keyword Checking

structsqlite3_str;

CAPI3REFDynamic String Object

nothrow sqlite3_str*sqlite3_str_new(sqlite3*);

CAPI3REFCreate A New Dynamic String Object

nothrow char*sqlite3_str_finish(sqlite3_str*);

CAPI3REFFinalize A Dynamic String

nothrow voidsqlite3_str_appendf(sqlite3_str*, const(char)*zFormat, ...); nothrow voidsqlite3_str_vappendf(sqlite3_str*, const(char)*zFormat, va_list); nothrow voidsqlite3_str_append(sqlite3_str*, const(char)*zIn, intN); nothrow voidsqlite3_str_appendall(sqlite3_str*, const(char)*zIn); nothrow voidsqlite3_str_appendchar(sqlite3_str*, intN, charC); nothrow voidsqlite3_str_reset(sqlite3_str*);

CAPI3REFAdd Content To A Dynamic String

nothrow intsqlite3_str_errcode(sqlite3_str*);

CAPI3REFStatus Of A Dynamic String

nothrow intsqlite3_status(intop, int*pCurrent, int*pHighwater, intresetFlag); nothrow intsqlite3_status64(intop, long*pCurrent, long*pHighwater, intresetFlag);

CAPI3REFSQLite Runtime Status

SQLITE_STATUS_SCRATCH_USED

NOT USED

SQLITE_STATUS_SCRATCH_OVERFLOW

NOT USED

SQLITE_STATUS_SCRATCH_SIZE

NOT USED

nothrow intsqlite3_db_status(sqlite3*, intop, int*pCur, int*pHiwtr, intresetFlg);

CAPI3REFDatabase Connection Status

SQLITE_DBSTATUS_MAX

Largest defined DBSTATUS

nothrow intsqlite3_stmt_status(sqlite3_stmt*, intop, intresetFlg);

CAPI3REFPrepared Statement Status

structsqlite3_pcache;

CAPI3REFCustom Page Cache Object

structsqlite3_pcache_page;

CAPI3REFCustom Page Cache Object

structsqlite3_pcache_methods2;

CAPI3REFApplication Defined Page Cache.

structsqlite3_backup;

CAPI3REFOnline Backup Object

nothrow sqlite3_backup*sqlite3_backup_init(sqlite3*pDest, const(char)*zDestName, sqlite3*pSource, const(char)*zSourceName); nothrow intsqlite3_backup_step(sqlite3_backup*p, intnPage); nothrow intsqlite3_backup_finish(sqlite3_backup*p); nothrow intsqlite3_backup_remaining(sqlite3_backup*p); nothrow intsqlite3_backup_pagecount(sqlite3_backup*p);

CAPI3REFOnline Backup API.

nothrow intsqlite3_unlock_notify(sqlite3*pBlocked, void function(void** apArg, int nArg)xNotify, void*pNotifyArg);

CAPI3REFUnlock Notification

nothrow intsqlite3_stricmp(const char*, const char*);

CAPI3REFString Comparison

nothrow voidsqlite3_log(intiErrCode, const char*zFormat, ...);

CAPI3REFError Logging Interface

nothrow void*sqlite3_wal_hook(sqlite3*, int function(void*, sqlite3*, const char*, int), void*);

CAPI3REFWrite-Ahead Log Commit Hook

nothrow intsqlite3_wal_autocheckpoint(sqlite3*db, intN);

CAPI3REFConfigure an auto-checkpoint

nothrow intsqlite3_wal_checkpoint(sqlite3*db, const char*zDb);

CAPI3REFCheckpoint a database

nothrow intsqlite3_wal_checkpoint_v2(sqlite3*db, const(char)*zDb, inteMode, int*pnLog, int*pnCkpt);

CAPI3REFCheckpoint a database

enum intSQLITE_VTAB_CONSTRAINT_SUPPORT;

nothrow intsqlite3_preupdate_old(sqlite3*, int, sqlite3_value**);

nothrow intsqlite3_preupdate_count(sqlite3*);

nothrow intsqlite3_preupdate_depth(sqlite3*);

nothrow intsqlite3_preupdate_new(sqlite3*, int, sqlite3_value**);

CAPI3REFVirtual Table Configuration Options

nothrow intsqlite3_rtree_geometry_callback(sqlite3*db, const(char)*zGeom, int function(sqlite3_rtree_geometry*, int nCoord, double* aCoord, int* pRes)xGeom, void*pContext);

SELECT ... FROM <rtree> WHERE <rtree col> MATCH zGeom(... params ...)

structsqlite3_rtree_geometry;

A pointer to a structure of the following type is passed as the first argument to callbacks registered using rtree_geometry_callback().

void*pContext;: Copy of pContext passed to s_r_g_c()
intnParam;: Size of array aParam[]
double*aParam;: Parameters passed to SQL geom function
void*pUser;: Callback implementation user data
void function(void*)xDelUser;: Called by SQLite to clean up pUser

NOT_WITHIN

Object completely outside of query region

PARTLY_WITHIN

Object partially overlaps query region

FULLY_WITHIN

nothrow intsqlite3changeset_start_v2(sqlite3_changeset_iter**pp, intnChangeset, void*pChangeset, intflags);

nothrow intsqlite3changeset_apply_v2(sqlite3*db, intnChangeset, void*pChangeset, int function(void*pCtx, const(char)* zTab)xFilter, int function(void*pCtx, int eConflict, sqlite3_changeset_iter* p)xConflict, void*pCtx, void**ppRebase, int*pnRebase, intflags);

nothrow intsqlite3changeset_apply_v2_strm(sqlite3*db, int function(void*pIn, void* pData, int* pnData)xInput, void*pIn, int function(void*pCtx, const(char)* zTab)xFilter, int function(void*pCtx, int eConflict, sqlite3_changeset_iter* p)xConflict, void*pCtx, void**ppRebase, int*pnRebase, intflags);

nothrow intsqlite3changeset_concat_strm(int function(void* pIn, void* pData, int* pnData)xInputA, void*pInA, int function(void* pIn, void* pData, int* pnData)xInputB, void*pInB, int function(void*pOut, const(void)* pData, int nData)xOutput, void*pOut);

nothrow intsqlite3changeset_invert_strm(int function(void*pIn, void* pData, int* pnData)xInput, void*pIn, int function(void*pOut, const(void)* pData, int nData)xOutput, void*pOut);

nothrow intsqlite3changeset_start_strm(sqlite3_changeset_iter**pp, int function(void*pIn, void* pData, int* pnData)xInput, void*pIn);

nothrow intsqlite3changeset_start_v2_strm(sqlite3_changeset_iter**pp, int function(void*pIn, void* pData, int* pnData)xInput, void*pIn, intflags);

nothrow intsqlite3session_changeset_strm(sqlite3_session*pSession, int function(void*pOut, const(void)* pData, int nData)xOutput, void*pOut);

nothrow intsqlite3session_patchset_strm(sqlite3_session*pSession, int function(void*pOut, const(void)* pData, int nData)xOutput, void*pOut);

nothrow intsqlite3changegroup_add_strm(sqlite3_changegroup*, int function(void*pIn, void* pData, int* pnData)xInput, void*pIn);

nothrow intsqlite3changegroup_output_strm(sqlite3_changegroup*, int function(void*pOut, const(void)* pData, int nData)xOutput, void*pOut);

nothrow intsqlite3rebaser_rebase_strm(sqlite3_rebaser*pRebaser, int function(void*pIn, void* pData, int* pnData)xInput, void*pIn, int function(void*pOut, const(void)* pData, int nData)xOutput, void*pOut);

Object fully contained within query region

structFts5Context;

aliasfts5_extension_function = extern (C) void function(const(Fts5ExtensionApi*) pApi, Fts5Context* pFts, sqlite3_context* pCtx, int nVal, sqlite3_value** apVal) nothrow;

structFts5PhraseIter;

structFts5ExtensionApi;

structFts5Tokenizer;

enum intFTS5_TOKENIZE_QUERY;

enum intFTS5_TOKENIZE_PREFIX;

enum intFTS5_TOKENIZE_DOCUMENT;

enum intFTS5_TOKENIZE_AUX;

enum intFTS5_TOKEN_COLOCATED;

structfts5_api;

Interfaces to extend FTS5.

Movatterモバイル変換

Library Reference

etc.c.sqlite3