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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2006 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_bpel_purge">
<refmeta>
<refentrytitle>BPEL.BPEL.purge_instance</refentrytitle>
<refmiscinfo>bpel</refmiscinfo>
</refmeta>
<refnamediv>
<refname>BPEL.BPEL.purge_instance</refname>
<refpurpose>removes old BPEL process instances</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_purge">
<funcprototype id="fproto_purge">
<funcdef><function>BPEL.BPEL.purge_instance</function></funcdef>
<paramdef>in <parameter>completed_before</parameter> datetime</paramdef>
<paramdef>in <parameter>make_archive</parameter> int (default 1)</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="params_purge"><title>Parameters</title>
<refsect2><title>completed_before</title>
<para><type>datetime</type> all instances completed before this date and time will be removed</para>
</refsect2>
<refsect2><title>make_archive</title>
<para><type>int</type> flag to archive or not instances before removal</para>
</refsect2>
</refsect1>
<refsect1 id="ret_purge"><title>Return Types</title>
<para></para></refsect1>
<refsect1 id="desc_purge">
<title>Description</title>
<para><function>BPEL.BPEL.purge_instance</function> this will erase all instances completed before the datetime specified.</para>
</refsect1>
<refsect1 id="examples_purge"><title>Examples</title>
<example id="ex_purge"><title>Simple example</title>
<para>The following wil lremove all process instances completed before 10 of January 2004.</para>
<screen>
SQL> BPEL.BPEL.purge_instance (stringdate ('2004-01-10'));
Done. -- 10 msec.
</screen>
</example>
</refsect1>
</refentry>
|
