.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "DR::Tarantool::Spaces 3pm" .TH DR::Tarantool::Spaces 3pm "2014-02-24" "perl v5.20.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" DR::Tarantool::Spaces \- Tarantool schema description .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 10 \& use DR::Tarantool::Spaces; \& my $s = new DR::Tarantool::Spaces({ \& 1 => { \& name => \*(Aqusers\*(Aq, # space name \& default_type => \*(AqSTR\*(Aq, # undescribed fields \& fields => [ \& qw(login password role), \& { \& name => \*(Aqcounter\*(Aq, \& type => \*(AqNUM\*(Aq \& }, \& { \& name => \*(Aqsomething\*(Aq, \& type => \*(AqUTF8STR\*(Aq, \& }, \& { \& name => \*(Aqopts\*(Aq, \& type => \*(AqJSON\*(Aq, \& } \& ], \& indexes => { \& 0 => \*(Aqlogin\*(Aq, \& 1 => [ qw(login password) ], \& 2 => { \& name => \*(Aqmy_idx\*(Aq, \& fields => \*(Aqlogin\*(Aq, \& }, \& 3 => { \& name => \*(Aqmy_idx2\*(Aq, \& fields => [ \*(Aqcounter\*(Aq, \*(Aqsomething\*(Aq ] \& } \& } \& }, \& \& 0 => { \& ... \& } \& }); \& \& my $f = $s\->pack_field(\*(Aqusers\*(Aq, \*(Aqcounter\*(Aq, 10); \& my $f = $s\->pack_field(\*(Aqusers\*(Aq, 3, 10); # the same \& my $f = $s\->pack_field(1, 3, 10); # the same \& \& my $ts = $s\->pack_keys([1,2,3] => \*(Aqmy_idx\*(Aq); \& my $t = $s\->pack_primary_key([1,2,3]); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The package describes all spaces used in an application. It supports the following field types: .IP "\s-1NUM, NUM64, STR\s0" 4 .IX Item "NUM, NUM64, STR" The standard Tarantool types. .IP "\s-1UTF8STR\s0" 4 .IX Item "UTF8STR" The same as \fB\s-1STR\s0\fR, but the string is utf8\-decoded after it's received from the server. .IP "\s-1INT & INT64\s0" 4 .IX Item "INT & INT64" The same as \fB\s-1NUM\s0\fR and \fB\s-1NUM64\s0\fR, but contain signed values. .IP "\s-1JSON\s0" 4 .IX Item "JSON" The field is encoded with \s-1JSON::XS\s0 when putting into a database, and decoded after is received back from the server. .SH "METHODS" .IX Header "METHODS" .SS "new" .IX Subsection "new" .Vb 1 \& my $spaces = DR::Tarantool::Spaces\->new( $spaces ); .Ve .SS "space" .IX Subsection "space" Return space object by number or name. .PP .Vb 2 \& my $space = $spaces\->space(\*(Aqname\*(Aq); \& my $space = $spaces\->space(0); .Ve .SS "space_number" .IX Subsection "space_number" Return space number by its name. .SS "pack_field" .IX Subsection "pack_field" Packs one field into a format suitable for making a database request: .PP .Vb 1 \& my $field = $spaces\->pack_field(\*(Aqspace\*(Aq, \*(Aqfield\*(Aq, $data); .Ve .SS "unpack_field" .IX Subsection "unpack_field" Unpack one field after getting it from the server: .PP .Vb 1 \& my $field = $spaces\->unpack_field(\*(Aqspace\*(Aq, \*(Aqfield\*(Aq, $data); .Ve .SS "pack_tuple" .IX Subsection "pack_tuple" Pack a tuple before making database request. .PP .Vb 1 \& my $t = $spaces\->pack_tuple(\*(Aqspace\*(Aq, [ 1, 2, 3 ]); .Ve .SS "unpack_tuple" .IX Subsection "unpack_tuple" Unpack a tuple after getting it from the database: .PP .Vb 1 \& my $t = $spaces\->unpack_tuple(\*(Aqspace\*(Aq, \e@fields); .Ve .SH "SPACES methods" .IX Header "SPACES methods" .SS "new" .IX Subsection "new" constructor .PP .Vb 2 \& use DR::Tarantool::Spaces; \& my $space = DR::Tarantool::Space\->new($no, $space); .Ve .SS "tuple_class" .IX Subsection "tuple_class" Create (or return) a class to hold tuple data. The class is a descendant of DR::Tarantool::Tuple. Returns a unique class (package) name. If a package with such name is already exists, the method doesn't recreate it. .SS "name" .IX Subsection "name" Get a space name. .SS "number" .IX Subsection "number" Get a space number. .SS "field_number" .IX Subsection "field_number" Return field index by field name. .SS "tail_index" .IX Subsection "tail_index" Return index of the first element that is not described in the space. .SS "pack_field" .IX Subsection "pack_field" Pack a field before making a database request. .SS "unpack_field" .IX Subsection "unpack_field" Unpack a single field in a server response. .SS "pack_tuple" .IX Subsection "pack_tuple" Pack a tuple to the binary protocol format: .SS "unpack_tuple" .IX Subsection "unpack_tuple" Unpack a tuple in a server response. .SS "index_number" .IX Subsection "index_number" returns index number by its name. .SS "index_name" .IX Subsection "index_name" returns index name by its number. .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" .Vb 2 \& Copyright (C) 2011 Dmitry E. Oboukhov \& Copyright (C) 2011 Roman V. Nikolaev \& \& This program is free software, you can redistribute it and/or \& modify it under the terms of the Artistic License. .Ve .SH "VCS" .IX Header "VCS" The project is placed git repo on github: .