<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head profile="http://internetalchemy.org/2003/02/profile">
<link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" />
<link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" />
<meta name="dc.title" content="Function: set_user_id - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: set_user_id - Virtuoso Functions Guide" />
<meta name="dc.creator" content="OpenLink Software Documentation Team ; " />
<meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" />
<link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" />
<link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" />
<link rel="parent" href="functions.html" title="Chapter Contents" />
<link rel="prev" href="appendixa.html" title="Appendix" />
<link rel="next" href="functions.html#.html" title="" />
<link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" />
<link rel="stylesheet" type="text/css" href="doc.css" />
<link rel="stylesheet" type="text/css" href="/doc/translation.css" />
<title>Function: set_user_id - Virtuoso Functions Guide</title>
<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
<meta name="author" content="OpenLink Software Documentation Team ; " />
<meta name="copyright" content="OpenLink Software, 1999 - 2009" />
<meta name="keywords" content="" />
<meta name="GENERATOR" content="OpenLink XSLT Team" />
</head>
<body>
<div id="header">
<a name="fn_set_user_id" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - set_user_id</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_set_row_count.html" title="set_row_count">Prev</a> | <a class="link" href="fn_set_identity_column.html" title="set_identity_column">Next</a>
</div>
</div>
<div id="currenttoc">
<form method="post" action="/doc/adv_search.vspx">
<div class="search">Keyword Search: <br />
<input type="text" name="q" /> <input type="submit" name="go" value="Go" />
</div>
</form>
<div>
<a href="http://www.openlinksw.com/">www.openlinksw.com</a>
</div>
<div>
<a href="http://docs.openlinksw.com/">docs.openlinksw.com</a>
</div>
<br />
<div>
<a href="index.html">Book Home</a>
</div>
<br />
<div>
<a href="contents.html">Contents</a>
</div>
<div>
<a href="preface.html">Preface</a>
</div>
<br />
<div>
<a class="selected" href="functions.html">Virtuoso Functions Guide</a>
</div>
<br />
<div>
<a href="functions.html#admin">Administration</a>
</div>
<div>
<a href="functions.html#aggr">Aggregate Functions</a>
</div>
<div>
<a href="functions.html#array">Array Manipulation</a>
</div>
<div>
<a href="functions.html#bpel">BPEL APIs</a>
</div>
<div>
<a href="functions.html#backup">Backup</a>
</div>
<div>
<a href="functions.html#compression">Compression</a>
</div>
<div>
<a href="functions.html#cursors">Cursor</a>
</div>
<div>
<a href="functions.html#time">Date & Time Manipulation</a>
</div>
<div>
<a href="functions.html#debug">Debug</a>
</div>
<div>
<a href="functions.html#dict">Dictionary Manipulation</a>
</div>
<div>
<a href="functions.html#encoding">Encoding & Decoding</a>
</div>
<div>
<a href="functions.html#file">File Manipulation</a>
</div>
<div>
<a href="functions.html#ft">Free Text</a>
</div>
<div>
<a href="functions.html#hash">Hashing / Cryptographic</a>
</div>
<div>
<a href="functions.html#ldap">LDAP</a>
</div>
<div>
<a href="functions.html#localization">Locale</a>
</div>
<div>
<a href="functions.html#mail">Mail</a>
</div>
<div>
<a href="functions.html#misc">Miscellaneous</a>
</div>
<div>
<a href="functions.html#number">Number</a>
</div>
<div>
<a href="functions.html#phrz">Phrases</a>
</div>
<div>
<a href="functions.html#rdf">RDF data</a>
</div>
<div>
<a href="functions.html#rmt">Remote SQL Data Source</a>
</div>
<div>
<a href="functions.html#repl">Replication</a>
</div>
<div>
<a href="functions.html#soap">SOAP</a>
</div>
<div>
<a class="selected" href="functions.html#sql">SQL</a>
</div>
<div class="selected">
<div>
<a href="fn___any_grants.html">__any_grants</a>
</div>
<div>
<a href="fn_exec_close.html">close</a>
</div>
<div>
<a href="fn_collation_define.html">collation_define</a>
</div>
<div>
<a href="fn_complete_table_name.html">complete_table_name</a>
</div>
<div>
<a href="fn_delay.html">delay</a>
</div>
<div>
<a href="fn_end_result.html">end_result</a>
</div>
<div>
<a href="fn_exec.html">exec</a>
</div>
<div>
<a href="fn_exec_metadata.html">exec_metadata</a>
</div>
<div>
<a href="fn_exec_next.html">exec_next</a>
</div>
<div>
<a href="fn_exec_result.html">exec_result</a>
</div>
<div>
<a href="fn_exec_result_names.html">exec_result_names</a>
</div>
<div>
<a href="fn_exec_score.html">exec_score</a>
</div>
<div>
<a href="fn_identity_value.html">identity_value</a>
</div>
<div>
<a href="fn_name_part.html">name_part</a>
</div>
<div>
<a href="fn_registry_get.html">registry_get</a>
</div>
<div>
<a href="fn_registry_get_all.html">registry_get_all</a>
</div>
<div>
<a href="fn_registry_name_is_protected.html">registry_name_is_pro...</a>
</div>
<div>
<a href="fn_registry_remove.html">registry_remove</a>
</div>
<div>
<a href="fn_registry_set.html">registry_set</a>
</div>
<div>
<a href="fn_result.html">result</a>
</div>
<div>
<a href="fn_result_names.html">result_names</a>
</div>
<div>
<a href="fn_row_count.html">row_count</a>
</div>
<div>
<a href="fn_sequence_get_all.html">sequence_get_all</a>
</div>
<div>
<a href="fn_sequence_next.html">sequence_next</a>
</div>
<div>
<a href="fn_sequence_remove.html">sequence_remove</a>
</div>
<div>
<a href="fn_sequence_set.html">sequence_set</a>
</div>
<div>
<a href="fn_set_identity_column.html">set_identity_column</a>
</div>
<div>
<a href="fn_set_row_count.html">set_row_count</a>
</div>
<div>
<a class="selected" href="fn_set_user_id.html">set_user_id</a>
</div>
<div>
<a href="fn_signal.html">signal</a>
</div>
<div>
<a href="fn_sinv_create_inverse.html">sinv_create_inverse</a>
</div>
<div>
<a href="fn_sinv_create_key_mapping.html">sinv_create_key_mapp...</a>
</div>
<div>
<a href="fn_sinv_drop_inverse.html">sinv_drop_inverse</a>
</div>
<div>
<a href="fn_sys_stat_analyze.html">sys_stat_analyze</a>
</div>
<div>
<a href="fn_sys_stat_histogram.html">sys_stat_histogram</a>
</div>
<div>
<a href="fn_table_drop_policy.html">table_drop_policy</a>
</div>
<div>
<a href="fn_table_set_policy.html">table_set_policy</a>
</div>
<div>
<a href="fn_username.html">username</a>
</div>
</div>
<div>
<a href="functions.html#string">String</a>
</div>
<div>
<a href="functions.html#txn">Transaction</a>
</div>
<div>
<a href="functions.html#type">Type Mapping</a>
</div>
<div>
<a href="functions.html#uddi">UDDI</a>
</div>
<div>
<a href="functions.html#udt">User Defined Types & The CLR</a>
</div>
<div>
<a href="functions.html#vad">VAD</a>
</div>
<div>
<a href="functions.html#jvmpl">Virtuoso Java PL API</a>
</div>
<div>
<a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a>
</div>
<div>
<a href="functions.html#ws">Web & Internet</a>
</div>
<div>
<a href="functions.html#xml">XML</a>
</div>
<div>
<a href="functions.html#XPATH">XPATH & XQUERY</a>
</div>
<br />
<div>
<a href="functionidx.html">Functions Index</a>
</div>
<br />
</div>
<div id="text">
<h2>set_user_id</h2>
<div class="refpurpose">sets the current user for execution</div>
<div class="funcsynopsis">
<span class="funcdef">integer <span class="function">set_user_id</span>
</span>
(<span class="paramdef">in <span class="parameter">user_name </span>varchar</span>,
<span class="paramdef">in <span class="parameter">mode </span>integer</span>,
<span class="paramdef">in <span class="parameter">password </span>varchar</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>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.
</p>
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">user_name – </span>
the name of SQL user account to be used as effective user and group.
</div>
<div class="refsect2">
<span class="refsect2title">mode – </span>
optional, integer 1 (default) means change of privileges remains in effect only while within current stored procedure context.
</div>
<div class="refsect2">
<span class="refsect2title">password – </span>
this optional parameter is needed if calling the function without DBA privileges. Password of the user <span class="computeroutput">user_name</span>.
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Return Types</div>
<p>No return value</p>
</div>
</div>
<div id="footer">
<div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div>
<div id="validation">
<a href="http://validator.w3.org/check/referer">
<img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" />
</a>
<a href="http://jigsaw.w3.org/css-validator/">
<img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" />
</a>
</div>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
71d40963b505df4524269198e237b3e3
>
files
>
536
