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 warn 'Inside copy_create...';
372 return undef unless ($pg->current_xact_session);
374 my $cdbi = $self->{cdbi};
376 my $pri = $cdbi->columns('Primary');
378 my @cols = grep {$_ ne $pri} $cdbi->columns('All');
380 my $col_list = join ',', @cols;
382 $log->debug('Starting COPY import for '.$cdbi->table, DEBUG);
383 $cdbi->sql_copy_start($cdbi->table, $col_list)->execute;
385 my $dbh = $cdbi->db_Main;
386 for my $node ( @fm_nodes ) {
388 my $line = join("\t", map { defined($node->$_()) ? $node->$_() : '\N' } @cols);
389 $log->debug("COPY line: [$line]",DEBUG);
390 $dbh->func($line."\n", 'putline');
393 $dbh->func('endcopy');
395 return scalar(@fm_nodes);
401 #---------------------------------------------------------------------
402 package asset::call_number_note;
404 asset::call_number->table( 'asset.call_number_note' );
405 asset::call_number->sequence( 'asset.call_number_note_id_seq' );
407 #---------------------------------------------------------------------
408 package asset::copy_note;
410 asset::copy->table( 'asset.copy_note' );
411 asset::copy->sequence( 'asset.copy_note_id_seq' );
413 #---------------------------------------------------------------------
414 package asset::call_number;
416 asset::call_number->table( 'asset.call_number' );
417 asset::call_number->sequence( 'asset.call_number_id_seq' );
419 #---------------------------------------------------------------------
422 asset::copy->table( 'asset.copy' );
423 asset::copy->sequence( 'asset.copy_id_seq' );
425 #---------------------------------------------------------------------
426 package biblio::record_entry;
428 biblio::record_entry->table( 'biblio.record_entry' );
429 biblio::record_entry->sequence( 'biblio.record_entry_id_seq' );
431 #---------------------------------------------------------------------
432 package biblio::record_node;
434 biblio::record_node->table( 'biblio.record_data' );
435 biblio::record_node->sequence( 'biblio.record_data_id_seq' );
437 #---------------------------------------------------------------------
438 package biblio::record_marc;
440 biblio::record_marc->table( 'biblio.record_marc' );
441 biblio::record_marc->sequence( 'biblio.record_marc_id_seq' );
443 #---------------------------------------------------------------------
444 package biblio::record_mods;
446 biblio::record_mods->table( 'biblio.record_mods' );
447 biblio::record_mods->sequence( 'biblio.record_mods_id_seq' );
449 #---------------------------------------------------------------------
450 package biblio::record_note;
452 biblio::record_note->table( 'biblio.record_note' );
453 biblio::record_note->sequence( 'biblio.record_note_id_seq' );
455 #---------------------------------------------------------------------
458 actor::user->table( 'actor.usr' );
459 actor::user->sequence( 'actor.usr_id_seq' );
461 #---------------------------------------------------------------------
462 package actor::org_unit_type;
464 actor::org_unit_type->table( 'actor.org_unit_type' );
465 actor::org_unit_type->sequence( 'actor.org_unit_type_id_seq' );
467 #---------------------------------------------------------------------
468 package actor::org_unit;
470 actor::org_unit->table( 'actor.org_unit' );
471 actor::org_unit->sequence( 'actor.org_unit_id_seq' );
473 #---------------------------------------------------------------------
475 #-------------------------------------------------------------------------------
476 package metabib::metarecord;
478 metabib::metarecord->table( 'metabib.metarecord' );
479 metabib::metarecord->sequence( 'metabib.metarecord_id_seq' );
481 #-------------------------------------------------------------------------------
483 #-------------------------------------------------------------------------------
484 package metabib::title_field_entry;
486 metabib::title_field_entry->table( 'metabib.title_field_entry' );
487 metabib::title_field_entry->sequence( 'metabib.title_field_entry_id_seq' );
488 metabib::title_field_entry->columns( 'FTS' => 'index_vector' );
490 # metabib::title_field_entry->add_trigger(
491 # before_create => \&OpenILS::Application::Storage::Driver::Pg::tsearch2_trigger
493 # metabib::title_field_entry->add_trigger(
494 # before_update => \&OpenILS::Application::Storage::Driver::Pg::tsearch2_trigger
497 OpenILS::Application::Storage->register_method(
498 api_name => 'open-ils.storage.metabib.title_field_entry.batch.create',
499 method => 'copy_create',
501 'package' => 'OpenILS::Application::Storage',
502 cdbi => 'metabib::title_field_entry',
505 #-------------------------------------------------------------------------------
507 #-------------------------------------------------------------------------------
508 package metabib::author_field_entry;
510 metabib::author_field_entry->table( 'metabib.author_field_entry' );
511 metabib::author_field_entry->sequence( 'metabib.author_field_entry_id_seq' );
512 metabib::author_field_entry->columns( 'FTS' => 'index_vector' );
514 OpenILS::Application::Storage->register_method(
515 api_name => 'open-ils.storage.metabib.author_field_entry.batch.create',
516 method => 'copy_create',
518 'package' => 'OpenILS::Application::Storage',
519 cdbi => 'metabib::author_field_entry',
522 #-------------------------------------------------------------------------------
524 #-------------------------------------------------------------------------------
525 package metabib::subject_field_entry;
527 metabib::subject_field_entry->table( 'metabib.subject_field_entry' );
528 metabib::subject_field_entry->sequence( 'metabib.subject_field_entry_id_seq' );
529 metabib::subject_field_entry->columns( 'FTS' => 'index_vector' );
531 OpenILS::Application::Storage->register_method(
532 api_name => 'open-ils.storage.metabib.subject_field_entry.batch.create',
533 method => 'copy_create',
535 'package' => 'OpenILS::Application::Storage',
536 cdbi => 'metabib::subject_field_entry',
539 #-------------------------------------------------------------------------------
541 #-------------------------------------------------------------------------------
542 package metabib::keyword_field_entry;
544 metabib::keyword_field_entry->table( 'metabib.keyword_field_entry' );
545 metabib::keyword_field_entry->sequence( 'metabib.keyword_field_entry_id_seq' );
546 metabib::keyword_field_entry->columns( 'FTS' => 'index_vector' );
548 OpenILS::Application::Storage->register_method(
549 api_name => 'open-ils.storage.metabib.keyword_field_entry.batch.create',
550 method => 'copy_create',
552 'package' => 'OpenILS::Application::Storage',
553 cdbi => 'metabib::keyword_field_entry',
556 #-------------------------------------------------------------------------------
558 #-------------------------------------------------------------------------------
559 #package metabib::title_field_entry_source_map;
561 #metabib::title_field_entry_source_map->table( 'metabib.title_field_entry_source_map' );
563 #-------------------------------------------------------------------------------
565 #-------------------------------------------------------------------------------
566 #package metabib::author_field_entry_source_map;
568 #metabib::author_field_entry_source_map->table( 'metabib.author_field_entry_source_map' );
570 #-------------------------------------------------------------------------------
572 #-------------------------------------------------------------------------------
573 #package metabib::subject_field_entry_source_map;
575 #metabib::subject_field_entry_source_map->table( 'metabib.subject_field_entry_source_map' );
577 #-------------------------------------------------------------------------------
579 #-------------------------------------------------------------------------------
580 #package metabib::keyword_field_entry_source_map;
582 #metabib::keyword_field_entry_source_map->table( 'metabib.keyword_field_entry_source_map' );
584 #-------------------------------------------------------------------------------
586 #-------------------------------------------------------------------------------
587 package metabib::metarecord_source_map;
589 metabib::metarecord_source_map->table( 'metabib.metarecord_source_map' );
591 #-------------------------------------------------------------------------------
593 #-------------------------------------------------------------------------------
594 package metabib::full_rec;
596 metabib::full_rec->table( 'metabib.full_rec' );
597 metabib::full_rec->sequence( 'metabib.full_rec_id_seq' );
598 metabib::full_rec->columns( 'FTS' => 'index_vector' );
600 OpenILS::Application::Storage->register_method(
601 api_name => 'open-ils.storage.metabib.full_rec.batch.create',
602 method => 'copy_create',
604 'package' => 'OpenILS::Application::Storage',
605 cdbi => 'metabib::full_rec',
609 #-------------------------------------------------------------------------------