File: vt_batch_update.xml

package info (click to toggle)
virtuoso-opensource 7.2.5.1%2Bdfsg1-0.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 285,240 kB
  • sloc: ansic: 641,220; sql: 490,413; xml: 269,570; java: 83,893; javascript: 79,900; cpp: 36,927; sh: 31,653; cs: 25,702; php: 12,690; yacc: 10,227; lex: 7,601; makefile: 7,129; jsp: 4,523; awk: 1,697; perl: 1,013; ruby: 1,003; python: 326
file content (87 lines) | stat: -rw-r--r-- 3,734 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
<?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_vt_batch_update">
  <refmeta>
    <refentrytitle>VT_BATCH_UPDATE</refentrytitle>
    <refmiscinfo>ft</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>VT_BATCH_UPDATE</refname>
    <refpurpose>Set  batch mode update of free text indexing.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis id="fsyn_vt_batch_update">
      <funcprototype id="fproto_vt_batch_update">
        <funcdef>integer DB.DBA.<function>VT_BATCH_UPDATE</function></funcdef>
        <paramdef>in <parameter>table</parameter> varchar</paramdef>
        <paramdef>in <parameter>flag</parameter> varchar</paramdef>
        <paramdef>in <parameter>interval_minutes</parameter> integer</paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="desc_vt_batch_update"><title>Description</title>
	<para>
This function controls the time of update of a text index. If flag is ON, changes are accumulated
into a change tracking table and applied as a batch. If flag is OFF, the text index is updated
in the same transaction as the indexed data itself. The change tracking table is automatically
created and is named VTLOG_&lt;q&gt;_&lt;o&gt;_&lt;table&gt;, in the qualifier and owner of
the indexed table, where q, o and table are the qualifier, owner and name of the table.
The changes accumulated into that table can be explicitly applied to the
index using the VT_INC_INDEX_&lt;q&gt;_&lt;o&gt;_&lt;table&gt; function.
</para>
  </refsect1>
  <refsect1 id="params_vt_batch_update"><title>Parameters</title>
    <refsect2><title>table</title>
      <para>the name of the table to perform batch updating of.</para></refsect2>
    <refsect2><title>flag</title>
      <para>If ON, updates are in batch mode, if OFF, they are synchronous.</para></refsect2>

    <refsect2><title>interval_minutes</title>
      <para>the update interval.  NULL means that updates are not  scheduled.</para></refsect2>
  </refsect1>
  <refsect1 id="errors_vt_batch_update"><title>Errors</title>
    <table><title>Errors signalled by</title>
      <tgroup cols="4">
       <thead><row><entry>SQLState</entry><entry>Error Code</entry><entry>Error Text</entry><entry>Description</entry></row></thead>
	<tbody>
	  <row>
	    <entry><errorcode></errorcode></entry>
	    <entry><errorcode></errorcode></entry>
	    <entry><errorname></errorname></entry>
	    <entry></entry>
	  </row>
	</tbody>
      </tgroup>
    </table>
  </refsect1>
  <refsect1 id="seealso_vt_batch_update"><title>See Also</title>
    <para><link linkend="fn_vt_drop_ftt">vt_drop_ftt()</link></para>
    <para><link linkend="fn_vt_batch">vt_batch()</link></para>
    <para><link linkend="fn_vt_create_text_index">vt_create_text_index()</link></para>
    <para><link linkend="fn_vt_batch_feed">vt_batch_feed()</link></para>
  </refsect1>
</refentry>