sack::sql Namespace

SQL access library. This provides a simple access to ODBC connections, and to sqlite. If no database is specified, there is an internal database that can be used. These methods on the PODBC connection are NOT thread safe. Multiple threads shall never use the same PODBC; they can use seperate PODBC connections. Under linux this links to unixODBC.

DoSQLCommandf

DoSQLRecordQueryf

GetSQLRecord

ConnectToDatabase

DoSQLCommandf

DoSQLRecordQueryf

FetchSQLRecord

There is a configuration file for the default SQL connection, this is kept in a file 'sql.config' which is processed with ProcessConfigurationFile(); If this file does not exist, it will be automatically created with default values.

(Need to describe this sql.config file)

Namespace

sack Namespace

Namespaces

Name	Description
options	Contains methods for saving and recovering options from a database. If enabled, will use a local option.db sqlite database. Use EditOptions application to modify options. Can use any database connection, but sql.config file will specify 'option.db' to start.

Topics

Name	Description
Classes	The following table lists classes in this documentation.
Structs, Records, Enums	The following table lists structs, records, enums in this documentation.
Types	The following table lists types in this documentation.
Macros	The following table lists macros in this documentation.

Classes

	Name	Description
	required_key_def	Describes a key column of a table.

Macros

Name	Description
CheckODBCTable	This is macro sack::sql::CheckODBCTable.
ConvertSQLDate
ConvertSQLDateTime
CreateTable
DoSQLCommand
DoSQLQuery
DoSQLQueryRecord
DoSQLRecordQuery
EscapeBinary
EscapeSQLBinary
EscapeSQLString
EscapeString
FetchLastInsertID
FIELDS	recently added {} container braces for structure element
GetFieldsInSQL
GetLastInsertID
GetNameIndex	This is macro sack::sql::GetNameIndex.
GetNameIndexEx	This is macro sack::sql::GetNameIndexEx.
GetSQLResultRecord
IsSQLOpen	This is macro sack::sql::IsSQLOpen.
MAX_KEY_COLUMNS	maximum columns that can be specified for a multicolumn index in required_key_def.
MAX_PREVIOUS_FIELD_NAMES	a field definition can be a rename, and contain prior names, so that the rename can be tracked and migrated appropraitely. Unfortuntaly this sort of operation only affects this code, and not all auxiliary code.
OpenSQLConnect	This is macro sack::sql::OpenSQLConnect.
PopODBC	This is macro sack::sql::PopODBC.
PopODBCEx	This is macro sack::sql::PopODBCEx.
PushSQLQueryEx
ReadFromNameTable
ReadFromNameTableExx
ReadNameTable
ReadNameTableExx
SQLCommand
SQLCreateTable
SQLPROXY_PROC	This is macro PSSQL_PROC.
SQLQuery
SQLQueryRecord
SQLReadNameTable
SQLReadNameTableExx
SQLRecordQuery
TABLE_KEYS	sets the count and the array of a statically declared required_table_tag.

Structs, Records, Enums

	Name	Description
	CreateTableOptions	CreateTable Options (CTO_)
	required_field_tag
	required_table_tag
	responce_tag	some internal stub-proxy linkage for generating remote responders.. This was work in progress for providing a msgsvr service to SQL. One of the implementations of this library was across a windows message queue using ATOM types to transport results and commands. Was going to implement this on the abstract msgqueue interface.
	FIELD
	PFIELD
	PSQL_RESPONCE	some internal stub-proxy linkage for generating remote responders.. This was work in progress for providing a msgsvr service to SQL. One of the implementations of this library was across a windows message queue using ATOM types to transport results and commands. Was going to implement this on the abstract msgqueue interface.
	SQL_RESPONCE	some internal stub-proxy linkage for generating remote responders.. This was work in progress for providing a msgsvr service to SQL. One of the implementations of this library was across a windows message queue using ATOM types to transport results and commands. Was going to implement this on the abstract msgqueue interface.

Types

Name	Description
DB_KEY_DEF	Describes a key column of a table.
HandleSQLFeedback	Function signature for the callback when the SQL layer can log a status about a database connection (connection, disconnected, failed...) See SQLSetFeedbackHandler.
ODBC	This is the connection object that provides interface to the database. Can be NULL to specify the default connection interface. See namespace sql. An ODBC connection handles commands as a stack. Each command is done as a temporary entry on the stack. A query is done as an entry on the stack, but the entry remains on the stack until the final result is retrieved or an early PopODBC is called. The structure of this is such that if a command is slow to a database, it would be possible to stack commands that are temporary and pending until... more
PDB_KEY_DEF	Describes a key column of a table.
PTABLE
result_responder	function call signature for callback method passed to RegisterResponceHandler.
TABLE

Links

sack Namespace, Legend, Namespaces, Topics, Classes, Macros, Structs, Records, Enums, Types

Created with a commercial version of

Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at

support@toolsfactory.com.

Contents | Index | Reference | Home

What do you think about this topic? Send feedback!