theSq3Lite 10.0
Loading...
Searching...
No Matches
Sq3LiteC_Misc_ATL_API

Sq3LiteC - various functions to perform misc operations … More...

+ Collaboration diagram for Sq3LiteC_Misc_ATL_API:

Functions

static OT_ProcRet atlsq3lite_Sq3LiteC_DbStatusBFL (Sq3LiteC_ARGS)
  Atl: MkBufferListC [Sq3LiteC::DbStatusBFL $sq3lite op:Sq3DbStatusE resetFlg:bool] C-API
Database Connection Status …
 
static OT_ProcRet atlsq3lite_Sq3LiteC_DbCacheflush (Sq3LiteC_ARGS)
  Atl: Sq3LiteC::DbCacheflush $sq3lite C-API
Flush caches to disk mid-transaction …
 
static OT_ProcRet atlsq3lite_Sq3LiteC_DbFilename (Sq3LiteC_ARGS)
  Atl: string [Sq3LiteC::DbFilename $db zDbName:string] C-API
Return The Filename For A Database Connection …
 
static OT_ProcRet atlsq3lite_Sq3LiteC_DbName (Sq3LiteC_ARGS)
  Atl: string [Sq3LiteC::DbName $db N:int32] C-API
Return The Schema Name For A Database Connection …
 
static OT_ProcRet atlsq3lite_Sq3LiteC_DbReadonly (Sq3LiteC_ARGS)
  Atl: Sq3LiteC::DbReadonly $db zDbName:string C-API
Determine if a database is read-only …
 
static OT_ProcRet atlsq3lite_Sq3LiteC_DbReleaseMemory (Sq3LiteC_ARGS)
  Atl: Sq3LiteC::DbReleaseMemory $sq3lite C-API
Free Memory Used By A Database Connection …
 
static OT_ProcRet atlsq3lite_Sq3LiteC_Deserialize (Sq3LiteC_ARGS)
  Atl: Sq3LiteC::Deserialize $sq3lite zSchema:string pData:binary mFlags:Sq3DeSerializeEF C-API
Deserialize a database …
 
static OT_ProcRet atlsq3lite_Sq3LiteC_DropModules (Sq3LiteC_ARGS)
  Atl: Sq3LiteC::DropModules $sq3lite azKeepBfl:MkBufferListC C-API
Remove Unnecessary Virtual Table Implementations …
 
MK_DEPRECATED static MK_UNUSED OT_ProcRet atlsq3lite_Sq3LiteC_Log (Sq3LiteC_ARGS)
 
static OT_ProcRet atlsq3lite_Sq3LiteC_OverloadFunction (Sq3LiteC_ARGS)
  Atl: Sq3LiteC::OverloadFunction $sq3lite zFuncName:string nArg:int32 C-API
Overload A Function For A Virtual Table …
 
static OT_ProcRet atlsq3lite_Sq3LiteC_Serialize (Sq3LiteC_ARGS)
  Atl: binary [Sq3LiteC::Serialize $sq3lite zSchema:string mFlags:Sq3SerializeE] C-API
Serialize a database …
 
static OT_ProcRet atlsq3lite_Sq3LiteC_DbStatus (Sq3LiteC_ARGS)
  Atl: {pCur:int32 pHiwtr:int32} [Sq3LiteC::DbStatus $sq3lite op:Sq3DbStatusE resetFlg:bool] C-API
Database Connection Status …
 
static OT_ProcRet atlsq3lite_Sq3LiteC_TableColumnMetadata (Sq3LiteC_ARGS)
  Atl: {pzDataType:string pzCollSeq:string pNotNull:int32 pPrimaryKey:int32 pAutoinc:int32} [Sq3LiteC::TableColumnMetadata $db zDbName:string zTableName:string zColumnName:string] C-API
Extract Metadata About A Column Of A Table …
 

Detailed Description

Sq3LiteC - various functions to perform misc operations …

Function Documentation

◆ atlsq3lite_Sq3LiteC_DbCacheflush()

static OT_ProcRet atlsq3lite_Sq3LiteC_DbCacheflush ( Sq3LiteC_ARGS )
static

Atl: Sq3LiteC::DbCacheflush $sq3lite C-API
Flush caches to disk mid-transaction …

Definition at line 601 of file Sq3LiteC_atl.c.

601 {
607 goto end;
608 error:
610 end:
612}
#define OT_SETUP_NOARG(d)
#define OT_retObj_SET_Error
#define OT_retObj_SET_None
#define OT_retObj_RETURN
#define OT_CHECK_NOARGS
#define MkErrorC_Check(mng, PROC)
#define OT_SETUP_hdl
#define DbCacheflush_doc
static enum MkErrorE Sq3LiteDbCacheflush(SQ3_LITE sq3lite)
Flush caches to disk mid-transaction …

◆ atlsq3lite_Sq3LiteC_DbFilename()

static OT_ProcRet atlsq3lite_Sq3LiteC_DbFilename ( Sq3LiteC_ARGS )
static

Atl: string [Sq3LiteC::DbFilename $db zDbName:string] C-API
Return The Filename For A Database Connection …

Definition at line 615 of file Sq3LiteC_atl.c.

615 {
618 MK_STRN zDbName = 0;
621 OT_retObj_SET_STR(Sq3LiteDbFilename (hdl, zDbName));
622 goto end;
623 error:
625 end:
627}
#define OT_SETUP_ONEARG(d)
#define OT_CHECK_REQUIRED(val)
#define OT_retObj_SET_STR(nat)
#define OT_CHECK_STRN(val)
#define DbFilename_doc
const MK_STRB * MK_STRN
static SQ3_FILENAME Sq3LiteDbFilename(SQ3_LITE db, MK_STRN zDbName)
Return The Filename For A Database Connection …

◆ atlsq3lite_Sq3LiteC_DbName()

static OT_ProcRet atlsq3lite_Sq3LiteC_DbName ( Sq3LiteC_ARGS )
static

Atl: string [Sq3LiteC::DbName $db N:int32] C-API
Return The Schema Name For A Database Connection …

Definition at line 630 of file Sq3LiteC_atl.c.

630 {
633 MK_I32 N = 0;
637 goto end;
638 error:
640 end:
642}
#define OT_CHECK_NI4(val)
#define DbName_doc
signed int MK_I32
static MK_STRN Sq3LiteDbName(SQ3_LITE db, MK_I32 N)
Return The Schema Name For A Database Connection …

◆ atlsq3lite_Sq3LiteC_DbReadonly()

static OT_ProcRet atlsq3lite_Sq3LiteC_DbReadonly ( Sq3LiteC_ARGS )
static

Atl: Sq3LiteC::DbReadonly $db zDbName:string C-API
Determine if a database is read-only …

Definition at line 645 of file Sq3LiteC_atl.c.

645 {
648 MK_STRN zDbName = 0;
651 MkErrorC_Check(hdl,Sq3LiteDbReadonly (hdl, zDbName));
653 goto end;
654 error:
656 end:
658}
#define DbReadonly_doc
static enum MkErrorE Sq3LiteDbReadonly(SQ3_LITE db, MK_STRN zDbName)
Determine if a database is read-only …

◆ atlsq3lite_Sq3LiteC_DbReleaseMemory()

static OT_ProcRet atlsq3lite_Sq3LiteC_DbReleaseMemory ( Sq3LiteC_ARGS )
static

Atl: Sq3LiteC::DbReleaseMemory $sq3lite C-API
Free Memory Used By A Database Connection …

Definition at line 661 of file Sq3LiteC_atl.c.

661 {
667 goto end;
668 error:
670 end:
672}
#define DbReleaseMemory_doc
static enum MkErrorE Sq3LiteDbReleaseMemory(SQ3_LITE sq3lite)
Free Memory Used By A Database Connection …

◆ atlsq3lite_Sq3LiteC_DbStatus()

static OT_ProcRet atlsq3lite_Sq3LiteC_DbStatus ( Sq3LiteC_ARGS )
static

Atl: {pCur:int32 pHiwtr:int32} [Sq3LiteC::DbStatus $sq3lite op:Sq3DbStatusE resetFlg:bool] C-API
Database Connection Status …

Definition at line 753 of file Sq3LiteC_atl.c.

753 {
756 enum Sq3DbStatusE op = 0;
758 MK_BOOL resetFlg = 0;
761 MK_I32 pCur;
762 MK_I32 pHiwtr;
763 MkErrorC_Check(hdl,Sq3LiteDbStatus (hdl, op, &pCur, &pHiwtr, resetFlg));
767 goto end;
768 error:
770 end:
772}
#define OT_CHECK_bool(val)
#define OT_SETUP_VARARGS(min, max, d)
#define OT_retObj_SET_List
#define OT_TMP_I32_OBJ(val)
#define OT_CHECK_ENUM(ename, val)
#define OT_retObj_APPEND(var)
#define DbStatus_doc
bool MK_BOOL
static enum MkErrorE Sq3LiteDbStatus(SQ3_LITE sq3lite, enum Sq3DbStatusE op, MK_I32 *pCur, MK_I32 *pHiwtr, MK_BOOL resetFlg)
Database Connection Status …
Sq3DbStatusE
Status Parameters for database connections.
Definition Sq3Enum_sq3.h:79

◆ atlsq3lite_Sq3LiteC_DbStatusBFL()

static OT_ProcRet atlsq3lite_Sq3LiteC_DbStatusBFL ( Sq3LiteC_ARGS )
static

Atl: MkBufferListC [Sq3LiteC::DbStatusBFL $sq3lite op:Sq3DbStatusE resetFlg:bool] C-API
Database Connection Status …

Definition at line 580 of file Sq3LiteC_atl.c.

580 {
583 enum Sq3DbStatusE op = 0;
585 MK_BOOL resetFlg = 0;
588 MK_BFL val_out;
589 MkErrorC_Check(hdl,Sq3LiteDbStatusBFL (hdl, op, &val_out, resetFlg));
590 OT_retObj_SET_BFL(val_out);
591 goto end;
592 error:
594 end:
596}
#define OT_retObj_SET_BFL(nat)
#define DbStatusBFL_doc
#define Sq3LiteDbStatusBFL(...)

◆ atlsq3lite_Sq3LiteC_Deserialize()

static OT_ProcRet atlsq3lite_Sq3LiteC_Deserialize ( Sq3LiteC_ARGS )
static

Atl: Sq3LiteC::Deserialize $sq3lite zSchema:string pData:binary mFlags:Sq3DeSerializeEF C-API
Deserialize a database …

Definition at line 675 of file Sq3LiteC_atl.c.

675 {
678 MK_STRN zSchema = 0;
680 MkBinaryR pData = {0};
682 enum Sq3DeSerializeEF mFlags = 0;
685 MkErrorC_Check(hdl,Sq3LiteDeserialize (hdl, zSchema, pData, mFlags));
687 goto end;
688 error:
690 end:
692}
#define OT_CHECK__ME_REF_MkBinaryR(val)
#define Deserialize_doc
#define Sq3LiteDeserialize(...)
Sq3DeSerializeEF
Flags for sqlite3_deserialize()

◆ atlsq3lite_Sq3LiteC_DropModules()

static OT_ProcRet atlsq3lite_Sq3LiteC_DropModules ( Sq3LiteC_ARGS )
static

Atl: Sq3LiteC::DropModules $sq3lite azKeepBfl:MkBufferListC C-API
Remove Unnecessary Virtual Table Implementations …

Definition at line 695 of file Sq3LiteC_atl.c.

695 {
698 MkBufferListCreateTLS_T(azKeepBfl,10);
701 MkErrorC_Check(hdl,Sq3LiteDropModules (hdl, azKeepBfl));
703 goto end;
704 error:
706 end:
708}
#define DropModules_doc
#define MkBufferListCreateTLS_T(name, num)
#define MK_NULL_NO
#define Sq3LiteDropModules(...)
#define OT_CHECK_BFL(val, nullB)

◆ atlsq3lite_Sq3LiteC_Log()

MK_DEPRECATED static MK_UNUSED OT_ProcRet atlsq3lite_Sq3LiteC_Log ( Sq3LiteC_ARGS )
static

Definition at line 712 of file Sq3LiteC_atl.c.

#define OT_ERROR_LNG_RETURN

◆ atlsq3lite_Sq3LiteC_OverloadFunction()

static OT_ProcRet atlsq3lite_Sq3LiteC_OverloadFunction ( Sq3LiteC_ARGS )
static

Atl: Sq3LiteC::OverloadFunction $sq3lite zFuncName:string nArg:int32 C-API
Overload A Function For A Virtual Table …

Definition at line 715 of file Sq3LiteC_atl.c.

715 {
718 MK_STRN zFuncName = 0;
720 MK_I32 nArg = 0;
723 MkErrorC_Check(hdl,Sq3LiteOverloadFunction (hdl, zFuncName, nArg));
725 goto end;
726 error:
728 end:
730}
#define OverloadFunction_doc
static enum MkErrorE Sq3LiteOverloadFunction(SQ3_LITE sq3lite, MK_STRN zFuncName, MK_I32 nArg)
Overload A Function For A Virtual Table …

◆ atlsq3lite_Sq3LiteC_Serialize()

static OT_ProcRet atlsq3lite_Sq3LiteC_Serialize ( Sq3LiteC_ARGS )
static

Atl: binary [Sq3LiteC::Serialize $sq3lite zSchema:string mFlags:Sq3SerializeE] C-API
Serialize a database …

Definition at line 733 of file Sq3LiteC_atl.c.

733 {
736 MK_STRN zSchema = 0;
738 enum Sq3SerializeE mFlags = 0;
741 MkBinaryR retVal = Sq3LiteSerialize (hdl, zSchema, mFlags);
743 goto end;
744 error:
746 end:
748}
#define OT_GET__ME_REF_MkBinaryR(b)
#define OT_retObj_SET(val)
#define Serialize_doc
static MkBinaryR Sq3LiteSerialize(SQ3_LITE sq3lite, MK_STRN zSchema, enum Sq3SerializeE mFlags)
Serialize a database …
Sq3SerializeE
Flags for sqlite3_serialize.

◆ atlsq3lite_Sq3LiteC_TableColumnMetadata()

static OT_ProcRet atlsq3lite_Sq3LiteC_TableColumnMetadata ( Sq3LiteC_ARGS )
static

Atl: {pzDataType:string pzCollSeq:string pNotNull:int32 pPrimaryKey:int32 pAutoinc:int32} [Sq3LiteC::TableColumnMetadata $db zDbName:string zTableName:string zColumnName:string] C-API
Extract Metadata About A Column Of A Table …

Definition at line 775 of file Sq3LiteC_atl.c.

775 {
778 MK_STRN zDbName = 0;
780 MK_STRN zTableName = 0;
781 OT_CHECK_REQUIRED(OT_CHECK_STRN (zTableName))
782 MK_STRN zColumnName = 0;
783 OT_CHECK_REQUIRED(OT_CHECK_STRN (zColumnName))
785 MK_STRN pzDataType;
786 MK_STRN pzCollSeq;
787 MK_I32 pNotNull;
788 MK_I32 pPrimaryKey;
789 MK_I32 pAutoinc;
790 MkErrorC_Check(hdl,Sq3LiteTableColumnMetadata (hdl, zDbName, zTableName, zColumnName, &pzDataType, &pzCollSeq, &pNotNull, &pPrimaryKey, &pAutoinc));
792 OT_retObj_APPEND(OT_TMP_STR_OBJ(pzDataType));
795 OT_retObj_APPEND(OT_TMP_I32_OBJ(pPrimaryKey));
797 goto end;
798 error:
800 end:
802}
#define OT_TMP_STR_OBJ(val)
#define TableColumnMetadata_doc
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 …