Firebird ist seit langem in der Lage, die Funktionen der PSQL-Sprache durch das Schreiben externer Funktionen zu erweitern - UDF (User Defined Functions). UDF kann in fast jeder kompilierten Programmiersprache geschrieben werden.
Firebird 3.0 führte eine Plug-In-Architektur ein, um die Funktionen von Firebird zu erweitern. Eines dieser Plugins ist die External Engine (externe Engines). Der UDR-Mechanismus (User Defined Routines - User Defined Routines) fügt der FirebirdExternal-Engine-Oberfläche eine Ebene hinzu.
In diesem Handbuch erfahren Sie, wie Sie UDR deklarieren, welche internen Mechanismen und Funktionen sie haben und wie Sie UDR in Pascal schreiben. Darüber hinaus werden einige Aspekte der Verwendung der neuen objektorientierten API behandelt.
Bemerkung
In diesem Artikel erfahren Sie, wie Sie UDR mithilfe der Objekt-Firebird-API schreiben.
Die schriftlichen Funktionen und Verfahren haben möglicherweise keine praktische Anwendung.
UDRs bieten gegenüber Legacy-UDF die folgenden Vorteile:
- Sie können nicht nur Funktionen schreiben, die ein skalares Ergebnis zurückgeben, sondern auch gespeicherte Prozeduren (sowohl ausführbare als auch selektive) sowie Trigger.
- verbesserte Steuerung der Eingabe- und Ausgabeparameter. In einigen Fällen (Übergabe durch Deskriptor) wurden die Typen und anderen Eigenschaften der Eingabeparameter überhaupt nicht gesteuert. Sie können diese Eigenschaften jedoch in UDF abrufen. UDRs bieten eine einheitlichere Möglichkeit, Eingabe- und Ausgabeparameter zu deklarieren, wie dies bei regulären PSQL-Funktionen und -Prozeduren der Fall ist.
- UDR Der Kontext der aktuellen Verbindung oder Transaktion ist verfügbar, sodass Sie eine Ausführung durchführen können
einige Manipulationen mit der aktuellen Datenbank in diesem Zusammenhang; - Die Firebird-Fehlergenerierung ist verfügbar, wenn Ausnahmen auftreten. Es ist nicht erforderlich, einen speziellen Wert zurückzugeben.
- Externe Prozeduren und Funktionen (UDR) können in PSQL-Paketen gruppiert werden.
- UDR kann in jeder Programmiersprache geschrieben werden (optional in Objektcodes kompiliert). Dazu muss das entsprechende External Engine Plug-In geschrieben sein. Beispielsweise gibt es Plugins zum Schreiben externer Module in Java oder einer der .NET-Sprachen.
Bemerkung
Die aktuelle UDR-Implementierung verwendet einen PSQL-Stub. Zum Beispiel ist es gewohnt
Überprüfen von Parametern und Rückgabewerten auf Einhaltung von Einschränkungen. Stub
wurde wegen der Unflexibilität verwendet, um interne Funktionen direkt aufzurufen. Ergebnisse
Ein Test, der die Leistung von UDR und UDF vergleicht, zeigt, dass UDR ungefähr ist
2,5-mal langsamer mit der einfachsten Funktion, zwei Argumente als Beispiel hinzuzufügen. Geschwindigkeit
UDR entspricht ungefähr der Geschwindigkeit einer regulären PSQL-Funktion. Vielleicht in Zukunft das
Moment wird optimiert. In komplexeren Funktionen kann dieser Overhead werden
nicht wahrnehmbar.
Weiter in verschiedenen Teilen dieses Handbuchs, wenn die Begriffe externes Verfahren verwendet werden,
Funktion oder Trigger meinen wir genau UDR (und nicht UDF).
Bemerkung
Alle unsere Beispiele arbeiten mit Delphi 2009 und höher sowie mit Free Pascal. Alle
Beispiele können sowohl in Delphi als auch in Free Pascal zusammengestellt werden, wenn
nicht separat angegeben.
Firebird API
Um externe Prozeduren, Funktionen oder Trigger in kompilierten Programmiersprachen zu schreiben, benötigen wir Kenntnisse der neuen objektorientierten Firebird-API. Dieses Handbuch enthält keine vollständige Beschreibung der Firebird-API. Sie können es im Dokumentationsverzeichnis lesen, das mit Firebird verteilt wird ( doc/Using_OO_API.html ).
Plug-Ins für verschiedene Programmiersprachen, die APIs enthalten, werden nicht als Teil der Firebird-Distribution für Windows verteilt. Sie können sie jedoch aus von Linux verteilten komprimierten Tarbar-Dateien extrahieren (der Pfad im Archiv /opt/firebird/include/firebird/Firebird.pas ).
CLOOP
CLOOP - Sprachübergreifende objektorientierte Programmierung. Dieses Tool ist nicht in Firebird enthalten. Es befindet sich im Quellcode https://github.com/FirebirdSQL/firebird/tree/B3_0_Release/extern/cloop . Nach dem Zusammenstellen des Tools können Sie eine API für Ihre Programmiersprache ( IdlFbInterfaces.h oder Firebird.pas ) basierend auf der Schnittstellenbeschreibungsdatei include/firebird/FirebirdInterface.idl .
Für Object Pascal erfolgt dies mit dem folgenden Befehl:
cloop FirebirdInterface.idl pascal Firebird.pas Firebird --uses SysUtils \ --interfaceFile Pascal.interface.pas \ --implementationFile Pascal.implementation.pas \ --exceptionClass FbException --prefix I \ --functionsFile fb_get_master_interface.pas
Die fb_get_master_interface.pas Pascal.interface.pas , Pascal.implementation.pas und fb_get_master_interface.pas finden Sie unter https://github.com/FirebirdSQL/firebird/tree/B3_0_Release/src/misc/pascal .
Bemerkung
In diesem Fall wird das Präfix I für die Firebird-APIs hinzugefügt, da dies in Object Pascal akzeptiert wird.
Konstanten
Die resultierende Datei Firebird.pas enthält keine isc_* . Diese Konstanten für C / C ++ - Sprachen finden Sie unter https://github.com/FirebirdSQL/firebird/blob/B3_0_Release/src/include/consts_pub.h . Um die Konstanten für die Pascal-Sprache zu erhalten, verwenden wir das AWK-Skript, um die Syntax zu konvertieren. Unter Windows müssen Sie Gawk für Windows installieren oder das Windows-Subsystem für Linux verwenden (verfügbar unter Windows 10). Dies erfolgt mit folgendem Befehl:
awk -f Pascal.Constants.awk consts_pub.h > const.pas
Der Inhalt der resultierenden Datei muss unmittelbar nach der Implementierung in den leeren const-Abschnitt der Firebird.pas Datei kopiert werden. Die Datei Pascal.Constants.awk finden Sie unter
https://github.com/FirebirdSQL/firebird/tree/B3_0_Release/src/misc/pascal .
Lebenszeitmanagement
Firebird-Schnittstellen basieren nicht auf der COM-Spezifikation, daher unterscheidet sich die Verwaltung ihrer Lebensdauer.
In Firebird gibt es zwei Schnittstellen, die sich mit der Lebensdauerverwaltung befassen: IDisposable und IReferenceCounted. Letzteres ist besonders aktiv beim Erstellen anderer Schnittstellen: IPlugin zählt Links, wie viele andere von Plug-Ins verwendete Schnittstellen. Dazu gehören Schnittstellen, die beschreiben, wie eine Verbindung zu einer Datenbank hergestellt wird, Transaktionsverwaltung und SQL-Anweisungen.
Ein zusätzlicher Overhead der Schnittstelle mit Referenzzählung ist nicht immer erforderlich. Beispielsweise hat IMaster, die Hauptschnittstelle, die Funktionen aufruft, die für den Rest der API verfügbar sind, per Definition eine unbegrenzte Lebensdauer. Bei anderen APIs wird die Lebensdauer streng durch die Lebensdauer der übergeordneten Schnittstelle bestimmt. IStatus-Schnittstelle ist nicht
Multithreaded. Für Schnittstellen mit einer begrenzten Lebensdauer ist es nützlich, eine einfache Möglichkeit zu haben, sie zu zerstören, dh die Funktion dispose ().
Hinweis
Wenn Sie nicht wissen, wie ein Objekt zerstört wird, überprüfen Sie die Hierarchie, falls vorhanden
Schnittstelle IReferenceCounted, dann wird die Referenzzählung verwendet.
Für Schnittstellen mit Referenzzählung ist es nach Abschluss der Arbeit mit einem Objekt erforderlich
Verringern Sie den Referenzzähler, indem Sie die release () -Methode aufrufen.
UDR-Ankündigung
UDRs können mithilfe von DDL-Befehlen zur Datenbank hinzugefügt oder daraus entfernt werden, genau wie Sie reguläre PSQL-Prozeduren, -Funktionen oder -Trigger hinzufügen oder entfernen. In diesem Fall wird anstelle des Triggerkörpers dessen Position im externen Modul mit der EXTERNAL NAME-Klausel angegeben.
Berücksichtigen Sie die Syntax dieses Satzes, die externen Prozeduren, Funktionen und Triggern gemeinsam ist.
Syntax:
EXTERNAL NAME '<extname>' ENGINE <engine> [AS <extbody>] <extname> ::= '<module name>!<routine name>[!<misc info>]'
Das Argument für diese EXTERNAL NAME-Klausel ist eine Zeichenfolge, die den Speicherort der Funktion im externen Modul angibt. Bei externen Modulen, die die UDR-Engine verwenden, gibt diese Zeile durch das Trennzeichen den Namen des externen Moduls, den Namen der Funktion innerhalb des Moduls und benutzerdefinierte Informationen an. Ein Ausrufezeichen (!) Wird als Trennzeichen verwendet.
Die ENGINE-Klausel gibt den Namen der Engine für die Verarbeitung der Verbindung externer Module an. Firebird verwendet die UDR-Engine, um mit externen Modulen zu arbeiten, die in kompilierten Sprachen (C, C ++, Pascal) geschrieben sind. In Java geschriebene externe Funktionen erfordern die Java-Engine.
Nach dem Schlüsselwort AS kann ein String-Literal angegeben werden - der "Body" des externen Moduls (Prozedur, Funktion oder Trigger), der vom externen Modul für verschiedene Zwecke verwendet werden kann. Beispielsweise kann eine SQL-Abfrage angegeben werden, um auf eine externe Datenbank oder einen Text in einer bestimmten Sprache zur Interpretation durch Ihre Funktion zuzugreifen.
Externe Funktionen
Syntax {CREATE [OR ALTER] | RECREATE} FUNCTION funcname [(<inparam> [, <inparam> ...])] RETURNS <type> [COLLATE collation] [DETERMINISTIC] EXTERNAL NAME <extname> ENGINE <engine> [AS <extbody>] <inparam> ::= <param_decl> [{= |DEFAULT} <value>] <value> ::= {literal | NULL | context_var} <param_decl> ::= paramname <type> [NOT NULL] [COLLATE collation] <extname> ::= '<module name>!<routine name> [!<misc info>]' <type> ::= <datatype> | [TYPE OF] domain | TYPE OF COLUMN rel.col <datatype> ::= {SMALLINT | INT[EGER] | BIGINT} | BOOLEAN | {FLOAT | DOUBLE PRECISION} | {DATE | TIME | TIMESTAMP} | {DECIMAL | NUMERIC} [(precision [, scale])] | {CHAR | CHARACTER | CHARACTER VARYING | VARCHAR} [(size)] [CHARACTER SET charset] | {NCHAR |NATIONAL CHARACTER | NATIONAL CHAR} [VARYING] [(size)] | BLOB [SUB_TYPE {subtype_num | subtype_name}] [SEGMENT SIZE seglen] [CHARACTER SET charset] | BLOB [(seglen [, subtype_num])]
Alle Parameter einer externen Funktion können mit der Anweisung ALTER FUNCTION geändert werden.
Syntax:
ALTER FUNCTION funcname [(<inparam> [, <inparam> ...])] RETURNS <type> [COLLATE collation] [DETERMINISTIC] EXTERNAL NAME <extname> ENGINE <engine> [AS <extbody>] <extname> ::= '<module name>!<routine name>[!<misc info>]'
Sie können eine externe Funktion mit der Anweisung DROP FUNCTION löschen.
Syntax:
DROP FUNCTION funcname
Hier werden wir die Syntax der Eingabeparameter und der Ausgabe nicht beschreiben. Es entspricht vollständig der Syntax für reguläre PSQL-Funktionen, die im SQL Language Guide ausführlich beschrieben wird. Stattdessen geben wir Beispiele für die Deklaration externer Funktionen mit Erklärungen.
Die Funktion zum Hinzufügen von drei Argumenten
create function sum_args ( n1 integer, n2 integer, n3 integer ) returns integer external name 'udrcpp_example!sum_args' engine udr;
Die Implementierung der Funktion erfolgt im Modul udrcpp_example. Innerhalb dieses Moduls ist eine Funktion unter dem Namen sum_args registriert. Eine externe Funktion verwendet die UDR-Engine.
Java-Funktion
create or alter function regex_replace ( regex varchar(60), str varchar(60), replacement varchar(60) ) returns varchar(60) external name 'org.firebirdsql.fbjava.examples.fbjava_example.FbRegex.replace( String, String, String)' engine java;
Die Implementierung der Funktion erfolgt in der statischen org.firebirdsql.fbjava.examples.fbjava_example.FbRegex Klasse org.firebirdsql.fbjava.examples.fbjava_example.FbRegex . Eine externe Funktion verwendet die Java-Engine.
Externe Verfahren
Syntax {CREATE [OR ALTER] | RECREATE} PROCEDURE procname [(<inparam> [, <inparam> ...])] RETURNS (<outparam> [<outparam> ...]) EXTERNAL NAME <extname> ENGINE <engine> [AS <extbody>] <inparam> ::= <param_decl> [{= | DEFAULT} <value>] <outparam> ::= <param_decl> <value> ::= {literal | NULL | context_var} <param_decl> ::= paramname <type> [NOT NULL] [COLLATE collation] <extname> ::= '<module name>!<routine name>[!<misc info>]' <type> ::= <datatype> | [TYPE OF] domain | TYPE OF COLUMN rel.col <datatype> ::= {SMALLINT | INT[EGER] | BIGINT} | BOOLEAN | {FLOAT | DOUBLE PRECISION} | {DATE | TIME | TIMESTAMP} | {DECIMAL | NUMERIC} [(precision [,scale])] | {CHAR | CHARACTER | CHARACTER VARYING | VARCHAR} [(size)] [CHARACTER SET charset] | {NCHAR | NATIONAL CHARACTER | NATIONAL CHAR} [VARYING] [(size)] | BLOB [SUB_TYPE {subtype_num | subtype_name}] [SEGMENT SIZE seglen] [CHARACTER SET charset] | BLOB [(seglen [, subtype_num])]
Alle Parameter der externen Prozedur können mit der Anweisung ALTER PROCEDURE geändert werden.
Syntax:
ALTER PROCEDURE procname [(<inparam> [, <inparam> ...])] RETURNS (<outparam> [, <outparam> ...]) EXTERNAL NAME <extname> ENGINE <engine> [AS <extbody>]
Sie können eine externe Prozedur mit der Anweisung DROP PROCEDURE löschen.
Syntax:
DROP PROCEDURE procname
Hier wird die Syntax der Eingabe- und Ausgabeparameter nicht beschrieben. Es entspricht vollständig der Syntax für reguläre PSQL-Prozeduren, die im SQL-Sprachhandbuch ausführlich beschrieben wird. Stattdessen geben wir Beispiele für die Deklaration externer Verfahren mit Erläuterungen.
create procedure gen_rows_pascal ( start_n integer not null, end_n integer not null ) returns ( result integer not null ) external name 'pascaludr!gen_rows' engine udr;
Die Implementierung der Funktion erfolgt im Pascaludr-Modul. Innerhalb dieses Moduls ist die Prozedur unter dem Namen gen_rows registriert. Eine externe Prozedur verwendet die UDR-Engine.
create or alter procedure write_log ( message varchar(100) ) external name 'pascaludr!write_log' engine udr;
Die Implementierung der Funktion erfolgt im Pascaludr-Modul. Innerhalb dieses Moduls ist die Prozedur unter dem Namen write_log registriert. Eine externe Prozedur verwendet die UDR-Engine.
create or alter procedure employee_pgsql (
Die Implementierung der Funktion erfolgt in der statischen Funktion executeQuery der Klasse
org.firebirdsql.fbjava.examples.fbjava_example.FbJdbc . Nach dem Ausrufezeichen (!) Befinden sich Informationen für die Verbindung mit einer externen Datenbank über JDBC. Eine externe Funktion verwendet die Java-Engine. Hier wird als "Hauptteil" einer externen Prozedur eine SQL-Abfrage übergeben, um Daten abzurufen.
Bemerkung
Diese Prozedur verwendet einen Stub, in dem ein nicht verwendeter Parameter übergeben wird. Dies liegt an der Tatsache, dass in Firebird 3.0 ein Fehler bei der Verarbeitung externer Prozeduren ohne Parameter vorliegt.
Platzierung externer Prozeduren und Funktionen in Paketen
Es ist praktisch, eine Gruppe miteinander verbundener Prozeduren und Funktionen in PSQL-Paketen zu platzieren. Pakete können sowohl externe als auch reguläre PSQL-Prozeduren und -Funktionen enthalten.
Syntax {CREATE [OR ALTER] | RECREATE} PACKAGE package_name AS BEGIN [<package_item> ...] END {CREATE | RECREATE} PACKAGE BODY package_name AS BEGIN [<package_item> ...] [<package_body_item> ...] END <package_item> ::= <function_decl>; | <procedure_decl>; <function_decl> ::= FUNCTION func_name [(<in_params>)] RETURNS <type> [COLLATE collation] [DETERMINISTIC] <procedure_decl> ::= PROCEDURE proc_name [(<in_params>)] [RETURNS (<out_params>)] <package_body_item> ::= <function_impl> | <procedure_impl> <function_impl> ::= FUNCTION func_name [(<in_impl_params>)] RETURNS <type> [COLLATE collation] [DETERMINISTIC] <routine body> <procedure_impl> ::= PROCEDURE proc_name [(<in_impl_params>)] [RETURNS (<out_params>)] <routine body> <routine body> ::= <sql routine body> | <external body reference> <sql routine body> ::= AS [<declarations>] BEGIN [<PSQL_statements>] END <declarations> ::= <declare_item> [<declare_item> ...] <declare_item> ::= <declare_var>; | <declare_cursor>; | <subroutine declaration>; | <subroutine implimentation> <subroutine declaration> ::= <subfunc_decl> | <subproc_decl> <subroutine implimentation> ::= <subfunc_impl> | <subproc_impl> <external body reference> ::= EXTERNAL NAME <extname> ENGINE <engine> [AS <extbody>] <extname> ::= '<module name>!<routine name>[!<misc info>]'
Bei externen Prozeduren und Funktionen werden der Name des Pakets, die Eingabeparameter, ihre Typen, Standardwerte und Ausgabeparameter im Paketkopf angegeben, und im Paketkörper ist bis auf die Standardwerte sowie die Position im externen Modul (EXTERNAL NAME-Klausel) alles gleich. , den Namen des Motors und möglicherweise den "Körper" der Prozedur / Funktion.
Angenommen, Sie haben eine UDR für die Arbeit mit regulären Ausdrücken geschrieben, die sich im externen PCRE-Modul (dynamische Bibliothek) befindet, und Sie haben mehrere weitere UDRs, die andere Aufgaben ausführen. Wenn wir keine PSQL-Pakete verwendet hätten, würden alle unsere externen Prozeduren und Funktionen sowohl miteinander als auch mit normalen PSQL-Prozeduren und -Funktionen gemischt. Dies erschwert die Suche nach Abhängigkeiten und das Vornehmen von Änderungen an externen Modulen und führt außerdem zu Verwirrung und erzwingt zumindest die Verwendung von Präfixen zum Gruppieren von Prozeduren und Funktionen. PSQL-Pakete erleichtern uns diese Aufgabe erheblich.
RegExp-Paket SET TERM ^; CREATE OR ALTER PACKAGE REGEXP AS BEGIN PROCEDURE preg_match( APattern VARCHAR(8192), ASubject VARCHAR(8192)) RETURNS (Matches VARCHAR(8192)); FUNCTION preg_is_match( APattern VARCHAR(8192), ASubject VARCHAR(8192)) RETURNS BOOLEAN; FUNCTION preg_replace( APattern VARCHAR(8192), AReplacement VARCHAR(8192), ASubject VARCHAR(8192)) RETURNS VARCHAR(8192); PROCEDURE preg_split( APattern VARCHAR(8192), ASubject VARCHAR(8192)) RETURNS (Lines VARCHAR(8192)); FUNCTION preg_quote( AStr VARCHAR(8192), ADelimiter CHAR(10) DEFAULT NULL) RETURNS VARCHAR(8192); END^ RECREATE PACKAGE BODY REGEXP AS BEGIN PROCEDURE preg_match( APattern VARCHAR(8192), ASubject VARCHAR(8192)) RETURNS (Matches VARCHAR(8192)) EXTERNAL NAME 'PCRE!preg_match' ENGINE UDR; FUNCTION preg_is_match( APattern VARCHAR(8192), ASubject VARCHAR(8192)) RETURNS BOOLEAN AS BEGIN RETURN EXISTS( SELECT * FROM preg_match(:APattern, :ASubject)); END FUNCTION preg_replace( APattern VARCHAR(8192), AReplacement VARCHAR(8192), ASubject VARCHAR(8192)) RETURNS VARCHAR(8192) EXTERNAL NAME 'PCRE!preg_replace' ENGINE UDR; PROCEDURE preg_split( APattern VARCHAR(8192), ASubject VARCHAR(8192)) RETURNS (Lines VARCHAR(8192)) EXTERNAL NAME 'PCRE!preg_split' ENGINE UDR; FUNCTION preg_quote( AStr VARCHAR(8192), ADelimiter CHAR(10)) RETURNS VARCHAR(8192) EXTERNAL NAME 'PCRE!preg_quote' ENGINE UDR; END^ SET TERM ;^
Externe Trigger
Syntax {CREATE [OR ALTER] | RECREATE} TRIGGER trigname {<relation_trigger_legacy> | <relation_trigger_sql2003> | <database_trigger> | <ddl_trigger> } <external-body> <external-body> ::= EXTERNAL NAME <extname> ENGINE <engine> [AS <extbody>] <relation_trigger_legacy> ::= FOR {tablename | viewname} [ACTIVE | INACTIVE] {BEFORE | AFTER} <mutation_list> [POSITION number] <relation_trigger_sql2003> ::= [ACTIVE | INACTIVE] {BEFORE | AFTER} <mutation_list> [POSITION number] ON {tablename | viewname} <database_trigger> ::= [ACTIVE | INACTIVE] ON db_event [POSITION number] <ddl_trigger> ::= [ACTIVE | INACTIVE] {BEFORE | AFTER} <ddl_events> [POSITION number] <mutation_list> ::= <mutation> [OR <mutation> [OR <mutation>]] <mutation> ::= INSERT | UPDATE | DELETE <db_event> ::= CONNECT | DISCONNECT | TRANSACTION START | TRANSACTION COMMIT | TRANSACTION ROLLBACK <ddl_events> ::= ANY DDL STATEMENT | <ddl_event_item> [{OR <ddl_event_item>} ...] <ddl_event_item> ::= CREATE TABLE | ALTER TABLE | DROP TABLE | CREATE PROCEDURE | ALTER PROCEDURE | DROP PROCEDURE | CREATE FUNCTION | ALTER FUNCTION | DROP FUNCTION | CREATE TRIGGER | ALTER TRIGGER | DROP TRIGGER | CREATE EXCEPTION | ALTER EXCEPTION | DROP EXCEPTION | CREATE VIEW | ALTER VIEW | DROP VIEW | CREATE DOMAIN | ALTER DOMAIN | DROP DOMAIN | CREATE ROLE | ALTER ROLE | DROP ROLE | CREATE SEQUENCE | ALTER SEQUENCE | DROP SEQUENCE | CREATE USER | ALTER USER | DROP USER | CREATE INDEX | ALTER INDEX | DROP INDEX | CREATE COLLATION | DROP COLLATION | ALTER CHARACTER SET | CREATE PACKAGE | ALTER PACKAGE | DROP PACKAGE | CREATE PACKAGE BODY | DROP PACKAGE BODY | CREATE MAPPING | ALTER MAPPING | DROP MAPPING
Ein externer Trigger kann mit der Anweisung ALTER TRIGGER geändert werden.
Syntax:
ALTER TRIGGER trigname { [ACTIVE | INACTIVE] [ {BEFORE | AFTER} {<mutation_list> | <ddl_events>} | ON db_event ] [POSITION number] [<external-body>] <external-body> ::= EXTERNAL NAME <extname> ENGINE <engine> [AS <extbody>] <extname> ::= '<module name>!<routine name>[!<misc info>]' <mutation_list> ::= <mutation> [OR <mutation> [OR <mutation>]] <mutation> ::= { INSERT | UPDATE | DELETE }
Sie können einen externen Trigger mit der Anweisung DROP TRIGGER entfernen.
Syntax:
DROP TRIGGER trigname
Hier finden Sie Beispiele für die Deklaration externer Trigger mit Erläuterungen.
create database 'c:\temp\slave.fdb'; create table persons ( id integer not null, name varchar(60) not null, address varchar(60), info blob sub_type text ); commit; create database 'c:\temp\master.fdb'; create table persons ( id integer not null, name varchar(60) not null, address varchar(60), info blob sub_type text ); create table replicate_config ( name varchar(31) not null, data_source varchar(255) not null ); insert into replicate_config (name, data_source) values ('ds1', 'c:\temp\slave.fdb'); create trigger persons_replicate after insert on persons external name 'udrcpp_example!replicate!ds1' engine udr;
Die Trigger-Implementierung befindet sich im Modul udrcpp_example. Innerhalb dieses Moduls ist ein Trigger unter dem Namen replicate registriert. Ein externer Trigger verwendet die UDR-Engine.
In der Verknüpfung zum externen Modul wird ein zusätzlicher Parameter ds1 , mit dem die Konfiguration zum Lesen der externen Datenbank aus der Tabelle replicate_config vom externen Trigger gelesen wird.
UDR-Struktur
Jetzt ist die Zeit gekommen, den ersten UDR zu schreiben. Wir werden die Struktur von UDR in Pascal beschreiben. Um die minimale Struktur für die examples/udr/ eines UDR zu erläutern, verwenden wir Standardbeispiele aus examples/udr/ die in Pascal übersetzt wurden.
Erstellen Sie ein neues Projekt für die neue dynamische Bibliothek, die wir MyUdr nennen werden. Daher sollten Sie die Datei MyUdr.dpr (wenn Sie das Projekt in Delphi erstellt haben) oder die Datei MyUdr.lpr (wenn Sie das Projekt in Lazarus erstellt haben) erhalten. Ändern wir nun die Hauptprojektdatei so, dass sie folgendermaßen aussieht:
library MyUdr; {$IFDEF FPC} {$MODE DELPHI}{$H+} {$ENDIF} uses {$IFDEF unix} cthreads,
In diesem Fall müssen Sie nur eine firebird_udr_plugin Funktion firebird_udr_plugin , die der Einstiegspunkt für das Plug-In externer UDR-Module ist. Die Implementierung dieser Funktion befindet sich im UdrInit-Modul.
Bemerkung
Wenn Sie Ihren UDR in Free Pascal entwickeln, benötigen Sie zusätzliche Anweisungen. Die {$mode objfpc} ist erforderlich, um den Object Pascal-Modus zu aktivieren. Stattdessen können Sie die Direktive {$mode delphi} , um die Kompatibilität mit Delphi sicherzustellen. Da meine Beispiele sowohl in FPC als auch in Delphi erfolgreich kompiliert werden sollten, wähle ich den {$mode delphi} .
Die Direktive {$H+} unterstützt lange Zeichenfolgen. Dies ist erforderlich, wenn Sie die Typen string, ansistring und nicht nur nullterminierte Zeichenfolgen PChar, PAnsiChar, PWideChar verwenden.
Darüber hinaus müssen separate Module angeschlossen werden, um Multithreading unter Linux und anderen Unix-ähnlichen Betriebssystemen zu unterstützen.
Registrieren Sie Prozeduren, Funktionen oder Trigger
Fügen Sie nun das UdrInit-Modul hinzu, es sollte folgendermaßen aussehen:
unit UdrInit; {$IFDEF FPC} {$MODE DELPHI}{$H+} {$ENDIF} interface uses Firebird;
In der Funktion firebird_udr_plugin müssen die Fabriken unserer externen Prozeduren, Funktionen und Trigger registriert werden. Für jede Funktion, Prozedur oder jeden Trigger müssen Sie Ihre eigene Factory schreiben. Dies erfolgt mithilfe der IUdrPlugin-Schnittstellenmethoden:
- registerFunction - registriert eine externe Funktion;
- registerProcedure — ;
- registerTrigger — .
, ( ). // SQL. ( ).
. SumArgsFunc. .
SumArgsFunc unit SumArgsFunc; {$IFDEF FPC} {$MODE DELPHI}{$H+} {$ENDIF} interface uses Firebird;
IUdrFunctionFactory. IUdrFunctionFactoryImpl. . , , . .
dispose , . .
setup . , . .
newItem . , . IRoutineMetadata , . PSQL. . TSumArgsFunction .
IExternalFunction. IExternalFunctionImpl .
dispose , . .
.
getCharSet , . , .
execute . , , .
. , , BLOB. BLOB, .
, . , . , , , NULL ( Null ). , , IMessageMetadata. , execute.
. Für
Null Null
, NULL,
UDR . : . , .. EXECUTE PROCEDURE .
UdrInit firebird_udr_plugin .
function firebird_udr_plugin(AStatus: IStatus; AUnloadFlagLocal: BooleanPtr; AUdrPlugin: IUdrPlugin): BooleanPtr; cdecl; begin
Bemerkung
uses SumArgsProc, .
IUdrProcedureFactory. IUdrProcedureFactoryImpl. . , , . .
dispose , . .
setup . , . .
newItem . , . IRoutineMetadata , . PSQL. . TSumArgsProcedure .
SumArgsProc.
SumArgsProc unit SumArgsProc; {$IFDEF FPC} {$MODE DELPHI}{$H+} {$ENDIF} interface uses Firebird; type
IExternalProcedure. IExternalProcedureImpl .
dispose , . .
getCharSet . , .
open . , , . , nil, . . TSumArgsFunction.execute.
UDR . firebird_udr_plugin .
function firebird_udr_plugin(AStatus: IStatus; AUnloadFlagLocal: BooleanPtr; AUdrPlugin: IUdrPlugin): BooleanPtr; cdecl; begin
Bemerkung
uses GenRowsProc, .
. , open, .
GenRowsProc unit GenRowsProc; {$IFDEF FPC} {$MODE DELPHI}{$H+} {$ENDIF} interface uses Firebird, SysUtils; type TInput = record start: Integer; startNull: WordBool; finish: Integer; finishNull: WordBool; end; PInput = ^TInput; TOutput = record n: Integer; nNull: WordBool; end; POutput = ^TOutput;
open TGenRowsProcedure NULL, NULL, NULL, SELECT, nil.
, , . UDR Firebird. UDR Legacy UDF.
, open , IExternalResultSet. IExternalResultSetImpl .
dispose . .
fetch SELECT. SUSPEND PSQL . , . true, , false , . , .
Bemerkung
Delphi yeild,
while(...) do { ... yield result; }
, open, , fetch. ( SELECT FIRST/ROWS/FETCH FIRST SELECT.)
UDR .
Hinweis
C++ . , . .
UdrInit firebird_udr_plugin .
function firebird_udr_plugin(AStatus: IStatus; AUnloadFlagLocal: BooleanPtr; AUdrPlugin: IUdrPlugin): BooleanPtr; cdecl; begin
Bemerkung
uses TestTrigger, .
IUdrTriggerFactory. IUdrTriggerFactoryImpl.
.
dispose , . .
setup . , . .
newItem . , . IRoutineMetadata , . PSQL. . TMyTrigger .
TestTrigger.
TestTrigger unit TestTrigger; {$IFDEF FPC} {$MODE DELPHI}{$H+} {$ENDIF} interface uses Firebird, SysUtils; type
IExternalTrigger. IExternalTriggerImpl .
dispose , . .
getCharSet . , .
execute . , , () . () IExternalTrigger. ACTION_ . , Firebird . , DDL , , , nil. . , , .
Bemerkung
, , . IMessageMetadata. , . , , /.
, PSQL
if (:new.B IS NULL) THEN :new.B = :new.A + 1;
Nachrichten
UDR , . NEW OLD.
, , .
:
( Delphi , .. record);
IMessageMetadata, / , .
, — , UDR.
. :
TMyStruct = record <var_1>: <type_1>; <nullIndicator_1>: WordBool; <var_2>: <type_1>; <nullIndicator_2>: WordBool; ... <var_N>: <type_1>; <nullIndicator_N>: WordBool; end; PMyStruct = ^TMyStruct;
/ ( ). Null- /, NOT NULL. Null- 2 . -1
/ NULL. NULL- NULL, 2- . SQL :
, .
:
function SUM_ARGS(A SMALLINT, B INTEGER) RETURNS BIGINT ....
:
TInput = record A: Smallint; ANull: WordBool; B: Integer; BNull: WordBool; end; PInput = ^TInput; TOutput = record Value: Int64; Null: WordBool; end; POutput = ^TOutput;
( 3 ):
function SUM_ARGS(A NUMERIC(4, 2), B NUMERIC(9, 3)) RETURNS NUMERIC(18, 6) ....
:
TInput = record A: Smallint; ANull: WordBool; B: Integer; BNull: WordBool; end; PInput = ^TInput; TOutput = record Value: Int64; Null: WordBool; end; POutput = ^TOutput;
:
procedure SOME_PROC(A CHAR(3) CHARACTER SET WIN1251, B VARCHAR(10) CHARACTER SET UTF8) ....
:
TInput = record A: array[0..2] of AnsiChar; ANull: WordBool; B: record Length: Smallint; Value: array[0..39] of AnsiChar; end; BNull: WordBool; end; PInput = ^TInput;
IMessageMetadata. /
:
- /;
- ;
- ;
- BLOB;
- /;
- / NULL;
- ;
- NULL-.
getCount
unsigned getCount(StatusType* status)
/ . , , : 0 <= index < getCount().
getField
const char* getField(StatusType* status, unsigned index)
.
getRelation
const char* getRelation(StatusType* status, unsigned index)
( ).
getOwner
const char* getOwner(StatusType* status, unsigned index)
.
getAlias
const char* getAlias(StatusType* status, unsigned index)
.
getType
unsigned getType(StatusType* status, unsigned index)
SQL .
isNullable
FB_BOOLEAN isNullable(StatusType* status, unsigned index)
true, NULL.
getSubType
int getSubType(StatusType* status, unsigned index)
BLOB (0 — , 1 — . .).
getLength
unsigned getLength(StatusType* status, unsigned index)
.
getScale
int getScale(StatusType* status, unsigned index)
.
getCharSet
unsigned getCharSet(StatusType* status, unsigned index)
BLOB.
getOffset
unsigned getOffset(StatusType* status, unsigned index)
( ).
getNullOffset
unsigned getNullOffset(StatusType* status, unsigned index)
NULL .
getBuilder
IMetadataBuilder* getBuilder(StatusType* status)
IMetadataBuilder, .
getMessageLength
unsigned getMessageLength(StatusType* status)
( ).
IMessageMetadata IRoutineMetadata. , . . Zum Beispiel:
IMessageMetadata getInputMetadata getOutputMetadata IRoutineMetadata. , , getTriggerMetadata.
, IMessageMetadata . IReferenceCounted. getInputMetadata getOutputMetadata 1 , xInputMetadata xOutputMetadata release.
. IMessageMetadata getOffset . .
null , getNullOffset.
. .
, . IUdrProcedureFactory, IUdrFunctionFactory IUdrTriggerFactory UDR. UDR firebird_udr_plugin .
function firebird_udr_plugin(AStatus: IStatus; AUnloadFlagLocal: BooleanPtr; AUdrPlugin: IUdrPlugin): BooleanPtr; cdecl; begin
TSumArgsFunctionFactory IUdrFunctionFactory, TGenRowsFactory IUdrProcedureFactory, TMyTriggerFactory IUdrTriggerFactory.
, . Firebird. , SuperServer , Classic
.
setup newItem IUdrProcedureFactory, IUdrFunctionFactory IUdrTriggerFactory.
IUdrFunctionFactory = class(IDisposable) const VERSION = 3; procedure setup(status: IStatus; context: IExternalContext; metadata: IRoutineMetadata; inBuilder: IMetadataBuilder; outBuilder: IMetadataBuilder); function newItem(status: IStatus; context: IExternalContext; metadata: IRoutineMetadata): IExternalFunction; end; IUdrProcedureFactory = class(IDisposable) const VERSION = 3; procedure setup(status: IStatus; context: IExternalContext; metadata: IRoutineMetadata; inBuilder: IMetadataBuilder; outBuilder: IMetadataBuilder); function newItem(status: IStatus; context: IExternalContext; metadata: IRoutineMetadata): IExternalProcedure; end; IUdrTriggerFactory = class(IDisposable) const VERSION = 3; procedure setup(status: IStatus; context: IExternalContext; metadata: IRoutineMetadata; fieldsBuilder: IMetadataBuilder); function newItem(status: IStatus; context: IExternalContext; metadata: IRoutineMetadata): IExternalTrigger; end;
, IDisposable, dispose. Firebird , . dispose , , .
IUdrProcedureFactoryImpl , IUdrFunctionFactoryImpl , IUdrTriggerFactoryImpl . .
newItem
newItem , . UDR , .. , . .
. , , , IUdrFunctionFactory . . .
newItem ,
UDR UDR.
function TSumArgsFunctionFactory.newItem(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata): IExternalFunction; begin
IRoutineMetadata , UDR . UDR. UDR .
setup
setup . IMetadataBuilder, , .
setup, setup DLL , . .
. , SumArgs.
,
type
, setup , .
SumArgsFunctionFactory procedure TSumArgsFunctionFactory.dispose; begin Destroy; end; function TSumArgsFunctionFactory.newItem(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata): IExternalFunction; begin Result := TSumArgsFunction.Create(); end; procedure TSumArgsFunctionFactory.setup(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata; AInBuilder, AOutBuilder: IMetadataBuilder); begin
SQL Firebird . , SQL NULL. XSQLDA.
procedure TSumArgsFunction.execute(AStatus: IStatus; AContext: IExternalContext; AInMsg, AOutMsg: Pointer); var xInput: PSumArgsInMsg; xOutput: PSumArgsOutMsg; begin
, , , setup.
create or alter function FN_SUM_ARGS ( N1 varchar(15), N2 varchar(15), N3 varchar(15)) returns varchar(15) EXTERNAL NAME 'MyUdrSetup!sum_args' ENGINE UDR;
select FN_SUM_ARGS('15', '21', '35') from rdb$database
UDR , UDR. . Delphi 2009, Free Pascal FPC 2.2.
Bemerkung
Free Pascal
Delphi. FPC 2.6.0 Delphi
.
:
newItem . IUdrFunctionFactoryImpl , IUdrProcedureFactoryImpl , IUdrTriggerFactoryImpl . :
SimpleFactories unit UdrFactories; {$IFDEF FPC} {$MODE DELPHI}{$H+} {$ENDIF} interface uses SysUtils, Firebird; type
setup , , dispose . newItem T .
implementation procedure TProcedureSimpleFactory<T>.dispose; begin Destroy; end; function TProcedureSimpleFactory<T>.newItem(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata): IExternalProcedure; begin Result := T.Create; end; procedure TProcedureSimpleFactory<T>.setup(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata; AInBuilder, AOutBuilder: IMetadataBuilder); begin end; procedure TFunctionSimpleFactory<T>.dispose; begin Destroy; end; function TFunctionSimpleFactory<T>.newItem(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata): IExternalFunction; begin Result := T.Create; end; procedure TFunctionSimpleFactory<T>.setup(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata; AInBuilder, AOutBuilder: IMetadataBuilder); begin end; procedure TTriggerSimpleFactory<T>.dispose; begin Destroy; end; function TTriggerSimpleFactory<T>.newItem(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata): IExternalTrigger; begin Result := T.Create; end; procedure TTriggerSimpleFactory<T>.setup(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata; AFieldsBuilder: IMetadataBuilder); begin end;
1 , . :
function firebird_udr_plugin(AStatus: IStatus; AUnloadFlagLocal: BooleanPtr; AUdrPlugin: IUdrPlugin): BooleanPtr; cdecl; begin
. , . newItem . UDR IRoutineMetadata , Firebird, UDR. , , UDR, ,
UDR. , , .
unit UdrFactories; {$IFDEF FPC} {$MODE DELPHI}{$H+} {$ENDIF} interface uses SysUtils, Firebird; type ...
, .
unit UdrFactories; {$IFDEF FPC} {$MODE DELPHI}{$H+} {$ENDIF} interface uses SysUtils, Firebird; type ...
, .
UDR .
unit UdrFactories; {$IFDEF FPC} {$MODE DELPHI}{$H+} {$ENDIF} interface uses SysUtils, Firebird; type ...
newItem ,
, .
implementation ... procedure TFunctionFactory<T>.dispose; begin Destroy; end; function TFunctionFactory<T>.newItem(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata): IExternalFunction; begin Result := T.Create; (Result as T).Metadata := AMetadata; end; procedure TFunctionFactory<T>.setup(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata; AInBuilder, AOutBuilder: IMetadataBuilder); begin end; procedure TProcedureFactory<T>.dispose; begin Destroy; end; function TProcedureFactory<T>.newItem(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata): IExternalProcedure; begin Result := T.Create; (Result as T).Metadata := AMetadata; end; procedure TProcedureFactory<T>.setup(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata; AInBuilder, AOutBuilder: IMetadataBuilder); begin end; procedure TTriggerFactory<T>.dispose; begin Destroy; end; function TTriggerFactory<T>.newItem(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata): IExternalTrigger; begin Result := T.Create; (Result as T).Metadata := AMetadata; end; procedure TTriggerFactory<T>.setup(AStatus: IStatus; AContext: IExternalContext; AMetadata: IRoutineMetadata; AFieldsBuilder: IMetadataBuilder); begin end;
https://github.com/sim1984/udr-book/blob/master/examples/Common/UdrFactories.pas .
BLOB
BLOB ( BLOB), . , BLOB , . BLOB . BLOB
IBlob .
BLOB , BLOB , BLOB , BLOB .
BLOB , BLOB (), 64 . getSegment IBlob . putSegment IBlob .
BLOB
BLOB
(
LIST).
create procedure split ( txt blob sub_type text character set utf8, delimiter char(1) character set utf8 = ',' ) returns ( id integer ) external name 'myudr!split' engine udr;
:
function firebird_udr_plugin(AStatus: IStatus; AUnloadFlagLocal: BooleanPtr; AUdrPlugin: IUdrPlugin): BooleanPtr; cdecl; begin
, . .
. .
TInput = record txt: ISC_QUAD; txtNull: WordBool; delimiter: array [0 .. 3] of AnsiChar; delimiterNull: WordBool; end; TInputPtr = ^TInput; TOutput = record Id: Integer; Null: WordBool; end; TOutputPtr = ^TOutput;
BLOB BLOB, ISC_QUAD .
:
Split TSplitProcedure = class(IExternalProcedureImpl) private procedure SaveBlobToStream(AStatus: IStatus; AContext: IExternalContext; ABlobId: ISC_QUADPtr; AStream: TStream); function readBlob(AStatus: IStatus; AContext: IExternalContext; ABlobId: ISC_QUADPtr): string; public
SaveBlobToStream readBlob BLOB. BLOB , — Delphi. OutputArray Counter.
open BLOB . Split . .
TSplitProcedure.open function TSplitProcedure.open(AStatus: IStatus; AContext: IExternalContext; AInMsg, AOutMsg: Pointer): IExternalResultSet; var xInput: TInputPtr; xText: string; xDelimiter: string; begin xInput := AInMsg; if xInput.txtNull or xInput.delimiterNull then begin Result := nil; Exit; end; xText := readBlob(AStatus, AContext, @xInput.txt); xDelimiter := TFBCharSet.CS_UTF8.GetString(TBytes(@xInput.delimiter), 0, 4);
Bemerkung
TFBCharSet Firebird.pas.
Firebird.
UTF-8.
FbCharsets.pas
BLOB . BLOB . openBlob IAttachment . BLOB , . ,
( IExternalContext ).
BLOB (), 64 . getSegment IBlob .
TSplitProcedure.SaveBlobToStream procedure TSplitProcedure.SaveBlobToStream(AStatus: IStatus; AContext: IExternalContext; ABlobId: ISC_QUADPtr; AStream: TStream); var att: IAttachment; trx: ITransaction; blob: IBlob; buffer: array [0 .. 32767] of AnsiChar; l: Integer; begin try att := AContext.getAttachment(AStatus); trx := AContext.getTransaction(AStatus); blob := att.openBlob(AStatus, trx, ABlobId, 0, nil); while True do begin case blob.getSegment(AStatus, SizeOf(buffer), @buffer, @l) of IStatus.RESULT_OK: AStream.WriteBuffer(buffer, l); IStatus.RESULT_SEGMENT: AStream.WriteBuffer(buffer, l); else break; end; end; AStream.Position := 0; blob.close(AStatus); finally if Assigned(att) then att.release; if Assigned(trx) then trx.release; if Assigned(blob) then blob.release; end; end;
Bemerkung
, IAttachment , ITransaction IBlob
IReferenceCounted ,
.
1.
release.
SaveBlobToStream BLOB
:
function TSplitProcedure.readBlob(AStatus: IStatus; AContext: IExternalContext; ABlobId: ISC_QUADPtr): string; var {$IFDEF FPC} xStream: TBytesStream; {$ELSE} xStream: TStringStream; {$ENDIF} begin {$IFDEF FPC} xStream := TBytesStream.Create(nil); {$ELSE} xStream := TStringStream.Create('', 65001); {$ENDIF} try SaveBlobToStream(AStatus, AContext, ABlobId, xStream); {$IFDEF FPC} Result := TEncoding.UTF8.GetString(xStream.Bytes, 0, xStream.Size); {$ELSE} Result := xStream.DataString; {$ENDIF} finally xStream.Free; end; end;
Bemerkung
Free Pascal
Delphi TStringStream . FPC
,
.
fetch Counter , . . isc_convert_error .
isc_convert_error procedure TSplitResultSet.dispose; begin SetLength(OutputArray, 0); Destroy; end; function TSplitResultSet.fetch(AStatus: IStatus): Boolean; var statusVector: array [0 .. 4] of NativeIntPtr; begin if Counter <= High(OutputArray) then begin Output.Null := False;
Bemerkung
isc_random
, .
:
SELECT ids.ID FROM SPLIT((SELECT LIST(ID) FROM MYTABLE), ',') ids
Bemerkung
, BLOB
,
.
,
.
fetch .
BLOB
BLOB
BLOB .
Bemerkung
UDF
BLOB / . UDF
blobsaveload.zip
BLOB /
CREATE PACKAGE BlobFileUtils AS BEGIN PROCEDURE SaveBlobToFile(ABlob BLOB, AFileName VARCHAR(255) CHARACTER SET UTF8); FUNCTION LoadBlobFromFile(AFileName VARCHAR(255) CHARACTER SET UTF8) RETURNS BLOB; END^ CREATE PACKAGE BODY BlobFileUtils AS BEGIN PROCEDURE SaveBlobToFile(ABlob BLOB, AFileName VARCHAR(255) CHARACTER SET UTF8) EXTERNAL NAME 'BlobFileUtils!SaveBlobToFile' ENGINE UDR; FUNCTION LoadBlobFromFile(AFileName VARCHAR(255) CHARACTER SET UTF8) RETURNS BLOB EXTERNAL NAME 'BlobFileUtils!LoadBlobFromFile' ENGINE UDR; END^
:
function firebird_udr_plugin(AStatus: IStatus; AUnloadFlagLocal: BooleanPtr; AUdrPlugin: IUdrPlugin): BooleanPtr; cdecl; begin
BLOB , UDR
06.BlobSaveLoad . LoadBlobFromFile :
interface uses Firebird, Classes, SysUtils; type
execute TLoadBlobFromFile , .
execute procedure TLoadBlobFromFileFunc.execute(AStatus: IStatus; AContext: IExternalContext; AInMsg: Pointer; AOutMsg: Pointer); const MaxBufSize = 16384; var xInput: TInputPtr; xOutput: TOutputPtr; xFileName: string; xStream: TFileStream; att: IAttachment; trx: ITransaction; blob: IBlob; buffer: array [0 .. 32767] of Byte; xStreamSize: Integer; xBufferSize: Integer; xReadLength: Integer; begin xInput := AInMsg; xOutput := AOutMsg; if xInput.filenameNull then begin xOutput.blobDataNull := True; Exit; end; xOutput.blobDataNull := False;
BLOB blobId createBlob IAttachment . BLOB , . , ( IExternalContext ).
BLOB, putSegment IBlob , . close .
BLOB
BLOB
, BLOB .
BLOB,
.
Delphi Free Pascal
.
IBlob
/ Blob.
FbBlob, .
BlobHelper unit FbBlob; interface uses Classes, SysUtils, Firebird; const MAX_SEGMENT_SIZE = $7FFF; type TFbBlobHelper = class helper for IBlob procedure LoadFromStream(AStatus: IStatus; AStream: TStream); procedure SaveToStream(AStatus: IStatus; AStream: TStream); end; implementation uses Math; procedure TFbBlobHelper.LoadFromStream(AStatus: IStatus; AStream: TStream); var xStreamSize: Integer; xReadLength: Integer; xBuffer: array [0 .. MAX_SEGMENT_SIZE] of Byte; begin xStreamSize := AStream.Size; AStream.Position := 0; while xStreamSize <> 0 do begin xReadLength := Min(xStreamSize, MAX_SEGMENT_SIZE); AStream.ReadBuffer(xBuffer, xReadLength); Self.putSegment(AStatus, xReadLength, @xBuffer[0]); Dec(xStreamSize, xReadLength); end; end; procedure TFbBlobHelper.SaveToStream(AStatus: IStatus; AStream: TStream); var xInfo: TFbBlobInfo; Buffer: array [0 .. MAX_SEGMENT_SIZE] of Byte; xBytesRead: Cardinal; xBufferSize: Cardinal; begin AStream.Position := 0; xBufferSize := Min(SizeOf(Buffer), MAX_SEGMENT_SIZE); while True do begin case Self.getSegment(AStatus, xBufferSize, @Buffer[0], @xBytesRead) of IStatus.RESULT_OK: AStream.WriteBuffer(Buffer, xBytesRead); IStatus.RESULT_SEGMENT: AStream.WriteBuffer(Buffer, xBytesRead); else break; end; end; end; end.
BLOB, BLOB :
TLoadBlobFromFileFunc.execute procedure TLoadBlobFromFileFunc.execute(AStatus: IStatus; AContext: IExternalContext; AInMsg: Pointer; AOutMsg: Pointer); var xInput: TInputPtr; xOutput: TOutputPtr; xFileName: string; xStream: TFileStream; att: IAttachment; trx: ITransaction; blob: IBlob; begin xInput := AInMsg; xOutput := AOutMsg; if xInput.filenameNull then begin xOutput.blobDataNull := True; Exit; end; xOutput.blobDataNull := False;
, , , / . , BLOB.
, IExternalContext execute , open . IExternalContext getAttachment , getTransaction . UDR, , , startTransaction IExternalContext . . , , .. (2PC).
, SELECT JSON. :
create function GetJson ( sql_text blob sub_type text character set utf8, sql_dialect smallint not null default 3 ) returns returns blob sub_type text character set utf8 external name 'JsonUtils!getJson' engine udr;
SQL , , . IMessageMetadata . , ,
Firebird.
Bemerkung
JSON .
CHAR, VARCHAR OCTETS NONE BLOB SUB_TYPE BINARY
base64,
JSON.
:
function firebird_udr_plugin(AStatus: IStatus; AUnloadFlagLocal: BooleanPtr; AUdrPlugin: IUdrPlugin): BooleanPtr; cdecl; begin
, :
GetJson unit JsonFunc; {$IFDEF FPC} {$MODE objfpc}{$H+} {$DEFINE DEBUGFPC} {$ENDIF} interface uses Firebird, UdrFactories, FbTypes, FbCharsets, SysUtils, System.NetEncoding, System.Json;
MakeScaleInteger , writeJson Json . , execute .
TJsonFunction.execute procedure TJsonFunction.execute(AStatus: IStatus; AContext: IExternalContext; AInMsg, AOutMsg: Pointer); var xFormatSettings: TFormatSettings; xInput: InputPtr; xOutput: OutputPtr; att: IAttachment; tra: ITransaction; stmt: IStatement; inBlob, outBlob: IBlob; inStream: TBytesStream; outStream: TStringStream; cursorMetaData: IMessageMetadata; rs: IResultSet; msgLen: Cardinal; msg: Pointer; jsonArray: TJsonArray; begin xInput := AInMsg; xOutput := AOutMsg;
getAttachment getTransaction IExternalContext . BLOB SQL . prepare IAttachment . SQL . IStatement.PREPARE_PREFETCH_METADATA , . getOutputMetadata IStatement .
Bemerkung
getOutputMetadata .
IStatement.PREPARE_PREFETCH_METADATA
.
, .
openCursor ( 2). getMessageLength IMessageMetadata . , .
fetchNext IResultSet . msg IStatus.RESULT_OK , . writeJson , TJsonObject TJsonArray .
, close , Json , , Blob.
writeJson . IUtil , . IMessageMetadata . TJsonObject . . NullFlag, null , Json.
writeJson function TJsonFunction.MakeScaleInteger(AValue: Int64; Scale: Smallint): string; var L: Integer; begin Result := AValue.ToString; L := Result.Length; if (-Scale >= L) then Result := '0.' + Result.PadLeft(-Scale, '0') else Result := Result.Insert(Scale + L, '.'); end; procedure TJsonFunction.writeJson(AStatus: IStatus; AContext: IExternalContext; AJson: TJsonArray; ABuffer: PByte; AMeta: IMessageMetadata; AFormatSettings: TFormatSettings); var jsonObject: TJsonObject; i: Integer; FieldName: string; NullFlag: WordBool; pData: PByte; util: IUtil; metaLength: Integer;
Bemerkung
TFbType Firebird.pas .
,
FbTypes .
TFBCharSet Firebird.pas .
FbCharsets . ,
,
, , ,
TEncoding ,
Delphi.
CHAR VARCHAR , OCTETS, base64, Delphi. , VARCHAR 2 .
SMALLINT, INTEGER, BIGINT , . getScale IMessageMetadata . 0, , MakeScaleInteger .
DATE, TIME TIMESTAMP decodeDate decodeTime IUtil . - Delphi TDateTime .
BLOB Delphi. BLOB , TBytesStream . base64. BLOB , TStringStream , . BLOB
.
Das ist alles UDR Firebird, .