1 { # Based on the change to Class::DBI in OpenILS::Application::Storage. This will
2 # allow us to use TSearch2 via a simple cdbi "search" interface.
3 #-------------------------------------------------------------------------------
10 if (ref($args[-1]) eq 'HASH') {
11 $args[-1]->{_placeholder} = "to_tsquery('default',?)";
13 push @args, {_placeholder => "to_tsquery('default',?)"};
15 $self->_do_search("@@" => @args);
19 { # Every driver needs to provide a 'compile()' method to OpenILS::Application::Storage::FTS.
20 # If that driver wants to support FTI, that is...
21 #-------------------------------------------------------------------------------
22 package OpenILS::Application::Storage::FTS;
23 use OpenSRF::Utils::Logger qw/:level/;
24 my $log = 'OpenSRF::Utils::Logger';
30 $self = ref($self) || $self;
31 $self = bless {} => $self;
33 $self->decompose($term);
35 my $newterm = join('&', $self->words);
38 $newterm = '('.$newterm.')&('. join('|', $self->nots) . ')';
41 $log->debug("Compiled term is [$newterm]", DEBUG);
42 $newterm = OpenILS::Application::Storage::Driver::Pg->quote($newterm);
43 $log->debug("Quoted term is [$newterm]", DEBUG);
45 $self->{fts_query} = ["to_tsquery('default',$newterm)"];
46 $self->{fts_query_nots} = [];
47 $self->{fts_op} = '@@';
48 $self->{text_col} = shift;
49 $self->{fts_col} = shift;
54 sub sql_where_clause {
56 my $column = $self->fts_col;
60 for my $fts ( $self->fts_query ) {
61 push @output, join(' ', $self->fts_col, $self->{fts_op}, $fts);
62 push @ranks, "rank($column, $fts)";
64 $self->{fts_rank} = \@ranks;
66 my $phrase_match = $self->sql_exact_phrase_match();
67 return join(' AND ', @output) . $phrase_match;
73 { # The driver package itself just needs a db_Main method (or db_Slaves if
74 #Class::DBI::Replication is in use) for Class::DBI to call.
76 # Any other fixups can go in here too... Also, the drivers should subclass the
77 # DBI driver that they are wrapping, or provide a 'quote()' method that calls
78 # the DBD::xxx::quote() method on FTI's behalf.
80 # The dirver MUST be a subclass of Class::DBI(::Replication) and
81 # OpenILS::Application::Storage.
82 #-------------------------------------------------------------------------------
83 package OpenILS::Application::Storage::Driver::Pg;
85 use base qw/Class::DBI OpenILS::Application::Storage/;
87 use OpenSRF::EX qw/:try/;
88 use OpenSRF::DomainObject::oilsResponse;
89 use OpenSRF::Utils::Logger qw/:level/;
90 my $log = 'OpenSRF::Utils::Logger';
92 __PACKAGE__->set_sql( retrieve_limited => 'SELECT * FROM __TABLE__ ORDER BY id LIMIT ?' );
93 __PACKAGE__->set_sql( copy_start => 'COPY %s (%s) FROM STDIN;' );
94 __PACKAGE__->set_sql( copy_end => '\.' );
103 $log->debug("Running child_init inside ".__PACKAGE__, INTERNAL);
105 $_db_params = [ $_db_params ] unless (ref($_db_params) eq 'ARRAY');
107 my %attrs = ( %{$self->_default_attributes},
108 RootClass => 'DBIx::ContextualFetch',
109 ShowErrorStatement => 1,
115 FetchHashKeyName => 'NAME_lc',
119 my $master = shift @$_db_params;
120 $master_db = DBI->connect("dbi:Pg:host=$$master{host};dbname=$$master{db}",$$master{user},$$master{pw}, \%attrs);
121 $master_db->do("SET NAMES '$$master{client_encoding}';") if ($$master{client_encoding});
123 $log->debug("Connected to MASTER db '$$master{db} at $$master{host}", INFO);
125 for my $db (@$_db_params) {
126 push @slave_dbs, DBI->connect("dbi:Pg:host=$$db{host};dbname=$$db{db}",$$db{user},$$db{pw}, \%attrs);
127 $slave_dbs[-1]->do("SET NAMES '$$db{client_encoding}';") if ($$master{client_encoding});
129 $log->debug("Connected to MASTER db '$$master{db} at $$master{host}", INFO);
132 $log->debug("All is well on the western front", INTERNAL);
137 return $master_db if ($self->current_xact_session);
138 return $master_db unless (@slave_dbs);
139 return ($master_db, @slave_dbs)[rand(scalar(@slave_dbs))];
144 return $self->db_Main->quote(@_)
147 # sub tsearch2_trigger {
149 # return unless ($self->value);
150 # $self->index_vector(
151 # $self->db_Slaves->selectrow_array(
152 # "SELECT to_tsvector('default',?);",
161 sub current_xact_session {
163 if (defined($_xact_session)) {
164 return $_xact_session;
169 sub current_xact_is_auto {
172 if (defined($_xact_session) and ref($_xact_session)) {
174 $_xact_session->session_data(autocommit => $auto);
176 return $_xact_session->session_data('autocommit');
180 sub current_xact_id {
182 if (defined($_xact_session) and ref($_xact_session)) {
183 return $_xact_session->session_id;
188 sub set_xact_session {
191 if (!defined($ses)) {
194 $_xact_session = $ses;
195 return $_xact_session;
198 sub unset_xact_session {
200 my $ses = $_xact_session;
201 undef $_xact_session;
209 package OpenILS::Application::Storage;
210 use OpenSRF::Utils::Logger;
211 my $log = 'OpenSRF::Utils::Logger';
213 my $pg = 'OpenILS::Application::Storage::Driver::Pg';
215 sub pg_begin_xaction {
219 if (my $old_xact = $pg->current_xact_session) {
220 if ($pg->current_xact_is_auto) {
221 $log->debug("Commiting old autocommit transaction with Open-ILS XACT-ID [$old_xact]", INFO);
222 $self->pg_commit_xaction($client);
224 $log->debug("Rolling back old NON-autocommit transaction with Open-ILS XACT-ID [$old_xact]", INFO);
225 $self->pg_rollback_xaction($client);
226 throw OpenSRF::DomainObject::oilsException->new(
228 status => "Previous transaction rolled back!",
233 $pg->set_xact_session( $client->session );
234 my $xact_id = $pg->current_xact_id;
236 $log->debug("Beginning a new trasaction with Open-ILS XACT-ID [$xact_id]", INFO);
238 my $dbh = OpenILS::Application::Storage::CDBI->db_Main;
245 $log->debug("Failed to begin a new trasaction with Open-ILS XACT-ID [$xact_id]: ".$e, INFO);
250 my $death_cb = $client->session->register_callback(
252 __PACKAGE__->pg_rollback_xaction;
256 $log->debug("Registered 'death' callback [$death_cb] for new trasaction with Open-ILS XACT-ID [$xact_id]", DEBUG);
258 $client->session->session_data( death_cb => $death_cb );
260 if ($self->api_name =~ /autocommit$/o) {
261 $pg->current_xact_is_auto(1);
262 my $dc_cb = $client->session->register_callback(
265 $ses->unregister_callback(death => $death_cb);
266 __PACKAGE__->pg_commit_xaction;
269 $log->debug("Registered 'disconnect' callback [$dc_cb] for new trasaction with Open-ILS XACT-ID [$xact_id]", DEBUG);
270 if ($client and $client->session) {
271 $client->session->session_data( disconnect_cb => $dc_cb );
278 __PACKAGE__->register_method(
279 method => 'pg_begin_xaction',
280 api_name => 'open-ils.storage.transaction.begin',
284 __PACKAGE__->register_method(
285 method => 'pg_begin_xaction',
286 api_name => 'open-ils.storage.transaction.begin.autocommit',
291 sub pg_commit_xaction {
294 my $xact_id = $pg->current_xact_id;
297 $log->debug("Committing trasaction with Open-ILS XACT-ID [$xact_id]", INFO);
298 my $dbh = OpenILS::Application::Storage::CDBI->db_Main;
303 $log->debug("Failed to commit trasaction with Open-ILS XACT-ID [$xact_id]: ".$e, INFO);
307 $pg->current_xact_session->unregister_callback( death =>
308 $pg->current_xact_session->session_data( 'death_cb' )
309 ) if ($pg->current_xact_session);
311 if ($pg->current_xact_is_auto) {
312 $pg->current_xact_session->unregister_callback( disconnect =>
313 $pg->current_xact_session->session_data( 'disconnect_cb' )
317 $pg->unset_xact_session;
322 __PACKAGE__->register_method(
323 method => 'pg_commit_xaction',
324 api_name => 'open-ils.storage.transaction.commit',
329 sub pg_rollback_xaction {
332 my $xact_id = $pg->current_xact_id;
334 my $dbh = OpenILS::Application::Storage::CDBI->db_Main;
335 $log->debug("Rolling back a trasaction with Open-ILS XACT-ID [$xact_id]", INFO);
340 $log->debug("Failed to roll back trasaction with Open-ILS XACT-ID [$xact_id]: ".$e, INFO);
344 $pg->current_xact_session->unregister_callback( death =>
345 $pg->current_xact_session->session_data( 'death_cb' )
346 ) if ($pg->current_xact_session);
348 if ($pg->current_xact_is_auto) {
349 $pg->current_xact_session->unregister_callback( disconnect =>
350 $pg->current_xact_session->session_data( 'disconnect_cb' )
354 $pg->unset_xact_session;
358 __PACKAGE__->register_method(
359 method => 'pg_rollback_xaction',
360 api_name => 'open-ils.storage.transaction.rollback',
370 return undef unless ($pg->current_xact_session);
372 my $cdbi = $self->{cdbi};
374 my $pri = $cdbi->columns('Primary');
376 my @cols = grep {$_ ne $pri} $cdbi->columns('All');
378 my $col_list = join ',', @cols;
380 $log->debug('Starting COPY import for '.$cdbi->table." ($col_list)", DEBUG);
381 $cdbi->sql_copy_start($cdbi->table, $col_list)->execute;
383 my $dbh = $cdbi->db_Main;
384 for my $node ( @fm_nodes ) {
386 my $line = join("\t", map { defined($node->$_()) ? $node->$_() : '\N' } @cols);
387 $log->debug("COPY line: [$line]",DEBUG);
388 $dbh->func($line."\n", 'putline');
391 $dbh->func('endcopy');
393 return scalar(@fm_nodes);
399 #---------------------------------------------------------------------
400 package action::survey;
402 action::survey->table( 'action.survey' );
403 action::survey->sequence( 'action.survey_id_seq' );
405 #---------------------------------------------------------------------
406 package action::survey_question;
408 action::survey_question->table( 'action.survey_question' );
409 action::survey_question->sequence( 'action.survey_question_id_seq' );
411 #---------------------------------------------------------------------
412 package action::survey_answer;
414 action::survey_answer->table( 'action.survey_answer' );
415 action::survey_answer->sequence( 'action.survey_answer_id_seq' );
417 #---------------------------------------------------------------------
418 package action::survey_response;
420 action::survey_response->table( 'action.survey_response' );
421 action::survey_response->sequence( 'action.survey_response_id_seq' );
423 #---------------------------------------------------------------------
424 package config::metabib_field;
426 config::metabib_field->table( 'config.metabib_field' );
427 config::metabib_field->sequence( 'config.metabib_field_id_seq' );
429 #---------------------------------------------------------------------
430 package config::bib_source;
432 config::bib_source->table( 'config.bib_source' );
433 config::bib_source->sequence( 'config.bib_source_id_seq' );
435 #---------------------------------------------------------------------
436 package config::identification_type;
438 config::identification_type->table( 'config.identification_type' );
439 config::identification_type->sequence( 'config.identification_type_id_seq' );
441 #---------------------------------------------------------------------
442 package asset::call_number_note;
444 asset::call_number->table( 'asset.call_number_note' );
445 asset::call_number->sequence( 'asset.call_number_note_id_seq' );
447 #---------------------------------------------------------------------
448 package asset::copy_note;
450 asset::copy->table( 'asset.copy_note' );
451 asset::copy->sequence( 'asset.copy_note_id_seq' );
453 #---------------------------------------------------------------------
454 package asset::call_number;
456 asset::call_number->table( 'asset.call_number' );
457 asset::call_number->sequence( 'asset.call_number_id_seq' );
459 #---------------------------------------------------------------------
462 asset::copy->table( 'asset.copy' );
463 asset::copy->sequence( 'asset.copy_id_seq' );
465 #---------------------------------------------------------------------
466 package asset::stat_cat;
468 asset::stat_cat->table( 'asset.stat_cat' );
469 asset::stat_cat->sequence( 'asset.stat_cat_id_seq' );
471 #---------------------------------------------------------------------
472 package asset::stat_cat_entry;
474 asset::stat_cat_entry->table( 'asset.stat_cat_entry' );
475 asset::stat_cat_entry->sequence( 'asset.stat_cat_entry_id_seq' );
477 #---------------------------------------------------------------------
478 package asset::stat_cat_entry_copy_map;
480 asset::stat_cat_entry_copy_map->table( 'asset.stat_cat_entry_copy_map' );
481 asset::stat_cat_entry_copy_map->sequence( 'asset.stat_cat_entry_copy_map_id_seq' );
483 #---------------------------------------------------------------------
484 package biblio::record_entry;
486 biblio::record_entry->table( 'biblio.record_entry' );
487 biblio::record_entry->sequence( 'biblio.record_entry_id_seq' );
489 #---------------------------------------------------------------------
490 #package biblio::record_marc;
492 #biblio::record_marc->table( 'biblio.record_marc' );
493 #biblio::record_marc->sequence( 'biblio.record_marc_id_seq' );
495 #---------------------------------------------------------------------
496 package biblio::record_note;
498 biblio::record_note->table( 'biblio.record_note' );
499 biblio::record_note->sequence( 'biblio.record_note_id_seq' );
501 #---------------------------------------------------------------------
504 actor::user->table( 'actor.usr' );
505 actor::user->sequence( 'actor.usr_id_seq' );
507 #---------------------------------------------------------------------
508 package actor::org_unit_type;
510 actor::org_unit_type->table( 'actor.org_unit_type' );
511 actor::org_unit_type->sequence( 'actor.org_unit_type_id_seq' );
513 #---------------------------------------------------------------------
514 package actor::org_unit;
516 actor::org_unit->table( 'actor.org_unit' );
517 actor::org_unit->sequence( 'actor.org_unit_id_seq' );
519 #---------------------------------------------------------------------
520 package actor::stat_cat;
522 actor::stat_cat->table( 'actor.stat_cat' );
523 actor::stat_cat->sequence( 'actor.stat_cat_id_seq' );
525 #---------------------------------------------------------------------
526 package actor::stat_cat_entry;
528 actor::stat_cat_entry->table( 'actor.stat_cat_entry' );
529 actor::stat_cat_entry->sequence( 'actor.stat_cat_entry_id_seq' );
531 #---------------------------------------------------------------------
532 package actor::stat_cat_entry_user_map;
534 actor::stat_cat_entry_user_map->table( 'actor.stat_cat_entry_copy_map' );
535 actor::stat_cat_entry_user_map->sequence( 'actor.stat_cat_entry_usr_map_id_seq' );
537 #---------------------------------------------------------------------
540 actor::card->table( 'actor.card' );
541 actor::card->sequence( 'actor.card_id_seq' );
544 #---------------------------------------------------------------------
546 #-------------------------------------------------------------------------------
547 package metabib::metarecord;
549 metabib::metarecord->table( 'metabib.metarecord' );
550 metabib::metarecord->sequence( 'metabib.metarecord_id_seq' );
552 OpenILS::Application::Storage->register_method(
553 api_name => 'open-ils.storage.direct.metabib.metarecord.batch.create',
554 method => 'copy_create',
556 'package' => 'OpenILS::Application::Storage',
557 cdbi => 'metabib::metarecord',
561 #-------------------------------------------------------------------------------
563 #-------------------------------------------------------------------------------
564 package metabib::title_field_entry;
566 metabib::title_field_entry->table( 'metabib.title_field_entry' );
567 metabib::title_field_entry->sequence( 'metabib.title_field_entry_id_seq' );
568 metabib::title_field_entry->columns( 'FTS' => 'index_vector' );
570 # metabib::title_field_entry->add_trigger(
571 # before_create => \&OpenILS::Application::Storage::Driver::Pg::tsearch2_trigger
573 # metabib::title_field_entry->add_trigger(
574 # before_update => \&OpenILS::Application::Storage::Driver::Pg::tsearch2_trigger
577 OpenILS::Application::Storage->register_method(
578 api_name => 'open-ils.storage.direct.metabib.title_field_entry.batch.create',
579 method => 'copy_create',
581 'package' => 'OpenILS::Application::Storage',
582 cdbi => 'metabib::title_field_entry',
585 #-------------------------------------------------------------------------------
587 #-------------------------------------------------------------------------------
588 package metabib::author_field_entry;
590 metabib::author_field_entry->table( 'metabib.author_field_entry' );
591 metabib::author_field_entry->sequence( 'metabib.author_field_entry_id_seq' );
592 metabib::author_field_entry->columns( 'FTS' => 'index_vector' );
594 OpenILS::Application::Storage->register_method(
595 api_name => 'open-ils.storage.direct.metabib.author_field_entry.batch.create',
596 method => 'copy_create',
598 'package' => 'OpenILS::Application::Storage',
599 cdbi => 'metabib::author_field_entry',
602 #-------------------------------------------------------------------------------
604 #-------------------------------------------------------------------------------
605 package metabib::subject_field_entry;
607 metabib::subject_field_entry->table( 'metabib.subject_field_entry' );
608 metabib::subject_field_entry->sequence( 'metabib.subject_field_entry_id_seq' );
609 metabib::subject_field_entry->columns( 'FTS' => 'index_vector' );
611 OpenILS::Application::Storage->register_method(
612 api_name => 'open-ils.storage.direct.metabib.subject_field_entry.batch.create',
613 method => 'copy_create',
615 'package' => 'OpenILS::Application::Storage',
616 cdbi => 'metabib::subject_field_entry',
619 #-------------------------------------------------------------------------------
621 #-------------------------------------------------------------------------------
622 package metabib::keyword_field_entry;
624 metabib::keyword_field_entry->table( 'metabib.keyword_field_entry' );
625 metabib::keyword_field_entry->sequence( 'metabib.keyword_field_entry_id_seq' );
626 metabib::keyword_field_entry->columns( 'FTS' => 'index_vector' );
628 OpenILS::Application::Storage->register_method(
629 api_name => 'open-ils.storage.direct.metabib.keyword_field_entry.batch.create',
630 method => 'copy_create',
632 'package' => 'OpenILS::Application::Storage',
633 cdbi => 'metabib::keyword_field_entry',
636 #-------------------------------------------------------------------------------
638 #-------------------------------------------------------------------------------
639 #package metabib::title_field_entry_source_map;
641 #metabib::title_field_entry_source_map->table( 'metabib.title_field_entry_source_map' );
643 #-------------------------------------------------------------------------------
645 #-------------------------------------------------------------------------------
646 #package metabib::author_field_entry_source_map;
648 #metabib::author_field_entry_source_map->table( 'metabib.author_field_entry_source_map' );
650 #-------------------------------------------------------------------------------
652 #-------------------------------------------------------------------------------
653 #package metabib::subject_field_entry_source_map;
655 #metabib::subject_field_entry_source_map->table( 'metabib.subject_field_entry_source_map' );
657 #-------------------------------------------------------------------------------
659 #-------------------------------------------------------------------------------
660 #package metabib::keyword_field_entry_source_map;
662 #metabib::keyword_field_entry_source_map->table( 'metabib.keyword_field_entry_source_map' );
664 #-------------------------------------------------------------------------------
666 #-------------------------------------------------------------------------------
667 package metabib::metarecord_source_map;
669 metabib::metarecord_source_map->table( 'metabib.metarecord_source_map' );
670 OpenILS::Application::Storage->register_method(
671 api_name => 'open-ils.storage.direct.metabib.metarecord_source_map.batch.create',
672 method => 'copy_create',
674 'package' => 'OpenILS::Application::Storage',
675 cdbi => 'metabib::metarecord_source_map',
679 #-------------------------------------------------------------------------------
680 package metabib::record_descriptor;
682 metabib::record_descriptor->table( 'metabib.rec_descriptor' );
683 metabib::record_descriptor->sequence( 'metabib.rec_descriptor_id_seq' );
685 OpenILS::Application::Storage->register_method(
686 api_name => 'open-ils.storage.direct.metabib.record_descriptor.batch.create',
687 method => 'copy_create',
689 'package' => 'OpenILS::Application::Storage',
690 cdbi => 'metabib::record_descriptor',
693 #-------------------------------------------------------------------------------
696 #-------------------------------------------------------------------------------
697 package metabib::full_rec;
699 metabib::full_rec->table( 'metabib.full_rec' );
700 metabib::full_rec->sequence( 'metabib.full_rec_id_seq' );
701 metabib::full_rec->columns( 'FTS' => 'index_vector' );
703 OpenILS::Application::Storage->register_method(
704 api_name => 'open-ils.storage.direct.metabib.full_rec.batch.create',
705 method => 'copy_create',
707 'package' => 'OpenILS::Application::Storage',
708 cdbi => 'metabib::full_rec',
712 #-------------------------------------------------------------------------------