theSq3Lite 10.0
Loading...
Searching...
No Matches
Sq3LiteC_Misc_CC_API

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

+ Collaboration diagram for Sq3LiteC_Misc_CC_API:

Functions

MkBufferListCccsq3lite::Sq3LiteC::DbStatusBFL (Sq3DbStatusE op, MK_BOOL resetFlg)
  C++: MkBufferListC* sq3lite.DbStatusBFL(Sq3DbStatusE op, MK_BOOL resetFlg) C-API
Database Connection Status …
 
void ccsq3lite::Sq3LiteC::DbCacheflush ()
  C++: sq3lite.DbCacheflush() C-API
Flush caches to disk mid-transaction …
 
SQ3_FILENAME ccsq3lite::Sq3LiteC::DbFilename (MK_STRN zDbName)
  C++: SQ3_FILENAME db.DbFilename(MK_STRN zDbName) C-API
Return The Filename For A Database Connection …
 
SQ3_FILENAME ccsq3lite::Sq3LiteC::DbFilename (const std::string &zDbName)
  C++: SQ3_FILENAME db.DbFilename(MK_STRN zDbName) C-API
Return The Filename For A Database Connection …
 
MK_STRN ccsq3lite::Sq3LiteC::DbName (MK_I32 N)
  C++: MK_STRN db.DbName(MK_I32 N) C-API
Return The Schema Name For A Database Connection …
 
void ccsq3lite::Sq3LiteC::DbReadonly (MK_STRN zDbName)
  C++: db.DbReadonly(MK_STRN zDbName) C-API
Determine if a database is read-only …
 
void ccsq3lite::Sq3LiteC::DbReadonly (const std::string &zDbName)
  C++: db.DbReadonly(MK_STRN zDbName) C-API
Determine if a database is read-only …
 
void ccsq3lite::Sq3LiteC::DbReleaseMemory ()
  C++: sq3lite.DbReleaseMemory() C-API
Free Memory Used By A Database Connection …
 
void ccsq3lite::Sq3LiteC::Deserialize (MK_STRN zSchema, MK_BNP pData, Sq3DeSerializeEF mFlags)
  C++: sq3lite.Deserialize(MK_STRN zSchema, MK_BNP pData, Sq3DeSerializeEF mFlags) C-API
Deserialize a database …
 
void ccsq3lite::Sq3LiteC::Deserialize (const std::string &zSchema, MK_BNP pData, Sq3DeSerializeEF mFlags)
  C++: sq3lite.Deserialize(MK_STRN zSchema, MK_BNP pData, Sq3DeSerializeEF mFlags) C-API
Deserialize a database …
 
void ccsq3lite::Sq3LiteC::DropModules (MkBufferListC *azKeepBfl)
  C++: sq3lite.DropModules(MkBufferListC* azKeepBfl) C-API
Remove Unnecessary Virtual Table Implementations …
 
void ccsq3lite::Sq3LiteC::DropModules (const MkBufferListC &azKeepBfl)
  C++: sq3lite.DropModules(MkBufferListC* azKeepBfl) C-API
Remove Unnecessary Virtual Table Implementations …
 
void ccsq3lite::Sq3LiteC::OverloadFunction (MK_STRN zFuncName, MK_I32 nArg)
  C++: sq3lite.OverloadFunction(MK_STRN zFuncName, MK_I32 nArg) C-API
Overload A Function For A Virtual Table …
 
void ccsq3lite::Sq3LiteC::OverloadFunction (const std::string &zFuncName, MK_I32 nArg)
  C++: sq3lite.OverloadFunction(MK_STRN zFuncName, MK_I32 nArg) C-API
Overload A Function For A Virtual Table …
 
MK_BNP ccsq3lite::Sq3LiteC::Serialize (MK_STRN zSchema, Sq3SerializeE mFlags)
  C++: MK_BNP sq3lite.Serialize(MK_STRN zSchema, Sq3SerializeE mFlags) C-API
Serialize a database …
 
MK_BNP ccsq3lite::Sq3LiteC::Serialize (const std::string &zSchema, Sq3SerializeE mFlags)
  C++: MK_BNP sq3lite.Serialize(MK_STRN zSchema, Sq3SerializeE mFlags) C-API
Serialize a database …
 
std::tuple< MK_I32, MK_I32ccsq3lite::Sq3LiteC::DbStatus (Sq3DbStatusE op, MK_BOOL resetFlg)
  C++: {pCur:MK_I32 pHiwtr:MK_I32} sq3lite.DbStatus(Sq3DbStatusE op, MK_BOOL resetFlg) C-API
Database Connection Status …
 
std::tuple< MK_STRN, MK_STRN, MK_I32, MK_I32, MK_I32ccsq3lite::Sq3LiteC::TableColumnMetadata (MK_STRN zDbName, MK_STRN zTableName, MK_STRN zColumnName)
  C++: {pzDataType:MK_STRN pzCollSeq:MK_STRN pNotNull:MK_I32 pPrimaryKey:MK_I32 pAutoinc:MK_I32} db.TableColumnMetadata(MK_STRN zDbName, MK_STRN zTableName, MK_STRN zColumnName) C-API
Extract Metadata About A Column Of A Table …
 
std::tuple< MK_STRN, MK_STRN, MK_I32, MK_I32, MK_I32ccsq3lite::Sq3LiteC::TableColumnMetadata (const std::string &zDbName, const std::string &zTableName, const std::string &zColumnName)
  C++: {pzDataType:MK_STRN pzCollSeq:MK_STRN pNotNull:MK_I32 pPrimaryKey:MK_I32 pAutoinc:MK_I32} db.TableColumnMetadata(MK_STRN zDbName, MK_STRN zTableName, MK_STRN zColumnName) C-API
Extract Metadata About A Column Of A Table …
 

Detailed Description

Sq3LiteC - various functions to perform misc operations …

Function Documentation

◆ DbCacheflush()

void ccsq3lite::Sq3LiteC::DbCacheflush ( )
inline

C++: sq3lite.DbCacheflush() C-API
Flush caches to disk mid-transaction …

Definition at line 401 of file Sq3LiteC_inline_cc.hh.

401 {
402 MK_UNUSED auto sq3lite = getLITE();
403 enum MkErrorE errVal = Sq3LiteDbCacheflush(sq3lite);
404 MkErrorC_Check(sq3lite, errVal);
405 }
#define MK_UNUSED
SQ3_LITE getLITE() const
return the LibMsgqueObject from current Sq3LiteC instance
static enum MkErrorE Sq3LiteDbCacheflush(SQ3_LITE sq3lite)
Flush caches to disk mid-transaction …

◆ DbFilename() [1/2]

SQ3_FILENAME ccsq3lite::Sq3LiteC::DbFilename ( const std::string & zDbName)
inline

C++: SQ3_FILENAME db.DbFilename(MK_STRN zDbName) C-API
Return The Filename For A Database Connection …

Definition at line 415 of file Sq3LiteC_inline_cc.hh.

415 {
416 MK_UNUSED auto db = getLITE();
417 const MK_STRN zDbName_hdl = zDbName.c_str();
418 SQ3_FILENAME __retVal__L = Sq3LiteDbFilename(db, zDbName_hdl);
419 return __retVal__L;
420 }
const MK_STRB * MK_STRN
static SQ3_FILENAME Sq3LiteDbFilename(SQ3_LITE db, MK_STRN zDbName)
Return The Filename For A Database Connection …

◆ DbFilename() [2/2]

SQ3_FILENAME ccsq3lite::Sq3LiteC::DbFilename ( MK_STRN zDbName)
inline

C++: SQ3_FILENAME db.DbFilename(MK_STRN zDbName) C-API
Return The Filename For A Database Connection …

Definition at line 408 of file Sq3LiteC_inline_cc.hh.

408 {
409 MK_UNUSED auto db = getLITE();
410 SQ3_FILENAME __retVal__L = Sq3LiteDbFilename(db, zDbName);
411 return __retVal__L;
412 }

◆ DbName()

MK_STRN ccsq3lite::Sq3LiteC::DbName ( MK_I32 N)
inline

C++: MK_STRN db.DbName(MK_I32 N) C-API
Return The Schema Name For A Database Connection …

Definition at line 423 of file Sq3LiteC_inline_cc.hh.

423 {
424 MK_UNUSED auto db = getLITE();
425 MK_STRN __retVal__L = Sq3LiteDbName(db, N);
426 return __retVal__L;
427 }
static MK_STRN Sq3LiteDbName(SQ3_LITE db, MK_I32 N)
Return The Schema Name For A Database Connection …

◆ DbReadonly() [1/2]

void ccsq3lite::Sq3LiteC::DbReadonly ( const std::string & zDbName)
inline

C++: db.DbReadonly(MK_STRN zDbName) C-API
Determine if a database is read-only …

Definition at line 437 of file Sq3LiteC_inline_cc.hh.

437 {
438 MK_UNUSED auto db = getLITE();
439 const MK_STRN zDbName_hdl = zDbName.c_str();
440 enum MkErrorE errVal = Sq3LiteDbReadonly(db, zDbName_hdl);
441 MkErrorC_Check(db, errVal);
442 }
static enum MkErrorE Sq3LiteDbReadonly(SQ3_LITE db, MK_STRN zDbName)
Determine if a database is read-only …

◆ DbReadonly() [2/2]

void ccsq3lite::Sq3LiteC::DbReadonly ( MK_STRN zDbName)
inline

C++: db.DbReadonly(MK_STRN zDbName) C-API
Determine if a database is read-only …

Definition at line 430 of file Sq3LiteC_inline_cc.hh.

430 {
431 MK_UNUSED auto db = getLITE();
432 enum MkErrorE errVal = Sq3LiteDbReadonly(db, zDbName);
433 MkErrorC_Check(db, errVal);
434 }

◆ DbReleaseMemory()

void ccsq3lite::Sq3LiteC::DbReleaseMemory ( )
inline

C++: sq3lite.DbReleaseMemory() C-API
Free Memory Used By A Database Connection …

Definition at line 445 of file Sq3LiteC_inline_cc.hh.

445 {
446 MK_UNUSED auto sq3lite = getLITE();
447 enum MkErrorE errVal = Sq3LiteDbReleaseMemory(sq3lite);
448 MkErrorC_Check(sq3lite, errVal);
449 }
static enum MkErrorE Sq3LiteDbReleaseMemory(SQ3_LITE sq3lite)
Free Memory Used By A Database Connection …

◆ DbStatus()

std::tuple< MK_I32, MK_I32 > ccsq3lite::Sq3LiteC::DbStatus ( Sq3DbStatusE op,
MK_BOOL resetFlg )
inline

C++: {pCur:MK_I32 pHiwtr:MK_I32} sq3lite.DbStatus(Sq3DbStatusE op, MK_BOOL resetFlg) C-API
Database Connection Status …

Definition at line 521 of file Sq3LiteC_inline_cc.hh.

521 {
522 MK_UNUSED auto sq3lite = getLITE();
523 MK_I32 pCur;
524 MK_I32 pHiwtr;
525 enum MkErrorE errVal = Sq3LiteDbStatus(sq3lite, op, &pCur, &pHiwtr, resetFlg);
526 MkErrorC_Check(sq3lite, errVal);
527 std::tuple<MK_I32,MK_I32> __retVal__L = {pCur,pHiwtr};
528 return __retVal__L;
529 }
signed int MK_I32
static enum MkErrorE Sq3LiteDbStatus(SQ3_LITE sq3lite, enum Sq3DbStatusE op, MK_I32 *pCur, MK_I32 *pHiwtr, MK_BOOL resetFlg)
Database Connection Status …

◆ DbStatusBFL()

MkBufferListC * ccsq3lite::Sq3LiteC::DbStatusBFL ( Sq3DbStatusE op,
MK_BOOL resetFlg )
inline

C++: MkBufferListC* sq3lite.DbStatusBFL(Sq3DbStatusE op, MK_BOOL resetFlg) C-API
Database Connection Status …

Definition at line 390 of file Sq3LiteC_inline_cc.hh.

390 {
391 MK_UNUSED auto sq3lite = getLITE();
392 MK_BFL val_out;
393 enum MkErrorE errVal = Sq3LiteDbStatusBFL(sq3lite, op, &val_out, resetFlg);
394 MkErrorC_Check(sq3lite, errVal);
396 }
static MkBufferListC * MkBufferListC_ObjNew(MK_RT_ARGS MK_BFL hdl)
struct MkBufferListS * MK_BFL
#define MK_RT_CALL
#define Sq3LiteDbStatusBFL(...)

◆ Deserialize() [1/2]

void ccsq3lite::Sq3LiteC::Deserialize ( const std::string & zSchema,
MK_BNP pData,
Sq3DeSerializeEF mFlags )
inline

C++: sq3lite.Deserialize(MK_STRN zSchema, MK_BNP pData, Sq3DeSerializeEF mFlags) C-API
Deserialize a database …

Definition at line 460 of file Sq3LiteC_inline_cc.hh.

460 {
461 MK_UNUSED auto sq3lite = getLITE();
462 const MK_STRN zSchema_hdl = zSchema.c_str();
463 const MkBinaryR pData_ref = MkBinaryCreate(pData.first,pData.second);
464 enum MkErrorE errVal = Sq3LiteDeserialize(sq3lite, zSchema_hdl, pData_ref, mFlags);
465 MkErrorC_Check(sq3lite, errVal);
466 }
static MkBinaryR MkBinaryCreate(MK_SIZE size, MK_BINN data)
#define Sq3LiteDeserialize(...)

◆ Deserialize() [2/2]

void ccsq3lite::Sq3LiteC::Deserialize ( MK_STRN zSchema,
MK_BNP pData,
Sq3DeSerializeEF mFlags )
inline

C++: sq3lite.Deserialize(MK_STRN zSchema, MK_BNP pData, Sq3DeSerializeEF mFlags) C-API
Deserialize a database …

Definition at line 452 of file Sq3LiteC_inline_cc.hh.

452 {
453 MK_UNUSED auto sq3lite = getLITE();
454 const MkBinaryR pData_ref = MkBinaryCreate(pData.first,pData.second);
455 enum MkErrorE errVal = Sq3LiteDeserialize(sq3lite, zSchema, pData_ref, mFlags);
456 MkErrorC_Check(sq3lite, errVal);
457 }

◆ DropModules() [1/2]

void ccsq3lite::Sq3LiteC::DropModules ( const MkBufferListC & azKeepBfl)
inline

C++: sq3lite.DropModules(MkBufferListC* azKeepBfl) C-API
Remove Unnecessary Virtual Table Implementations …

Definition at line 477 of file Sq3LiteC_inline_cc.hh.

477 {
478 MK_UNUSED auto sq3lite = getLITE();
479 const MK_BFL azKeepBfl_hdl = MkBufferListC::getBFL(azKeepBfl);
480 enum MkErrorE errVal = Sq3LiteDropModules(sq3lite, azKeepBfl_hdl);
481 MkErrorC_Check(sq3lite, errVal);
482 }
#define Sq3LiteDropModules(...)

◆ DropModules() [2/2]

void ccsq3lite::Sq3LiteC::DropModules ( MkBufferListC * azKeepBfl)
inline

C++: sq3lite.DropModules(MkBufferListC* azKeepBfl) C-API
Remove Unnecessary Virtual Table Implementations …

Definition at line 469 of file Sq3LiteC_inline_cc.hh.

469 {
470 MK_UNUSED auto sq3lite = getLITE();
471 MK_BFL azKeepBfl_hdl = MkBufferListC::getBFL(azKeepBfl);
472 enum MkErrorE errVal = Sq3LiteDropModules(sq3lite, azKeepBfl_hdl);
473 MkErrorC_Check(sq3lite, errVal);
474 }

◆ OverloadFunction() [1/2]

void ccsq3lite::Sq3LiteC::OverloadFunction ( const std::string & zFuncName,
MK_I32 nArg )
inline

C++: sq3lite.OverloadFunction(MK_STRN zFuncName, MK_I32 nArg) C-API
Overload A Function For A Virtual Table …

Definition at line 496 of file Sq3LiteC_inline_cc.hh.

496 {
497 MK_UNUSED auto sq3lite = getLITE();
498 const MK_STRN zFuncName_hdl = zFuncName.c_str();
499 enum MkErrorE errVal = Sq3LiteOverloadFunction(sq3lite, zFuncName_hdl, nArg);
500 MkErrorC_Check(sq3lite, errVal);
501 }
static enum MkErrorE Sq3LiteOverloadFunction(SQ3_LITE sq3lite, MK_STRN zFuncName, MK_I32 nArg)
Overload A Function For A Virtual Table …

◆ OverloadFunction() [2/2]

void ccsq3lite::Sq3LiteC::OverloadFunction ( MK_STRN zFuncName,
MK_I32 nArg )
inline

C++: sq3lite.OverloadFunction(MK_STRN zFuncName, MK_I32 nArg) C-API
Overload A Function For A Virtual Table …

Definition at line 489 of file Sq3LiteC_inline_cc.hh.

489 {
490 MK_UNUSED auto sq3lite = getLITE();
491 enum MkErrorE errVal = Sq3LiteOverloadFunction(sq3lite, zFuncName, nArg);
492 MkErrorC_Check(sq3lite, errVal);
493 }

◆ Serialize() [1/2]

MK_BNP ccsq3lite::Sq3LiteC::Serialize ( const std::string & zSchema,
Sq3SerializeE mFlags )
inline

C++: MK_BNP sq3lite.Serialize(MK_STRN zSchema, Sq3SerializeE mFlags) C-API
Serialize a database …

Definition at line 511 of file Sq3LiteC_inline_cc.hh.

511 {
512 MK_UNUSED auto sq3lite = getLITE();
513 const MK_STRN zSchema_hdl = zSchema.c_str();
514 MkBinaryR __retVal__L = Sq3LiteSerialize(sq3lite, zSchema_hdl, mFlags);
515 return std::make_pair(MkBinaryGetSize(__retVal__L),MkBinaryGetData(__retVal__L));
516 }
static MK_SIZE MkBinaryGetSize(const MkBinaryR bin)
static MK_BINN MkBinaryGetData(const MkBinaryR bin)
static MkBinaryR Sq3LiteSerialize(SQ3_LITE sq3lite, MK_STRN zSchema, enum Sq3SerializeE mFlags)
Serialize a database …

◆ Serialize() [2/2]

MK_BNP ccsq3lite::Sq3LiteC::Serialize ( MK_STRN zSchema,
Sq3SerializeE mFlags )
inline

C++: MK_BNP sq3lite.Serialize(MK_STRN zSchema, Sq3SerializeE mFlags) C-API
Serialize a database …

Definition at line 504 of file Sq3LiteC_inline_cc.hh.

504 {
505 MK_UNUSED auto sq3lite = getLITE();
506 MkBinaryR __retVal__L = Sq3LiteSerialize(sq3lite, zSchema, mFlags);
507 return std::make_pair(MkBinaryGetSize(__retVal__L),MkBinaryGetData(__retVal__L));
508 }

◆ TableColumnMetadata() [1/2]

std::tuple< MK_STRN, MK_STRN, MK_I32, MK_I32, MK_I32 > ccsq3lite::Sq3LiteC::TableColumnMetadata ( const std::string & zDbName,
const std::string & zTableName,
const std::string & zColumnName )
inline

C++: {pzDataType:MK_STRN pzCollSeq:MK_STRN pNotNull:MK_I32 pPrimaryKey:MK_I32 pAutoinc:MK_I32} db.TableColumnMetadata(MK_STRN zDbName, MK_STRN zTableName, MK_STRN zColumnName) C-API
Extract Metadata About A Column Of A Table …

Definition at line 546 of file Sq3LiteC_inline_cc.hh.

546 {
547 MK_UNUSED auto db = getLITE();
548 MK_STRN pzDataType;
549 MK_STRN pzCollSeq;
550 MK_I32 pNotNull;
551 MK_I32 pPrimaryKey;
552 MK_I32 pAutoinc;
553 const MK_STRN zDbName_hdl = zDbName.c_str();
554 const MK_STRN zTableName_hdl = zTableName.c_str();
555 const MK_STRN zColumnName_hdl = zColumnName.c_str();
556 enum MkErrorE errVal = Sq3LiteTableColumnMetadata(db, zDbName_hdl, zTableName_hdl, zColumnName_hdl, &pzDataType, &pzCollSeq, &pNotNull, &pPrimaryKey, &pAutoinc);
557 MkErrorC_Check(db, errVal);
558 std::tuple<MK_STRN,MK_STRN,MK_I32,MK_I32,MK_I32> __retVal__L = {pzDataType,pzCollSeq,pNotNull,pPrimaryKey,pAutoinc};
559 return __retVal__L;
560 }
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 …

◆ TableColumnMetadata() [2/2]

std::tuple< MK_STRN, MK_STRN, MK_I32, MK_I32, MK_I32 > ccsq3lite::Sq3LiteC::TableColumnMetadata ( MK_STRN zDbName,
MK_STRN zTableName,
MK_STRN zColumnName )
inline

C++: {pzDataType:MK_STRN pzCollSeq:MK_STRN pNotNull:MK_I32 pPrimaryKey:MK_I32 pAutoinc:MK_I32} db.TableColumnMetadata(MK_STRN zDbName, MK_STRN zTableName, MK_STRN zColumnName) C-API
Extract Metadata About A Column Of A Table …

Definition at line 532 of file Sq3LiteC_inline_cc.hh.

532 {
533 MK_UNUSED auto db = getLITE();
534 MK_STRN pzDataType;
535 MK_STRN pzCollSeq;
536 MK_I32 pNotNull;
537 MK_I32 pPrimaryKey;
538 MK_I32 pAutoinc;
539 enum MkErrorE errVal = Sq3LiteTableColumnMetadata(db, zDbName, zTableName, zColumnName, &pzDataType, &pzCollSeq, &pNotNull, &pPrimaryKey, &pAutoinc);
540 MkErrorC_Check(db, errVal);
541 std::tuple<MK_STRN,MK_STRN,MK_I32,MK_I32,MK_I32> __retVal__L = {pzDataType,pzCollSeq,pNotNull,pPrimaryKey,pAutoinc};
542 return __retVal__L;
543 }