Clair::ALE

_SQL


SummaryPackage variablesSynopsisGeneral documentationMethods

SummaryTop
Clair::ALE::_SQL - Internal SQL adapter for use by ALE

Package variablesTop
No package variables defined.

Included modulesTop
Carp
Clair::Utils::ALE(1)
Clair::Utils::ALE(2) qw ( %ALE_ENV )
DBI

SynopsisTop
This module is used internally by the other ALE modules to connect to an
SQL database. Other modules (particularly Clair::ALE::Search)
will use this automatically, so you shouldn't have to use it yourself
unless you're writing an ALE module.
It is a thin frontend for the DBI module. It's main purpose is to make
it easy to change databases or database structures without having to
change any other code.

DescriptionTop
No description!
MethodsTop
_quoteNo descriptionCode
_refresh_tablenamesNo descriptionCode
commitNo descriptionCode
connectNo descriptionCode
disconnectNo descriptionCode
doNo descriptionCode
errdieNo descriptionCode
errstrNo descriptionCode
insertidNo descriptionCode
links_tableNo descriptionCode
newNo descriptionCode
queryNo descriptionCode
querycancelNo descriptionCode
queryoneNo descriptionCode
queryresultNo descriptionCode
quoteNo descriptionCode
rollbackNo descriptionCode
setNo descriptionCode
setdefaultsNo descriptionCode
urls_tableNo descriptionCode
words_tableNo descriptionCode

Methods description


None available.

Methods code


_quotedescriptionprevnextTop
sub _quote {
  return $_[0]->{_dbh}->quote($_[1]);
}

_refresh_tablenamesdescriptionprevnextTop
sub _refresh_tablenames {
    my $self = shift;
    my $alespace_prefix;
    if (!$ALE_ENV{ALESPACE} or ($ALE_ENV{ALESPACE} eq 'default'))
    {   
        $alespace_prefix="";
    }
    else
    {
        $alespace_prefix="$ALE_ENV{ALESPACE}_";
    }
    $self->{_links_table} = $alespace_prefix."links";
    $self->{_words_table} = $alespace_prefix."words";
    $self->{_urls_table} = $alespace_prefix."urls";
}

commitdescriptionprevnextTop
sub commit {
  my $self = shift;
  $self->{_dbh}->commit;
}

connectdescriptionprevnextTop
sub connect {
  my $self = shift;
  
  if (!$self->{_dbh})
  {
      #print "$self->{DSN}\n";
    $self->{_dbh} = DBI->connect($self->{DSN}, 
				 $self->{username},
				 $self->{password},
				 {AutoCommit => $self->{AutoCommit},
				  PrintError => 0,
				 })
      or croak "ALE::_SQL couldn't connect to database: ".DBI->errstr."\n";
  }
  $self;
}

disconnectdescriptionprevnextTop
sub disconnect {
  my $self = shift;
  
  if ($self->{_dbh})
  {
    $self->{_dbh}->disconnect;
    delete $self->{_dbh};
  }
  $self;
}

dodescriptionprevnextTop
sub do {
  my $self = shift;

  if ($ALE_ENV{DEBUGSQL})
  {
    print "SQL: @_\n";
  }
  $self->connect;
  $self->{_dbh}->do(@_);
}

errdiedescriptionprevnextTop
sub errdie {
  my $self = shift;

  croak join("",@_) . ": Database error ".$self->errstr;
}

errstrdescriptionprevnextTop
sub errstr {
  my $self = shift;
  return $self->{_dbh}->errstr;
}

insertiddescriptionprevnextTop
sub insertid {
  my $self = shift;
  return $self->{_dbh}->{mysql_insertid};
}

links_tabledescriptionprevnextTop
sub links_table {
    my $self = shift;
    $self->_refresh_tablenames();
    return $self->{_links_table};
}

newdescriptionprevnextTop
sub new {
  my $class = shift;
  my $self = {};
  bless $self,$class;

  $self->setdefaults;
  $self->set(@_);

  $self;
}

querydescriptionprevnextTop
sub query {
  my $self = shift;
  my($sql)=@_;
  
  $self->{_sql}=$sql;
  if ($ALE_ENV{SQLDEBUG}) { print "SQL: $sql\n"; }
  $self->connect;
  $self->{_sth} = $self->{_dbh}->prepare($sql)
    or croak "Error preparing SQL statement '$sql': ".$self->{_dbh}->errstr;
  $self->{_sth}{mysql_use_result}=1;
  $self->{_sth}->execute
    or croak "Error executing SQL statement '$sql': ".$self->{_dbh}->errstr;

  $self;
}

querycanceldescriptionprevnextTop
sub querycancel {
  my $self = shift;

  $self->{_sth}->finish
    or croak "Error finishing SQL statement '$self->{_sql}': ".$self->{_dbh}->errstr;
}

queryonedescriptionprevnextTop
sub queryone {
  my $self = shift;

  $self->query(@_);
  my $r = $self->queryresult;
  if ($r)
  {
    $self->querycancel;
  }
  $r;
}

queryresultdescriptionprevnextTop
sub queryresult {
  my $self = shift;
  $self->{_sth}
    or croak "Attempted to get query results without running query!";
  my $row = $self->{_sth}->fetchrow_hashref;
  if (!$row)
  {
    $self->{_sth}->finish
      or croak "Error finishing SQL statement '$self->{_sql}': ".$self->{_dbh}->errstr;
  }
  return $row;
}

quotedescriptionprevnextTop
sub quote {
  my $self = shift;
  
  $self->connect;
  return $self->_quote(@_);
}

rollbackdescriptionprevnextTop
sub rollback {
  my $self = shift;
  $self->{_dbh}->rollback;
}

setdescriptionprevnextTop
sub set {
  my $self = shift;
  my($var,$val);
  
  while($var=shift)
  {
    $val = shift;
    if ($SETTABLE{$var})
    {
      $self->{$var}=$val;
    }
  }
  $self;
}

setdefaultsdescriptionprevnextTop
sub setdefaults {
  my $self = shift;

  my $user = 'root';
  my $pass = '';
  if ($ALE_ENV{ALE_DB_USER}) {
    $user = $ALE_ENV{ALE_DB_USER}; 
  }
  if ($ALE_ENV{ALE_DB_PASS}) {
    $pass = $ALE_ENV{ALE_DB_PASS};
  }
  return $self->set(
		    DSN => 'DBI:mysql:database=clair',
		    username => $user,
		    password => $pass,
		    AutoCommit => 1,
		   );
}

urls_tabledescriptionprevnextTop
sub urls_table {
    my $self = shift;
    $self->_refresh_tablenames();
    return $self->{_urls_table};
}

words_tabledescriptionprevnextTop
sub words_table {
    my $self = shift;
    $self->_refresh_tablenames();
    return $self->{_words_table};
}

General documentation


No general documentation available.