File: mysql_query.xml

package info (click to toggle)
scilab-scimysql 0.1.1-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 988 kB
  • ctags: 105
  • sloc: xml: 7,315; ansic: 2,573; sql: 143; makefile: 19; sh: 6
file content (131 lines) | stat: -rw-r--r-- 4,026 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8"?>
<refentry version="5.0-subset Scilab" xml:id="mysql_query" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:db="http://docbook.org/ns/docbook">
  <refnamediv>
    <refname>mysql_query</refname>

    <refpurpose>Executes SQL statements.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>Calling Sequence</title>

    <synopsis>result = mysql_query(mysql, stmt_str)</synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Description</title>

    <para>Executes the SQL statement pointed to by 
      string <literal>stmt_str</literal>. Normally, the
      string must consist of a single SQL statement and
      you should not add a terminating semicolon (";") or
      \g to the statement. If multiple-statement execution has 
      been enabled, the string can contain several statements
      separated by semicolons. </para>
    <para><literal>mysql_query</literal> cannot be used for
      statements that contain binary data; you must use
      <literal>mysql_real_query</literal> instead. 
      (Binary data may contain the "\0" character, which 
      <literal>mysql_query</literal> interprets as the end
      of the statement string.)</para>
    <para>If you want to know whether the statement should
      return a result set, you can use 
      <literal>mysql_field_count</literal> to check for this.</para>
  </refsection>

  <refsection>
    <title>Parameters</title>

    <variablelist>
      <varlistentry>
        <term>mysql</term>

        <listitem>
          <para>a MySQL pointer</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>stmt_str</term>

        <listitem>
          <para>the SQL statement to be executed</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>result</term>

        <listitem>
          <para> Zero if the statement was successful. Nonzero if an
          error occurred.</para>
	  <para>The error list:</para>
	  <itemizedlist>
	    <listitem>
	      <para>CR_COMMANDS_OUT_OF_SYNC Commands were executed in
		an improper order.</para>
	    </listitem>
	    <listitem>
	      <para>CR_SERVER_GONE_ERROR The MySQL server has gone
		away.</para>
	    </listitem>
	    <listitem>
	      <para>CR_SERVER_LOST The connection to the server was lost during the query.</para>
	    </listitem>
	    <listitem>
	      <para>CR_UNKNOWN_ERROR An unknown error occurred.</para>
	    </listitem>
	  </itemizedlist>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  
  <refsection>
    <title>Examples</title>

    <programlisting role="example"><![CDATA[ 
username = 'glpk'; // Put your username
password = 'gnu';  // Put your password
database = 'glpk'; 
port     = 3306;   // use netstat -a | grep mysql to locate the mysql port
                   // or ps -elf | grep mysql and locate --port
myhost   = 'localhost'; // localhost most of the time

sql_ptr = mysql_init();
status  = mysql_real_connect(sql_ptr, myhost, username, password, database, port);

sql    = sprintf("select val from sudoku where val>=0 and val<7;\n");
status = mysql_query(sql_ptr, sql);
rs     = mysql_store_result(sql_ptr);
res    = mysql_fetch_field(rs);

mysql_free_result(rs);
mysql_close(sql_ptr);
 ]]></programlisting>
  </refsection>

  <refsection>
    <title>See Also</title>

    <simplelist type="inline">
      <member><link linkend="mysql_init">mysql_init</link></member>
      <member><link linkend="mysql_real_connect">mysql_real_connect</link></member>
      <member><link linkend="mysql_close">mysql_close</link></member>
    </simplelist>
  </refsection>

  <refsection>
    <title>Authors</title>

    <simplelist type="vert">
      <member>Yann COLLETTE</member>
    </simplelist>
  </refsection>
</refentry>