Class TSLDatabase

Unit

Declaration

type TSLDatabase = class()

Description

Methods

Overview

	procedure BeginTransaction;
	procedure Close;
	procedure CloseDataSets;
	function CloseVM (var aSQLite_VM: Integer; var anErrMsg: String): Integer;
	procedure Commit;
	constructor Create (AOwner: TComponent); override;
	destructor Destroy; override;
	function DoGetDBList (aStrs: TStrings): Boolean;
	function DoGetTable (aStrs: TStrings): Boolean;
	function ExecSQL (anObj: TObject; const aSQL: String; aForceTrans: Boolean; var anErrMsg: String): Integer;
	procedure FreeTable (aPtr: Pointer);
	function GetDBInfo (const aDbName: String): TDBInfo;
	function GetDBListCount: Integer;
	function GetDBListItem (const anIdx: Integer): TDBInfo;
	function GetFunCount: Integer;
	function GetFunItem (const anIdx: Integer): TObject;
	function GetIndexInfo (const aTblName: String; const anIdxName: String): TIdxInfo;
	function GetIndexList (const aTblName: String; aStrs: TStrings): Boolean;
	function GetTable (const aSQL: String; var aResult: Pointer; var aRecCount: Cardinal; var aColCount: Cardinal; var anErrMsg: String): Integer;
	function GetTableCount: Integer;
	function GetTableItem (const anIdx: Integer): TTblInfo;
	function GetTblInfo (const aTblName: String): TTblInfo;
	procedure InitializeDB;
	procedure InitializeFun (aFun: TObject = nil);
	function LastInsertRow: Integer;
	procedure Loaded; override;
	procedure Open;
	function OpenVM (const aSQL: String; var aTail: String; var aSQLite_VM: Integer; var anErrMsg: String): Integer;
	procedure RefreshDBList;
	procedure RefreshTblList;
	procedure RegisterAggregate (aFunObject: TObject);
	procedure RegisterDataSet (aDtSet: TObject);
	procedure RegisterFunction (aFun: TObject);
	procedure Rollback;
	function VMStep (const aSQLite_VM: Integer; var aColCount: Cardinal; var aValuePtr: Pointer; var aColsPtr: Pointer): Integer;

Description

procedure BeginTransaction;

Starting transaction.

procedure Close;

closing database connection.

procedure CloseDataSets;

closing all datasets connected to the database

function CloseVM (var aSQLite_VM: Integer; var anErrMsg: String): Integer;

procedure Commit;

Commiting transaction.

constructor Create (AOwner: TComponent); override;

destructor Destroy; override;

function DoGetDBList (aStrs: TStrings): Boolean;

function DoGetTable (aStrs: TStrings): Boolean;

function ExecSQL (anObj: TObject; const aSQL: String; aForceTrans: Boolean; var anErrMsg: String): Integer;

query engine with Exec function (callback)

procedure FreeTable (aPtr: Pointer);

function GetDBInfo (const aDbName: String): TDBInfo;

info of a database (SQLite file) defined by name. See also TDBInfo.

function GetDBListCount: Integer;

function GetDBListItem (const anIdx: Integer): TDBInfo;

function GetFunCount: Integer;

function GetFunItem (const anIdx: Integer): TObject;

function GetIndexInfo (const aTblName: String; const anIdxName: String): TIdxInfo;

info of index specified by name. See also TIdxInfo.

function GetIndexList (const aTblName: String; aStrs: TStrings): Boolean;

list of indices for table specified by name.

function GetTable (const aSQL: String; var aResult: Pointer; var aRecCount: Cardinal; var aColCount: Cardinal; var anErrMsg: String): Integer;

query engine with GetTable API function (all data at once)

function GetTableCount: Integer;

function GetTableItem (const anIdx: Integer): TTblInfo;

function GetTblInfo (const aTblName: String): TTblInfo;

info of a table defined by name. See also TTblInfo.

procedure InitializeDB;

procedure InitializeFun (aFun: TObject = nil);

function LastInsertRow: Integer;

procedure Loaded; override;

procedure Open;

opening database connection.

function OpenVM (const aSQL: String; var aTail: String; var aSQLite_VM: Integer; var anErrMsg: String): Integer;

procedure RefreshDBList;

refreshing cached information about attached databases (SQLite files).

procedure RefreshTblList;

refreshing cached information about tables/views structure.

procedure RegisterAggregate (aFunObject: TObject);

procedure RegisterDataSet (aDtSet: TObject);

procedure RegisterFunction (aFun: TObject);

procedure Rollback;

Cancelling (rooling back) transaction.

function VMStep (const aSQLite_VM: Integer; var aColCount: Cardinal; var aValuePtr: Pointer; var aColsPtr: Pointer): Integer;

Properties

Overview

	property Active: Boolean;
	property DBList[const Idx: Integer]: TDBInfo;
	property DBListCount: Integer;
	property DBName: TFileName;
	property Engine: TSLEngine;
	property Fun[const Idx: Integer]: TObject;
	property FunCount: Integer;
	property Handle: Pointer;
	property InTransaction: Boolean;
	property SLDBOptions: TSLDBOptions;
	property Table[const Idx: Integer]: TTblInfo;
	property TableCount: Integer;

Description

property Active: Boolean;

Determine if database is connected.

property DBList[const Idx: Integer]: TDBInfo;

Information about attached database (SQLite file). See also TDBInfo.

property DBListCount: Integer;

Number of databases (SQLite files) being attached.

property DBName: TFileName;

Name of file with main database.

property Engine: TSLEngine;

Engine object.

property Fun[const Idx: Integer]: TObject;

property FunCount: Integer;

property Handle: Pointer;

Handle to SQLite object

property InTransaction: Boolean;

Determinig if database is in transaction.

property SLDBOptions: TSLDBOptions;

Options speciffied for database. See also TSLDBOptions.

property Table[const Idx: Integer]: TTblInfo;

Table or view selected by it's numver. See also TTblInfo.

property TableCount: Integer;

Number of tables/views.