acs-db-00-procs.tcl

Publicity: Public Only All

acs-db-00-procs.tcl

Low level interface for defining the basic classes for the DB interface.
This file defines the following Objects and Classes: ::acs::db::Driver, ::acs::db::nsdb, ::acs::db::nsdbi

Location:

packages/acs-tcl/tcl/acs-db-00-procs.tcl
Created:

2022-02-07
Author:

Gustaf Neumann

Procedures in this file

Class ::acs::db::Driver (public)
Class ::acs::db::nsdb (public)
Class ::acs::db::nsdbi (public)
acs::db::Driver instproc qn (public)
acs::db::nsdb instproc list (public)
acs::db::nsdb instproc list_of_lists (public)
acs::db::nsdbi instproc list (public)
acs::db::nsdbi instproc list_of_lists (public)

Detailed information

Class ::acs::db::Driver (public)

 ::nx::Class ::acs::db::Driver

Abstract class of the database interface

Testcases:
No testcase defined.

Class ::acs::db::nsdb (public)

 ::nx::Class ::acs::db::nsdb

Database interface based on the nsdb driver of NaviServer

Testcases:
No testcase defined.

Class ::acs::db::nsdbi (public)

 ::nx::Class ::acs::db::nsdbi

Database interface based on the nsdbi driver of NaviServer

Testcases:
No testcase defined.

acs::db::Driver method qn (public)

 <instance of acs::db::Driver> qn query_name

Return fully qualified query name as used in OpenACS.

Parameters:

query_name (required)

Testcases:
No testcase defined.

acs::db::nsdb method list (public)

 <instance of acs::db::nsdb> list [ -dbn dbn ] [ -bind bind ] \
    [ -prepare prepare ] qn sql

Return a Tcl list, where each element contains just the first the column values of the tuples returned by the provided SQL query.

Switches:

-dbn (optional)
database identifier
-bind (optional)
optional bind variables for the SQL query
-prepare (optional)
type information for the bind variables in the prepared statement

Parameters:

qn (required)
name of the SQL query

sql (required)
SQL query

Testcases:
No testcase defined.

acs::db::nsdb method list_of_lists (public)

 <instance of acs::db::nsdb> list_of_lists [ -dbn dbn ] \
    [ -bind bind ] [ -prepare prepare ] qn sql

Return a Tcl list, where each element consists of a list of the column values corresponding to the values of the tuples returned by the provided SQL query.

Switches:

-dbn (optional)
database identifier
-bind (optional)
optional bind variables for the SQL query
-prepare (optional)
type information for the bind variables in the prepared statement

Parameters:

qn (required)
name of the SQL query

sql (required)
SQL query

Testcases:
No testcase defined.

acs::db::nsdbi method list (public)

 <instance of acs::db::nsdbi> list [ -dbn dbn ] [ -bind bind ] \
    [ -prepare prepare ] qn sql

Return a Tcl list, where each element contains just the first the column values of the tuples returned by the provided SQL query.

Switches:

-dbn (optional)
database identifier
-bind (optional)
optional bind variables for the SQL query
-prepare (optional)
not used for NSDBI, providing interface compatibility with NSDB

Parameters:

qn (required)
name of the SQL query

sql (required)
SQL query

Testcases:
No testcase defined.

acs::db::nsdbi method list_of_lists (public)

 <instance of acs::db::nsdbi> list_of_lists [ -dbn dbn ] \
    [ -bind bind ] [ -prepare prepare ] qn sql

Return a Tcl list, where each element consists of a list of the column values corresponding to the values of the tuples returned by the provided SQL query.

Switches:

-dbn (optional)
database identifier
-bind (optional)
optional bind variables for the SQL query
-prepare (optional)
not used for NSDBI, providing interface compatibility with NSDB

Parameters:

qn (required)
name of the SQL query

sql (required)
SQL query

Testcases:
No testcase defined.

[ show source ]