Frank Seitz
and 1 contributors

NAME

Prty::Database::Connection - Verbindung zu einer Relationalen Datenbank

BASE CLASS

Prty::Hash

DESCRIPTION

Ein Objekt der Klasse repräsentiert eine Verbindung zu einer Relationalen Datenbank.

METHODS

Konstruktor/Destruktor

new() - Öffne Datenbankverbindung

Synopsis

    $db = $class->new(@opt);
    $db = $class->new($udl,@opt);
    $db = $class->new($udlObj,@opt);
    $db2 = $db->new(@opt);

Alias

connect()

Description

Instantiiere eine Datenbankverbindung und liefere eine Referenz auf dieses Objekt zurück.

Ist $udl nicht angegeben, wird der Wert der Environment-Variable $UDL verwendet.

Wird die Methode als Objektmethode einer bestehenden Datenbankverbindung gerufen, wird eine weitere Verbindung zur selben Datenbank aufgebaut. Dies ist nützlich, wenn eine parallele Transaktion benötigt wird.

Options

-handle => $dbh (Default: undef)

Bereits aufgebaute Low-Level Datenbankverbindung zuweisen.

-log => $bool (Default: 0)

Logging von SQL-Statements.

-logfile => $filename (Default: '-')

Logdatei. Wenn nicht angegeben oder '-' wird auf STDOUT gelogged.

-sqlClass => $class (Default: 'Prty::Sql')

Name der Sql-Klasse zur Statementgenerierung.

-utf8 => $bool (Default: 0)

Definiere das clientseitige Character Encoding als UTF-8.

newFromSbit() - Instantiiere Prty::Database::Connection-Datenbankobjekt aus Sbit-Datenbankobjekt

Synopsis

    $db = $class->newFromSbit($db);

disconnect() - Schließe Datenbankverbindung

Synopsis

    $db->disconnect;
    $db->disconnect($commit);

Alias

destroy()

Description

Schließe Datenbankverbindung. Ist $commit "wahr", committe die Daten vor dem Schließen der Verbindung. Die Methode liefert keinen Wert zurück.

Die Objektreferenz $db ist nach Aufruf der Methode ungültig und kann nicht mehr verwendet werden.

dbExists() - Prüfe, ob Datenbankverbindung aufgebaut werden kann

Synopsis

    $bool = $class->dbExists($udl);

Description

Prüfe, ob Verbindung zur Datenbank $udl möglich ist. Liefere "wahr", wenn dies der Fall ist, andernfalls "falsch".

Accessors

maxBlobSize() - Liefere/Setze max. Größe von BLOB/TEXT (Oracle)

Synopsis

    $n = $db->maxBlobSize;
    $n = $db->maxBlobSize($n);

Description

Liefere/Setze die maximale Größe eines BLOB/TEXT-Werts auf $n Bytes. Defaulteinstellung ist 1024*1024 Bytes (1MB).

Dieser Wert ist nur für Oracle relevant und wird bei der Selektion von BLOB/TEXT-Kolumnen benötigt. Ist der Wert einer BLOB/TEXT-Kolumne größer als die angegebene Anzahl an Bytes wird eine Exception ausgelöst.

Bei anderen DBMSen als Oracle hat das Setzen keinen Effekt und der Returnwert der Methode ist immer 0.

strict() - Strict-Modus abfragen oder umschalten

Synopsis

    $bool = $db->strict;
    $bool = $db->strict($bool);

Description

Bei eingeschaltetem Strict-Modus wird eine Exception

Example

    my $db = Prty::Database::Connection->new('dbi#mysql',
        -handle=>$main::dbh,
    );
    
    ...
    
    $db->strict(1);
    
    # bei Datenbank-Fehler wird Exception geworfen
    
    $db->strict(0)

stmt() - Liefere das Sql-Objekt

Synopsis

    $sqlObj = $db->stmt;

Alias

sqlEngine()

Description

Liefere das Sql-Objekt der Datenbankverbindung. Mit dem Sql-Objekt lassen sich SQL-Statements generieren, z.B.

    $stmt = $db->stmt->dropTable($table);

udl() - Liefere das Udl-Objekt

Synopsis

    $udlObj = $db->udl;

Description

Liefere das Udl-Objekt der Datenbankverbindung. Das Udl-Objekt hält Information über die Datenbankverbindung, z.B.

    $user = $db->udl->user;

Time Measurement

startTime() - Liefere Zeitpunkt des Verbindungsaufbaus

Synopsis

    $time = $cur->startTime;

time() - Liefere Dauer seit Beginn des Verbindungsaufbaus

Synopsis

    $time = $cur->time;

DBMS-Tests

Die folgenden Methoden testen auf das DBMS. Sie werden angewendet, wenn DBMS-spezifische Unterscheidungen vorgenommen werden müssen.

dbms() - Liefere den Namen des DBMS

Synopsis

    $dbms = $db->dbms;

dbmsTestVector() - Vektor für DBMS-Tests

Synopsis

    ($oracle,$postgresql,$sqlite,$mysql,$access) = $db->dbmsTestVector;

isOracle() - Prüfe auf Oracle-DBMS

Synopsis

    $bool = $db->isOracle;

Description

Liefere "wahr", wenn die Datenbank eine Oracle-Datenbank ist, sonst "falsch".

isPostgreSQL() - Prüfe auf PostgreSQL-DBMS

Synopsis

    $bool = $db->isPostgreSQL;

Description

Liefere "wahr", wenn die Datenbank eine PostgreSQL-Datenbank ist, sonst "falsch".

isSQLite() - Prüfe auf SQLite-DBMS

Synopsis

    $bool = $db->isSQLite;

Description

Liefere "wahr", wenn die Datenbank eine SQLite-Datenbank ist, sonst "falsch".

isMySQL() - Prüfe auf MySQL-DBMS

Synopsis

    $bool = $db->isMySQL;

Description

Liefere "wahr", wenn die Datenbank eine MySQL-Datenbank ist, sonst "falsch".

isAccess() - Prüfe auf Access-DBMS

Synopsis

    $bool = $db->isAccess;

Description

Liefere "wahr", wenn die Datenbank eine Access-Datenbank ist, sonst "falsch".

Information

defaultRowClass() - Liefere Namen der Default-Rowklasse

Synopsis

    $rowClass = $this->defaultRowClass($raw);

Description

Liefere den Namen der Default-Rowklasse:

    Prty::Database::Row::Object  ($raw ist "falsch")
    Prty::Database::Row::Array   ($raw ist "wahr")

Auf die Default-Rowklasse werden Datensätze instantiiert, für die bei einer Datenbank-Selektion oder einer Instantiierung einer Table-Klasse keine Row-Klasse explizit angegeben wurde.

Logging

Alle Statements einer Session oder ein gewisser Abschnitt kann gelogged werden.

Für die gesamte Session:

    $db = Prty::Database::Connection->new($udl,-log=>1);

Innerhalb eines Abschnitts:

    $db->openLog;
    ...
    $db->closeLog;

Testen, ob Db-Logging eingeschaltet ist:

    $db->isLog;

Schreiben eigener Meldungen ins Log:

    $db->printLog($msg);

Scheiben von Fortschrittsmeldungen ins Log:

    $db->startProgressLog($n);
    while (...) {
        $db->printProgressLog($msg);
    }
    $db->endProgressLog;

isLog() - Prüfe, ob Logging eingeschaltet ist

Synopsis

    $bool = $db->isLog;

openLog() - Öffne SQL-Log

Synopsis

    $db->openLog;

writeLog() - Schreibe Zeichenkette ins SQL-Log

Synopsis

    $db->writeLog(@str);

Description

Schreibe Argumente @str ins geöffnete SQL-Log. Ist das SQL-Log nicht geöffnet, wird nichts geschrieben. Die Methode liefert keinen Wert zurück.

msgToLog() - Schreibe Meldung ins SQL-Log

Synopsis

    $db->msgToLog($msg);

Alias

printLog()

Description

Schreibe Meldung $msg ins SQL-Log. Die Methode liefert keinen Wert zurück.

Der Logfileeintrag hat folgenden Aufbau:

    <LogMsgSeparator>
    <LogMsgPrefix> <msg>

Mit Defaultwerten:

    ---
    # <msg>

Ist die Meldung mehrzeilig, wird der LogMsgPrefix jeder Zeile vorangestellt.

stmtToLog() - Schreibe SQL Statement ins SQL-Log

Synopsis

    $db->stmtToLog($stmt);

Description

Schreibe SQL Statement $stmt ins SQL-Log. Die Methode liefert keinen Wert zurück.

Der Logfileeintrag hat folgenden Aufbau:

    <LogMsgSeparator>
    <stmt>

Mit Defaultwerten:

    ===
    <stmt>

Ist die Meldung mehrzeilig, wird der LogMsgPrefix jeder Zeile vorangestellt.

timeToLog() - Schreibe Ausführungszeit ins SQL-Log

Synopsis

    $db->timeToLog($time);

Description

Schreibe Ausführungszeit $time ins SQL-Log. Die Methode liefert keinen Wert zurück.

Der Logfileeintrag hat per Default folgenden Aufbau:

    /* <time> */

closeLog() - Schließe SQL-Log

Synopsis

    $db->closeLog;

startProgressLog() - Beginne Fortschrittsmeldungen

Synopsis

    $db->startProgressLog($n);

printProgressLog() - Schreibe Fortschrittsmeldung ins SQL-Log

Synopsis

    $db->printProgressLog($msg);

Description

Schreibe Fortschrittsmeldung $msg ins SQL-Log. Die Methode liefert keinen Wert zurück.

Der Logfileeintrag hat folgenden Aufbau:

    <LogMsgPrefix> <msg>

Mit Defaultwerten:

    # <msg>

Ist die Meldung mehrzeilig, wird sie einzeilig gemacht, indem NEWLINE durch SPACE ersetzt wird.

endProgressLog() - Beende Fortschrittsmeldungs-Folge im SQL-Log

Synopsis

    $db->endProgressLog($msg);

Export/Import

exportTable() - Exportiere Tabelle

Synopsis

    $db->exportTable($table,$file);

Description

Exportiere die Daten der Tabelle $table in Datei $file.

importTable() - Importiere Tabelle

Synopsis

    $db->importTable($table,$file);

Description

Importiere die Daten aus Datei $file in Tabelle $table.

Locking

lockTable() - Locke Tabelle

Synopsis

    $db->lockTable($table);

SQL Excecution

sql() - Führe SQL-Statement aus

Synopsis

    $cur = $db->sql($stmt,@opt);

Description

Führe SQL-Statement $stmt über Datenbankverbindung $db aus, instantiiere ein Resultat-Objekt (Cursor), und liefere eine Referenz auf dieses Objekt zurück.

Options

-chunkSize => $n (Default: 500)

Fetche Datensätze in Chunks von $n Sätzen. Diese Option hat aktuell nur bei PostgreSQL und -fetchMode 1 oder 2 eine Bedeutung.

-fetchMode => 0|1|2 (Default: 1)

Der Parameter hat nur im Falle PostgreSQL eine Auswirkung. Siehe auch Abschnitt "SELECT mit PostgreSQL".

0

Normaler DBI::Pg-Fetchmodus, d.h. die gesamte Ergebnismenge wird zum Client transferiert, bevor dieser den ersten Datensatz erhält. Dieser Modus ist für große Datenmengen schlecht geeignet.

1

Die Datensätze werden in Chunks von -chunkSize Sätzen gefetcht. Dies ist der Default-Modus.

2

Wie 1, wobei zusätzlich eine eigene Connection für die Selektion geöffnet wird. Dies ist notwendig, wenn während der Datensatz-Verarbeitung COMMITs oder ROLLBACKs ausgeführt werden sollen. Eine Cursor-basierte Selektion wird bei PostgreSQL ohne eigene Connection wird mit dem ersten COMMIT oder ROLLBACK ungültig.

-forceExec => $bool (Default: 0)

Forciere die Ausführung des Statement. Dies kann bei Oracle PL/SQL Code notwendig sein, wenn Konstrukte enthalten sind, die von DBI/DBD irrtümlich als Bind-Variablen interpretiert werden. Z.B. bei folgender Trigger-Definition das ":new":

    CREATE OR REPLACE TRIGGER x_before_insert
    BEFORE INSERT
        ON x
        FOR EACH ROW
    BEGIN
        :new.create_date := sysdate;
    END;

Ohne -forceExec=>1 würde das Statement lediglich präpariert, nicht ausgeführt.

-log => 0|1 (Default: -log der Connection)

Schreibe SQL-Statement und Ausführungszeit nach STDOUT.

-raw => $bool (Default: 0)

Fetche die Datensätze als einfache Arrays statt als komplexe Row-Objekte. Als Default-Rowklasse verwende Prty::Database::Row::Array statt Prty::Database::Row::Object (der Parameter -rowClass überschreibt diesen Default).

-rowClass => $rowClass (Default: 'Prty::Database::Row::Object')

Name der Datensatzklasse, auf die die Datensätze der Ergebnismenge geblesst werden.

-tableClass => $tableClass (Default: siehe Text)

Name der Tabellenklasse, die die Ergebnismenge speichert. Bei Raw-Datensätzen ist Prty::Database::ResultSet::Array der Default, ansonsten Prty::Database::ResultSet::Object.

Returns

Referenz auf Cursor-Objekt (Prty::Database::Cursor)

Details

SELECT mit PostgreSQL

Bei PostgreSQL (DBD::Pg) holt ein SELECT erst die gesamte Ergebnismenge zum Client. Das ist für große Ergebnismengen fatal.

Um die Datensätze in Chunks zu holen, muss ein CURSOR verwendet werden:

    DECLARE <cursor> CURSOR FOR <stmt>;
    FETCH <n> FROM <cursor>;
    ...
    CLOSE <cursor>;

Hierbei ist:

    <cursor> der Name des Cursors
    <stmt> das SELECT-Statement
    <n> die Anzahl der zu fetchenden Datensätze

Die Methode $db->sql() implementiert im Falle von PostgreSQL SELECTs durch obige Anweisungsfolge, wenn die Option -pgFetchMode gesetzt ist.

    -fetchMode=>0|1|2 (Default: 0)
        0=Defaultverhalten, 1=dekl. Cursor, 2=dekl. Cursor und extra Session
    -chunkSize=>$n (Default: 500)
        Fetche Datensätze in Chunks von $n Stück

sqlAtomic() - Führe SQL-Statement atomar aus

Synopsis

    $cur = $db->sqlAtomic($stmt,@opt);

Description

Führe DDL-Statement $stmt aus, instantiiere ein Resultat-Objekt (Cursor), und liefere eine Referenz auf dieses Objekt zurück.

Das Statement wird atomar ausgeführt, d.h. ist das Statement erfolgreich, wird anschließend ein COMMIT ausgeführt, schlägt das Statement fehl, wird ein ROLLBACK ausgeführt.

Dieses Verhalten ist insbesondere im Falle von PostgreSQL wichtig, da bei PostgreSQL praktisch alles einer Transaktionskontrolle unterliegt. Z.B. können erzeugte Objekte nicht zugriffen werden, solange ihre Erzeugung nicht abgeschlossen ist, der Zugriff auf die erzeugten Objekt wird blockiert. Oder das Setzen von Session-Einstellungen verfällt mit einem ROLLBACK. usw.

Sessions

setSchema() - Setze Default-Schema

Synopsis

    $cur = $db->setSchema($schema);

Description

Setze das Default-Schema der Session und liefere das Resultat der Ausführung zurück.

Das Datenbank-Objekt merkt sich das Default-Schema. Von mehreren Aufrufen hintereinander mit dem selben Schema, wird nur der erste Aufruf gegenüber dem DBMS ausgeführt, die anderen sind Null-Operationen.

setEncoding() - Definiere Client-Encoding

Synopsis

    $cur = $db->setEncoding($charset);

setDateFormat() - Setze Default-Datumsformat

Synopsis

    $cur = $db->setDateFormat;

setNumberFormat() - Setze Default-Zahlenformat

Synopsis

    $cur = $db->setNumberFormat;

Transactions

begin() - Beginne Transaktion

Synopsis

    $cur = $db->begin;

Description

Beginne Transaktion und liefere das Resultat der Ausführung zurück.

commit() - Bestätige Datenänderungen

Synopsis

    $cur = $db->commit;
    $cur = $db->commit($commit);

Description

Bestätige alle auf der Datenbank durchgeführten Änderungen und liefere das Resultat der Ausführung zurück.

Wird die Methode mit Argument aufgerufen, entscheidet dessen Wahrheitswert, ob ein COMMIT oder ein ROLLBACK ausgeführt wird. Im Falle von "wahr" wird ein COMMIT ausgeführt, im Falle von "falsch" ein ROLLBACK.

rollback() - Verwirf Datenänderungen

Synopsis

    $cur = $db->rollback;

Description

Verwirf alle auf der Datenbank durchgeführten Datenänderungen.

save() - Aktualisiere Datensatz auf Datenbank

Synopsis

    $cur = $db->save($table,$row,@where);

Description

Aktualisiert den Datensatz $row gemäß seines Status auf der Datenbank $db und liefere das Resultat der Statement-Ausführung zurück.

Welche Datenbankoperation konkret ausgeführt wird, ergibt sich aus dem Status des Datensatzes.

Statuswerte

'0' (unverändert)

Es wird keine Datenbankoperation ausgeführt.

'U' (modifiziert)

Es wird eine Update-Operation auf der Datenbank ausgeführt, d.h. es wird die Methode $row->update() gerufen.

'I' (neu)

Es wird eine Insert-Operation auf der Datenbank ausgeführt, d.h. es wird die Methode $row->insert() gerufen.

'D' (zu löschen)

Es wird eine Delete-Operation auf der Datenbank ausgeführt, d.h. es wird die Methode $row->delete() gerufen.

Kolumnentitel

titles() - Liefere Liste der Kolumnentitel

Synopsis

    $titleA|@titles = $db->titles(@select);

Description

Ermittele die Liste der Kolumentitel zum Statement @select und liefere diese zurück. In skalaren Kontext liefere eine Referenz auf die Liste.

Anmerkung: Die Titelliste wird gecacht. Je Statement wird die Datenbank nur einmal befragt. Alle weiteren Aufrufe werden aus dem Cache befriedigt.

primaryKey() - Liefere Primärschlüssel-Kolumne

Synopsis

    $title = $db->primaryKey($table);

Description

Liefere die Primärschlüsselkolumne der Tabelle $table.

Die Primärschlüsselkolumne ist per Definition die erste Kolumne der Tabelle. Datenmodelle mit zusammengesetzten Primärschlüsseln werden nicht unterstützt.

Select Operations

select() - Liefere Liste von Datensätzen

Synopsis

    $tab|@rows|$cur = $db->select(@select,@opt);

Options

-chunkSize => $n

Siehe Prty::Database::Connection/sql().

-cursor => $bool (Default: 0)

Siehe Prty::Database::Connection/sql().

-fetchMode => 0|1|2

Siehe Prty::Database::Connection/sql().

-raw => $bool (Default: 0)

Siehe Prty::Database::Connection/sql().

-rowClass => $rowClass

Siehe Prty::Database::Connection/sql().

-tableClass => $tableClass

Siehe Prty::Database::Connection/sql().

lookup() - Liefere Datensatz

Synopsis

    $row|@vals = $db->lookup(@select,@opt);

Options

-new => $bool (Default: 0)

Liefere einen leeren Neu-Datensatz, wenn der Datensatz nicht gefunden wird.

-raw => $bool (Default: 0)

Liefere Datensatz in Array-Repräsentation

-rowClass => $class (Default: 'Prty::Database::Row::Object')

Default Datensatz-Klasse. Im Falle von -raw=>1 ist 'Prty::Database::Row::Array' der Default.

-sloppy => 0|1|2|3 (default: 0)
0

Es muss genau ein Datensatz getroffen werden.

1

Es darf 0 oder 1 Datensatz getroffen werden.

2

Es muss mindestens ein Datensatz getroffen werden.

3

Es dürfen beliebig viele Datensätze getroffen werden.

Wird kein Datensatz getroffen und ist dies erlaubt, wird undef geliefert. Wird mehr als ein Datensatz getroffen und ist dies erlaubt, wird der erste geliefert.

loadRow() - Lade Datensatz

Synopsis

    $row = $db->loadRow($table,@keyVal);

Description

Lade Datensatz mit WHERE-Bedingung @keyVal. Ist @keyVal leer oder einer der Werte leer, liefere einen Null-Datensatz.

Diese Methode ist nützlich, um ein Formular mit einem neuen oder existierenden Datensatz zu versorgen.

nullRow() - Liefere Null-Datensatz

Synopsis

    $row = $db->nullRow(@select,@opt);

Description

Liefere Null-Datensatz zu Select-Statement @select und der spezifizierten Klasse.

Anmerkung: Die Row-Instantiierung wird gecacht. Je Statement und Klasse wird beim ersten Aufruf eine Row instantiiert. Bei allen weiteren Aufrufen wird diese Row kopiert.

Options

-raw => $bool (Default: 0)

Liefere Datensatz in Array-Repräsentation

-rowClass => $class (Default: 'Prty::Database::Row::Object')

Default Datensatz-Klasse. Im Falle von -raw=>1 ist 'Prty::Database::Row::Array' der Default.

Example

  • Null-Datensatz einer Tabelle instantiieren

        $per = Prty::Database::Connection->nullRow('person');

values() - Liefere Kolumnenwerte als Liste oder Hash

Synopsis

    @keyVal|%hash|$arr = $db->values(@select);
    $hash = $db->values(@select,-hash=>1);

Description

Selektiere Kolumnenwerte und liefere sie als Liste oder Hash zurück. Im Skalarkontext liefere eine Referenz auf die Liste bzw. den Hash.

  • Die Select-Liste kann aus ein oder mehreren Kolumnen bestehen. Bei einer Kolumne wird die Liste der Werte der Kolumne geliefert. bei mehreren Kolumnen werden die Werte zu einer flachen Liste vereinigt. Bei zwei, vier, ... Kolumnen, kann das Resultat an einen Hash zugewiesen werden.

  • Soll die Liste nicht alle, sondern nur verschiedene Werte enthalten, wird DISTINCT selektiert.

  • Sollen NULL-Werte nicht berücksichtigt werden, wird der WHERE-Klausel eine entsprechende IS NOT NULL-Bedingung hinzugefügt.

  • Sollen die Werte sortiert geliefert werden, wird dem Statement eine ORDER BY Klausel hinzugefügt.

  • Im Skalarkontext wird ein Objekt der Klasse Prty::Array oder der Klasse Prty::Hash geliefert. Letzteres, wenn Option -hash=>1 angegeben ist.

Options

-hash => $bool (Default: 0)

Liefere Hashreferenz.

Examples

Alle Werte einer Kolumne (sortiert):

    @arr = $db->values(
        -select=>'per_nachname',
        -from=>'person',
        -orderBy=>1,
    );

Nur verschiedene Werte (sortiert):

    @arr = $db->values(
        -select=>'per_nachname',
        -distinct=>1,
        -from=>'person',
        -orderBy=>1,
    );

Abbildung von Id auf Nachname:

    %hash = $db->values(
        -select=>'per_id','per_nachname',
        -from=>'person',
    );

Dasselbe, nur dass eine Referenz (Hash-Objekt) geliefert wird:

    $hash = $db->values(
        -select=>'per_id','per_nachname',
        -from=>'person',
        -hash=>1,
    );

Lookup-Hash für Nachname:

    $hash = $db->values(
        -select=>'per_nachname',1,
        -from=>'person',
        -hash=>1,
    );

Array mit Paaren:

    @arr = $db->values(
        -select=>'per_id','per_nachname',
        -from=>'person',
    );

Dasselbe, nur dass eine Referenz (Array-Objekt) geliefert wird:

    $arr = $db->values(
        -select=>'per_id','per_nachname',
        -from=>'person',
    );

Array mit Abfolge von Tripeln:

    @arr = $db->values(
        -select=>'per_id','per_nachname','per_vorname',
        -from=>'person',
    );

value() - Liefere Wert einer Kolumne eines Datensatzes

Synopsis

    $val = $db->value(@select,@opt);

Description

Lies den ersten Datensatz der Ergebnismenge und liefere den Wert der ersten Kolumne zurück.

Anmerkungen

  • Die Select-Liste des Statement sollte sinnvollerweise aus einer Kolumne bestehen. Mehr als eine Kolumne ist zulässig, allerdings ist dies eine Verschwendung von Platz und Zeit, denn auch wenn mehrere Kolumnen angegeben sind, wird nur der Wert der ersten geliefert.

  • Ist die Ergebnismenge leer, wird eine Exception ausgelöst.

  • Es ist kein Fehler, wenn mehr als ein Datensatz getroffen wird. Es wird allerdings nur der erste Datensatz geliefert.

Options

-sloppy => $bool (Default: 0)

Wirf keine Exception, wenn die Ergebnismenge leer ist, sondern undef.

-default => $val (Default: undef)

Wenn auf einen Wert ungleich undef gesetzt, wirf keine Exception, wenn die Ergebnismenge leer ist, sondern $val.

Insert Operations

insert() - Füge Datensatz zu Tabelle hinzu

Synopsis

    $cur = $db->insert($table,@opt,$row);
    $cur = $db->insert($table,@opt,@keyVal);
    $cur = $db->insert($table,@opt,\@keys,\@values);

Description

Füge Datensatz zu Tabelle $table hinzu und liefere das Resultat der Ausführung zurück.

Options

-sloppy => $bool (Default: 0)

Ignoriere Doubletten-Fehler.

insertRows() - Füge mehrere Datensätze zu Tabelle hinzu

Synopsis

    $cur = $db->insertRows($table,\@keys,
        [@vals1],
        [@vals2],
        ...
    );
    
    $cur = $db->insertRows($table,\@keys,
        @vals1,
        @vals2,
        ...
    );

Description

Füge mehrere Datensätze zu Tabelle $table hinzu. Die Datensätze haben die Kolumnen @keys und die Werte @vals. Die Methode liefert das Resultat der Ausführung (Cursor) zurück

Example

  • Datensätze als Arrays

        $db->insertRows('person',
            [qw/per_id per_vorname per_nachname per_geburtstag/],
            [qw/1 Frank Seitz 31.1.1961/],
            [qw/2 Hanno Seitz 7.4.2000/],
            [qw/3 Linus Seitz 11.11.2002/],
        );
  • Datensätze als Abfolge von Werten

        $db->insertRows('person',
            [qw/per_id per_vorname per_nachname per_geburtstag/],
            qw/1 Frank Seitz 31.1.1961/,
            qw/2 Hanno Seitz 7.4.2000/,
            qw/3 Linus Seitz 11.11.2002/,
        );

Update Operation

update() - Aktualisiere Datensätze

Synopsis

    $cur = $db->update($table,$row); [1]
    $cur = $db->update($table,$row,@where); [2]
    $cur = $db->update($table,@keyVal,-where,@where); # [3]

Description

[1] Aktualisiere Datensatz $row und liefere das Resultat der Ausführung zurück. Als Where-Bedingung wird der Name/Wert der ersten Kolumne von Tabelle $table genommen.

[2] Wie [1], nur dass die Where-Bedingung explizit angegeben ist.

[2] Aktualisiere 0, einen oder mehrere Datensatze in Tabelle $table und liefere das Resultat der Ausführung zurück.

Delete Operation

delete() - Lösche Datensatz bzw. Datensätze aus Tabelle

Synopsis

    $cur = $db->delete($table,$row,@where);
    $cur = $db->delete($table,@where);

Description

Lösche Datensatz bzw. Datensätze aus Tabelle $table und liefere das Resultat der Ausführung zurück.

Tables

createTable() - Erzeuge Tabelle

Synopsis

    $cur = $db->createTable($table,
        [$colName,@colOpts],
        ...
        @opt,
    );

Description

Erzeuge Tabelle $table auf der Datenbank.

Options

-replace => $bool (Default: 0)

Erzeuge Tabelle neu, falls sie bereits existiert.

-sloppy => $bool (Default: 0)

Erzeuge Tabelle nicht, falls sie bereits existiert.

dropTable() - Lösche Tabelle

Synopsis

    $cur = $db->dropTable($table);

Description

Lösche die Tabelle $table (name mit oder ohne Schemaanteil) von der Datenbank $db und liefere das Resultat-Objekt der Statementausführung zurück.

Es wird vorab geprüft, ob die Tabelle existiert. Ist dies nicht der Fall, wird keine Löschung versucht und ein Null-Cursor zurückgeliefert.

Wird die Tabelle erfolgreich gedroppt, führt die Methode ein COMMIT durch. Schlägt dies fehl, führt sie ein ROLLBACK durch. Dies ist für PostgreSQL und SQLite notwendig.

tableExists() - Prüfe, ob Tabelle existiert

Synopsis

    $bool = $db->tableExists($table);

Description

Prüfe, ob Tabelle $table existiert. Wenn ja, liefere "wahr", sonst "falsch".

analyzeTable() - Analysiere Tabelle

Synopsis

    $db->analyzeTable($table);

Description

Analysiere Tabelle $table und liefere einen Cursor zurück.

addForeignKeyConstraint() - Füge FOREIGN KEY Constraint zu Tabelle hinzu

Synopsis

    $cur = $db->addForeignKeyConstraint($tableName,\@tableCols,
        $refTableName,@opt);

Description

Siehe Prty::Sql::addForeignKeyConstraint()

countRows() - Zähle die Anzahl der Datensätze in der Tabelle

Synopsis

    $n = $db->countRows($tableName);

Columns

columnExists() - Prüfe, ob Kolumne existiert

Synopsis

    $cur = $db->columnExists($table,$column);

Description

Prüfe, ob Kolumne existiert. Wenn ja, liefere "wahr", sonst "falsch".

addColumn() - Füge Kolumne zu Tabelle hinzu

Synopsis

    $cur = $db->addColumn($table,$column,@colDef,@opt);

Options

-sloppy => $bool (Default: 0)

Wirf keine Exception, wenn die Kolumne bereits existiert, sondern liefere undef.

Example

    $cur = $db->addColumn('person','mag_eis',
        type=>'STRING(1)',
        notNull=>1,
        default=>1,
    );

dropColumn() - Entferne Kolumne aus Tabelle

Synopsis

    $cur = $db->dropColumn($table,$column);

Description

Entferne Kolumne $column aus Tabelle $table und liefere das Resultat der Statement-Ausführung zurück.

Es ist kein Fehler, wenn die Kolumne nicht existiert. In dem Fall wird undef geliefert.

modifyColumn() - Modifiziere Kolumne

Synopsis

    $cur = $db->modifyColumn($table,$column,$property=>$value);

Description

Modifiziere Kolumne $column in Tabelle $table und liefere das Resultat der Statement-Ausführung zurück.

renameColumn() - Benenne Kolumne um

Synopsis

    $cur = $db->renameColumn($table,$oldName,$newName;

Description

Benenne Tabelle $table die Kolumne $oldName in $newName um und liefere das Resultat der Statement-Ausführung zurück.

distinctValues() - Liefere die Anzahl der unterschiedlichen Werte

Synopsis

    $n = $db->distinctValues($table,$column);

minValue() - Liefere den kleinsten Kolumnenwert

Synopsis

    $val = $db->minValue($table,$column);

maxValue() - Liefere den größten Kolumnenwert

Synopsis

    $val = $db->maxValue($table,$column);

countDistinctMinMax() - Liefere Count/Count Distinct/Min/Max

Synopsis

    ($count,$distinctCount,$min,$max) = $db->countDistinctMinMax($table,$column);

Description

Die Methode liefert Information über den Inhalt einer Tabellenkolumne. Sie ist für das Reverse Engineering einer unbekannte Datenbanktabelle nützlich.

Indexes

indexExists() - Prüfe, ob Index existiert

Synopsis

    $bool = $db->indexExists($table,\@colNames);

Description

Prüfe, ob Index existiert. Wenn ja, liefere "wahr", sonst "falsch".

createIndex() - Erzeuge Index

Synopsis

    $cur = $db->createIndex($table,\@colNames,@opt);

Description

Erzeuge Index für Tabelle $table und Kolumnen @colNames auf der Datenbank.

Options

-indexName => $str (Default: <TABLE>_ix_<COLUMNS>)

Name des Index.

-reCreate => $bool (Default: 0)

Erzeuge Index neu, falls er bereits existiert.

-tableSpace => $tableSpaceName (Default: keiner)

Name des Tablespace, in dem der Index erzeugt wird (Oracle und PostgreSQL).

-unique => $bool (Default: 0)

Statement für Unique Index.

createUniqueIndex() - Erzeuge Unique Index

Synopsis

    $cur = $db->createUniqueIndex($table,\@colNames,@opt);

Description

Erzeuge Unique Index für Tabelle $table und Kolumnen @colNames auf der Datenbank.

Options

Siehe $db->createIndex()

dropIndex() - Droppe Index

Synopsis

    $cur = $db->dropIndex($table,\@colNames);

Sequences

createSequence() - Erzeuge Sequenz

Synopsis

    $db->createSequence($name,@opt);

Description

Erzeuge Sequenz $name auf Datenbank $db. Die Methode liefert keinen Wert zurück.

Unter Oracle und PostgreSQL, die das Konzept der Sequenz haben, wird eine normale Sequenz auf der Datenbank erzeugt.

Unter MySQL und SQLite, die das Konzept der Sequenz nicht haben, wird eine Tabelle mit Autoinkrement-Kolumne zur Simulation einer Sequenz erzeugt.

Options

-reCreate => $bool (Default: 0)

Droppe Sequenz, falls sie bereits existiert.

-startWith => $n (Default: 1)

Die Sequenz beginnt mit Startwert $n.

dropSequence() - Droppe Sequenz

Synopsis

    $cur = $db->dropSequence($name);

Description

Droppe Sequenz $name und liefere das Resultat der Statementausführung zurück.

setSequence() - Setze Sequenz auf neuen Startwert

Synopsis

    $db->setSequence($sequence,$n);

Description

Setze Sequenz $sequence auf Wert $n. Die Methode liefert keinen Wert zurück.

nextValue() - Liefere nächsten Sequenzwert

Synopsis

    $n = $db->nextValue($sequence);

Description

Ermittele den nächsten Sequenzwert der Sequenz $sequence und liefere diesen zurück.

Unter Oracle und PostgreSQL wird die betreffende Sequenz befragt.

Unter MySQL und SQLite wird ein leerer Datensatz in die Sequenz-Tabelle eingefügt und dessen automatisch generierter Primärschlüsselwert ermittelt. Um die Sequenz-Tabelle nicht beliebig anwachsen zu lassen, wird die Tabelle alle 100 Werte (d.h. wenn $n % 100 == 0) bereinigt: alle Datensätze mit einem kleineren Wert als $n werden gelöscht.

Views

createView() - Erzeuge View

Synopsis

    $cur = $db->createView($viewName,$selectStmt,@opt);

Options

-reCreate => $bool (Default: 0)

Erzeuge View neu, falls sie bereits existiert.

dropView() - Lösche View

Synopsis

    $cur = $db->dropView($viewName);

Description

Lösche die View $viewName von der Datenbank $db und liefere das Resultat-Objekt der Statementausführung zurück.

Es wird vorab geprüft, ob die View existiert. Ist dies nicht der Fall, wird nicht zu löschen versucht und ein Null-Cursor zurückgeliefert.

Wird die View erfolgreich gedroppt, führt die Methode ein COMMIT durch. Schlägt dies fehl, führt sie ein ROLLBACK durch. Dies ist für PostgreSQL und SQLite notwendig.

viewExists() - Prüfe, ob View existiert

Synopsis

    $bool = $db->viewExists($viewName);

Description

Prüfe, ob View existiert. Wenn ja, liefere "wahr", sonst "falsch".

Trigger

createTrigger() - Erzeuge Trigger

Synopsis

    $cur = $db->createTrigger($table,$name,$when,$event,$level,$body,@opt);
    $cur = $db->createTrigger($table,$name,$when,$event,$level,
        $dbms=>$body,
        ...,
        @opt
    );

Description

Erzeuge einen Trigger mit Name $name für Tabelle $table und Zeitpunkt $when (BEFORE oder AFTER), der bei Ereignis $event (INSERT, UPDATE oder DELETE) auf Ebene $level (ROW oder STATEMENT) feuert und die Rumpf/Anweisungsfolge $body ausführt.

Es kann ein einzelner Rumpf angegeben werden, wenn die Applikation auf einem bestimmten RDBMS läuft. Oder es können, um portabel programmieren zu können, unterschiedliche Prozedur-Rümpfe für verschiedene RDBMSe definiert werden:

    ...
    Oracle=>"
    <oracle_body>
    ",
    PostgreSQL=>"
    <postgresql_body>
    ",
    ...

Die Methode wählt dann die zur Datenbank $db passende Rumpf-Definition aus.

Options

-replace => $bool (Default: 0)

Ersetze den Trigger, falls ein solcher existiert.

Returns

Cursor

Example

Erzeuge unterschiedlichen Triggercode für Oracle und PostgreSQL:

    $db->createTrigger('mytab','mytrig','before','insert|update','row',
        Oracle=>"
        BEGIN
            :new.c := 'a';
        END
        ",
        PostgreSQL=>"
        BEGIN
            NEW.c = 'a';
            RETURN NEW;
        END;
        ",
    );

Für Oracle wird ein Trigger mit Rumpf erzeugt:

    CREATE TRIGGER mytrig
    BEFORE INSERT OR UPDATE ON mytab
    FOR EACH ROW
    BEGIN
        :new.c := 'a';
    END;

Für PostgreSQL wird zunächst eine Funktion set_c_proc (Triggername plus "_proc") erzeugt, welche die Triggerfunktionalität implementiert:

    CREATE FUNCTION mytrig_proc()
    RETURNS trigger
    AS $SQL$
    BEGIN
        NEW.c = 'a';
        RETURN NEW;
    END;
    $SQL$ LANGUAGE plpgsql

Dann wird der Trigger definiert, der diese Funktion aufruft:

    CREATE TRIGGER set_c
    BEFORE INSERT OR UPDATE ON mytab
    FOR EACH ROW
    EXECUTE PROCEDURE mytrig_proc()

dropTrigger() - Entferne Trigger

Synopsis

    $cur = $db->dropTrigger($name);

triggerExists() - Prüfe, ob Trigger existiert

Synopsis

    $bool = $db->triggerExists($name);

Spezielle Operationen

diff() - Ermittele Datendifferenzen

Synopsis

    $tab|@rows|$cur = $db->diff(@args);

Options

Wie $db->select()

DETAILS

Zeitmessung

Im Zuge der Ausführung eines SQL-Statement werden drei Zeiten ermittelt:

  1. Der Startzeitpunkt der Ausführung (Aufruf von sql)

  2. Die Dauer der Statementausführung

  3. Die Zeit, die seit Start des Statement vergangen ist

Diese Zeiten können vom Cursor abgefragt werden mittels:

    $cur->startTime;
    $cur->execTime;
    $cur->time;

Parallele Datenbankverbindung

Eine parallele Verbindung zur gleichen Datenbank unter dem gleichen User kann mittels

    $db2 = $db->new;

aufgebaut werden. Dies kann nützlich sein, um einen nebenläufigen Transkationsrahmen zu eröffnen.

Null-Cursor

Wird ein Cursor benötigt, ohne dass ein Statement ausgeführt werden soll, kann ein Null-Cursor erzeugt werden:

    $cur = $db->sql;

Statement-Generierung

Die Methode sql() liefert das SQL-Objekt der Datenbankverbindung. Dies ist ein Objekt der Klasse Prty::Sql, das beim Verbindungsaufbau passend zum DBMS instantiiert wurde.

Alle SQL-Generierungsmethoden der Klasse Prty::Sql können über diese Methode aufgerufen werden, zum Beispiel:

    $stmt = $db->stmt->createTable('person',
        ['per_id',type=>'INTEGER',primaryKey=>1],
        ['per_vorname',type=>'STRING(20)'],
        ['per_nachname',type=>'STRING(20)'],
    );

Statement-Generierung plus -Ausführung

Die meisten Statements der Klasse Prty::Sql können auch direkt ausgeführt werden, ohne dass das Statement zuvor generiert werden muss, zum Beispiel:

    $db->createTable('person',
        ['per_id',type=>'INTEGER',primaryKey=>1],
        ['per_vorname',type=>'STRING(20)'],
        ['per_nachname',type=>'STRING(20)'],
    );

Die direkte Ausführung ist einer getrennten Generierung und Ausführung vorzuziehen, da die Prty::Database::Connection-Methoden bei der Ausführung teilweise DBMS-abhängige Sonderbehandlungen vornehmen.

Erweiterte Statement-Generierung

Anstelle der Default Sql-Klasse Prty::Sql kann beim Verbindungsaufbau eine anwendungspezifische Klasse vereinbart werden:

    package MyApp::Sql;
    use base qw/Prty::Sql/;
    
    ...
    
    package main;
    
    $db = Prty::Database::Connection->new(...,-sqlClass=>'MyApp::Sql');

Prepare/Bind

DML-Statements (SELECT, INSERT, UPDATE, DELETE) können mit Platzhaltern versehen werden. Das Statement wird dann nicht ausgeführt, sondern ein Bind-Cursor geliefert.

Beispiel mit INSERT

    my $bindCur = $db->insert('person',
        per_id=>\'?',
        per_vorname=>\'?',
        per_nachname=>\'?',
    );
    
    $bindCur->bind(
        1,'Rudi','Ratlos',
        2,'Elli','Pirelli',
        3,'Erika','Mustermann',
    );

Beispiel mit SELECT

    my $bindCur = $db->select(
        -from=>'person',
        -where=>'per_nachname = ?',
    );
    
    my $cur = $bindCur->bind('Mustermann');
    while (my $row = $cur->fetch) {
        print $row->asString,"\n";
    }
    $cur->close;

Lookup von Datensätzen

Selektion eines eindeutigen Objekts

    $row = $db->lookup('person',-where,per_id=>4711);

Es ist ein Fehler, wenn

  • kein Datensatz existiert

  • mehr als ein Datensatz existiert

Soll die Methode undef liefern, wenn kein Datensatz existiert, wird -sloppy=>1 angegeben:

    $row = $db->lookup('person',-sloppy=>1,-where,per_id=>4711);

Soll ein leerer Datensatz geliefert werden, der gesuchte Datensatz nicht gefunden wird, wird -new=>1 angegeben:

    $row = $db->lookup('person',-new=>1,-where,per_id=>4711);

Der Aufruf liefert also immer einen Datensatz. Mit der Methode rowStatus() kann geprüft werden, ob der Datensatz selektiert oder neu erzeugt wurde:

    if ($row->rowStatus eq 'I') {
        # initialisieren
    
        $row->set(
            per_id=>$db->nextValue('id');
            per_vorname=>'Erika',
            per_namchname=>'Mustermann',
        );
    
        # speichern
        $db->insert('person',$row);
    }

Einfügen von Datensätzen

Ad hoc

    my $per_id = $db->nextValue('id');
    $db->insert('person',
        per_id=>$per_id,
        per_vorname=>'Rudi',
        per_nachname=>'Ratlos',
    );
    my $per = $db->lookup('person',-where,per_id=>$per_id);

Der Datensatz wird durch Aufzählung der Kolumnen/Wert-Paare zur Tabelle hinzugefügt. Um das Objekt im Programm zu haben, muss der Datensatz selektiert werden.

Mittels anonymem Row-Objekt

    my $per = $db->nullRow('person');
    $per->set(
        per_id=>$db->nextValue('id'),
        per_vorname=>'Rudi',
        per_nachname=>'Ratlos',
    );
    $db->insert('person',$row);

Mittels Objekt (noch nicht implementiert)

    my $per = Person->new($db,
        per_id=>$db->nextValue('id'),
        per_vorname=>'Rudi',
        per_nachname=>'Ratlos',
    );
    $per->insert($db);

Default-Schema

Per UDL kann ein Default-Schema definiert werden:

    dbi#DBMS:DB%USER:PASSW;schema=SCHEMA

Namen von Datenbank-Objekten, die ohne Schema-Präfix angegeben werden, werden auf dieses Schema bezogen. Auf diese Weise ist es leicht möglich, eine Anwendung auf verschiedenen Schemata der gleichen Datenbank laufen zu lassen. Dies ist vor allem bei Oracle nützlich, dessen Instanzen einen großen Overhead haben.

Bei SQLite ist die Semantik eine leicht andere: Hier ist es nicht das Default-Schema, sondern es darf der Schema-Präfix SCHEMA verwendet werden.

BLOB Datentyp

  • Die maximale Größe eines BLOB/TEXT-Werts muss im Falle von Oracle eingestellt werden. Dies geschieht durch Aufruf von maxBlobSize():

        $db->maxBlobSize(500*1024); # 0,5 MB

    Der Defaultwert ist 1024*1024 Bytes (1MB).

Tabelle erzeugen

    $db->createTable('person',
        ['per_id',type=>'INTEGER',primaryKey=>1],
        ['per_vorname',type=>'STRING(20)'],
        ['per_nachname',type=>'STRING(20)'],
        ['per_foto',type=>'BLOB'],
    );

Daten speichern

    $cur = $db->insert('person',
        per_id=>\'?',
        per_vorname=>\'?',
        per_nachname=>\'?',
        per_foto=>\'?',
    );
    
    # BLOB-Kolumne bekannt machen, damit die Schnittstelle
    # die notwendigen Sonderbehandlungen für diesen Datentyp
    # durchführen kann. Dies ist im Falle von Oracle und PostgreSQL
    # nötig, da diese die Daten speziell kodieren. Bei SQLite und MySQL
    # ist das nicht erforderlich. Der Aufruf von bindTypes() sollte aus
    # Portabilitätsgründen aber immer gemacht werden.
    
    $cur->bindTypes(undef,undef,undef,'BLOB');
    
    my $foto = Prty::Path->read('/home/pirelli/Picture/elli.jpg');
    $cur->bind(1,'Elli','Pirelli',$foto);

Daten selektieren

    $per = $db->lookup('person',-where,per_id=>1);

TEXT-Datentyp

Wie BLOB-Datentyp, aber als Bind-Typ TXET angeben:

    $cur->bindTypes(undef,undef,undef,'TEXT');

Auch hier ist dies wegen Oracle erforderlich.

UTF-8

Beim Verbindungsaufbau kann angegeben werden, ob das Perl-Programm UTF-8 Encoding verwendet:

    $db = Prty::Database::Connection->new($udl,-utf8=>1);

Die Option sorgt dafür, dass Zeichenketten-Daten (STRING, TEXT) als UTF-8 Zeichenketten auf der Datenbank gespeichert werden und umgekehrt als UTF-8 Zeichenketten geliefert werden.

Existierende Handle nutzen

Existiert eine Lowlevel-Handle bereits, kann sie mit der Option -handle in das Datenbankobjekt eingesetzt werden.

Beispiel: Eine DBI MySQL-Handle $dbh wird als Lowlevel-Handle verwendet,

    UDL braucht nur die
    
       $db = Prty::Database::Connection->new('dbi#mysql',-handle=>$dbh);

Zugriff auf MS Access Datenbank

Unter Unix/Linux ist ein lesender Zugriff auf MS Access Datenbanken mittels des freien Open Source Package mtools möglich. Es enthält neben verschiedenen Programme auch einen ODBC-Treiber, der genutzt werden kann, um von Perl aus auf eine Access-Datenbank zuzugreifen.

Installation (Redhat)

ODBC-Treiber für MS-Access

mtools: http://mdbtools.sourceforge.net/

    # yum install mdbtools

ODBC Driver Manager

unixODBC: http://http://www.unixodbc.org/

    # yum install unixODBC

Perl DBI-Treiber für ODBC

DBD::ODBC: https://metacpan.org/pod/DBD::ODBC

    # cpanm DBD::ODBC

Konfiguration

ODBC-Treiber (aus den mtools) definieren:

    # vi /etc/odbcinst.ini
    [MDBTools]
    Description = MDB Tools ODBC
    Driver      = libmdbodbc.so
    FileUsage   = 1

Datenquelle definieren:

    # vi /etc/odbc.ini
    [test]
    Description = Access Test-Datenbank
    Driver      = MDB Tools ODBC
    Database    = /path/to/file.mdb

Perl-Programm

Von Perl aus auf die Access-Datenbank zugreifen:

    my $udl = 'dbi#access:test';
    my $db = Prty::Database::Connection->new($udl,-utf8=>1);
    
    my $stmt = 'select * from tdruckdaten';
    my $tab = $db->select($stmt);
    print $tab->asTable;

VERSION

1.108

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2017 Frank Seitz

LICENSE

This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

5 POD Errors

The following errors were encountered while parsing the POD:

Around line 1144:

Expected text after =item, not a number

Around line 1149:

Expected text after =item, not a number

Around line 1905:

Expected text after =item, not a number

Around line 1909:

Expected text after =item, not a number

Around line 1913:

Expected text after =item, not a number