Sq3LiteC_sq3.h File Reference

Sq3LiteC_sq3.h - 23 Dec 2024 - aotto1968. More...

#include "LibSq3Lite_sq3.h"
#include "Sq3LiteC_def_sq3.h"

Include dependency graph for Sq3LiteC_sq3.h:

Go to the source code of this file.

Macros
#define	Sq3Fupu_Sq3LiteBusyHandler_arg1_ret   MK_I32
#define	Sq3Fupu_Sq3LiteBusyHandler_arg1_args   MK_PTR arg0, MK_I32 arg1
#define	Sq3Fupu_Sq3LiteCommitHook_arg1_ret   MK_I32
#define	Sq3Fupu_Sq3LiteCommitHook_arg1_args   MK_PTR arg0
#define	Sq3Fupu_Sq3LiteRollbackHook_arg1_ret   void
#define	Sq3Fupu_Sq3LiteRollbackHook_arg1_args   MK_PTR arg0
#define	Sq3Fupu_Sq3LiteUpdateHook_arg1_ret   void
#define	Sq3Fupu_Sq3LiteUpdateHook_arg1_args   MK_PTR arg0, MK_I32 arg1, MK_STRN arg2, MK_STRN arg3, sqlite3_int64 arg4
#define	Sq3Fupu_Sq3LiteExec_callback_call_ret   MK_I32
#define	Sq3Fupu_Sq3LiteExec_callback_call_args   MK_CBP callV1, MK_I32 num, MK_STR *vals, MK_STR *cols
#define	Sq3Fupu_Sq3LiteAutovacuumPages_arg1_ret   MK_U32
#define	Sq3Fupu_Sq3LiteAutovacuumPages_arg1_args   MK_PTR arg0, MK_STRN arg1, MK_U32 arg2, MK_U32 arg3, MK_U32 arg4
#define	Sq3Fupu_Sq3LiteAutovacuumPages_arg3_ret   void
#define	Sq3Fupu_Sq3LiteAutovacuumPages_arg3_args   MK_PTR arg0
#define	Sq3Fupu_Sq3LiteCreateCollation_xCompare_ret   MK_I32
#define	Sq3Fupu_Sq3LiteCreateCollation_xCompare_args   MK_PTR arg0, MK_I32 arg1, MK_PTRN arg2, MK_I32 arg3, MK_PTRN arg4
#define	Sq3LiteVtabConfig(sq3lite, op, ...)
	Virtual Table Interface Configuration …
#define	Sq3Fupu_Sq3LiteExec_callback_call_check
#define	Sq3Fupu_Sq3LiteExecV2CB_callback_call_check
#define	Sq3LiteExecV2CB_ret   enum MkErrorE
#define	Sq3LiteExecV2CB_args   MK_RT_ARGS MK_CBP callV2, MK_BFL vals, MK_BFL cols

Typedefs
typedef Sq3Fupu_Sq3LiteBusyHandler_arg1_ret(*	Sq3Fupu_Sq3LiteBusyHandler_arg1) (Sq3Fupu_Sq3LiteBusyHandler_arg1_args)
typedef Sq3Fupu_Sq3LiteCommitHook_arg1_ret(*	Sq3Fupu_Sq3LiteCommitHook_arg1) (Sq3Fupu_Sq3LiteCommitHook_arg1_args)
typedef Sq3Fupu_Sq3LiteRollbackHook_arg1_ret(*	Sq3Fupu_Sq3LiteRollbackHook_arg1) (Sq3Fupu_Sq3LiteRollbackHook_arg1_args)
typedef Sq3Fupu_Sq3LiteUpdateHook_arg1_ret(*	Sq3Fupu_Sq3LiteUpdateHook_arg1) (Sq3Fupu_Sq3LiteUpdateHook_arg1_args)
typedef Sq3Fupu_Sq3LiteExec_callback_call_ret(*	Sq3Fupu_Sq3LiteExec_callback_call) (Sq3Fupu_Sq3LiteExec_callback_call_args)
typedef Sq3Fupu_Sq3LiteAutovacuumPages_arg1_ret(*	Sq3Fupu_Sq3LiteAutovacuumPages_arg1) (Sq3Fupu_Sq3LiteAutovacuumPages_arg1_args)
typedef Sq3Fupu_Sq3LiteAutovacuumPages_arg3_ret(*	Sq3Fupu_Sq3LiteAutovacuumPages_arg3) (Sq3Fupu_Sq3LiteAutovacuumPages_arg3_args)
typedef Sq3Fupu_Sq3LiteCreateCollation_xCompare_ret(*	Sq3Fupu_Sq3LiteCreateCollation_xCompare) (Sq3Fupu_Sq3LiteCreateCollation_xCompare_args)
typedef enum MkErrorE(*	Sq3LiteExecV2CB) (MK_RT mkrt, MK_CBP callV2, MK_BFL vals, MK_BFL cols)
	callback for Sq3LiteExecV2

Functions
void	Sq3LiteLog_RT (MK_RT mkrt, SQ3_LITEN const lite, MK_OBJN fmtobj, MK_DBG const debug, MK_STRN const callfunc, MK_I32 const lvl)
	log the lite …
static enum MkErrorE	Sq3LiteBusyHandler (SQ3_LITE sq3lite, Sq3Fupu_Sq3LiteBusyHandler_arg1 arg1, MK_PTR arg2)
	Register A Callback To Handle SQLITE_BUSY Errors …
static enum MkErrorE	Sq3LiteBusyTimeout (SQ3_LITE sq3lite, MK_I32 ms)
	Set A Busy Timeout …
static MK_PTR	Sq3LiteCommitHook (SQ3_LITE sq3lite, Sq3Fupu_Sq3LiteCommitHook_arg1 arg1, MK_PTR arg2)
	Commit And Rollback Notification Callbacks …
static enum MkErrorE	Sq3LiteDeclareVtab (SQ3_LITE sq3lite, MK_STRN zSQL)
	Declare The Schema Of A Virtual Table …
static enum MkErrorE	Sq3LiteExtendedResultCodes (SQ3_LITE sq3lite, MK_I32 onoff)
	Enable Or Disable Extended Result Codes …
static enum MkErrorE	Sq3LiteLimit (SQ3_LITE sq3lite, enum Sq3LimitE id, MK_I32 newVal)
	Run-time Limits …
static MK_PTR	Sq3LiteRollbackHook (SQ3_LITE sq3lite, Sq3Fupu_Sq3LiteRollbackHook_arg1 arg1, MK_PTR arg2)
	Commit And Rollback Notification Callbacks …
static MK_PTR	Sq3LiteUpdateHook (SQ3_LITE sq3lite, Sq3Fupu_Sq3LiteUpdateHook_arg1 arg1, MK_PTR arg2)
	Data Change Notification Callbacks …
static enum Sq3ErrorE	Sq3LiteErrCode (SQ3_LITE db)
	Error Codes And Messages …
static MK_STRN	Sq3LiteErrMsg (SQ3_LITE sq3lite)
	Error Codes And Messages …
static enum MkErrorE	Sq3LiteErrorOffset (SQ3_LITE db)
	Error Codes And Messages …
static enum Sq3ExtendetResultCodesE	Sq3LiteExtendetErrCode (SQ3_LITE db)
	Error Codes And Messages …
static enum MkErrorE	Sq3LiteSystemErrno (SQ3_LITE sq3lite)
	Low-level system error code …
static MK_STRN	Sq3LiteErrStr (MK_I32 arg0)
	Error Codes And Messages …
static enum MkErrorE	Sq3LiteExec (SQ3_LITE sq3lite, MK_STRN sql, Sq3Fupu_Sq3LiteExec_callback_call callback_call, MK_CBP callback_data)
	One-Step Query Execution Interface …
static enum MkErrorE	Sq3LiteSleep (MK_I32 arg0)
	Suspend Execution For A Short Time …
static MK_I32	Sq3LiteGetAutocommit (SQ3_LITE sq3lite)
	Test For Auto-Commit Mode …
static MK_I64	Sq3LiteLastInsertRowid (SQ3_LITE sq3lite)
	Last Insert Rowid …
static enum MkErrorE	Sq3LiteTxnState (SQ3_LITE sq3lite, MK_STRN zSchema)
	Determine the transaction state of a database …
static enum MkErrorE	Sq3LiteVtabOnConflict (SQ3_LITE sq3lite)
	Determine The Virtual Table Conflict Policy …
static enum MkErrorE	Sq3LiteAutovacuumPages (SQ3_LITE db, Sq3Fupu_Sq3LiteAutovacuumPages_arg1 arg1, MK_PTR arg2, Sq3Fupu_Sq3LiteAutovacuumPages_arg3 arg3)
	Autovacuum Compaction Amount Callback …
static enum MkErrorE	Sq3LiteCreateCollation (SQ3_LITE sq3lite, MK_STRN zName, MK_I32 eTextRep, MK_PTR pArg, Sq3Fupu_Sq3LiteCreateCollation_xCompare xCompare)
	Define New Collating Sequences …
static enum MkErrorE	Sq3LiteDbCacheflush (SQ3_LITE sq3lite)
	Flush caches to disk mid-transaction …
static SQ3_FILENAME	Sq3LiteDbFilename (SQ3_LITE db, MK_STRN zDbName)
	Return The Filename For A Database Connection …
static MK_STRN	Sq3LiteDbName (SQ3_LITE db, MK_I32 N)
	Return The Schema Name For A Database Connection …
static enum MkErrorE	Sq3LiteDbReadonly (SQ3_LITE db, MK_STRN zDbName)
	Determine if a database is read-only …
static enum MkErrorE	Sq3LiteDbReleaseMemory (SQ3_LITE sq3lite)
	Free Memory Used By A Database Connection …
static enum MkErrorE	Sq3LiteDeserializeHide (SQ3_LITE db, MK_STRN zSchema, MK_BIN pData, MK_I64 szDb, MK_I64 szBuf, enum Sq3DeSerializeEF mFlags)
	Deserialize a database …
static enum MkErrorE	Sq3LiteDropModulesHide (SQ3_LITE db, MK_STRN *azKeep)
	Remove Unnecessary Virtual Table Implementations …
static enum MkErrorE	Sq3LiteFileControl (SQ3_LITE sq3lite, MK_STRN zDbName, enum Sq3TestCtrlE op, MK_PTR arg3)
	Low-Level Control Of Database Files …
static enum MkErrorE	Sq3LiteOverloadFunction (SQ3_LITE sq3lite, MK_STRN zFuncName, MK_I32 nArg)
	Overload A Function For A Virtual Table …
static enum MkErrorE	Sq3LiteDbStatus (SQ3_LITE sq3lite, enum Sq3DbStatusE op, MK_I32 *pCur, MK_I32 *pHiwtr, MK_BOOL resetFlg)
	Database Connection Status …
static MK_BIN	Sq3LiteSerializeHide (SQ3_LITE db, MK_STRN zSchema, MK_I64 *piSize, enum Sq3SerializeE mFlags)
	Serialize a database …
static enum MkErrorE	Sq3LiteTableColumnMetadata (SQ3_LITE db, MK_STRN zDbName, MK_STRN zTableName, MK_STRN zColumnName, MK_STRN *pzDataType, MK_STRN *pzCollSeq, MK_I32 *pNotNull, MK_I32 *pPrimaryKey, MK_I32 *pAutoinc)
	Extract Metadata About A Column Of A Table …
static enum MkErrorE	Sq3LiteWalAutocheckpoint (SQ3_LITE db, MK_I32 N)
	Configure an auto-checkpoint …
static enum MkErrorE	Sq3LiteWalCheckpointV2 (SQ3_LITE db, MK_STRN zDb, MK_I32 eMode, MK_I32 *pnLog, MK_I32 *pnCkpt)
	Checkpoint a database …
static void	Sq3LiteInterrupt (SQ3_LITE sq3lite)
	Interrupt A Long-Running Query …
static MK_BOOL	Sq3LiteIsInterrupted (SQ3_LITE sq3lite)
	Interrupt A Long-Running Query …
static MK_I32	Sq3LiteChanges (SQ3_LITE sq3lite)
	Count The Number Of Rows Modified …
static MK_I64	Sq3LiteChanges64 (SQ3_LITE sq3lite)
	Count The Number Of Rows Modified …
static void	Sq3LiteSetLastInsertRowid (SQ3_LITE sq3lite, MK_I64 arg1)
	Set the Last Insert Rowid value …
static MK_I32	Sq3LiteTotalChanges (SQ3_LITE sq3lite)
	Total Number Of Rows Modified …
static MK_I64	Sq3LiteTotalChanges64 (SQ3_LITE sq3lite)
	Total Number Of Rows Modified …
static enum MkErrorE	Sq3LiteOpenV2 (MK_STRN filename, SQ3_LITE *ppDb, enum Sq3OpenEF flags, MK_STRN zVfs)
	Opening A New Database Connection …
static enum MkErrorE	Sq3LiteCloseV2 (SQ3_LITE sq3lite)
	Closing A Database Connection …
static MkBinaryR	Sq3LiteSerialize (SQ3_LITE sq3lite, MK_STRN zSchema, enum Sq3SerializeE mFlags)
	Serialize a database …
static enum MkErrorE	Sq3LiteDeserialize_RT (MK_RT mkrt, SQ3_LITE sq3lite, MK_STRN zSchema, MkBinaryR pData, enum Sq3DeSerializeEF mFlags)
	Deserialize a database …
enum MkErrorE	Sq3LiteVtabConfig (SQ3_LITE sq3lite, Sq3VtabE op,...)
	This function may be called by either the [xConnect] or [xCreate] method of a [virtual table] implementation to configure various facets of the virtual table interface.
static enum MkErrorE	Sq3LiteDbStatusBFL_RT (MK_RT mkrt, SQ3_LITE sq3lite, enum Sq3DbStatusE op, MK_BFL *val_out, MK_BOOL resetFlg)
	Database Connection Status …
enum MkErrorE	Sq3LiteDropModules_RT (MK_RT mkrt, SQ3_LITE sq3lite, MK_BFL azKeepBfl)
	Remove Unnecessary Virtual Table Implementations …
static enum MkErrorE	Sq3LitePrepareV2 (SQ3_LITE db, MkStringR zSql, SQ3_STMT *ppStmt)
	Compiling An SQL Statement …
enum MkErrorE	Sq3LiteExecV2_RT (MK_RT mkrt, SQ3_LITE sq3lite, MK_STRN sql, Sq3LiteExecV2CB callback_call, MK_CBP callback)
	The Sq3LiteExecV2() interface is a convenience wrapper around Sq3StmtPrepareV2(), Sq3StmtStep(), and Sq3StmtFinalize(), that allows an application to run multiple statements of SQL without having to use a lot of C code.

Detailed Description

Sq3LiteC_sq3.h - 23 Dec 2024 - aotto1968.

Copyright

(C) NHI - #1 - Project - Group This software has NO permission to copy, please contact AUTHOR for additional information

Version

bb094fe1c71d85b16ca7fff022e5010d7dcf7e8e

Date

Mon Dec 23 23:13:07 2024 +0100

Author

aotto1968 aotto.nosp@m.1968.nosp@m.@t-on.nosp@m.line.nosp@m..de

Definition in file Sq3LiteC_sq3.h.