.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "DlfStore 3pm"
.TH DlfStore 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire 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
Lire::DlfStore \- Interface to a DLF store
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Lire::DlfStore;
\&
\&  my $store = Lire::DlfStore\->open( "mystore", 1 );
\&  my $avail_streams = $store\->dlf_streams;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
.ie n .SS "open( $store_path, [ $create ] );"
.el .SS "open( \f(CW$store_path\fP, [ \f(CW$create\fP ] );"
.IX Subsection "open( $store_path, [ $create ] );"
Opens a Lire::DlfStore residing in the directory pointed by
\&\f(CW$store_path\fR and returns a Lire::DlfStore instance that can be used to
access its content.
.PP
If the store \f(CW$store_path\fR wasn\*(Aqt created, the method will die unless
the \f(CW$create\fR parameter was set to true.
.PP
If the store is locked by another process, the method will also die.
.PP
Trying to open the same store twice from the same process will fail.
.SS \fBclose()\fP
.IX Subsection "close()"
Calls this method to release the lock held by the current process on
the store. If you don\*(Aqt call it, it will be called automatically when
the store reference goes out of scope, but you better not rely on this
to close your stores.
.SS \fBis_closed()\fP
.IX Subsection "is_closed()"
Returns true if this DlfStore was closed and cannot be used anymore.
.SS path
.IX Subsection "path"
Returns the path to the store. This is the argument used to create the
store.
.SS config
.IX Subsection "config"
Returns the configuration of the store instantiated as a
Lire::Config::ConfigFile.
.SS \fBimport_jobs()\fP
.IX Subsection "import_jobs()"
Returns as an array ref the list of ImportJob currently configured
in the DlfStore
.SS \fBreport_jobs()\fP
.IX Subsection "report_jobs()"
Returns as an array ref the list of ReportJob currently configured
in the DlfStore
.ie n .SS "has_report_config( $name )"
.el .SS "has_report_config( \f(CW$name\fP )"
.IX Subsection "has_report_config( $name )"
Returns true if there is a report configuration named \f(CW$name\fR in
this DlfStore.
.SS \fBreport_configurations()\fP
.IX Subsection "report_configurations()"
Returns as an array ref the list of ReporConfig currently configured
in the DlfStore
.ie n .SS "get_report_config( $name )"
.el .SS "get_report_config( \f(CW$name\fP )"
.IX Subsection "get_report_config( $name )"
Returns the Lire::ReportConfig object named \f(CW$name\fR. Throws an exception
if it doesn\*(Aq exists.
.SH "DLF STREAMS RELATED METHOD"
.IX Header "DLF STREAMS RELATED METHOD"
A DlfStore can contains multiple Dlf Stream. Dlf Stream is data
conforming to a DLF schema. The streams are represented by
Lire::DlfStream objects.
.SS \fBdlf_streams()\fP
.IX Subsection "dlf_streams()"
List the DLF stream available in the DLF store. This returns a list of
DlfSchema\*(Aqs name.
.ie n .SS "has_dlf_stream( $name )"
.el .SS "has_dlf_stream( \f(CW$name\fP )"
.IX Subsection "has_dlf_stream( $name )"
Returns true if the DlfStore contains a DlfStream conforming to the
schema \f(CW$name\fR.
.ie n .SS "get_stream_config( $name )"
.el .SS "get_stream_config( \f(CW$name\fP )"
.IX Subsection "get_stream_config( $name )"
Returns the Lire::Config::Dictionary instance which contains the
stream configuration for the \f(CW$name\fR DlfStream. This method will create
an instance from the default if necessary. If \f(CW$name\fR isn\*(Aqt a valid
schema name, this method will throw an error.
.SS \fBconfigured_dlf_streams()\fP
.IX Subsection "configured_dlf_streams()"
Returns the list of DlfStreams which are referenced by the store
configuration. This is the result of \fBdlf_streams()\fR plus all schemas
that exists and are used by one of the confiured ImportJob or
DlfStreamSpec.
.ie n .SS "open_dlf_stream( $name, [$mode], [$sort_spec] )"
.el .SS "open_dlf_stream( \f(CW$name\fP, [$mode], [$sort_spec] )"
.IX Subsection "open_dlf_stream( $name, [$mode], [$sort_spec] )"
Returns a Lire::DlfStream object that can be used to a DLF stream in
the schema \f(CW$name\fR. The \f(CW$mode\fR parameter can either "r" or "w" and
defaults to "r".
.PP
If the mode is "w", the Lire::DlfStream is opened for writing (new Dlf
records can be inserted). If the DlfStore didn\*(Aqt contains a stream
\&\f(CW$name\fR, an empty one will be created.
.PP
If the mode is "r", the Lire::DlfStream is opened for reading (no DLF
records may be inserted). An exception will be thrown if there is no
stream \f(CW$name\fR available.
.PP
When the stream is opened in "r" mode, a sort order can be specified
by passing a \f(CW$sort_spec\fR. A \f(CW$sort_spec\fR is a white\-space delimited list
of field names which should specify the sort order. Reverse sort order
can be specified by prefixing the field\*(Aqs name by \*(Aq\-\*(Aq.
.ie n .SS "run_analysers( $stream, [ $dlf_source ] )"
.el .SS "run_analysers( \f(CW$stream\fP, [ \f(CW$dlf_source\fP ] )"
.IX Subsection "run_analysers( $stream, [ $dlf_source ] )"
Runs all the configured analysers on the DLF stream \f(CW$stream\fR.
\&\f(CW$dlf_source\fR limit the records which should be analysed.
.SS \fBclean_streams()\fP
.IX Subsection "clean_streams()"
Remove records that are days older than what is configured in the
\&\*(Aqkeep_days\*(Aq parameter.
.SH "REPORTS RELATED METHOD"
.IX Header "REPORTS RELATED METHOD"
A DlfStore also contains the periodically generated reports. These
reports are usually configured through the \fBlire\fR\|(1) command. The
generated reports are stored in Lire XML native format by period.
.ie n .SS "put_report( $job, $schedule, $report )"
.el .SS "put_report( \f(CW$job\fP, \f(CW$schedule\fP, \f(CW$report\fP )"
.IX Subsection "put_report( $job, $schedule, $report )"
Saves the \f(CW$report\fR Lire::Report which was generated by \f(CW$job\fR and
\&\f(CW$schedule\fR. Returns the filename where the report was saved.
.ie n .SS "find_report_source( $job, $schedule, [$time] )"
.el .SS "find_report_source( \f(CW$job\fP, \f(CW$schedule\fP, [$time] )"
.IX Subsection "find_report_source( $job, $schedule, [$time] )"
This method will returns an hash reference containing parameters on
how the ReportJob \f(CW$job\fR should be generated for the ReportSchedule
\&\f(CW$schedule\fR. The boundaries of the period are determined according to
\&\f(CW$time\fR which detauls to now.
.PP
The hash reference will contain a \*(Aqsource\*(Aq key as well as possible
others:
.IP source 4
.IX Item "source"
Specify from what kind of source the report should be generated.
Possible values are \*(Aqdlf\*(Aq when the report should be generated from
DLF, \*(Aqmerging\*(Aq when the report should be generated by merging previous
XML reports and \*(Aqnone\*(Aq when no data is available for that period and
the report cannot be generated.
.Sp
Note that \*(Aqmerging\*(Aq is only available as a source for schedule above
\&\*(Aqdaily\*(Aq. i.e. \*(Aqhourly\*(Aq and \*(Aqdaily\*(Aq reports can only be generated from
DLF. Also of important is the fact that only \*(Aqdaily\*(Aq reports are
available as a source of merging. So you need a daily report schedule
to generate \*(Aqweekly\*(Aq, \*(Aqmonthly\*(Aq and \*(Aqyearly\*(Aq schedule by merging.
.IP start 4
.IX Item "start"
The timestamp at which the available data for the period starts. This
can be higher than the requested period\*(Aqs starting boundary.
.IP end 4
.IX Item "end"
The timestamp at which the available data for the period ends. This
can be lower than the requested period\*(Aqs ending boundary.
.IP coverage 4
.IX Item "coverage"
An integer between 0 and 100 representing the ratio of data available
for the requested period. For example, if only 6 hours of data are
available for a \*(Aqdaily\*(Aq report, the \*(Aqcoverage\*(Aq will be 25.
.IP reports 4
.IX Item "reports"
This key is only available when \*(Aqsource\*(Aq is \*(Aqmerging\*(Aq. It contains an
array of report files which should be used as the source of merging.
.IP days 4
.IX Item "days"
This key is only available when \*(Aqsource\*(Aq is \*(Aqmerging\*(Aq. It contains the
days for which a reports was available for merging. For example, if
only 6 daily reports were available to generate a \*(Aqweekly\*(Aq report,
this will contain those 6 days dates in ISO format (%Y\-%m\-%d).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::DlfConverter\fR\|(3pm)
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR DlfStore.pm,v 1.41 2011/11/15 16:48:40 wraay Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2002,2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.