Index: openacs-4/packages/acs-core-docs/www/db-api-detailed.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/db-api-detailed.adp,v diff -u -r1.5.2.5 -r1.5.2.6 --- openacs-4/packages/acs-core-docs/www/db-api-detailed.adp 26 Aug 2020 07:46:25 -0000 1.5.2.5 +++ openacs-4/packages/acs-core-docs/www/db-api-detailed.adp 2 May 2021 20:18:15 -0000 1.5.2.6 @@ -386,7 +386,7 @@
db_foreach
-db_foreachstatement-name sql [ -bind bind_set_id | -bind bind_value_list ] \ +db_foreach statement-name sql [ -bind bind_set_id | -bind bind_value_list ] \ [ -column_array array_name | -column_set set_name ] \ code_block [ if_no_rows if_no_rows_block ]
Performs the SQL query sql
, executing code_block
once for each row
@@ -407,7 +407,7 @@
db_1row
-db_1rowstatement-namesql [ -bind bind_set_id | -bind bind_value_list ] \ +db_1row statement-name sql [ -bind bind_set_id | -bind bind_value_list ] \ [ -column_array array_name | -column_set set_name ]
Performs the SQL query sql
, setting variables to
column values. Raises an error if the query does not return exactly
@@ -421,15 +421,15 @@
db_0or1row
-db_0or1rowstatement-namesql [ -bind bind_set_id | -bind bind_value_list ] \ +db_0or1row statement-name sql [ -bind bind_set_id | -bind bind_value_list ] \ [ -column_array array_name | -column_set set_name ]
Performs the SQL query sql
. If a row is returned, sets
variables to column values and returns 1. If no rows are returned,
returns 0. If more than one row is returned, throws an error.
db_string
-db_stringstatement-namesql [ -default default ] [ -bind bind_set_id | -bind bind_value_list ] +db_string statement-name sql [ -default default ] [ -bind bind_set_id | -bind bind_value_list ]
Returns the first column of the result of SQL query sql
.
If sql
doesn't return a row,
returns default
(or throws an error if
@@ -438,38 +438,38 @@
db_nextval
-db_nextvalsequence-name +db_nextval sequence-name
Returns the next value for the sequence sequence-name (using a SQL statement
like SELECT
sequence-name
.nextval FROM DUAL
). If sequence pooling is
enabled for the sequence, transparently uses a value from the pool
if available to save a round-trip to the database.
db_list
-db_liststatement-namesql [ -bind bind_set_id | -bind bind_value_list ] +db_list statement-name sql [ -bind bind_set_id | -bind bind_value_list ]
Returns a Tcl list of the values in the first column of the
result of SQL query sql
. If sql
doesn't return any rows, returns an empty list. Analogous to
database_to_tcl_list
.
db_list_of_lists
-db_list_of_listsstatement-namesql [ -bind bind_set_id | -bind bind_value_list ] +db_list_of_lists statement-name sql [ -bind bind_set_id | -bind bind_value_list ]
Returns a Tcl list, each element of which is a list of all
column values in a row of the result of SQL query sql
.
If sql
doesn't return any
rows, returns an empty list. (Analogous to database_to_tcl_list_list
.)
db_list_of_ns_sets
-db_list_of_ns_setsstatement-namesql [ -bind bind_set_id | -bind bind_value_list ] +db_list_of_ns_sets statement-name sql [ -bind bind_set_id | -bind bind_value_list ]
Returns a list of ns_sets with the values of each column of each
row returned by the sql
query
specified.
db_dml
-db_dmlstatement-namesql \ +db_dml statement-name sql \ [ -bind bind_set_id | -bind bind_value_list ] \ [ -blobs blob_list | -clobs clob_list | -blob_files blob_file_list | -clob_files clob_file_list ] @@ -501,11 +501,11 @@ db_blob_get_file
-db_write_clobstatement-namesql [ -bind bind_set_id | -bind bind_value_list ] +db_write_clob statement-name sql [ -bind bind_set_id | -bind bind_value_list ] -db_write_blobstatement-namesql [ -bind bind_set_id | -bind bind_value_list ] +db_write_blob statement-name sql [ -bind bind_set_id | -bind bind_value_list ] -db_blob_get_filestatement-namesql [ -bind bind_set_id | -bind bind_value_list ] +db_blob_get_file statement-name sql [ -bind bind_set_id | -bind bind_value_list ]
Analogous to ns_ora
write_clob/write_blob/blob_get_file
.
@@ -514,7 +514,7 @@
db_transaction
-db_transactioncode_block [ on_error { code_block } ]
+db_transaction code_block [ on_error { code_block } ]
Executes code_block
transactionally.
Nested transactions are supported (end
transaction
is transparently ns_db dml
'ed when the outermost
@@ -614,7 +614,7 @@
db_with_handle
-db_with_handlevarcode_block
+db_with_handle var code_block
Places a database handle into the variable var
and executes code_block
. This is useful when
you don't want to have to use the new API (db_foreach
, db_1row
, etc.), but need to use database