Hilfsscript dbupgrade2_tool.pl diff --git a/doc/html/ch04s03.html b/doc/html/ch04s03.html index b8e68f993..39f03d32c 100644 --- a/doc/html/ch04s03.html +++ b/doc/html/ch04s03.html @@ -31,11 +31,10 @@ erlaubt und sollten stattdessen mit Unterstrichen ersetzt werden.

charset -

Empfohlen. Gibt den Zeichensatz an, in dem das Script - geschrieben wurde, z.B. "UTF-8". Aus - KompatibilitÃ¤tsgrÃ¼nden mit alten Upgrade-Scripten wird bei - Abwesenheit des Tags der Zeichensatz - "ISO-8859-15" angenommen.

Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "UTF-8". Aus + KompatibilitÃ¤tsgrÃ¼nden mit alten Upgrade-Scripten wird bei Abwesenheit des Tags fÃ¼r SQL-Upgradedateien der Zeichensatz + "ISO-8859-15" angenommen. Perl-Upgradescripte hingegen mÃ¼ssen immer in UTF-8 encodiert sein und sollten + demnach auch ein "use utf8;" enthalten.

description

BenÃ¶tigt. Eine Beschreibung, was in diesem Update passiert. Diese wird dem Benutzer beim eigentlichen @@ -67,7 +66,33 @@ ignore

Optional. Falls der Wert auf 1 (true) steht, wird das Skript bei der Anmeldung ignoriert und entsprechend nicht - ausgefÃ¼hrt.

4.3.3. Hilfsscript dbupgrade2_tool.pl

Um die Arbeit mit den AbhÃ¤ngigkeiten etwas zu erleichtern, + ausgefÃ¼hrt.

4.3.3. Format von in Perl geschriebenen Datenbankupgradescripten

In Perl geschriebene Datenbankscripte werden nicht einfach so ausgefÃ¼hrt sondern mÃ¼ssen sich an gewisse Konventionen + halten. DafÃ¼r bekommen sie aber auch einige Komfortfunktionen bereitgestellt.

Ein Upgradescript stellt dabei eine vollstÃ¤ndige Objektklasse dar, die vom Elternobjekt + "SL::DBUpgrade2::Base" erben und eine Funktion namens "run" zur VerfÃ¼gung stellen muss. Das + Script wird ausgefÃ¼hrt, indem eine Instanz dieser Klasse erzeugt und darauf die erwÃ¤hnte "run" aufgerufen + wird.

Zu beachten ist, dass sich der Paketname der Datei aus dem Wert fÃ¼r "@tag" ableitet. Dabei werden alle + Zeichen, die in Paketnamen ungÃ¼ltig wÃ¤ren (gerade Bindestriche), durch Unterstriche ersetzt. Insgesamt sieht der Paketname wie folgt + aus: "SL::DBUpgrade2::tag".

Welche Komfortfunktionen zur VerfÃ¼gung stehen, erfahren Sie in der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit + "perldoc SL/DBUpgrade2/Base.pm".

Ein MindestgerÃ¼st eines gÃ¼ltigen Perl-Upgradescriptes sieht wie folgt aus:

# @tag: beispiel-upgrade-file42
+# @description: Ein schÃ¶nes Beispielscript
+# @depends: release_3_0_0
+package SL::DBUpgrade2::beispiel_upgrade_file42;
+
+use strict;
+use utf8;
+
+use parent qw(SL::DBUpgrade2::Base);
+
+sub run {
+  my ($self) = @_;
+
+  # hier Aktionen ausfÃ¼hren
+
+  return 1;
+}
+
+1;
+

4.3.4. Hilfsscript dbupgrade2_tool.pl

Um die Arbeit mit den AbhÃ¤ngigkeiten etwas zu erleichtern, existiert ein Hilfsscript namens "scripts/dbupgrade2_tool.pl". Es muss aus dem kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool diff --git a/doc/html/index.html b/doc/html/index.html index 340202aa8..2eb6bde78 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -3,7 +3,7 @@ kivitendo 3.0.0: Installation, Konfiguration, Entwicklung