1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/sesam.xml, last change in rev 1.1 -->
<refentry id="function.sesam-settransaction">
<refnamediv>
<refname>sesam_settransaction</refname>
<refpurpose>Set SESAM transaction parameters</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>sesam_settransaction</methodname>
<methodparam><type>int</type><parameter>isolation_level</parameter></methodparam>
<methodparam><type>int</type><parameter>read_only</parameter></methodparam>
</methodsynopsis>
<para>
Returns: &true; if the values are valid, and the
<function>settransaction</function> operation was successful,
&false; otherwise.
</para>
<para>
<function>sesam_settransaction</function> overrides the default
values for the "isolation level" and "read-only" transaction
parameters (which are set in the SESAM configuration file), in
order to optimize subsequent queries and guarantee database
consistency. The overridden values are used for the next
transaction only.
</para>
<para>
<function>sesam_settransaction</function> can only be called
before starting a transaction, not after the transaction has been
started already.
</para>
<para>
To simplify the use in PHP scripts, the following constants have
been predefined in PHP (see SESAM handbook for detailed
explanation of the semantics):
<table>
<title>
Valid values for <parameter>"Isolation_Level"</parameter>
parameter
</title>
<tgroup cols="3">
<thead>
<row>
<entry>Value</entry>
<entry>Constant</entry>
<entry>Meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry><literal>SESAM_TXISOL_READ_UNCOMMITTED</literal></entry>
<entry>Read Uncommitted</entry>
</row>
<row>
<entry>2</entry>
<entry><literal>SESAM_TXISOL_READ_COMMITTED</literal></entry>
<entry>Read Committed</entry>
</row>
<row>
<entry>3</entry>
<entry><literal>SESAM_TXISOL_REPEATABLE_READ</literal></entry>
<entry>Repeatable Read</entry>
</row>
<row>
<entry>4</entry>
<entry><literal>SESAM_TXISOL_SERIALIZABLE</literal></entry>
<entry>Serializable</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>
Valid values for <parameter>"Read_Only"</parameter> parameter
</title>
<tgroup cols="3">
<thead>
<row>
<entry>Value</entry>
<entry>Constant</entry>
<entry>Meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry>0</entry>
<entry><literal>SESAM_TXREAD_READWRITE</literal></entry>
<entry>Read/Write</entry>
</row>
<row>
<entry>1</entry>
<entry><literal>SESAM_TXREAD_READONLY</literal></entry>
<entry>Read-Only</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
The values set by <function>sesam_settransaction</function> will
override the default setting specified in the <link
linkend="ini.sesam-configfile">SESAM configuration file</link>.
</para>
<para>
<example>
<title>Setting SESAM transaction parameters</title>
<programlisting role="php">
<![CDATA[
<?php
sesam_settransaction (SESAM_TXISOL_REPEATABLE_READ,
SESAM_TXREAD_READONLY);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|