File: mysql_change_user.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 (140 lines) | stat: -rw-r--r-- 5,031 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
132
133
134
135
136
137
138
139
140
<?xml version="1.0" encoding="UTF-8"?>
<refentry version="5.0-subset Scilab" xml:id="mysql_change_user" 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_change_user</refname>

    <refpurpose>Changes the user and causes the database specified by db 
      to become the default (current) database on the connection specified by mysql.</refpurpose>
  </refnamediv>

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

    <synopsis>flag = mysql_change_user(mysql, user, passwd, db)</synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Description</title>

    <para>Changes the user and causes the database specified by db to become 
      the default (current) database on the connection specified by mysql.</para>
    <para>In subsequent queries, this database is the default for table references 
      that do not include an explicit database specifier.</para>
    <para><literal>mysql_change_user</literal> fails if the connected user cannot
      be authenticated or doesn't have permission to use the database. 
      In this case, the user and database are not changed.</para>
    <para>The db parameter may be set to empty if you don't want
      to have a default database.</para>
    <para>This command resets the state as if one had done a new connect.</para>
    <para>It always performs a ROLLBACK of any active transactions, closes
      and drops all temporary tables, and unlocks all locked tables.</para>
    <para>Session system variables are reset to the values of the
      corresponding global system variables. Prepared statements are
      released and HANDLER variables are closed.</para>
  </refsection>

  <refsection>
    <title>Parameters</title>

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

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

      <varlistentry>
        <term>user</term>

        <listitem>
          <para>the name of the user.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>passwd</term>

        <listitem>
          <para>the password of the user.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>db</term>

        <listitem>
          <para>the new default database (can be empty if you don't
	  want any default database).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>flag</term>

        <listitem>
          <para>Zero for success. Nonzero if an error occurred.</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>
	    <listitem><para>ER_UNKNOWN_COM_ERROR The MySQL server doesn't implement this command 
		(probably an old server).</para></listitem>
	    <listitem><para>ER_ACCESS_DENIED_ERROR The user or password was wrong.</para></listitem>
	    <listitem><para>ER_BAD_DB_ERROR The database didn't exist.</para></listitem>
	    <listitem><para>ER_DBACCESS_DENIED_ERROR The user did not have access rights 
		to the database.</para></listitem>
	    <listitem><para>ER_WRONG_DB_NAME The database name was too long.</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);

status = mysql_change_user(sql_ptr,"me","andmypassword",[]);

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>
      <member><link linkend="error_list">error list</link></member>
    </simplelist>
  </refsection>

  <refsection>
    <title>Authors</title>

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