php-doc-en/reference/mysqli/reference.xml

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.19 $ -->
 <reference id='ref.mysqli'>
  <title>Improved MySQL Extension</title>
  <titleabbrev>mysqli</titleabbrev>

  <partintro>
   <section id='mysqli.intro'>
    &reftitle.intro;
    <para>
     The mysqli extension allows you to access the functionality provided by
     MySQL 4.1 and above. More information about the MySQL Database server 
     can be found at <ulink url="&url.mysql;">&url.mysql;</ulink>
    </para>
    <para>
     Documentation for MySQL can be found at <ulink
     url="&url.mysql.docs;">&url.mysql.docs;</ulink>.
    </para>
    <para>Parts of this documentation included from MySQL manual with permissions of MySQL AB.</para>
   </section>
   
   <section id='mysqli.requirements'>
    &reftitle.required;
    <para>
     In order to have these functions available, you must compile PHP with
     support for the mysqli extension.
    </para>
    <note>
     <para>
      The mysqli extension is designed to work with the version 4.1.3 or above
      of MySQL. For previous versions, please see the <link
      linkend="ref.mysql">MySQL</link> extension documentation.
     </para>
    </note>
   </section>

   &reference.mysqli.configure;
   &reference.mysqli.ini;
   
   <section id='mysqli.classes'>
    &reftitle.classes;

    <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-get-server-version'>get_server_version</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> - check if more results exist 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-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-stmt-init'>stmt_init</link>- initializes a statement for use with <link linkend='function.mysqli-stmt-prepare'>mysqli_stmt_prepare</link></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-get-client-info'>client_info</link> - returns the MySQL client version as a string</para>
       </listitem>
       <listitem>
        <para><link linkend='function.mysqli-get-client-version'>client_version</link> - returns the MySQL client version as an integer</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.classes.stmt'>
     <title><classname>mysqli_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-stmt-free-result'>free_result</link> - frees stored result memory for the given statement handle</para>
       </listitem>
       <listitem>
        <para><link linkend='function.mysqli-stmt-result-metadata'>result_metadata</link> - retrieves a resultset from a prepared statement for metadata information</para>
       </listitem>
       <listitem>
        <para><link linkend='function.mysqli-stmt-prepare'>prepare</link> - prepares a SQL query</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-reset'>reset</link> - resets a prepared statement</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-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-stmt-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.classes.result'>
     <title><classname>mysqli_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-fetch-lengths'>lengths</link> - returns an array of columnlengths</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>

   &reference.mysqli.constants;
   
   <section>
    <title>Examples</title>
    <para>
     All Examples in the MySQLI documentation use the world database from MySQL AB.
     The world database can be found at <ulink url="&url.mysql.example;">&url.mysql.example;</ulink>
    </para>
   </section>   
  </partintro>

  &reference.mysqli.functions;
 </reference>

<!-- 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
-->