X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref-transaction.xml;fp=doc%2Fref-transaction.xml;h=0d708b7e5729e2182a499a35ce425892cf5f1187;hb=5248ae9f94d2022596ef8846e0581ea716607a84;hp=0000000000000000000000000000000000000000;hpb=23a10375f83c89c138369e05c8f57f679bb43ec9;p=clsql.git diff --git a/doc/ref-transaction.xml b/doc/ref-transaction.xml new file mode 100644 index 0000000..0d708b7 --- /dev/null +++ b/doc/ref-transaction.xml @@ -0,0 +1,548 @@ + + +%myents; +]> + + + + Transaction Handling + + + + + + + + + ADD-TRANSACTION-COMMIT-HOOK + + Function + + + Syntax + + (ADD-TRANSACTION-COMMIT-HOOK DATABASE COMMIT-HOOK) [function] => + + + Arguments and Values + + + + + + Description + + + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + ADD-TRANSACTION-ROLLBACK-HOOK + + Function + + + Syntax + + (ADD-TRANSACTION-ROLLBACK-HOOK DATABASE ROLLBACK-HOOK) [function] => + + + Arguments and Values + + + + + + Description + + + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + COMMIT + + Function + + + Syntax + + (COMMIT &KEY (DATABASE *DEFAULT-DATABASE*)) [function] => + + + Arguments and Values + + + + + + Description + If DATABASE, which defaults to *DEFAULT-DATABASE*, is + currently within the scope of a transaction, commits changes + made since the transaction began. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + + IN-TRANSACTION-P + + Function + + + Syntax + + (IN-TRANSACTION-P &KEY (DATABASE *DEFAULT-DATABASE*)) [function] => + + + Arguments and Values + + + + + + Description + A predicate to test whether DATABASE, which + defaults to *DEFAULT-DATABASE*, is currently within + the scope of a transaction. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + ROLLBACK + + Function + + + Syntax + + (ROLLBACK &KEY (DATABASE *DEFAULT-DATABASE*)) [function] => + + + Arguments and Values + + + + + + Description + If DATABASE, which defaults to *DEFAULT-DATABASE*, is + currently within the scope of a transaction, rolls back changes + made since the transaction began. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + SET-AUTOCOMMIT + + Function + + + Syntax + + (SET-AUTOCOMMIT VALUE &KEY (DATABASE *DEFAULT-DATABASE*)) [function] => + + + Arguments and Values + + + + + + Description + Sets autocommit on or off. Returns old value of of autocommit flag. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + + + + START-TRANSACTION + + Function + + + Syntax + + (START-TRANSACTION &KEY (DATABASE *DEFAULT-DATABASE*)) [function] => + + + Arguments and Values + + + + + + Description + Starts a transaction block on DATABASE which defaults to + *DEFAULT-DATABASE* and which continues until ROLLBACK or COMMIT + are called. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + WITH-TRANSACTION + + Function + + + Syntax + + (WITH-TRANSACTION &KEY (DATABASE '*DEFAULT-DATABASE*) &REST BODY) [macro] => + + + Arguments and Values + + + + + + Description + Starts a transaction in the database + specified by DATABASE, which is *DEFAULT-DATABASE* by + default, and executes BODY within that transaction. If + BODY aborts or throws, DATABASE is rolled back and + otherwise the transaction is committed. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + +