mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
7734036606
Jim have you realized that the functions anchors are now broken again in the bigmanual? git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@9915 c90b9560-bf6c-de11-be94-00142212c4b1
971 lines
31 KiB
Text
971 lines
31 KiB
Text
|
|
<reference id="ref.msql">
|
|
<title>mSQL functions</title>
|
|
<titleabbrev>mSQL</titleabbrev>
|
|
|
|
<refentry id="function.msql">
|
|
<refnamediv>
|
|
<refname>msql</refname>
|
|
<refpurpose>send mSQL query</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql</function></funcdef>
|
|
<paramdef>string <parameter>database</parameter></paramdef>
|
|
<paramdef>string <parameter>query</parameter></paramdef>
|
|
<paramdef>int <parameter>link_identifier</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns a positive mSQL query identifier to the query result, or
|
|
false on error.
|
|
<para>
|
|
msql() selects a database and executes a query on it. If the
|
|
optional link identifier isn't specified, the function will try
|
|
to find an open link to the mSQL server and if no such link is
|
|
found it'll try to create one as if
|
|
<function>msql_connect</function> was called with no arguments
|
|
(see <function>msql_connect</function>).
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-affected-rows">
|
|
<refnamediv>
|
|
<refname>msql_affected_rows</refname>
|
|
<refpurpose>returns number of affected rows</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_affected_rows</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns number of affected ("touched") rows by a specific query
|
|
(i.e. the number of rows returned by a SELECT, the number of rows
|
|
modified by an update, or the number of rows removed by a delete).
|
|
<para>
|
|
See also:
|
|
<function>msql_query</function>
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-close">
|
|
<refnamediv>
|
|
<refname>msql_close</refname>
|
|
<refpurpose>close mSQL connection</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_close</function></funcdef>
|
|
<paramdef>int <parameter>link_identifier</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns true on success, false on error.
|
|
<para>
|
|
msql_close() closes the link to a mSQL database that's associated
|
|
with the specified link identifier. If the link identifier isn't
|
|
specified, the last opened link is assumed.
|
|
<para>
|
|
Note that this isn't usually necessary, as non-persistent open
|
|
links are automatically closed at the end of the script's
|
|
execution.
|
|
<para>
|
|
msql_close() will not close persistent links generated by
|
|
<function>msql_pconnect</function>.
|
|
<para>
|
|
See also:
|
|
<function>msql_connect</function> and
|
|
<function>msql_pconnect</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-connect">
|
|
<refnamediv>
|
|
<refname>msql_connect</refname>
|
|
<refpurpose>open mSQL connection</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_connect</function></funcdef>
|
|
<paramdef>string <parameter>hostname</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns a positive mSQL link identifier on success, or false on
|
|
error.
|
|
<para>
|
|
msql_connect() establishes a connection to a mSQL server. The
|
|
hostname argument is optional, and if it's missing, localhost is
|
|
assumed.
|
|
<para>
|
|
In case a second call is made to msql_connect() with the same
|
|
arguments, no new link will be established, but instead, the link
|
|
identifier of the already opened link will be returned.
|
|
<para>
|
|
The link to the server will be closed as soon as the execution of
|
|
the script ends, unless it's closed earlier by explicitly calling
|
|
<function>msql_close</function>.
|
|
<para>
|
|
See also
|
|
<function>msql_pconnect</function>,
|
|
<function>msql_close</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-create-db">
|
|
<refnamediv>
|
|
<refname>msql_create_db</refname>
|
|
<refpurpose>create mSQL database</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_create_db</function></funcdef>
|
|
<paramdef>string <parameter>database name</parameter></paramdef>
|
|
<paramdef>int <parameter><optional>link_identifier</optional>
|
|
</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
msql_create_db() attempts to create a new database on the server
|
|
associated with the specified link identifier.
|
|
<para>
|
|
See also:
|
|
<function>msql_drop_db</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-createdb">
|
|
<refnamediv>
|
|
<refname>msql_createdb</refname>
|
|
<refpurpose>create mSQL database</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_createdb</function></funcdef>
|
|
<paramdef>string <parameter>database name</parameter></paramdef>
|
|
<paramdef>int <parameter><optional>link_identifier</optional>
|
|
</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Identical to <function>msql_create_db</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-data-seek">
|
|
<refnamediv>
|
|
<refname>msql_data_seek</refname>
|
|
<refpurpose>move internal row pointer</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_data_seek</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
<paramdef>int <parameter>row_number</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns true on success, false on failure.
|
|
<para>
|
|
msql_data_seek() moves the internal row pointer of the mSQL
|
|
result associated with the specified query identifier to pointer
|
|
to the specifyed row number. The next call to
|
|
<function>msql_fetch_row</function> would return that row.
|
|
<para>
|
|
See also:
|
|
<function>msql_fetch_row</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-dbname">
|
|
<refnamediv>
|
|
<refname>msql_dbname</refname>
|
|
<refpurpose>get current mSQL database name</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>string <function>msql_dbname</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
<paramdef>int <parameter>i</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
<function>msql_dbname</function> returns the database name stored
|
|
in position <parameter>i</parameter> of the result pointer
|
|
returned from the <function>msql_listdbs</function> function. The
|
|
<function>msql_numrows</function> function can be used to
|
|
determine how many database names are available.
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-drop-db">
|
|
<refnamediv>
|
|
<refname>msql_drop_db</refname>
|
|
<refpurpose>drop (delete) mSQL database</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_drop_db</function></funcdef>
|
|
<paramdef>string <parameter>database_name</parameter></paramdef>
|
|
<paramdef>int <parameter>link_identifier</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns true on success, false on failure.
|
|
<para>
|
|
msql_drop_db() attempts to drop (remove) an entire database from
|
|
the server associated with the specified link identifier.
|
|
<para>
|
|
See also:
|
|
<function>msql_create_db</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-dropdb">
|
|
<refnamediv>
|
|
<refname>msql_dropdb</refname>
|
|
<refpurpose>drop (delete) mSQL database</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>See <function>msql_drop_db</function>.</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-error">
|
|
<refnamediv>
|
|
<refname>msql_error</refname>
|
|
<refpurpose>returns error message of last msql call</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>string <function>msql_error</function></funcdef>
|
|
<paramdef> <parameter></parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Errors coming back from the mSQL database backend no longer
|
|
issue warnings. Instead, use these functions to retrieve the
|
|
error string.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-fetch-array">
|
|
<refnamediv>
|
|
<refname>msql_fetch_array</refname>
|
|
<refpurpose>fetch row as array</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_fetch_array</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns an array that corresponds to the fetched row, or false if
|
|
there are no more rows.
|
|
<para>
|
|
<function>msql_fetch_array</function> is an extended version of
|
|
<function>msql_fetch_row</function>. In addition to storing the
|
|
data in the numeric indices of the result array, it also stores
|
|
the data in associative indices, using the field names as keys.
|
|
<para>
|
|
Be careful if you are retrieving results from a query that may
|
|
return a record that contains only one field that has a value of
|
|
0 (or an empty string, or NULL).
|
|
<para>
|
|
An important thing to note is that using
|
|
<function>msql_fetch_array</function> is NOT significantly slower
|
|
than using <function>msql_fetch_row</function>, while it provides
|
|
a significant added value. <para> For further details, also see
|
|
<function>msql_fetch_row</function>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-fetch-field">
|
|
<refnamediv>
|
|
<refname>msql_fetch_field</refname>
|
|
<refpurpose>get field information</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>object <function>msql_fetch_field</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
<paramdef>int <parameter>field_offset</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns an object containing field information
|
|
<para>
|
|
msql_fetch_field() can be used in order to obtain information
|
|
about fields in a certain query result. If the field offset
|
|
isn't specified, the next field that wasn't yet retreived by
|
|
msql_fetch_field() is retreived.
|
|
<para>
|
|
The properties of the object are:
|
|
<itemizedlist>
|
|
<listitem><simpara>name - column name</simpara></listitem>
|
|
<listitem><simpara>table - name of the table the column belongs
|
|
to</simpara></listitem>
|
|
<listitem><simpara>not_null - 1 if the column cannot be
|
|
null</simpara></listitem>
|
|
<listitem><simpara>primary_key - 1 if the column is a primary
|
|
key</simpara></listitem>
|
|
<listitem><simpara>unique - 1 if the column is a unique
|
|
key</simpara></listitem>
|
|
<listitem><simpara>type - the type of the
|
|
column</simpara></listitem>
|
|
</itemizedlist>
|
|
<para>
|
|
See also
|
|
<function>msql_field_seek</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-fetch-object">
|
|
<refnamediv>
|
|
<refname>msql_fetch_object</refname>
|
|
<refpurpose>fetch row as object</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_fetch_object</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns an object with properties that correspond to the fetched
|
|
row, or false if there are no more rows.
|
|
<para>
|
|
msql_fetch_object() is similar to
|
|
<function>msql_fetch_array</function>, with one difference - an
|
|
object is returned, instead of an array. Indirectly, that means
|
|
that you can only access the data by the field names, and not by
|
|
their offsets (numbers are illegal property names).
|
|
<para>
|
|
Speed-wise, the function is identical to
|
|
<function>msql_fetch_array</function>, and almost as quick as
|
|
<function>msql_fetch_row</function> (the difference is
|
|
insignificant).
|
|
<para> See also:
|
|
<function>msql_fetch_array</function> and
|
|
<function>msql_fetch_row</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-fetch-row">
|
|
<refnamediv>
|
|
<refname>msql_fetch_row</refname>
|
|
<refpurpose>get row as enumerated array</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>array <function>msql_fetch_row</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns an array that corresponds to the fetched row, or false if
|
|
there are no more rows.
|
|
<para>
|
|
msql_fetch_row() fetches one row of data from the result
|
|
associated with the specified query identifier. The row is
|
|
returned as an array. Each result column is stored in an array
|
|
offset, starting at offset 0.
|
|
<para>
|
|
Subsequent call to msql_fetch_row() would return the next row in
|
|
the result set, or false if there are no more rows.
|
|
<para> See also:
|
|
<function>msql_fetch_array</function>,
|
|
<function>msql_fetch_object</function>,
|
|
<function>msql_data_seek</function>, and
|
|
<function>msql_result</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-fieldname">
|
|
<refnamediv>
|
|
<refname>msql_fieldname</refname>
|
|
<refpurpose>get field name</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>string <function>msql_fieldname</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
<paramdef>int <parameter>field</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
msql_fieldname() returns the name of the specified field.
|
|
<parameter>query_identifier</parameter> is the query identifier, and
|
|
<parameter>field</parameter> is the field index.
|
|
<literal>msql_fieldname($result, 2);</literal> will return the
|
|
name of the second field in the result associated with the result
|
|
identifier.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-field-seek">
|
|
<refnamediv>
|
|
<refname>msql_field_seek</refname>
|
|
<refpurpose>set field offset</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_field_seek</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
<paramdef>int <parameter>field_offset</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Seeks to the specified field offset. If the next call to
|
|
<function>msql_fetch_field</function> won't include a field
|
|
offset, this field would be returned.
|
|
<para>
|
|
See also:
|
|
<function>msql_fetch_field</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-fieldtable">
|
|
<refnamediv>
|
|
<refname>msql_fieldtable</refname>
|
|
<refpurpose>get table name for field</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_fieldtable</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
<paramdef>int <parameter>field</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns the name of the table <parameter>field</parameter> was
|
|
fetched from.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-fieldtype">
|
|
<refnamediv>
|
|
<refname>msql_fieldtype</refname>
|
|
<refpurpose>get field type</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>string <function>msql_fieldtype</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
<paramdef>int <parameter>i</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
msql_fieldtype() is similar to the
|
|
<function>msql_fieldname</function> function. The arguments are
|
|
identical, but the field type is returned. This will be one of
|
|
"int", "string" or "real".
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-fieldflags">
|
|
<refnamediv>
|
|
<refname>msql_fieldflags</refname>
|
|
<refpurpose>get field flags</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>string <function>msql_fieldflags</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
<paramdef>int <parameter>i</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
msql_fieldflags() returns the field flags of the specified
|
|
field. Currently this is either, "not null", "primary key", a
|
|
combination of the two or "" (an empty string).
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-fieldlen">
|
|
<refnamediv>
|
|
<refname>msql_fieldlen</refname>
|
|
<refpurpose>get field length</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_fieldlen</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
<paramdef>int <parameter>i</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
msql_fieldlen() returns the length of the specified field.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-free-result">
|
|
<refnamediv>
|
|
<refname>msql_free_result</refname>
|
|
<refpurpose>free result memory</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_free_result</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
<function>msql_free_result</function> frees the memory associated
|
|
with <parameter>query_identifier</parameter>. When PHP completes a
|
|
request, this memory is freed automatically, so you only need to
|
|
call this function when you want to make sure you don't use too
|
|
much memory while the script is running.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-freeresult">
|
|
<refnamediv>
|
|
<refname>msql_freeresult</refname>
|
|
<refpurpose>free result memory</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>See <function>msql_free_result</function>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-list-fields">
|
|
<refnamediv>
|
|
<refname>msql_list_fields</refname>
|
|
<refpurpose>list result fields</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_list_fields</function></funcdef>
|
|
<paramdef>string <parameter>database</parameter></paramdef>
|
|
<paramdef>string <parameter>tablename</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
msql_list_fields() retrieves information about
|
|
the given tablename. Arguments are the database name and the
|
|
table name. A result pointer is returned which can be used with
|
|
<function>msql_fieldflags</function>,
|
|
<function>msql_fieldlen</function>,
|
|
<function>msql_fieldname</function>, and
|
|
<function>msql_fieldtype</function>.
|
|
A query identifier is a positive integer. The function returns
|
|
<literal>-1</literal> if a error occurs. A string describing the
|
|
error will be placed in <literal>$phperrmsg</literal>, and unless
|
|
the function was called as <literal>@msql_list_fields()</literal>
|
|
then this error string will also be printed out.
|
|
<para>
|
|
See also <function>msql_error</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-listfields">
|
|
<refnamediv>
|
|
<refname>msql_listfields</refname>
|
|
<refpurpose>list result fields</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>See <function>msql_list_fields</function>.
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-list-dbs">
|
|
<refnamediv>
|
|
<refname>msql_list_dbs</refname>
|
|
<refpurpose>list mSQL databases on server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_list_dbs</function></funcdef>
|
|
<void>
|
|
</funcsynopsis>
|
|
<para>
|
|
<function>msql_list_dbs</function> will return a result pointer
|
|
containing the databases available from the current msql
|
|
daemon. Use the <function>msql_dbname</function> function to
|
|
traverse this result pointer.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-listdbs">
|
|
<refnamediv>
|
|
<refname>msql_listdbs</refname>
|
|
<refpurpose>list mSQL databases on server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>See <function>msql_list_dbs</function>.
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-list-tables">
|
|
<refnamediv>
|
|
<refname>msql_list_tables</refname>
|
|
<refpurpose>list tables in an mSQL database</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_list_tables</function></funcdef>
|
|
<paramdef>string <parameter>database</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
<function>msql_list_tables</function> takes a database name and
|
|
result pointer much like the <function>msql</function>
|
|
function. The <function>msql_tablename</function> function should
|
|
be used to extract the actual table names from the result
|
|
pointer.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-listtables">
|
|
<refnamediv>
|
|
<refname>msql_listtables</refname>
|
|
<refpurpose>list tables in an mSQL database</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>See <function>msql_list_tables</function>.
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-num-fields">
|
|
<refnamediv>
|
|
<refname>msql_num_fields</refname>
|
|
<refpurpose>get number of fields in result</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_num_fields</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
msql_num_fields() returns the number of fields in a result set.
|
|
<para>
|
|
See also:
|
|
<function>msql</function>,
|
|
<function>msql_query</function>,
|
|
<function>msql_fetch_field</function>, and
|
|
<function>msql_num_rows</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-num-rows">
|
|
<refnamediv>
|
|
<refname>msql_num_rows</refname>
|
|
<refpurpose>get number of rows in result</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_num_rows</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
msql_num_rows() returns the number of rows in a result set.
|
|
<para>
|
|
See also:
|
|
<function>msql</function>,
|
|
<function>msql_query</function>, and
|
|
<function>msql_fetch_row</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-numfields">
|
|
<refnamediv>
|
|
<refname>msql_numfields</refname>
|
|
<refpurpose>get number of fields in result</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_numfields</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Identical to <function>msql_num_fields</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-numrows">
|
|
<refnamediv>
|
|
<refname>msql_numrows</refname>
|
|
<refpurpose>get number of rows in result</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_numrows</function></funcdef>
|
|
<void>
|
|
</funcsynopsis>
|
|
<para>
|
|
Identical to <function>msql_num_rows</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-pconnect">
|
|
<refnamediv>
|
|
<refname>msql_pconnect</refname>
|
|
<refpurpose>open persistent mSQL connection</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_pconnect</function></funcdef>
|
|
<paramdef>string <parameter>hostname</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns a positive mSQL persistent link identifier on success, or
|
|
false on error.
|
|
<para>
|
|
msql_pconnect() acts very much like
|
|
<function>msql_connect</function> with two major differences.
|
|
<para>
|
|
First, when connecting, the function would first try to
|
|
find a (persistent) link that's already open with the same host.
|
|
If one is found, an identifier for it will be returned instead of
|
|
opening a new connection.
|
|
<para>
|
|
Second, the connection to the SQL server will not be closed
|
|
when the execution of the script ends. Instead, the link will
|
|
remain open for future use (<function>msql_close</function> will
|
|
not close links established by msql_pconnect()).
|
|
<para>
|
|
This type of links is therefore called 'persistent'.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-query">
|
|
<refnamediv>
|
|
<refname>msql_query</refname>
|
|
<refpurpose>send mSQL query</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_query</function></funcdef>
|
|
<paramdef>string <parameter>query</parameter></paramdef>
|
|
<paramdef>int <parameter>link_identifier</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
msql_query() sends a query to the currently
|
|
active database on the server that's associated with the
|
|
specified link identifier. If the link identifier isn't
|
|
specified, the last opened link is assumed. If no link is open,
|
|
the function tries to establish a link as if
|
|
<function>msql_connect</function> was called, and use it.
|
|
<para>
|
|
Returns a positive mSQL query identifier on success, or false on error.
|
|
<para>
|
|
See also:
|
|
<function>msql</function>,
|
|
<function>msql_select_db</function>, and
|
|
<function>msql_connect</function>.
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-regcase">
|
|
<refnamediv>
|
|
<refname>msql_regcase</refname>
|
|
<refpurpose>make regular expression for case insensitive match</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>See <function>sql_regcase</function>.
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-result">
|
|
<refnamediv>
|
|
<refname>msql_result</refname>
|
|
<refpurpose>get result data</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_result</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
<paramdef>int <parameter>i</parameter></paramdef>
|
|
<paramdef>mixed <parameter>field</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns the contents of the cell at the row and offset in the
|
|
specified mSQL result set.
|
|
<para>
|
|
msql_result() returns the contents of one cell from a mSQL
|
|
result set. The field argument can be the field's offset, or the
|
|
field's name, or the field's table dot field's name
|
|
(fieldname.tablename). If the column name has been aliased
|
|
('select foo as bar from...'), use the alias instead of the column
|
|
name.
|
|
<para>
|
|
When working on large result sets, you should consider
|
|
using one of the functions that fetch an entire row (specified
|
|
below). As these functions return the contents of multiple cells
|
|
in one function call, they're MUCH quicker than msql_result().
|
|
Also, note that specifying a numeric offset for the field argument
|
|
is much quicker than specifying a fieldname or tablename.fieldname
|
|
argument.
|
|
<para>
|
|
Recommended high-performance alternatives:
|
|
<function>msql_fetch_row</function>,
|
|
<function>msql_fetch_array</function>, and
|
|
<function>msql_fetch_object</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msql-select-db">
|
|
<refnamediv>
|
|
<refname>msql_select_db</refname>
|
|
<refpurpose>select mSQL database</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>msql_select_db</function></funcdef>
|
|
<paramdef>string <parameter>database_name</parameter></paramdef>
|
|
<paramdef>int <parameter>link_identifier</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns true on success, false on error.
|
|
<para>
|
|
msql_select_db() sets the current active database on the server
|
|
that's associated with the specified link identifier. If no link
|
|
identifier is specified, the last opened link is assumed. If no
|
|
link is open, the function will try to establish a link as if
|
|
msql_connect() was called, and use it.
|
|
<para>
|
|
Every subsequent call to <function>msql_query</function> will be
|
|
made on the active database.
|
|
<para>
|
|
See also:
|
|
<function>msql_connect</function>,
|
|
<function>msql_pconnect</function>, and
|
|
<function>msql_query</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-selectdb">
|
|
<refnamediv>
|
|
<refname>msql_selectdb</refname>
|
|
<refpurpose>select mSQL database</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>See <function>msql_select_db</function>.
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.msql-tablename">
|
|
<refnamediv>
|
|
<refname>msql_tablename</refname>
|
|
<refpurpose>get table name of field</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>string <function>msql_tablename</function></funcdef>
|
|
<paramdef>int <parameter>query_identifier</parameter></paramdef>
|
|
<paramdef>int <parameter>field</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
msql_tablename() takes a result pointer returned by the
|
|
<function>msql_list_tables</function>
|
|
function as well as an integer index and returns the name of a
|
|
table. The
|
|
<function>msql_numrows</function> function
|
|
may be used to determine the number of tables in the result
|
|
pointer.
|
|
|
|
<example>
|
|
<title>msql_tablename() example</title>
|
|
<programlisting role=php>
|
|
<?php
|
|
msql_connect ("localhost");
|
|
$result = msql_list_tables("wisconsin");
|
|
$i = 0;
|
|
while ($i < msql_numrows($result)) {
|
|
$tb_names[$i] = msql_tablename($result, $i);
|
|
echo $tb_names[$i] . "<BR>";
|
|
$i++;
|
|
}
|
|
?>
|
|
</programlisting>
|
|
|
|
</example>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
</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
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
-->
|