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
|
<?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_disconnect_user">
<refmeta>
<refentrytitle>disconnect_user</refentrytitle>
<refmiscinfo>admin</refmiscinfo>
</refmeta>
<refnamediv>
<refname>disconnect_user</refname>
<refpurpose>Disconnect client connections of a given user</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_disconnect_user">
<funcprototype id="fproto_disconnect_user">
<funcdef><function>disconnect_user</function></funcdef>
<paramdef>in <parameter>username_pattern</parameter>string</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_disconnect_user"><title>Description</title>
<para>disconnect_user disconnects clients whose
username matches the username_pattern string given as an argument, and
returns an integer value giving the number of clients disconnected.
This can be used after DELETE USER or REVOKE statement to make sure that
the affected user has no open connections.</para>
</refsect1>
<refsect1 id="params_disconnect_user"><title>Parameters</title>
<refsect2><title>username_pattern</title>
<para>A string pattern to match users to be disconnected. SQL wildcards
including Virtuoso extensions may be used:</para>
<simplelist>
<member>'smith' - disconnects user Smith's clients.</member>
<member>'@smith' - disconnects all users whose name resembles 'smith'.</member>
<member>'%' - disconnects all users including the current dba session.</member>
</simplelist>
</refsect2>
</refsect1>
<refsect1 id="ret_disconnect_user"><title>Return Values</title>
<para>The number of clients disconnected is returned.</para>
</refsect1>
<refsect1 id="errors_disconnect_user"><title>Errors</title>
<para><link linkend="datatypeerror">Parameter data type checking errors</link></para>
</refsect1>
<refsect1 id="examples_disconnect_user"><title>Examples</title>
<example id="ex_disconnect_user_1"><title>Disconnect users</title>
<!-- this is how the dba committed suicide the other day... I like the comment regardless of bug3151 -->
<para>This is how the DBA can close all sessions for all users who name
starts with db, including 'dba' which is the DBA itself.</para>
<screen>
SQL> disconnect_user ('db*');
*** Error 08S01: [Virtuoso Driver]CL065: Lost connection to server
at line 7 (7) of Top-Level: disconnect_user ('db*')
bash$
</screen>
</example>
</refsect1>
<refsect1 id="seealso_disconnect_user"><title>See Also:</title>
<para><link linkend="fn_username"><function>username</function></link>
</para>
</refsect1>
</refentry>
|
