File: set_identity_column.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 (72 lines) | stat: -rw-r--r-- 3,123 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
<?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_identity_column">
  <refmeta> 
    <refentrytitle>set_identity_column</refentrytitle> 
    <refmiscinfo>sql</refmiscinfo>
  </refmeta> 
  <refnamediv> 
    <refname>set_identity_column</refname> 
    <refpurpose>sets the sequence starting value for an identity column</refpurpose>
  </refnamediv> 
  <refsynopsisdiv> 
    <funcsynopsis id="fsyn_set_identity_column"> 
      <funcprototype id="fproto_set_identity_column">
        <funcdef>integer <function>set_identity_column</function></funcdef> 
        <paramdef>in <parameter>table_name </parameter>varchar</paramdef>
        <paramdef>in <parameter>column_name </parameter>varchar</paramdef>
        <paramdef>in <parameter>new_value </parameter>integer</paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="desc_set_identity_column"><title>Description</title>
	  <para>This function takes the table name, the column name and the new 
		sequence value as parameters.  It checks for the existence of the identity column, 
		and then sets the sequence value (using the sequence_set) and returns the 
		old sequence value.  The table and column names must be properly qualified to 
		ensure the correct resource is located.  The effect of calling this function 
		is immediate.  </para></refsect1>
  <refsect1 id="params_set_identity_column"><title>Parameters</title>
    <refsect2><title>table_name</title>
      <para>the fully qualified table name in the correct case exactly as it 
		  appears in the DB.DBA.SYS_KEYS table.</para></refsect2>
     <refsect2><title>column_name</title>
      <para>the exact column name as it appears in the DB.DBA.SYS_COLS table.</para></refsect2>
    <refsect2><title>new_value</title>
      <para>the new sequence value.</para></refsect2>
 </refsect1>
  <refsect1 id="ret_set_identity_column"><title>Return Types</title>
	  <para>the previous sequence 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>