etc.c.sqlite3 - Phobos documentation

* Change the key on an open database. If the current database is not * encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the * database is decrypted. * * The code to implement this API is not available in the public release * of SQLite.

void sqlite3_activate_see(const(char)* zPassPhrase);

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

void sqlite3_activate_cerod(const(char)* zPassPhrase);

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

int sqlite3_sleep(int);

* CAPI3REF: Suspend Execution For A Short Time

char* sqlite3_temp_directory;

* CAPI3REF: Name Of The Folder Holding Temporary Files

int sqlite3_get_autocommit(sqlite3*);

* CAPI3REF: Test For Auto-Commit Mode

sqlite3* sqlite3_db_handle(sqlite3_stmt*);

* CAPI3REF: Find The Database Handle Of A Prepared Statement

sqlite3_stmt* sqlite3_next_stmt(sqlite3* pDb, sqlite3_stmt* pStmt);

* CAPI3REF: Find the next prepared statement

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

* CAPI3REF: Commit And Rollback Notification Callbacks

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

* CAPI3REF: Data Change Notification Callbacks

int sqlite3_enable_shared_cache(int);

* CAPI3REF: Enable Or Disable Shared Pager Cache

int sqlite3_release_memory(int);

* CAPI3REF: Attempt To Free Heap Memory

sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);

* CAPI3REF: Impose A Limit On Heap Size

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

* CAPI3REF: Extract Metadata About A Column Of A Table

int sqlite3_load_extension(sqlite3* db, const(char)* zFile, const(char)* zProc, char** pzErrMsg);

* CAPI3REF: Load An Extension

int sqlite3_enable_load_extension(sqlite3* db, int onoff);

* CAPI3REF: Enable Or Disable Extension Loading

int sqlite3_auto_extension(void function() xEntryPoint);

* CAPI3REF: Automatically Load Statically Linked Extensions

void sqlite3_reset_auto_extension();

* CAPI3REF: Reset Automatic Extension Loading

alias mapFunction = extern (C) void function(sqlite3_context*, int, sqlite3_value**);
struct sqlite3_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.

* CAPI3REF: Virtual Table Object

struct sqlite3_index_info;

* CAPI3REF: Virtual Table Indexing Information

int nConstraint;

Number of entries in aConstraint

sqlite3_index_constraint* aConstraint;

Table of WHERE clause constraints

int nOrderBy;

Number of terms in the ORDER BY clause

sqlite3_index_orderby* aOrderBy;

The ORDER BY clause

int idxNum;

Number used to identify the index

char* idxStr;

String, possibly obtained from sqlite3_malloc

int needToFreeIdxStr;

Free idxStr using sqlite3_free() if true

int orderByConsumed;

True if output is already ordered

double estimatedCost;

Estimated cost of using this index

int SQLITE_INDEX_CONSTRAINT_EQ;

* CAPI3REF: Virtual Table Constraint Operator Codes

int SQLITE_INDEX_CONSTRAINT_GT;

* CAPI3REF: Virtual Table Constraint Operator Codes

int SQLITE_INDEX_CONSTRAINT_LE;

* CAPI3REF: Virtual Table Constraint Operator Codes

int SQLITE_INDEX_CONSTRAINT_LT;

* CAPI3REF: Virtual Table Constraint Operator Codes

int SQLITE_INDEX_CONSTRAINT_GE;

* CAPI3REF: Virtual Table Constraint Operator Codes

int SQLITE_INDEX_CONSTRAINT_MATCH;

* CAPI3REF: Virtual Table Constraint Operator Codes

int sqlite3_create_module(sqlite3* db, const(char)* zName, const(sqlite3_module)* p, void* pClientData);
int sqlite3_create_module_v2(sqlite3* db, const(char)* zName, const(sqlite3_module)* p, void* pClientData, void function(void) xDestroy*);

* CAPI3REF: Register A Virtual Table Implementation

struct sqlite3_vtab;

* CAPI3REF: Virtual Table Instance Object

const(sqlite3_module)* pModule;

The module for this virtual table

int nRef;

NO LONGER USED

char* zErrMsg;

Error message from sqlite3_mprintf()

struct sqlite3_vtab_cursor;

* CAPI3REF: Virtual Table Cursor Object

sqlite3_vtab* pVtab;

Virtual table of this cursor

int sqlite3_declare_vtab(sqlite3, const char zSQL);

* CAPI3REF: Declare The Schema Of A Virtual Table

int sqlite3_overload_function(sqlite3, const char zFuncName, int nArg);

* CAPI3REF: Overload A Function For A Virtual Table

struct sqlite3_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.

int sqlite3_blob_open(sqlite3, const(char) zDb, const(char) zTable, const(char) zColumn, sqlite3_int64 iRow, int flags, sqlite3_blob** ppBlob);

* CAPI3REF: Open A BLOB For Incremental I/O

int sqlite3_blob_reopen(sqlite3_blob*, sqlite3_int64);

* CAPI3REF: Move a BLOB Handle to a New Row

int sqlite3_blob_close(sqlite3_blob*);

* CAPI3REF: Close A BLOB Handle

int sqlite3_blob_bytes(sqlite3_blob*);

* CAPI3REF: Return The Size Of An Open BLOB

int sqlite3_blob_read(sqlite3_blob, void Z, int N, int iOffset);

* CAPI3REF: Read Data From A BLOB Incrementally

int sqlite3_blob_write(sqlite3_blob, const void z, int n, int iOffset);

* CAPI3REF: Write Data Into A BLOB Incrementally

sqlite3_vfs* sqlite3_vfs_find(const char* zVfsName);
int sqlite3_vfs_register(sqlite3_vfs, int makeDflt);
int sqlite3_vfs_unregister(sqlite3_vfs);

* CAPI3REF: Virtual File System Objects

sqlite3_mutex* sqlite3_mutex_alloc(int);
void sqlite3_mutex_free(sqlite3_mutex);
void sqlite3_mutex_enter(sqlite3_mutex);
int sqlite3_mutex_try(sqlite3_mutex);
void sqlite3_mutex_leave(sqlite3_mutex);

* CAPI3REF: Mutexes

struct sqlite3_mutex_methods;

* CAPI3REF: Mutex Methods Object

int sqlite3_mutex_held(sqlite3_mutex);
int sqlite3_mutex_notheld(sqlite3_mutex);

* CAPI3REF: Mutex Verification Routines

int SQLITE_MUTEX_FAST;

* CAPI3REF: Mutex Types

int SQLITE_MUTEX_RECURSIVE;

* CAPI3REF: Mutex Types

int SQLITE_MUTEX_STATIC_MASTER;

* CAPI3REF: Mutex Types

int SQLITE_MUTEX_STATIC_MEM;

Ditto sqlite3_malloc()

int SQLITE_MUTEX_STATIC_MEM2;

Ditto NOT USED

int SQLITE_MUTEX_STATIC_OPEN;

Ditto sqlite3BtreeOpen()

int SQLITE_MUTEX_STATIC_PRNG;

Ditto sqlite3_random()

int SQLITE_MUTEX_STATIC_LRU;

Ditto lru page list

int SQLITE_MUTEX_STATIC_LRU2;
int SQLITE_MUTEX_STATIC_PMEM;

Ditto NOT USED

sqlite3_mutex* sqlite3_db_mutex(sqlite3*);

* CAPI3REF: Retrieve the mutex for a database connection

int sqlite3_file_control(sqlite3, const char *zDbName, int op, void);

* CAPI3REF: Low-Level Control Of Database Files