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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_set_user_id">
<refmeta>
<refentrytitle>set_user_id</refentrytitle>
<refmiscinfo>sql</refmiscinfo>
</refmeta>
<refnamediv>
<refname>set_user_id</refname>
<refpurpose>sets the current user for execution</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_set_user_id">
<funcprototype id="fproto_set_user_id">
<funcdef>integer <function>set_user_id</function></funcdef>
<paramdef>in <parameter>user_name </parameter>varchar</paramdef>
<paramdef>in <parameter>mode </parameter>integer</paramdef>
<paramdef>in <parameter>password </parameter>varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_set_user_id"><title>Description</title>
<para>This function changes the effective user and group to that of the user defined by user_name parameter. When called by a user with DBA group privileges, the optional password may be omitted. Otherwise it has to be the valid password for user_name. The mode parameter determines persistence (context) of effects of the call: If omitted or set to integer value 1, the effective user privileges will remain in effect within current stored procedure context only - upon returning, the effective user privileges will be automatically reset to state effective before set_user_id. When mode is equal to integer value 0, the effective user privileges will remain set for duration of current ODBC session, current request in web server context, or until next call of set_user_id.
This function is analogous to the UNIX 'su' command.
</para></refsect1>
<refsect1 id="params_set_user_id"><title>Parameters</title>
<refsect2><title>user_name</title>
<para>
the name of SQL user account to be used as effective user and group.
</para></refsect2>
<refsect2><title>mode</title>
<para>
optional, integer 1 (default) means change of privileges remains in effect only while within current stored procedure context.
</para></refsect2>
<refsect2><title>password</title>
<para>
this optional parameter is needed if calling the function without DBA privileges. Password of the user <parameter>user_name</parameter>.
</para></refsect2>
</refsect1>
<refsect1 id="ret_set_user_id"><title>Return Types</title>
<para>No return value</para></refsect1>
<!--
<refsect1 id="examples"><title>Examples</title>
<example id="ex_"><title></title>
<para></para>
<screen></screen>
</example>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para><link linkend="fn"></link></para>
</refsect1>
-->
</refentry>
|
