mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
e41806c30b
Document false and null return types Cf. <https://news-web.php.net/php.doc.cvs/17645>. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351730 c90b9560-bf6c-de11-be94-00142212c4b1
149 lines
4.3 KiB
XML
149 lines
4.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.fbsql-query" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>fbsql_query</refname>
|
|
<refpurpose>Send a FrontBase query</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>fbsql_query</methodname>
|
|
<methodparam><type>string</type><parameter>query</parameter></methodparam>
|
|
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>batch_size</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sends a <parameter>query</parameter> to the currently active database on
|
|
the server.
|
|
</para>
|
|
<para>
|
|
If the query succeeds, you can call <function>fbsql_num_rows</function> to
|
|
find out how many rows were returned for a SELECT statement or
|
|
<function>fbsql_affected_rows</function> to find out how many rows were
|
|
affected by a DELETE, INSERT, REPLACE, or UPDATE statement.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>query</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The SQL query to be executed.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
The query string shall always end with a semicolon.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
&fbsql.link-identifier.description;
|
|
<varlistentry>
|
|
<term><parameter>batch_size</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
<function>fbsql_query</function> returns &true; (non-zero) or &false;
|
|
to indicate whether or not the query succeeded. A return value
|
|
of &true; means that the query was legal and could be executed by
|
|
the server. It does not indicate anything about the number of
|
|
rows affected or returned. It is perfectly possible for a query
|
|
to succeed but affect no rows or return no rows.
|
|
</para>
|
|
<para>
|
|
For SELECT statements, <function>fbsql_query</function> returns a new
|
|
result identifier that you can pass to <function>fbsql_result</function>.
|
|
</para>
|
|
<para>
|
|
<function>fbsql_query</function> will also fail and return &false; if you
|
|
don't have permission to access the table(s) referenced by the query.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
The following query is syntactically invalid, so
|
|
<function>fbsql_query</function> fails and returns &false;:
|
|
<example>
|
|
<title><function>fbsql_query</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$result = fbsql_query("SELECT * WHERE 1=1")
|
|
or die ("Invalid query");
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
The following query is semantically invalid if
|
|
<literal>my_col</literal> is not a column in the table
|
|
<literal>my_tbl</literal>, so <function>fbsql_query</function>
|
|
fails and returns &false;:
|
|
<example>
|
|
<title><function>fbsql_query</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$result = fbsql_query ("SELECT my_col FROM my_tbl;")
|
|
or die ("Invalid query");
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>fbsql_affected_rows</function></member>
|
|
<member><function>fbsql_db_query</function></member>
|
|
<member><function>fbsql_free_result</function></member>
|
|
<member><function>fbsql_result</function></member>
|
|
<member><function>fbsql_select_db</function></member>
|
|
<member><function>fbsql_connect</function></member>
|
|
</simplelist>
|
|
</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:"~/.phpdoc/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
|
|
-->
|