cvs: phpdoc /en/reference/mysqli WARNING.txt constants.xml reference.xml

georg Wed Jan 28 18:19:38 2004 EDT Removed files: /phpdoc/en/reference/mysqli WARNING.txt Modified files: /phpdoc/en/reference/mysqli constants.xml reference.xml Log: docu update

http://cvs.php.net/diff.php/phpdoc/en/reference/mysqli/constants.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/mysqli/constants.xml diff -u phpdoc/en/reference/mysqli/constants.xml:1.2 phpdoc/en/reference/mysqli/constants.xml:1.3 --- phpdoc/en/reference/mysqli/constants.xml:1.2 Sat May 24 02:06:56 2003 +++ phpdoc/en/reference/mysqli/constants.xml Wed Jan 28 18:19:38 2004 @@ -17,7 +17,8 @@ <constant id='constantmysqli-read-default-group'>MYSQLI_READ_DEFAULT_GROUP</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry> + <entry> + Read options from the named group from `my.cnf' or the file specified with <literal>MYSQLI_READ_DEFAULT_FILE</literal> </entry> </row> <row> @@ -26,6 +27,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + Read options from the named option file instead of from <literal>my.cnf</literal> </entry> </row> <row> @@ -34,6 +36,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + Connect timeout in seconds </entry> </row> <row> @@ -42,6 +45,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + Enables command <literal>LOAD LOCAL INFILE</literal> </entry> </row> <row> @@ -50,6 +54,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + Command to execute when connecting to MySQL server. Will automatically be re-executed when reconnecting. </entry> </row> <row> @@ -58,6 +63,8 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + Use SSL (encrypted protocol). This option should not be set by application programs; + it is set internally in the MySQL client library </entry> </row> <row> @@ -66,6 +73,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + Use compression protocol </entry> </row> <row> @@ -74,6 +82,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + Allow interactive_timeout seconds (instead of wait_timeout seconds) of inactivity before closing the connection. The client's session wait_timeout variable will be set to the value of the session interactive_timeout variable. </entry> </row> <row> @@ -82,6 +91,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + Allow spaces after function names. Makes all functions names reserved words. </entry> </row> <row> @@ -90,6 +100,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + Don't allow the db_name.tbl_name.col_name syntax. </entry> </row> <row> @@ -106,6 +117,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + For using buffered resultsets </entry> </row> <row> @@ -114,6 +126,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + For using unbuffered resultsets </entry> </row> <row> @@ -122,6 +135,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + Columns are returned into the array having the fieldname as the array index. </entry> </row> <row> @@ -130,6 +144,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + Columns are returned into the array having an enumerated index. </entry> </row> <row> @@ -138,6 +153,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + Columns are returned into the array having both a numerical index and the fieldname as the associative index. </entry> </row> <row> @@ -146,6 +162,7 @@ (<link linkend='language.types.integer'>integer</link>) </entry> <entry> + Indicates that a field is defined as <literal>NOT NULL</literal> </entry> </row> <row> @@ -153,147 +170,153 @@ <constant id='constantmysqli-pri-key-flag'>MYSQLI_PRI_KEY_FLAG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry> + Field is part of a primary index + </entry> </row> <row> <entry> <constant id='constantmysqli-unique-key-flag'>MYSQLI_UNIQUE_KEY_FLAG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry> + Field is part of an unique index. + </entry> </row> <row> <entry> <constant id='constantmysqli-multiple-key-flag'>MYSQLI_MULTIPLE_KEY_FLAG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry> + Field is part of an index. + </entry> </row> <row> <entry> <constant id='constantmysqli-blob-flag'>MYSQLI_BLOB_FLAG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>BLOB</literal></entry> </row> <row> <entry> <constant id='constantmysqli-unsigned-flag'>MYSQLI_UNSIGNED_FLAG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>UNSIGNED</literal></entry> </row> <row> <entry> <constant id='constantmysqli-zerofill-flag'>MYSQLI_ZEROFILL_FLAG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>ZEROFILL</literal></entry> </row> <row> <entry> <constant id='constantmysqli-auto-increment-flag'>MYSQLI_AUTO_INCREMENT_FLAG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>AUTO_INCREMENT</literal></entry> </row> <row> <entry> <constant id='constantmysqli-timestamp-flag'>MYSQLI_TIMESTAMP_FLAG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>TIMESTAMP</literal></entry> </row> <row> <entry> <constant id='constantmysqli-set-flag'>MYSQLI_SET_FLAG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>SET</literal></entry> </row> <row> <entry> <constant id='constantmysqli-num-flag'>MYSQLI_NUM_FLAG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>NUMERIC</literal></entry> </row> <row> <entry> <constant id='constantmysqli-part-key-flag'>MYSQLI_PART_KEY_FLAG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is part of an multi-index</entry> </row> <row> <entry> <constant id='constantmysqli-group-flag'>MYSQLI_GROUP_FLAG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is part of <literal>GROUP BY</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-decimal'>MYSQLI_TYPE_DECIMAL</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>DECIMAL</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-tiny'>MYSQLI_TYPE_TINY</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>TINYINT</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-short'>MYSQLI_TYPE_SHORT</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>INT</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-long'>MYSQLI_TYPE_LONG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>MEDIUMINT</literal></entry> </row> <row> <entry> - <constant id='constantmysqli-type-fload'>MYSQLI_TYPE_FLOAD</constant> + <constant id='constantmysqli-type-fload'>MYSQLI_TYPE_FLOAT</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>FLOAT</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-double'>MYSQLI_TYPE_DOUBLE</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>double</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-null'>MYSQLI_TYPE_NULL</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>DEFAULT NULL</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-timestamp'>MYSQLI_TYPE_TIMESTAMP</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>TIMESTAMP</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-longlong'>MYSQLI_TYPE_LONGLONG</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>BIGINT</literal></entry> </row> <row> <entry> @@ -307,196 +330,140 @@ <constant id='constantmysqli-type-date'>MYSQLI_TYPE_DATE</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>DATE</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-time'>MYSQLI_TYPE_TIME</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>TIME</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-datetime'>MYSQLI_TYPE_DATETIME</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>DATETIME</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-year'>MYSQLI_TYPE_YEAR</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>YEAR</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-newdate'>MYSQLI_TYPE_NEWDATE</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>DATE</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-enum'>MYSQLI_TYPE_ENUM</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>ENUM</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-set'>MYSQLI_TYPE_SET</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>SET</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-tiny-blob'>MYSQLI_TYPE_TINY_BLOB</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>TINYBLOB</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-medium-blob'>MYSQLI_TYPE_MEDIUM_BLOB</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>MEDIUMBLOB</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-long-blob'>MYSQLI_TYPE_LONG_BLOB</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>LONGBLOB</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-blob'>MYSQLI_TYPE_BLOB</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> - </row> - <row> - <entry> - <constant id='constantmysqli-type-var-string'>MYSQLI_TYPE_VAR_STRING</constant> - (<link linkend='language.types.integer'>integer</link>) - </entry> - <entry></entry> + <entry>Field is defined as <literal>BLOB</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-string'>MYSQLI_TYPE_STRING</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>VARCHAR</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-char'>MYSQLI_TYPE_CHAR</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> - </row> - <row> - <entry> - <constant id='constantmysqli-type-interval'>MYSQLI_TYPE_INTERVAL</constant> - (<link linkend='language.types.integer'>integer</link>) - </entry> - <entry></entry> + <entry>Field is defined as <literal>CHAR</literal></entry> </row> <row> <entry> <constant id='constantmysqli-type-geometry'>MYSQLI_TYPE_GEOMETRY</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Field is defined as <literal>GEOMETRY</literal></entry> </row> <row> <entry> <constant id='constantmysqli-bind-string'>MYSQLI_BIND_STRING</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Bind variable has type <literal>STRING</literal></entry> </row> <row> <entry> <constant id='constantmysqli-bind-int'>MYSQLI_BIND_INT</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Bind variable has type <literal>INT</literal></entry> </row> <row> <entry> <constant id='constantmysqli-bind-double'>MYSQLI_BIND_DOUBLE</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>Bind variable has type <literal>DOUBLE</literal></entry> </row> <row> <entry> <constant id='constantmysqli-bind-send-data'>MYSQLI_BIND_SEND_DATA</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> - </row> - <row> - <entry> - <constant id='constantmysqli-rpl-master'>MYSQLI_RPL_MASTER</constant> - (<link linkend='language.types.integer'>integer</link>) - </entry> - <entry></entry> - </row> - <row> - <entry> - <constant id='constantmysqli-rpl-slave'>MYSQLI_RPL_SLAVE</constant> - (<link linkend='language.types.integer'>integer</link>) - </entry> - <entry></entry> - </row> - <row> - <entry> - <constant id='constantmysqli-rpl-admin'>MYSQLI_RPL_ADMIN</constant> - (<link linkend='language.types.integer'>integer</link>) - </entry> - <entry></entry> + <entry>Sending bind variable in chunks</entry> </row> <row> <entry> <constant id='constantmysqli-need-data'>MYSQLI_NEED_DATA</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> + <entry>More data available for bind variable</entry> </row> <row> <entry> <constant id='constantmysqli-no-data'>MYSQLI_NO_DATA</constant> (<link linkend='language.types.integer'>integer</link>) </entry> - <entry></entry> - </row> - <row> - <entry> - <constant id='constantmysqli-pr-report-stderr'>MYSQLI_PR_REPORT_STDERR</constant> - (<link linkend='language.types.integer'>integer</link>) - </entry> - <entry></entry> - </row> - <row> - <entry> - <constant id='constantmysqli-pr-report-port'>MYSQLI_PR_REPORT_PORT</constant> - (<link linkend='language.types.integer'>integer</link>) - </entry> - <entry></entry> - </row> - <row> - <entry> - <constant id='constantmysqli-pr-report-file'>MYSQLI_PR_REPORT_FILE</constant> - (<link linkend='language.types.integer'>integer</link>) - </entry> - <entry></entry> + <entry>No more data available for bind variable</entry> </row> </tbody> </tgroup> http://cvs.php.net/diff.php/phpdoc/en/reference/mysqli/reference.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/mysqli/reference.xml diff -u phpdoc/en/reference/mysqli/reference.xml:1.4 phpdoc/en/reference/mysqli/reference.xml:1.5 --- phpdoc/en/reference/mysqli/reference.xml:1.4 Sun May 25 10:59:26 2003 +++ phpdoc/en/reference/mysqli/reference.xml Wed Jan 28 18:19:38 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <reference id='ref.mysqli'> <title>Improved MySQL Extension</title> <titleabbrev>mysqli</titleabbrev> @@ -16,9 +16,7 @@ Documentation for MySQL can be found at <ulink url="&url.mysql.docs;">&url.mysql.docs;</ulink>. </para> - - &warn.experimental; - + <para>Parts of this documentation included from MySQL manual with permissions of MySQL AB.</para> </section> <section id='mysqli.requirements'> @@ -29,7 +27,7 @@ </para> <note> <para> - The mysqli extension is designed to work with the version 4.1 or above + The mysqli extension is designed to work with the version 4.1.2 or above of MySQL. For previous versions, please see the <link linkend="ref.mysql">MySQL</link> extension documentation. </para> @@ -39,28 +37,280 @@ &reference.mysqli.configure; &reference.mysqli.ini; - <section id='mysqli.resources'> - &reftitle.resources; + <section id='mysqli.classes'> + &reftitle.classes - <section id='mysqli.resources.mysqli_link'> - <title><literal>mysqli_link</literal></title> + <section id='mysqli.class.mysql'> + <title><classname>mysqli</classname></title> <para> Represents a connection between PHP and a MySQL database. </para> + <section id='mysqli.class.mysql.constructor'> + &reftitle.constructor + <itemizedlist> + <listitem> + <para><link linkend='function.mysqli-connect'>mysqli()</link> - construct a new mysqli object</para> + </listitem> + </itemizedlist> + </section> + <section id='mysqli.class.mysql.methods'> + &reftitle.methods + <itemizedlist> + <listitem> + <para><link linkend='function.mysqli-autocommit'>autocommit()</link> - turns on or off auto-commiting database modifications</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-change-user'>change_user()</link> - changes the user of the specified database connection</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-character-set-name'>character_set_name</link> - returns the default character set for the database connection</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-close'>close</link> - closes a previously opened connection</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-commit'>commit</link> - commits the current transaction</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-connect'>connect</link> - opens a new connection to MySQL database server</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-debug'>debug</link> - performs debugging operations</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-dump-debug-info'>dump_debug_info</link> - dumps debug information</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-get-client-info'>get_client_info</link> - returns client version</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-get-host-info'>get_host_info</link> - returns type of connection used</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-get-server-info'>get_server_info</link> - returns version of the MySQL server</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-init'>init</link> - initializes mysqli object</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-info'>info</link> - retrieves information about the most recently executed query</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-kill'>kill</link> - asks the server to kill a mysql thread</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-multi-query'>multi_query</link> - performs multiple queries</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-more-results'>more_results</link> - checks if more results exists from currently executed multi-query</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-next-result'>next_result</link> - reads next result from currently executed multi-query</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-options'>options</link> - set options</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-ping'>ping</link> - pings a server connection or reconnects if there is no connection</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-prepare'>prepare</link> - prepares a SQL query</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-query'>query</link> - performs a query</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-real-connect'>real_connect</link> - attempts to open a connection to MySQL database server</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-real-escape-string'>escape_string</link> - Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the connection</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-rollback'>rollback</link> - rolls back the current transaction</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-select_db'>select_db</link> - selects the default database</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-set-opt'>set_opt</link> - sets options</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-ssl-set'>ssl_set</link> - sets ssl parameters</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-stat'>stat</link> - gets the current system status</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-store-result'>store_result</link> - transfers a resultset from last query</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-use-result'>use_result</link> - transfers an unbuffered resultset from last query</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-thread-safe'>thread-safe</link> - returns whether thread safety is given or not</para> + </listitem> + </itemizedlist> + </section> + <section id='mysqli.class.mysql.properties'> + &reftitle.properties + <itemizedlist> + <listitem> + <para><link linkend='function.mysqli-affected-rows'>affected_rows</link> - gets the number of affected rows in a previous MySQL operation</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-errno'>errno</link> - returns the error code for the most recent function call</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-error'>error</link> - returns the error string for the most recent function call</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-field-count'>field_count</link> - returns the number of columns for the most recent query</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-get-host-info'>host_info</link> - returns a string representing the type of connection used</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-info'>info</link> - retrieves information about the most recently executed query</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-insert-id'>insert-id</link> - returns the auto generated id used in the last query</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-get-proto-info'>protocol_version</link> - returns the version of the MySQL protocol used</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-sqlstate'>sqlstate</link> - returns a string containing the SQLSTATE error code for the last error</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-thread-id'>thread_id</link> - returns the thread ID for the current connection</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-warning-count'>warning-count</link> - returns the number of warnings generated during execution of the previous SQL statement </para> + </listitem> + + </itemizedlist> + </section> </section> - <section id='mysqli.resources.mysqli_stmt'> - <title><literal>mysqli_stmt</literal></title> + <section id='mysqli.classes.stmt'> + <title><classname>stmt</classname></title> <para> Represents a prepared statement. </para> + <section id='mysqli.class.stmt.methods'> + &reftitle.methods + <itemizedlist> + <listitem> + <para><link linkend='function.mysqli-bind-param'>bind_param</link> - Binds variables to a prepared statement</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-bind-result'>bind_result</link> - Binds variables to a prepared statement for result storage</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-stmt-close'>close</link> - Closes a prepared statement</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-stmt-data-seek'>data-seek</link> - Seeks to an arbitrary row in a statement result set</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-execute'>execute</link> - Executes a prepared statement</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-fetch'>fetch</link> - Fetches result from a prepared statement into bound variables</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-get-metadata'>get_metadata</link> - Retrieves a resultset from a prepared statement for metadata information</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-send-long-data'>send_long_data</link> - Sends data in chunks</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-stmt-store-result'>store_result</link> - Buffers complete resultset from a prepared statement</para> + </listitem> + </itemizedlist> + </section> + <section id='mysqli.class.stmt.properties'> + &reftitle.properties + <itemizedlist> + <listitem> + <para><link linkend='function.mysqli-stmt-affected-rows'>affected_rows</link> - Returns affected rows from last statement execution</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-stmt-field-count'>field_count</link> - Returns number of fields for a given prepared statement</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-stmt-errno'>errno</link> - Returns errorcode for last statement function</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-stmt-error'>errno</link> - Returns errormessage for last statement function</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-param-count'>param_count</link> - Returns number of parameter for a given prepare statement</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-stmt-sqlstate'>sqlstate</link> - returns a string containing the SQLSTATE error code for the last statement function</para> + </listitem> + </itemizedlist> + </section> </section> - <section id='mysqli.resources.mysqli_result'> - <title><literal>mysqli_result</literal></title> + <section id='mysqli.classes.result'> + <title><classname>result</classname></title> <para> Represents the result set obtained from a query against the database. </para> + <section id='mysqli.class.result.methods'> + &reftitle.methods + <itemizedlist> + <listitem> + <para><link linkend='function.mysqli-free-result'>close</link> - closes resultset</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-data-seek'>data_seek</link> - moves internal result pointer</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-fetch-field'>fetch_field</link> - gets column information from a resultset</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-fetch-fields'>fetch_fields</link> - gets information for all columns from a resulset</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-fetch-field-direct'>fetch_field_direct</link> - gets column information for specified column</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-fetch-array'>fetch_array</link> - fetches a result row as an associative array, a numeric array, or both.</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-fetch-assoc'>fetch_assoc</link> - fetches a result row as an associative array</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-fetch-object'>fetch_object</link> - fetches a result row as an object</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-fetch-row'>fetch_row</link> - gets a result row as an enumerated array</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-free-result'>close</link> - frees result memory</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-field-seek'>field_seek</link> - set result pointer to a specified field offset</para> + </listitem> + </itemizedlist> + </section> + <section id='mysqli.class.result.properties'> + &reftitle.properties + <itemizedlist> + <listitem> + <para><link linkend='function.mysqli-field-tell'>current_field</link> - returns offset of current fieldpointer</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-field-count'>field_count</link> - returns number of fields in resultset</para> + </listitem> + <listitem> + <para><link linkend='function.mysqli-num-rows'>num_rows</link> - returns number of rows in resultset</para> + </listitem> + </itemizedlist> + </section> </section> </section> @@ -68,8 +318,7 @@ </partintro> -&reference.mysqli.functions; - + &reference.mysqli.functions; </reference> <!-- Keep this comment at the end of the file