1 # $Id: Session.pm,v 1.18 2003-07-07 10:59:33 pop Exp $
3 # Zebra perl API header
4 # =============================================================================
5 package IDZebra::Session;
14 use IDZebra::Logger qw(:flags :calls);
15 use IDZebra::Resultset;
16 use IDZebra::ScanList;
17 use IDZebra::RetrievalRecord;
19 our $VERSION = do { my @r = (q$Revision: 1.18 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r };
20 our @ISA = qw(IDZebra::Logger Exporter);
21 our @EXPORT = qw (TRANS_RW TRANS_RO);
24 use constant TRANS_RW => 1;
25 use constant TRANS_RO => 0;
28 # -----------------------------------------------------------------------------
29 # Class constructors, destructor
30 # -----------------------------------------------------------------------------
32 my ($proto, %args) = @_;
33 my $class = ref($proto) || $proto;
35 $self->{args} = \%args;
37 bless ($self, $class);
38 $self->{cql_ct} = undef;
39 $self->{cql_mapfile} = "";
42 $self->{databases} = {};
46 my ($self, %args) = @_;
49 unless (defined($self->{zs})) {
50 if (defined($args{'configFile'})) {
51 $self->{zs} = IDZebra::start($args{'configFile'});
53 $self->{zs} = IDZebra::start("zebra.cfg");
60 if (defined($self->{zs})) {
61 IDZebra::stop($self->{zs}) if ($self->{zs});
68 my ($proto,%args) = @_;
71 if (ref($proto)) { $self = $proto; } else {
72 $self = $proto->new(%args);
76 %args = %{$self->{args}};
79 $self->start_service(%args);
81 unless (defined($self->{zs})) {
82 croak ("Falied to open zebra service");
85 unless (defined($self->{zh})) {
86 $self->{zh}=IDZebra::open($self->{zs});
89 # Reset result set counter
92 # This is needed in order to somehow initialize the service
93 $self->databases("Default");
95 # Load the default configuration
100 my $shadow = defined($args{shadow}) ? $args{shadow} : 0;
101 $self->shadow($shadow);
103 $self->{odr_input} = IDZebra::odr_createmem($IDZebra::ODR_DECODE);
104 $self->{odr_output} = IDZebra::odr_createmem($IDZebra::ODR_ENCODE);
111 unless (defined($self->{zh})) {
112 croak ("Zebra session is not opened");
122 # Delete all resulsets
123 my $r = IDZebra::deleteResultSet($self->{zh},
124 1, #Z_DeleteRequest_all,
128 while (IDZebra::trans_no($self->{zh}) > 0) {
129 logf (LOG_WARN,"Explicitly closing transaction with session");
133 IDZebra::close($self->{zh});
137 if ($self->{odr_input}) {
138 IDZebra::odr_reset($self->{odr_input});
139 IDZebra::odr_destroy($self->{odr_input});
140 $self->{odr_input} = undef;
143 if ($self->{odr_output}) {
144 IDZebra::odr_reset($self->{odr_output});
145 IDZebra::odr_destroy($self->{odr_output});
146 $self->{odr_output} = undef;
154 logf (LOG_LOG,"DESTROY $self");
157 if (defined ($self->{cql_ct})) {
158 IDZebra::cql_transform_close($self->{cql_ct});
162 # -----------------------------------------------------------------------------
163 # Record group selection This is a bit nasty... but used at many places
164 # -----------------------------------------------------------------------------
166 my ($self,%args) = @_;
169 $self->{rg} = $self->_makeRecordGroup(%args);
170 $self->_selectRecordGroup($self->{rg});
175 sub selectRecordGroup {
176 my ($self, $groupName) = @_;
178 $self->{rg} = $self->_getRecordGroup($groupName);
179 $self->_selectRecordGroup($self->{rg});
182 sub _displayRecordGroup {
183 my ($self, $rg) = @_;
184 print STDERR "-----\n";
185 foreach my $key qw (groupName
196 print STDERR "$key:",$rg->{$key},"\n";
200 sub _cloneRecordGroup {
201 my ($self, $orig) = @_;
202 my $rg = IDZebra::recordGroup->new();
203 my $r = IDZebra::init_recordGroup($rg);
204 foreach my $key qw (groupName
216 $rg->{$key} = $orig->{$key} if ($orig->{$key});
221 sub _getRecordGroup {
222 my ($self, $groupName, $ext) = @_;
223 my $rg = IDZebra::recordGroup->new();
224 my $r = IDZebra::init_recordGroup($rg);
225 $rg->{groupName} = $groupName if ($groupName ne "");
226 $ext = "" unless ($ext);
227 $r = IDZebra::res_get_recordGroup($self->{zh}, $rg, $ext);
231 sub _makeRecordGroup {
232 my ($self, %args) = @_;
235 my @keys = keys(%args);
236 unless ($#keys >= 0) {
237 return ($self->{rg});
240 if ($args{groupName}) {
241 $rg = $self->_getRecordGroup($args{groupName});
243 $rg = $self->_cloneRecordGroup($self->{rg});
245 $self->_setRecordGroupOptions($rg, %args);
249 sub _setRecordGroupOptions {
250 my ($self, $rg, %args) = @_;
252 foreach my $key qw (databaseName
263 if (defined ($args{$key})) {
264 $rg->{$key} = $args{$key};
268 sub _selectRecordGroup {
269 my ($self, $rg) = @_;
271 my $r = IDZebra::set_group($self->{zh}, $rg);
273 unless ($dbName = $rg->{databaseName}) {
276 unless ($self->databases($dbName)) {
277 croak("Fatal error selecting database $dbName");
280 # -----------------------------------------------------------------------------
281 # Selecting databases for search (and also for updating - internally)
282 # -----------------------------------------------------------------------------
284 my ($self, @databases) = @_;
289 return (keys(%{$self->{databases}}));
294 foreach my $db (@databases) {
296 next if ($self->{databases}{$db});
300 foreach my $db (keys (%{$self->{databases}})) {
301 $changed++ unless ($tmp{$db});
306 delete ($self->{databases});
307 foreach my $db (@databases) {
308 $self->{databases}{$db}++;
311 if (IDZebra::select_databases($self->{zh},
315 "Could not select database(s) %s errCode=%d",
316 join(",",@databases),
320 logf(LOG_LOG,"Database(s) selected: %s",join(",",@databases));
323 return (keys(%{$self->{databases}}));
326 # -----------------------------------------------------------------------------
328 # -----------------------------------------------------------------------------
331 return(IDZebra::errCode($self->{zh}));
336 return(IDZebra::errString($self->{zh}));
341 return(IDZebra::errAdd($self->{zh}));
344 # -----------------------------------------------------------------------------
346 # -----------------------------------------------------------------------------
349 $m = TRANS_RW unless (defined ($m));
350 if (my $err = IDZebra::begin_trans($self->{zh},$m)) {
351 if ($self->errCode == 2) {
352 croak ("TRANS_RW not allowed within TRANS_RO");
354 croak("Error starting transaction; code:".
355 $self->errCode . " message: " . $self->errString);
363 my $stat = IDZebra::ZebraTransactionStatus->new();
364 IDZebra::end_trans($self->{zh}, $stat);
369 my ($self, $value) = @_;
372 $value = 0 unless (defined($value));
373 my $r =IDZebra::set_shadow_enable($self->{zh},$value);
375 return (IDZebra::get_shadow_enable($self->{zh}));
382 return(IDZebra::commit($self->{zh}));
386 # -----------------------------------------------------------------------------
387 # We don't really need that...
388 # -----------------------------------------------------------------------------
390 my ($self, $name) = @_;
391 if ($name !~/^(input|output)$/) {
392 croak("Undefined ODR '$name'");
394 IDZebra::odr_reset($self->{"odr_$name"});
397 # -----------------------------------------------------------------------------
399 # -----------------------------------------------------------------------------
403 return(IDZebra::init($self->{zh}));
409 return(IDZebra::compact($self->{zh}));
413 my ($self, %args) = @_;
415 my $rg = $self->_update_args(%args);
416 $self->_selectRecordGroup($rg);
418 IDZebra::repository_update($self->{zh});
419 $self->_selectRecordGroup($self->{rg});
424 my ($self, %args) = @_;
426 my $rg = $self->_update_args(%args);
427 $self->_selectRecordGroup($rg);
429 IDZebra::repository_delete($self->{zh});
430 $self->_selectRecordGroup($self->{rg});
435 my ($self, %args) = @_;
437 my $rg = $self->_update_args(%args);
438 $self->_selectRecordGroup($rg);
440 IDZebra::repository_show($self->{zh});
441 $self->_selectRecordGroup($self->{rg});
446 my ($self, %args) = @_;
447 my $rg = $self->_makeRecordGroup(%args);
448 $self->_selectRecordGroup($rg);
452 # -----------------------------------------------------------------------------
454 # -----------------------------------------------------------------------------
456 my ($self, %args) = @_;
458 my @args = $self->_record_update_args(%args);
459 my $stat = IDZebra::insert_record($self->{zh}, @args);
460 my $sysno = $args[2]; $stat = -1 * $stat if ($stat > 0);
461 return $stat ? $stat : $$sysno;
462 if ($stat) { return ($stat); } else { return $sysno};
466 my ($self, %args) = @_;
468 my @args = $self->_record_update_args(%args);
469 my $stat = IDZebra::update_record($self->{zh}, @args);
470 my $sysno = $args[2]; $stat = -1 * $stat if ($stat > 0);
471 return $stat ? $stat : $$sysno;
472 if ($stat) { return ($stat); } else { return $$sysno};
476 my ($self, %args) = @_;
478 my @args = $self->_record_update_args(%args);
479 my $stat = IDZebra::delete_record($self->{zh}, @args);
480 my $sysno = $args[2]; $stat = -1 * $stat if ($stat > 0);
481 return $stat ? $stat : $$sysno;
484 sub _record_update_args {
485 my ($self, %args) = @_;
487 my $sysno = $args{sysno} ? $args{sysno} : 0;
488 my $match = $args{match} ? $args{match} : "";
489 my $rectype = $args{recordType} ? $args{recordType} : "";
490 my $fname = $args{file} ? $args{file} : "<no file>";
491 my $force = $args{force} ? $args{force} : 0;
498 elsif ($args{file}) {
499 CORE::open (F, $args{file}) || warn ("Cannot open $args{file}");
500 $buff = join('',(<F>));
503 my $len = length($buff);
505 delete ($args{sysno});
506 delete ($args{match});
507 delete ($args{recordType});
508 delete ($args{file});
509 delete ($args{data});
510 delete ($args{force});
512 my $rg = $self->_makeRecordGroup(%args);
514 # If no record type is given, then try to find it out from the
517 if (my ($ext) = $fname =~ /\.(\w+)$/) {
518 my $rg2 = $self->_getRecordGroup($rg->{groupName},$ext);
519 $rectype = $rg2->{recordType};
523 $rg->{databaseName} = "Default" unless ($rg->{databaseName});
528 return ($rg, $rectype, \$sysno, $match, $fname, $buff, $len, $force);
531 # -----------------------------------------------------------------------------
534 my ($self,$mapfile) = @_;
536 if ($self->{cql_mapfile} ne $mapfile) {
537 unless (-f $mapfile) {
538 croak("Cannot find $mapfile");
540 if (defined ($self->{cql_ct})) {
541 IDZebra::cql_transform_close($self->{cql_ct});
543 $self->{cql_ct} = IDZebra::cql_transform_open_fname($mapfile);
544 $self->{cql_mapfile} = $mapfile;
547 return ($self->{cql_mapfile});
551 my ($self, $cqlquery) = @_;
552 unless (defined($self->{cql_ct})) {
553 croak("CQL map file is not specified yet.");
555 my $res = "\0" x 2048;
556 my $r = IDZebra::cql2pqf($self->{cql_ct}, $cqlquery, $res, 2048);
558 # carp ("Error transforming CQL query: '$cqlquery', status:$r");
565 # -----------------------------------------------------------------------------
567 # -----------------------------------------------------------------------------
569 my ($self, %args) = @_;
573 if ($args{cqlmap}) { $self->cqlmap($args{cqlmap}); }
581 ($query, $cqlstat) = $self->cql2pqf($args{cql});
583 croak ("Failed to transform query: '$args{cql}', ".
584 "status: ($cqlstat)");
588 croak ("No query given to search");
593 if ($args{databases}) {
594 @origdbs = $self->databases;
595 $self->databases(@{$args{databases}});
598 my $rsname = $args{rsname} ? $args{rsname} : $self->_new_setname;
600 my $rs = $self->_search_pqf($query, $rsname);
602 if ($args{databases}) {
603 $self->databases(@origdbs);
608 carp("Sort skipped due to search error: ".
611 $rs->sort($args{sort});
620 return ("set_".$self->{rscount}++);
624 my ($self, $query, $setname) = @_;
629 my $res = IDZebra::search_PQF($self->{zh},
634 my $rs = IDZebra::Resultset->new($self,
636 recordCount => $hits,
637 errCode => $self->errCode,
638 errString => $self->errString);
642 # -----------------------------------------------------------------------------
645 # Sorting of multiple result sets is not supported by zebra...
646 # -----------------------------------------------------------------------------
649 my ($self, $sortspec, $setname, @sets) = @_;
654 croak ("Sorting/merging of multiple resultsets is not supported now");
659 foreach my $rs (@sets) {
660 push (@setnames, $rs->{name});
661 $count += $rs->{recordCount}; # is this really sure ??? It doesn't
665 my $status = IDZebra::sort($self->{zh},
671 my $errCode = $self->errCode;
672 my $errString = $self->errString;
674 logf (LOG_LOG, "Sort status $setname: %d, errCode: %d, errString: %s",
675 $status, $errCode, $errString);
677 if ($status || $errCode) {$count = 0;}
679 my $rs = IDZebra::Resultset->new($self,
681 recordCount => $count,
683 errString => $errString);
687 # -----------------------------------------------------------------------------
689 # -----------------------------------------------------------------------------
691 my ($self, %args) = @_;
695 unless ($args{expression}) {
696 croak ("No scan expression given");
699 my $sl = IDZebra::ScanList->new($self,%args);
704 # ============================================================================
710 IDZebra::Session - A Zebra database server session for update and retrieval
714 $sess = IDZebra::Session->new(configFile => 'demo/zebra.cfg');
717 $sess = IDZebra::Session->open(configFile => 'demo/zebra.cfg',
718 groupName => 'demo1');
720 $sess->group(groupName => 'demo2');
726 $sess->update(path => 'lib');
728 my $s1=$sess->update_record(data => $rec1,
729 recordType => 'grs.perl.pod',
730 groupName => "demo1",
733 my $stat = $sess->end_trans;
735 $sess->databases('demo1','demo2');
737 my $rs1 = $sess->search(cqlmap => 'demo/cql.map',
738 cql => 'dc.title=IDZebra',
739 databases => [qw(demo1 demo2)]);
744 Zebra is a high-performance, general-purpose structured text indexing and retrieval engine. It reads structured records in a variety of input formats (eg. email, XML, MARC) and allows access to them through exact boolean search expressions and relevance-ranked free-text queries.
746 Zebra supports large databases (more than ten gigabytes of data, tens of millions of records). It supports incremental, safe database updates on live systems. You can access data stored in Zebra using a variety of Index Data tools (eg. YAZ and PHP/YAZ) as well as commercial and freeware Z39.50 clients and toolkits.
748 =head1 OPENING AND CLOSING A ZEBRA SESSIONS
750 For the time beeing only local database services are supported, the same way as calling zebraidx or zebrasrv from the command shell. In order to open a local Zebra database, with a specific configuration file, use
752 $sess = IDZebra::Session->new(configFile => 'demo/zebra.cfg');
757 $sess = IDZebra::Session->open(configFile => 'demo/zebra.cfg');
759 where $sess is going to be the object representing a Zebra Session. Whenever this variable gets out of scope, the session is closed, together with all active transactions, etc... Anyway, if you'd like to close the session, just say:
764 - close all transactions
765 - destroy all result sets and scan lists
768 Note, that if I<shadow registers> are enabled, the changes will not be committed automatically.
770 In the future different database access methods are going to be available,
773 $sess = IDZebra::Session->open(server => 'ostrich.technomat.hu:9999');
775 You can also use the B<record group> arguments described below directly when calling the constructor, or the open method:
777 $sess = IDZebra::Session->open(configFile => 'demo/zebra.cfg',
778 groupName => 'demo');
783 If you manage different sets of records that share common characteristics, you can organize the configuration settings for each type into "groups". See the Zebra manual on the configuration file (zebra.cfg).
785 For each open session a default record group is assigned. You can configure it in the constructor, or by the B<group> method:
787 $sess->group(groupName => ..., ...)
789 The following options are available:
795 This will select the named record group, and load the corresponding settings from the configuration file. All subsequent values will overwrite those...
797 =item B<databaseName>
799 The name of the (logical) database the updated records will belong to.
803 This path is used for directory updates (B<update>, B<delete> methods);
807 This option determines how to identify your records. See I<Zebra manual: Locating Records>
811 The record type used for indexing.
813 =item B<flagStoreData>
815 Specifies whether the records should be stored internally in the Zebra system files. If you want to maintain the raw records yourself, this option should be false (0). If you want Zebra to take care of the records for you, it should be true(1).
817 =item B<flagStoreKeys>
819 Specifies whether key information should be saved for a given group of records. If you plan to update/delete this type of records later this should be specified as 1; otherwise it should be 0 (default), to save register space.
825 =item B<fileVerboseLimit>
827 Skip log messages, when doing a directory update, and the specified number of files are processed...
829 =item B<databaseNamePath>
833 =item B<explainDatabase>
835 The name of the explain database to be used
839 Follow links when doing directory update.
843 You can use the same parameters calling all update methods.
845 =head1 TRANSACTIONS (READ / WRITE LOCKS)
847 A transaction is a block of record update (insert / modify / delete) or retrieval procedures. So, all call to such function will implicitly start a transaction, unless one is already started by
853 $sess->begin_trans(TRANS_RW)
855 (these two are equivalents). The effect of this call is a kind of lock: if you call is a write lock is put on the registers, so other processes trying to update the database will be blocked. If there is already an RW (Read-Write) transaction opened by another process, the I<begin_trans> call will be blocked.
859 $sess->begin_trans(TRANS_RO),
861 if you would like to put on a "read lock". This one is B<deprecated>, as while you have explicitly opened a transaction for read, you can't open another one for update. For example:
863 $sess->begin_trans(TRANS_RO);
864 $sess->begin_tran(TRANS_RW); # invalid, die here
870 $sess->begin_tran(TRANS_RW);
871 $sess->begin_trans(TRANS_RO);
875 is valid, but probably useless. Note again, that for each retrieval call, an RO transaction is opened. I<TRANS_RW> and I<TRANS_RO> are exported by default by IDZebra::Session.pm.
877 For multiple per-record I<updates> it's efficient to start transactions explicitly: otherwise registers (system files, vocabularies, etc..) are updated one by one. After finishing all requested updates, use
879 $stat = $sess->end_trans;
881 The return value is a ZebraTransactionStatus object, containing the following members as a hash reference:
883 $stat->{processed} # Number of records processed
884 $stat->{updated} # Number of records processed
885 $stat->{deleted} # Number of records processed
886 $stat->{inserted} # Number of records processed
887 $stat->{stime} # System time used
888 $stat->{utime} # User time used
890 Normally, if the perl code dies due to some runtime error, or the session is closed, then the API attempts to close all pending transactions.
892 =head1 THE SHADOW REGISTERS
894 The Zebra server supports updating of the index structures. That is, you can add, modify, or remove records from databases managed by Zebra without rebuilding the entire index. Since this process involves modifying structured files with various references between blocks of data in the files, the update process is inherently sensitive to system crashes, or to process interruptions: Anything but a successfully completed update process will leave the register files in an unknown state, and you will essentially have no recourse but to re-index everything, or to restore the register files from a backup medium. Further, while the update process is active, users cannot be allowed to access the system, as the contents of the register files may change unpredictably.
896 You can solve these problems by enabling the shadow register system in Zebra. During the updating procedure, zebraidx will temporarily write changes to the involved files in a set of "shadow files", without modifying the files that are accessed by the active server processes. If the update procedure is interrupted by a system crash or a signal, you simply repeat the procedure - the register files have not been changed or damaged, and the partially written shadow files are automatically deleted before the new updating procedure commences.
898 At the end of the updating procedure (or in a separate operation, if you so desire), the system enters a "commit mode". First, any active server processes are forced to access those blocks that have been changed from the shadow files rather than from the main register files; the unmodified blocks are still accessed at their normal location (the shadow files are not a complete copy of the register files - they only contain those parts that have actually been modified). If the commit process is interrupted at any point during the commit process, the server processes will continue to access the shadow files until you can repeat the commit procedure and complete the writing of data to the main register files. You can perform multiple update operations to the registers before you commit the changes to the system files, or you can execute the commit operation at the end of each update operation. When the commit phase has completed successfully, any running server processes are instructed to switch their operations to the new, operational register, and the temporary shadow files are deleted.
900 By default, (in the API !) the use of shadow registers is disabled. If zebra is configured that way (there is a "shadow" entry in zebra.cfg), then the shadow system can be enabled by calling:
908 If shadow system is enabled, then you have to commit changes you did, by calling:
912 Note, that you can also determine shadow usage in the session constructor:
914 $sess = IDZebra::Session->open(configFile => 'demo/zebra.cfg',
917 Changes to I<shadow> will not have effect, within a I<transaction> (ie.: a transaction is started either with shadow enabled or disabled). For more details, read Zebra documentation: I<Safe Updating - Using Shadow Registers>.
921 There are two ways to update data in a Zebra database using the perl API. You can update an entire directory structure just the way it's done by zebraidx:
923 $sess->update(path => 'lib');
925 This will update the database with the files in directory "lib", according to the current record group settings.
929 This will update the database with the files, specified by the default record group setting. I<path> has to be specified there...
931 $sess->update(groupName => 'demo1',
934 Update the database with files in "lib" according to the settings of group "demo1"
936 $sess->delete(groupName => 'demo1',
939 Delete the records derived from the files in directory "lib", according to the "demo1" group settings. Sounds complex? Read zebra documentation about identifying records.
941 You can also update records one by one, even directly from the memory:
943 $sysno = $sess->update_record(data => $rec1,
944 recordType => 'grs.perl.pod',
945 groupName => "demo1");
947 This will update the database with the given record buffer. Note, that in this case recordType is explicitly specified, as there is no filename given, and for the demo1 group, no default record type is specified. The return value is the system assigned id of the record.
949 You can also index a single file:
951 $sysno = $sess->update_record(file => "lib/IDZebra/Data1.pm");
953 Or, provide a buffer, and a filename (where filename will only be used to identify the record, if configured that way, and possibly to find out it's record type):
955 $sysno = $sess->update_record(data => $rec1,
956 file => "lib/IDZebra/Data1.pm");
958 And some crazy stuff:
960 $sysno = $sess->delete_record(sysno => $sysno);
962 where sysno in itself is sufficient to identify the record
964 $sysno = $sess->delete_record(data => $rec1,
965 recordType => 'grs.perl.pod',
966 groupName => "demo1");
968 This case the record is extracted, and if already exists, located in the database, then deleted...
970 $sysno = $sess->update_record(data => $rec1,
972 recordType => 'grs.perl.pod',
973 groupName => "demo1");
975 Don't try this at home! This case, the record identifier string (which is normally generated according to the rules set in I<recordId> member of the record group, or in the I<recordId> parameter) is provided directly.... Looks much better this way:
977 $sysno = $sess->update_record(data => $rec1,
978 databaseName => 'books',
979 recordId => '(bib1,ISBN)',
980 recordType => 'grs.perl.pod',
984 You can notice, that it's not necessary to define a record group in zebra.cfg: you can do it "on the fly" in your code.
986 B<Important:> Note, that one record can be updated only once within a transaction - all subsequent updates are skipped. If you'd like to override this feature, use the I<force=E<gt>1> flag:
988 $sysno = $sess->update_record(data => $rec1,
989 recordType => 'grs.perl.pod',
990 groupName => "demo1",
993 If you don't like to update the record, if it alerady exists, use the I<insert_record> method:
995 $sysno = $sess->insert_record(data => $rec1,
996 recordType => 'grs.perl.pod',
997 groupName => "demo1");
999 In this case, sysno will be -1, if the record could not be added, because there was already one in the database, with the same record identifier (generated according to the I<recordId> setting).
1001 =head1 DATABASE SELECTION
1003 Within a zebra repository you can define logical databases. You can either do this by record groups, or by providing the databaseName argument for update methods. For each record the database name it belongs to is stored.
1005 For searching, you can select databases by calling:
1007 $sess->databases('db1','db2');
1009 This will not do anything if the given and only the given databases are already selected. You can get the list of the actually selected databases, by calling:
1011 @dblist = $sess->databases();
1015 It's nice to be able to store data in your repository... But it's useful to reach it as well. So this is how to do searching:
1017 $rs = $sess->search(databases => [qw(demo1,demo2)], # optional
1018 pqf => '@attr 1=4 computer');
1020 This is going to execute a search in databases demo1 and demo2, for title 'com,puter'. This is a PQF (Prefix Query Format) search, see YAZ documentation for details. The database selection is optional: if it's provided, the given list of databases is selected for this particular search, then the original selection is restored.
1022 =head2 CCL searching
1024 Not all users enjoy typing in prefix query structures and numerical attribute values, even in a minimalistic test client. In the library world, the more intuitive Common Command Language (or ISO 8777) has enjoyed some popularity - especially before the widespread availability of graphical interfaces. It is still useful in applications where you for some reason or other need to provide a symbolic language for expressing boolean query structures.
1026 The CCL searching is not currently supported by this API.
1028 =head2 CQL searching
1030 CQL - Common Query Language - was defined for the SRW protocol. In many ways CQL has a similar syntax to CCL. The objective of CQL is different. Where CCL aims to be an end-user language, CQL is the protocol query language for SRW.
1032 In order to map CQL queries to Zebra internal search structures, you have to define a mapping, the way it is described in YAZ documentation: I<Specification of CQL to RPN mapping>. The mapping is interpreted by the method:
1034 $sess->cqlmap($mapfile);
1036 Or, you can directly provide the I<mapfile> parameter for the search:
1038 $rs = $sess->search(cqlmap => 'demo/cql.map',
1039 cql => 'dc.title=IDZebra');
1041 As you see, CQL searching is so simple: just give the query in the I<cql> parameter.
1045 If you'd like the search results to be sorted, use the I<sort> parameter:
1047 $rs = $sess->search(cql => 'IDZebra',
1050 Note, that B<currently> this is (almost) equivalent to
1052 $rs = $sess->search(cql => 'IDZebra');
1053 $rs->sort('1=4 ia');
1055 but in the further versions of Zebra and this API a single phase search and sort will take place, optimizing performance. For more details on sorting, see I<IDZebra::ResultSet> manpage.
1059 As you have seen, the result of the search request is a I<Resultset> object.
1060 It contains number of hits, and search status, and can be used to sort and retrieve the resulting records.
1062 $count = $rs->count;
1064 printf ("RS Status is %d (%s)\n", $rs->errCode, $rs->errString);
1066 I<$rs-E<gt>errCode> is 0, if there were no errors during search. Read the I<IDZebra::Resultset> manpage for more details.
1070 Zebra supports scanning index values. The result of the
1072 $sl = $sess->scan(expression => "a");
1074 call is an I<IDZebra::ScanList> object, what you can use to list the values. The scan expression has to be provided in a PQF like format. Examples:
1076 B< a> (scan trough words of "default", "Any" indexes)
1079 B< @attr 1=1016 a> (same effect)
1082 B< @attr 1=4 @attr 6=2 a> (scan trough titles as phrases)
1084 An illegal scan expression will cause your code to die. If you'd like to select databases just for the scan call, you can optionally use the I<databases> parameter:
1086 $sl = $sess->scan(expression => "a",
1087 databases => [qw(demo1 demo2)]);
1089 You can use the I<IDZebra::ScanList> object returned by the i<scan> method, to reach the result. Check I<IDZebra::ScanList> manpage for more details.
1091 =head1 SESSION STATUS AND ERRORS
1093 Most of the API calls causes die, if an error occures. You avoid this, by using eval {} blocks. The following methods are available to get the status of Zebra service:
1099 The Zebra provided error code... (for the result of the last call);
1103 Error string corresponding to the message
1107 Additional information for the status
1111 This functionality may change, see TODO.
1113 =head1 LOGGING AND MISC. FUNCTIONS
1115 Zebra provides logging facility for the internal events, and also for application developers trough the API. See manpage I<IDZebra::Logger> for details.
1119 =item B<IDZebra::LogFile($filename)>
1121 Will set the output file for logging. By default it's STDERR;
1123 =item B<IDZebra::LogLevel(15)>
1125 Set log level. 0 for no logs. See IDZebra::Logger for usable flags.
1129 Some other functions
1133 =item B<$sess-E<gt>init>
1135 Initialize, and clean registers. This will remove all data!
1137 =item B<$sess-E<gt>compact>
1139 Compact the registers (? does this work)
1141 =item B<$sess-E<gt>show>
1143 Doesn't have too much meaning. Don't try :)
1151 =item B<Clean up error handling>
1153 By default all zebra errors should cause die. (such situations could be avoided by using eval {}), and then check for errCode, errString... An optional flag or package variable should be introduced to override this, and skip zebra errors, to let the user decide what to do.
1155 =item B<Make the package self-distributable>
1157 Build and link with installed header and library files
1161 Test shadow system, unicode...
1165 Cleanup, arrange, remove redundancy
1175 Peter Popovics, pop@technomat.hu
1179 Zebra documentation, Zebra::ResultSet, Zebra::ScanList, Zebra::Logger manpages