File: quick-start.en.rst

package info (click to toggle)
tarantool 2.6.0-1.4
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 85,412 kB
  • sloc: ansic: 513,775; cpp: 69,493; sh: 25,650; python: 19,190; perl: 14,973; makefile: 4,178; yacc: 1,329; sql: 1,074; pascal: 620; ruby: 190; awk: 18; lisp: 7
file content (98 lines) | stat: -rw-r--r-- 2,260 bytes parent folder | download | duplicates (7)
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
88
89
90
91
92
93
94
95
96
97
98
Quick start
===========

Connecting to the server
------------------------

Create connection to the server::

    >>> import tarantool
    >>> server = tarantool.connect("localhost", 33013)


Creating a space instance
-------------------------

Instance of :class:`~tarantool.space.Space` is a named object to access
the key space.

Create `` demo `` object which will be used to access the space `` 0 `` ::

    >>> demo = server.space(0)

All subsequent operations with space ``0`` performed using methods of the ``demo``.


Data Manipulation
-----------------

Select
^^^^^^

Select one single record with id ``'AAAA'`` from the space ``demo`` 
using primary key (index zero)::

    >>> demo.select('AAAA')

Select several records using primary index::

    >>> demo.select(['AAAA', 'BBBB', 'CCCC'])
    [('AAAA', 'Alpha'), ('BBBB', 'Bravo'), ('CCCC', 'Charlie')]


Insert
^^^^^^

Insert tuple ``('DDDD', 'Delta')`` into the space ``demo``::

    >>> demo.insert(('DDDD', 'Delta'))

The first element is the primary key for the tuple.


Update
^^^^^^

Update the record with id ``'DDDD'`` placing the value ``'Denver'`` 
into the field ``1``::

    >>> demo.update('DDDD', [(1, '=', 'Denver')])
    [('DDDD', 'Denver')]

To find the record :meth:`~tarantool.space.Space.update` always uses 
the primary index.
Fields numbers are starting from zero. 
So field ``0`` is the first element in the tuple. 


Delete
^^^^^^

Delete single record identified by id ``'DDDD'``::

    >>> demo.delete('DDDD')
    [('DDDD', 'Denver')]

To find the record :meth:`~tarantool.space.Space.delete` always uses 
the primary index.


Call server-side functions
--------------------------

To call stored function method 
:meth:`Connection.call() <tarantool.connection.Connection.call()>` can be used::

    >>> server.call("box.select_range", (0, 0, 2, 'AAAA'))
    [('AAAA', 'Alpha'), ('BBBB', 'Bravo')]

The same can be done using 
:meth:`Space.call() <tarantool.space.Space.call()>` method::

    >>> demo = server.space(0)
    >>> demo.call("box.select_range", (0, 0, 2, 'AAAA'))
    [('AAAA', 'Alpha'), ('BBBB', 'Bravo')]

Method :meth:`Space.call() <tarantool.space.Space.call()>` is just
an alias for
:meth:`Connection.call() <tarantool.connection.Connection.call()>`