.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "Data::Stag::HashDB 3pm"
.TH Data::Stag::HashDB 3pm "2022-06-12" "perl v5.34.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"
.Vb 1
\&  Data::Stag::HashDB \- build indexes over Stag files or objects
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 9
\&  # parsing a file into a hash
\&  my $hdb = Data::Stag::HashDB\->new;
\&  $hdb\->unique_key("ss_details/social_security_no");
\&  $hdb\->record_type("person");
\&  my $obj = {};
\&  $hdb\->index_hash($obj);
\&  Data::Stag\->parse(\-file=>$fn, \-handler=>$hdb);
\&  my $person = $obj\->{\*(Aq999\-9999\-9999\*(Aq};
\&  print $person\->xml;
\&
\&  # indexing an existing stag tree into a hash
\&  my $personset = Data::Stag\->parse($fn);
\&  my $hdb = Data::Stag::HashDB\->new;
\&  $hdb\->unique_key("ss_details/social_security_no");
\&  $hdb\->record_type("person");
\&  my $obj = {};
\&  $hdb\->index_hash($obj);
\&  $personset\->sax($hdb);
\&  my $person = $obj\->{\*(Aq999\-9999\-9999\*(Aq};
\&  print $person\->xml;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Used for building indexes over Stag files or objects
.PP
You need to provide a \fBrecord_type\fR \- this is the type of element
that will be indexed
.PP
You need to provide a \fBunique_key\fR \- this is a single value used to
index the \fBrecord_type\fRs
.PP
For example, if we have data in the stag structure below, and if ss_no
is unique (we assume it is) then we can index all the people in the
database using the code above
.PP
.Vb 7
\&  publicinfo:
\&    persondata:
\&      person:
\&        ss_details:
\&          social_security_no:
\&        name:
\&        address:
.Ve
.PP
There is a subclass of this method callsed Data::Stag::StagDB, which
makes the hash persistent
.SH "PUBLIC METHODS \-"
.IX Header "PUBLIC METHODS -"
.SS "record_type"
.IX Subsection "record_type"
.Vb 3
\&  Usage   \-
\&  Returns \-
\&  Args    \-
.Ve
.SS "unique_key"
.IX Subsection "unique_key"
.Vb 3
\&  Usage   \-
\&  Returns \-
\&  Args    \-
.Ve
.SS "index_hash"
.IX Subsection "index_hash"
.Vb 3
\&  Usage   \-
\&  Returns \-
\&  Args    \-
.Ve