From 55ad5185c7e10e795d036ff0f4e8259c47edc2c4 Mon Sep 17 00:00:00 2001
From: ocelot-inc <pgulutzan@ocelot.ca>
Date: Thu, 27 Nov 2014 20:47:58 -0700
Subject: [PATCH] moved auto_increment
---
doc/user/databases.xml | 73 +++++++++++++++++++++---------------------
1 file changed, 37 insertions(+), 36 deletions(-)
diff --git a/doc/user/databases.xml b/doc/user/databases.xml
index b92b498101..39d26d79e2 100644
--- a/doc/user/databases.xml
+++ b/doc/user/databases.xml
@@ -981,6 +981,43 @@ tarantool> <userinput>box.space.space19:dec{1,'a'}</userinput>
... </programlisting>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term>
+ <emphasis role="lua">box.space.<replaceable>space-name</replaceable>:auto_increment{<replaceable>field-value [, field-value ...]</replaceable>}</emphasis>
+ </term>
+ <listitem>
+ <para>
+ Insert a new tuple using an auto-increment primary key.
+ The space specified by space-name must have a
+ NUM primary key index of type TREE.
+ The primary-key field will be incremented before the insert.
+ </para>
+ <para>
+ Parameters: <code>space-name</code>, <code>field-value(s)</code> = values for the tuple's fields,
+ other than the primary-key field.
+ </para>
+ <para>
+ Returns: (type = tuple) the inserted tuple.
+ </para>
+ <para>
+ Complexity Factors: Index size, Index type, Number of indexes accessed, WAL settings.
+ </para>
+ <para>
+ Possible errors: index has wrong type or primary-key indexed field is not a number.
+ </para>
+ <bridgehead renderas="sect4">Example</bridgehead>
+<programlisting>tarantool> <userinput>box.space.tester:auto_increment{'Fld#1', 'Fld#2'}</userinput>
+---
+- [1, 'Fld#1', 'Fld#2']
+...
+tarantool> <userinput>box.space.tester:auto_increment{'Fld#3'}</userinput>
+---
+- [2, 'Fld#3']
+...
+</programlisting>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term>
@@ -1634,42 +1671,6 @@ The result will be a table of tuples and will look like this:
</listitem>
</varlistentry>
- <varlistentry>
- <term>
- <emphasis role="lua">box.space.<replaceable>space-name</replaceable>:auto_increment{<replaceable>field-value [, field-value ...]</replaceable>}</emphasis>
- </term>
- <listitem>
- <para>
- Insert a new tuple using an auto-increment primary key.
- The space specified by space-name must have a
- NUM primary key index of type TREE.
- The primary-key field will be incremented before the insert.
- </para>
- <para>
- Parameters: <code>space-name</code>, <code>field-value(s)</code> = values for the tuple's fields,
- other than the primary-key field.
- </para>
- <para>
- Returns: (type = tuple) the inserted tuple.
- </para>
- <para>
- Complexity Factors: Index size, Index type, Number of indexes accessed, WAL settings.
- </para>
- <para>
- Possible errors: index has wrong type or primary-key indexed field is not a number.
- </para>
- <bridgehead renderas="sect4">Example</bridgehead>
-<programlisting>tarantool> <userinput>box.space.tester:auto_increment{'Fld#1', 'Fld#2'}</userinput>
----
-- [1, 'Fld#1', 'Fld#2']
-...
-tarantool> <userinput>box.space.tester:auto_increment{'Fld#3'}</userinput>
----
-- [2, 'Fld#3']
-...
-</programlisting>
- </listitem>
- </varlistentry>
</variablelist>
<bridgehead renderas="sect4">Example showing use of the box functions</bridgehead>
--
GitLab