Sq3LiteC_Misc_TCL_API

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

Collaboration diagram for Sq3LiteC_Misc_TCL_API:

Functions
static OT_ProcRet	tclsq3lite_Sq3LiteC_DbStatusBFL (Sq3LiteC_ARGS)
	Tcl: MkBufferListC [$sq3lite DbStatusBFL op:Sq3DbStatusE resetFlg:bool] → C-API Database Connection Status …
static OT_ProcRet	tclsq3lite_Sq3LiteC_DbCacheflush (Sq3LiteC_ARGS)
	Tcl: $sq3lite DbCacheflush → C-API Flush caches to disk mid-transaction …
static OT_ProcRet	tclsq3lite_Sq3LiteC_DbFilename (Sq3LiteC_ARGS)
	Tcl: string [$db DbFilename zDbName:string] → C-API Return The Filename For A Database Connection …
static OT_ProcRet	tclsq3lite_Sq3LiteC_DbName (Sq3LiteC_ARGS)
	Tcl: string [$db DbName N:int32] → C-API Return The Schema Name For A Database Connection …
static OT_ProcRet	tclsq3lite_Sq3LiteC_DbReadonly (Sq3LiteC_ARGS)
	Tcl: $db DbReadonly zDbName:string → C-API Determine if a database is read-only …
static OT_ProcRet	tclsq3lite_Sq3LiteC_DbReleaseMemory (Sq3LiteC_ARGS)
	Tcl: $sq3lite DbReleaseMemory → C-API Free Memory Used By A Database Connection …
static OT_ProcRet	tclsq3lite_Sq3LiteC_Deserialize (Sq3LiteC_ARGS)
	Tcl: $sq3lite Deserialize zSchema:string pData:binary mFlags:Sq3DeSerializeEF → C-API Deserialize a database …
static OT_ProcRet	tclsq3lite_Sq3LiteC_DropModules (Sq3LiteC_ARGS)
	Tcl: $sq3lite DropModules azKeepBfl:MkBufferListC → C-API Remove Unnecessary Virtual Table Implementations …
MK_DEPRECATED static MK_UNUSED OT_ProcRet	tclsq3lite_Sq3LiteC_Log (Sq3LiteC_ARGS)
static OT_ProcRet	tclsq3lite_Sq3LiteC_OverloadFunction (Sq3LiteC_ARGS)
	Tcl: $sq3lite OverloadFunction zFuncName:string nArg:int32 → C-API Overload A Function For A Virtual Table …
static OT_ProcRet	tclsq3lite_Sq3LiteC_Serialize (Sq3LiteC_ARGS)
	Tcl: binary [$sq3lite Serialize zSchema:string mFlags:Sq3SerializeE] → C-API Serialize a database …
static OT_ProcRet	tclsq3lite_Sq3LiteC_DbStatus (Sq3LiteC_ARGS)
	Tcl: {pCur:int32 pHiwtr:int32} [$sq3lite DbStatus op:Sq3DbStatusE resetFlg:bool] → C-API Database Connection Status …
static OT_ProcRet	tclsq3lite_Sq3LiteC_TableColumnMetadata (Sq3LiteC_ARGS)
	Tcl: {pzDataType:string pzCollSeq:string pNotNull:int32 pPrimaryKey:int32 pAutoinc:int32} [$db TableColumnMetadata 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

tclsq3lite_Sq3LiteC_DbCacheflush()

static OT_ProcRet tclsq3lite_Sq3LiteC_DbCacheflush ( Sq3LiteC_ARGS )

static

Tcl: $sq3lite DbCacheflush → C-API
Flush caches to disk mid-transaction …

Definition at line 622 of file Sq3LiteC_tcl.c.

                                                            {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(DbCacheflush_doc);
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,Sq3LiteDbCacheflush (hdl));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclsq3lite_Sq3LiteC_DbFilename()

static OT_ProcRet tclsq3lite_Sq3LiteC_DbFilename ( Sq3LiteC_ARGS )

static

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

Definition at line 636 of file Sq3LiteC_tcl.c.

                                                          {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(DbFilename_doc);
  MK_STRN zDbName = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (zDbName))
  OT_CHECK_NOARGS;
  OT_retObj_SET_STR(Sq3LiteDbFilename (hdl, zDbName));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclsq3lite_Sq3LiteC_DbName()

static OT_ProcRet tclsq3lite_Sq3LiteC_DbName ( Sq3LiteC_ARGS )

static

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

Definition at line 651 of file Sq3LiteC_tcl.c.

                                                      {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(DbName_doc);
  MK_I32 N = 0;
  OT_CHECK_REQUIRED(OT_CHECK_NI4 (N))
  OT_CHECK_NOARGS;
  OT_retObj_SET_STR(Sq3LiteDbName (hdl, N));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclsq3lite_Sq3LiteC_DbReadonly()

static OT_ProcRet tclsq3lite_Sq3LiteC_DbReadonly ( Sq3LiteC_ARGS )

static

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

Definition at line 666 of file Sq3LiteC_tcl.c.

                                                          {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(DbReadonly_doc);
  MK_STRN zDbName = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (zDbName))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,Sq3LiteDbReadonly (hdl, zDbName));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclsq3lite_Sq3LiteC_DbReleaseMemory()

static OT_ProcRet tclsq3lite_Sq3LiteC_DbReleaseMemory ( Sq3LiteC_ARGS )

static

Tcl: $sq3lite DbReleaseMemory → C-API
Free Memory Used By A Database Connection …

Definition at line 682 of file Sq3LiteC_tcl.c.

                                                               {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(DbReleaseMemory_doc);
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,Sq3LiteDbReleaseMemory (hdl));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclsq3lite_Sq3LiteC_DbStatus()

static OT_ProcRet tclsq3lite_Sq3LiteC_DbStatus ( Sq3LiteC_ARGS )

static

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

Definition at line 774 of file Sq3LiteC_tcl.c.

                                                        {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(2,2,DbStatus_doc);
  enum Sq3DbStatusE op = 0;
  OT_CHECK_REQUIRED(OT_CHECK_ENUM (Sq3DbStatusE,op))
  MK_BOOL resetFlg = 0;
  OT_CHECK_REQUIRED(OT_CHECK_bool (resetFlg))
  OT_CHECK_NOARGS;
  MK_I32 pCur;
  MK_I32 pHiwtr;
  MkErrorC_Check(hdl,Sq3LiteDbStatus (hdl, op, &pCur, &pHiwtr, resetFlg));
  OT_retObj_SET_List;
  OT_retObj_APPEND(OT_TMP_I32_OBJ(pCur));
  OT_retObj_APPEND(OT_TMP_I32_OBJ(pHiwtr));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclsq3lite_Sq3LiteC_DbStatusBFL()

static OT_ProcRet tclsq3lite_Sq3LiteC_DbStatusBFL ( Sq3LiteC_ARGS )

static

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

Definition at line 601 of file Sq3LiteC_tcl.c.

                                                           {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(2,2,DbStatusBFL_doc);
  enum Sq3DbStatusE op = 0;
  OT_CHECK_REQUIRED(OT_CHECK_ENUM (Sq3DbStatusE,op))
  MK_BOOL resetFlg = 0;
  OT_CHECK_REQUIRED(OT_CHECK_bool (resetFlg))
  OT_CHECK_NOARGS;
  MK_BFL val_out;
  MkErrorC_Check(hdl,Sq3LiteDbStatusBFL (hdl, op, &val_out, resetFlg));
  OT_retObj_SET_BFL(val_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclsq3lite_Sq3LiteC_Deserialize()

static OT_ProcRet tclsq3lite_Sq3LiteC_Deserialize ( Sq3LiteC_ARGS )

static

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

Definition at line 696 of file Sq3LiteC_tcl.c.

                                                           {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(3,3,Deserialize_doc);
  MK_STRN zSchema = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (zSchema))
  MkBinaryR pData = {0};
  OT_CHECK_REQUIRED(OT_CHECK__ME_REF_MkBinaryR(pData))
  enum Sq3DeSerializeEF mFlags = 0;
  OT_CHECK_REQUIRED(OT_CHECK_ENUM (Sq3DeSerializeEF,mFlags))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,Sq3LiteDeserialize (hdl, zSchema, pData, mFlags));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclsq3lite_Sq3LiteC_DropModules()

static OT_ProcRet tclsq3lite_Sq3LiteC_DropModules ( Sq3LiteC_ARGS )

static

Tcl: $sq3lite DropModules azKeepBfl:MkBufferListC → C-API
Remove Unnecessary Virtual Table Implementations …

Definition at line 716 of file Sq3LiteC_tcl.c.

                                                           {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(DropModules_doc);
  MkBufferListCreateTLS_T(azKeepBfl,10);
  OT_CHECK_REQUIRED(OT_CHECK_BFL (azKeepBfl,MK_NULL_NO))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,Sq3LiteDropModules (hdl, azKeepBfl));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclsq3lite_Sq3LiteC_Log()

MK_DEPRECATED static MK_UNUSED OT_ProcRet tclsq3lite_Sq3LiteC_Log ( Sq3LiteC_ARGS )

static

Definition at line 733 of file Sq3LiteC_tcl.c.

{OT_ERROR_LNG_RETURN;}

tclsq3lite_Sq3LiteC_OverloadFunction()

static OT_ProcRet tclsq3lite_Sq3LiteC_OverloadFunction ( Sq3LiteC_ARGS )

static

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

Definition at line 736 of file Sq3LiteC_tcl.c.

                                                                {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(2,2,OverloadFunction_doc);
  MK_STRN zFuncName = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (zFuncName))
  MK_I32 nArg = 0;
  OT_CHECK_REQUIRED(OT_CHECK_NI4 (nArg))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,Sq3LiteOverloadFunction (hdl, zFuncName, nArg));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclsq3lite_Sq3LiteC_Serialize()

static OT_ProcRet tclsq3lite_Sq3LiteC_Serialize ( Sq3LiteC_ARGS )

static

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

Definition at line 754 of file Sq3LiteC_tcl.c.

                                                         {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(2,2,Serialize_doc);
  MK_STRN zSchema = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (zSchema))
  enum Sq3SerializeE mFlags = 0;
  OT_CHECK_REQUIRED(OT_CHECK_ENUM (Sq3SerializeE,mFlags))
  OT_CHECK_NOARGS;
  MkBinaryR retVal = Sq3LiteSerialize (hdl, zSchema, mFlags);
  OT_retObj_SET(OT_GET__ME_REF_MkBinaryR(retVal));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclsq3lite_Sq3LiteC_TableColumnMetadata()

static OT_ProcRet tclsq3lite_Sq3LiteC_TableColumnMetadata ( Sq3LiteC_ARGS )

static

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

Definition at line 796 of file Sq3LiteC_tcl.c.

                                                                   {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(3,3,TableColumnMetadata_doc);
  MK_STRN zDbName = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (zDbName))
  MK_STRN zTableName = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (zTableName))
  MK_STRN zColumnName = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (zColumnName))
  OT_CHECK_NOARGS;
  MK_STRN pzDataType;
  MK_STRN pzCollSeq;
  MK_I32 pNotNull;
  MK_I32 pPrimaryKey;
  MK_I32 pAutoinc;
  MkErrorC_Check(hdl,Sq3LiteTableColumnMetadata (hdl, zDbName, zTableName, zColumnName, &pzDataType, &pzCollSeq, &pNotNull, &pPrimaryKey, &pAutoinc));
  OT_retObj_SET_List;
  OT_retObj_APPEND(OT_TMP_STR_OBJ(pzDataType));
  OT_retObj_APPEND(OT_TMP_STR_OBJ(pzCollSeq));
  OT_retObj_APPEND(OT_TMP_I32_OBJ(pNotNull));
  OT_retObj_APPEND(OT_TMP_I32_OBJ(pPrimaryKey));
  OT_retObj_APPEND(OT_TMP_I32_OBJ(pAutoinc));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}