.\" Automatically generated by Pod::Man 2.27 (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 "HDB::Encode 3"
.TH HDB::Encode 3 "2004-05-10" "perl v5.16.3" "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"
HDB::Encode \- Hybrid DataBase \- HASH/ARRAY enconding.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
You can save \s-1HASH\s0 and \s-1ARRAY\s0 structures inside columns of a table in the database.
.PP
** The column that will receive the encoded data need to have a good size for the encoded \s-1HASH/ARRAY\s0!
.SH "USAGE"
.IX Header "USAGE"
.Vb 7
\&  my %HASH = (
\&  \*(Aqa\*(Aq => 1 ,
\&  \*(Aqb\*(Aq => 2 ,
\&  \*(Aqc\*(Aq => 3 ,
\&  \*(Aqd\*(Aq => { \*(Aqda\*(Aq => 41 , \*(Aqdb\*(Aq => 42 } ,
\&  \*(Aqe\*(Aq => [qw(x y z)] ,
\&  ) ;
\&  
\&  $HDB\->insert( \*(Aqusers\*(Aq , {
\&  user => \*(Aqjoe\*(Aq ,
\&  name => \*(Aqjoe tribianny\*(Aq ,
\&  more => \e%HASH ,
\&  } ) ;
\&  
\&  ...
\&  
\&  $HDB\->insert( \*(Aqusers\*(Aq , {
\&  user => \*(Aqjoe\*(Aq ,
\&  name => \*(Aqjoe tribianny\*(Aq ,
\&  more => { a => 1 , b => 2 } ,
\&  } ) ;
\&  
\&  ...
\&  
\&  my %hash = $HDB\->select( \*(Aqusers\*(Aq , \*(Aquser == joe\*(Aq , col => \*(Aqmore\*(Aq , \*(Aq$$@\*(Aq ) ; # $$@ to return directly the HASH.
.Ve
.SH "METHODS"
.IX Header "METHODS"
\&\fB** You don't need to use this methods, \s-1HDB\s0 will make everything automatically.\fR
.SS "Pack (\e%HASH or \e@ARRAY)"
.IX Subsection "Pack (%HASH or @ARRAY)"
Encode a \s-1HASH/ARRAY.\s0
Will use Pack_HASH & Pack_ARRAY.
.SS "Pack_HASH (\e%HASH)"
.IX Subsection "Pack_HASH (%HASH)"
Encode a \s-1HASH.\s0
.SS "Pack_ARRAY (\e@ARRAY)"
.IX Subsection "Pack_ARRAY (@ARRAY)"
Encode an \s-1ARRAY.\s0
.SS "UnPack (\s-1ENCODED_HASH\s0 or \s-1ENCODED_ARRAY\s0)"
.IX Subsection "UnPack (ENCODED_HASH or ENCODED_ARRAY)"
Decode a \s-1HASH/ARRAY.\s0
Will use UnPack_HASH & UnPack_ARRAY.
.SS "UnPack_HASH (\s-1ENCODED_HASH\s0)"
.IX Subsection "UnPack_HASH (ENCODED_HASH)"
Decode a \s-1HASH.\s0
.SS "UnPack_ARRAY (\s-1ENCODED_ARRAY\s0)"
.IX Subsection "UnPack_ARRAY (ENCODED_ARRAY)"
Decode an \s-1ARRAY.\s0
.SS "Is_Packed_HASH (\s-1DATA\s0)"
.IX Subsection "Is_Packed_HASH (DATA)"
Check if the encoded data is a \s-1HASH.\s0
.SS "Is_Packed_ARRAY (\s-1DATA\s0)"
.IX Subsection "Is_Packed_ARRAY (DATA)"
Check if the encoded data is an \s-1ARRAY.\s0
.SS "Check_Pack_Size (\s-1DATA\s0)"
.IX Subsection "Check_Pack_Size (DATA)"
Check if the encoded data is ok.
.SS "Packed_SIZE (\e%HASH or \e@ARRAY)"
.IX Subsection "Packed_SIZE (%HASH or @ARRAY)"
Return the size of the \s-1HASH/ARRAY\s0 encoded.
This will calculate the size without generate the encoded data.
.PP
Will use Packed_SIZE_HASH & Packed_SIZE_ARRAY.
.SS "Packed_SIZE_HASH (\e%HASH)"
.IX Subsection "Packed_SIZE_HASH (%HASH)"
Return the size of the \s-1HASH\s0 encoded without generate it.
.SS "Packed_SIZE_ARRAY (\e@ARRAY)"
.IX Subsection "Packed_SIZE_ARRAY (@ARRAY)"
Return the size of the \s-1ARRAY\s0 encoded without generate it.
.SH "ENCODED DATA"
.IX Header "ENCODED DATA"
The encoded \s-1HASH/ARRAY\s0 are very similar:
.PP
.Vb 1
\&  %HDB_PACKED_HASH%[1.0]{50}:DATA
\&
\&  1.0  >> Format version.
\&  50   >> DATA size.
\&  DATA >> The encoded data.
\&  
\&  # For ARRAY is:
\&  %HDB_PACKED_ARRAY%...
\&  
\&  ** The data has this begin to identify the encoded data in the database.
\&  ** The size is used to check if the data is crashed.
\&  
\&  DATA for HASH:
\&  
\&  02:aa4:bbbb
\&  
\&  0    >> normal value. 1 for HASH in the value. 2 for ARRAY in the value.
\&  2    >> size of key.
\&  aa   >> key
\&  4    >> size of value.  
\&  bbbb >> value
\&  
\&  DATA for ARRAY:
\&  
\&  02:aa
\&  
\&  0  >> normal value. 1 for HASH in the value. 2 for ARRAY in the value.
\&  2  >> size of value.
\&  aa >> value
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1HDB\s0, \s-1HDB::CMDS\s0, HDB::sqlite, HDB::mysql.
.SH "AUTHOR"
.IX Header "AUTHOR"
Graciliano M. P. <gm@virtuasites.com.br>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.