منذ فترة طويلة Firebird قادرة على توسيع قدرات لغة PSQL عن طريق كتابة وظائف خارجية - UDF (وظائف محددة من قبل المستخدم). يمكن كتابة UDF في أي لغة برمجة مترجمة تقريبًا.
قدم Firebird 3.0 بنية في المكونات لتوسيع قدرات Firebird. أحد هذه المكونات الإضافية هو محرك خارجي (محركات خارجية). تضيف آلية UDR (إجراءات محددة من قبل المستخدم - إجراءات محددة من قبل المستخدم) طبقة أعلى واجهة محرك FirebirdExternal.
في هذا الدليل ، سوف نخبرك بكيفية الإعلان عن UDR وعن آلياتها وقدراتها الداخلية وإعطاء أمثلة لكتابة UDR في Pascal. بالإضافة إلى ذلك ، سيتم تغطية بعض جوانب استخدام واجهة برمجة التطبيقات الجديدة الموجهة للكائنات.
تعليق
تهدف هذه المقالة إلى تعليمك كيفية كتابة UDR باستخدام كائن Firebird API.
قد لا يكون للوظائف والإجراءات المكتوبة تطبيق عملي.
UDRs لها المزايا التالية على Legacy UDF:
- يمكنك كتابة ليس فقط الوظائف التي تُرجع نتيجة عددية ، ولكن أيضًا الإجراءات المخزنة (سواء القابلة للتنفيذ أو الانتقائية) ، وكذلك المشغلات ؛
- تحسين السيطرة على المدخلات والمخرجات المعلمات. في بعض الحالات (بالمرور بواسطة واصف) لم يتم التحكم في الأنواع والخصائص الأخرى لمعلمات الإدخال على الإطلاق ، ومع ذلك ، يمكنك الحصول على هذه الخصائص داخل UDF. توفر UDRs طريقة أكثر توحيدًا لإعلان معلمات الإدخال والإخراج ، كما هو الحال مع وظائف وإجراءات PSQL العادية ؛
- UDR سياق الاتصال الحالي أو المعاملة المتاحة ، والذي يسمح لك لأداء
بعض التلاعب مع قاعدة البيانات الحالية في هذا السياق ؛ - يتوفر إنشاء خطأ Firebird عند حدوث استثناءات ؛ ليست هناك حاجة لإرجاع قيمة خاصة ؛
- يمكن تجميع الإجراءات والوظائف الخارجية (UDR) في حزم PSQL ؛
- يمكن كتابة UDR بأية لغة برمجة (يتم تجميعها اختياريًا في رموز الكائنات) ، لذلك من الضروري كتابة المكون الإضافي المقابل للمحرك الخارجي. على سبيل المثال ، هناك مكونات إضافية لكتابة الوحدات الخارجية في Java أو بأي من لغات .NET.
تعليق
يستخدم تطبيق UDR الحالي كعب روتين PSQL. على سبيل المثال ، يتم استخدامه ل
التحقق من المعلمات وقيم الإرجاع للامتثال للقيود. كاب
تم استخدامه بسبب عدم المرونة لاستدعاء الوظائف الداخلية مباشرة. النتائج
يُظهر اختبار مقارنة أداء UDR و UDF أن UDR تقريبًا
أبطأ مرتين ونصف باستخدام أبسط وظيفة لإضافة حجة اثنين كمثال. سرعة
UDR مساوية تقريبًا لسرعة وظيفة PSQL عادية. ربما في المستقبل هذا
سيتم تحسين اللحظة. في وظائف أكثر تعقيدا ، يمكن أن تصبح هذه النفقات العامة
غير محسوس.
كذلك في أجزاء مختلفة من هذا الدليل ، عند استخدام مصطلحات الإجراءات الخارجية ،
وظيفة أو الزناد سوف نعني UDR بالضبط (وليس UDF).
تعليق
جميع الأمثلة لدينا تعمل على دلفي 2009 وما بعده ، وكذلك على Free Pascal. جميع
يمكن تجميع الأمثلة في كل من دلفي وباسكال فري ، إذا
غير محدد بشكل منفصل.
Firebird API
لكتابة الإجراءات أو الوظائف أو المشغلات الخارجية بلغات البرمجة المترجمة ، نحتاج إلى معرفة واجهة برمجة تطبيقات Firebird API الجديدة. لا يتضمن هذا الدليل وصفًا كاملاً لواجهة Firebird API. يمكنك قراءتها في دليل الوثائق الموزع باستخدام Firebird ( doc/Using_OO_API.html
).
لا يتم توزيع المكونات الإضافية لمختلف لغات البرمجة التي تحتوي على واجهات برمجة التطبيقات كجزء من توزيع Firebird لنظام التشغيل Windows ، ولكن يمكنك استخراجها من ملفات tarbar المضغوطة الموزعة بواسطة Linux (المسار داخل أرشيف /opt/firebird/include/firebird/Firebird.pas
).
CLOOP
CLOOP - البرمجة المشتركة للكائنات ذات اللغة. لا يتم تضمين هذه الأداة مع Firebird. يمكن العثور عليه في التعليمات البرمجية المصدر https://github.com/FirebirdSQL/firebird/tree/B3_0_Release/extern/cloop . بعد تجميع الأداة ، يمكنك إنشاء واجهة برمجة تطبيقات للغة البرمجة الخاصة بك ( IdlFbInterfaces.h
أو Firebird.pas
) بناءً على ملف وصف include/firebird/FirebirdInterface.idl
.
بالنسبة لكائن pascal ، يتم ذلك باستخدام الأمر التالي:
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
يمكن العثور على fb_get_master_interface.pas
و fb_get_master_interface.pas
و fb_get_master_interface.pas
على https://github.com/FirebirdSQL/firebird/tree/B3_0_Release/src/misc/pascal .
تعليق
في هذه الحالة ، سيتم إضافة البادئة I لواجهة برمجة تطبيقات Firebird ، حيث يتم قبول ذلك في Object Pascal.
الثوابت
لا توجد isc_*
في ملف Firebird.pas
الناتج. يمكن العثور على هذه الثوابت للغات C / C ++ على https://github.com/FirebirdSQL/firebird/blob/B3_0_Release/src/include/consts_pub.h . للحصول على ثوابت لغة Pascal ، سوف نستخدم البرنامج النصي AWK لتحويل بناء الجملة. في نظام Windows ، ستحتاج إلى تثبيت Gawk لنظام Windows أو استخدام نظام Windows الفرعي لنظام Linux (متاح على نظام Windows 10). يتم ذلك باستخدام الأمر التالي:
awk -f Pascal.Constants.awk consts_pub.h > const.pas
يجب نسخ محتويات الملف الناتج إلى قسم const الفارغ في ملف Firebird.pas
مباشرة بعد التنفيذ. يمكن العثور على ملف Pascal.Constants.awk
في
https://github.com/FirebirdSQL/firebird/tree/B3_0_Release/src/misc/pascal .
إدارة الوقت الحياة
لا تعتمد واجهات Firebird على مواصفات COM ، لذا فإن إدارة حياتها مختلفة.
هناك واجهتان في Firebird تتعاملان مع إدارة مدى الحياة: IDisposable و IReferenceCounted. يكون الأخير نشطًا بشكل خاص عند إنشاء واجهات أخرى: يقوم IPlugin بحساب الروابط ، مثل العديد من الواجهات الأخرى التي تستخدمها المكونات الإضافية. تتضمن هذه واجهات تصف كيفية الاتصال بقاعدة بيانات وإدارة المعاملات وعبارات SQL.
الحمل الإضافي للواجهة مع حساب المرجع ليس ضروريًا دائمًا. على سبيل المثال ، تتمتع IMaster ، الواجهة الرئيسية التي تستدعي الوظائف المتاحة لبقية واجهة برمجة التطبيقات ، بعمر غير محدود بحكم التعريف. بالنسبة لواجهات برمجة التطبيقات الأخرى ، يتم تحديد العمر بدقة بواسطة عمر الواجهة الأصل ؛ واجهة IStatus ليست كذلك
مؤشرات. بالنسبة للواجهات ذات العمر المحدود ، من المفيد أن يكون لديك طريقة بسيطة لتدميرها ، أي وظيفة التخلص ().
مساعدة
إذا كنت لا تعرف كيف يتم تدمير كائن ما ، فراجع التسلسل الهرمي له
واجهة IReferenceCounted ، ثم يتم استخدام مرجع العد.
بالنسبة للواجهات التي لها حساب مرجعي ، عند الانتهاء من العمل مع كائن ، من الضروري
إنقاص العداد المرجع عن طريق استدعاء الأسلوب release ().
إعلان UDR
يمكن إضافة UDRs أو إزالتها من قاعدة البيانات باستخدام أوامر DDL ، تمامًا كما تضيف أو تزيل إجراءات أو وظائف أو مشغلات PSQL العادية. في هذه الحالة ، بدلاً من نص المشغل ، تتم الإشارة إلى موقعه في الوحدة الخارجية باستخدام جملة EXTERNAL NAME.
النظر في بناء جملة هذه الجملة ، وسوف تكون مشتركة بين الإجراءات الخارجية ، وظائف ، والمشغلات.
بناء الجملة:
EXTERNAL NAME '<extname>' ENGINE <engine> [AS <extbody>] <extname> ::= '<module name>!<routine name>[!<misc info>]'
الوسيطة إلى جملة EXTERNAL NAME عبارة عن سلسلة تشير إلى موقع الوظيفة في الوحدة النمطية الخارجية. بالنسبة للوحدات الخارجية التي تستخدم محرك UDR ، يشير هذا الخط عبر الفاصل إلى اسم الوحدة الخارجية واسم الوظيفة داخل الوحدة النمطية والمعلومات المعرفة من قبل المستخدم. يتم استخدام علامة تعجب (!) كفاصل.
تحدد جملة Engine اسم المحرك لمعالجة اتصال الوحدات الخارجية. يستخدم Firebird محرك UDR للعمل مع الوحدات الخارجية المكتوبة بلغات مترجمة (C ، C ++ ، Pascal). تتطلب الوظائف الخارجية المكتوبة بلغة جافا محرك جافا.
بعد الكلمة الأساسية AS ، يمكن تحديد حرفي السلسلة - "نص" الوحدة النمطية الخارجية (الإجراء أو الوظيفة أو المشغل) ، ويمكن استخدامه بواسطة الوحدة النمطية الخارجية لأغراض مختلفة. على سبيل المثال ، قد يتم تحديد استعلام SQL للوصول إلى قاعدة بيانات أو نص خارجي في بعض اللغات للترجمة بواسطة وظيفتك.
وظائف خارجية
بناء الجملة {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])]
يمكن تغيير جميع معلمات الوظيفة الخارجية باستخدام عبارة ALTER FUNCTION.
بناء الجملة:
ALTER FUNCTION funcname [(<inparam> [, <inparam> ...])] RETURNS <type> [COLLATE collation] [DETERMINISTIC] EXTERNAL NAME <extname> ENGINE <engine> [AS <extbody>] <extname> ::= '<module name>!<routine name>[!<misc info>]'
يمكنك حذف وظيفة خارجية باستخدام عبارة DROP FUNCTION.
بناء الجملة:
DROP FUNCTION funcname
هنا لن نصف بناء جملة معلمات الإدخال والإخراج. يتوافق بشكل كامل مع بناء جملة وظائف PSQL العادية ، والتي تم وصفها بالتفصيل في دليل لغة SQL. بدلاً من ذلك ، نقدم أمثلة على الإعلان عن الوظائف الخارجية مع التفسيرات.
وظيفة إضافة ثلاث حجج
create function sum_args ( n1 integer, n2 integer, n3 integer ) returns integer external name 'udrcpp_example!sum_args' engine udr;
تطبيق الوظيفة موجود في الوحدة النمطية udrcpp_example. داخل هذه الوحدة ، يتم تسجيل وظيفة تحت اسم sum_args. تستخدم وظيفة خارجية محرك UDR.
وظيفة جافا
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;
تنفيذ الوظيفة موجود في الوظيفة الثابتة التي تم org.firebirdsql.fbjava.examples.fbjava_example.FbRegex
للفئة org.firebirdsql.fbjava.examples.fbjava_example.FbRegex
. تستخدم وظيفة خارجية محرك جافا.
الإجراءات الخارجية
بناء الجملة {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])]
يمكن تغيير جميع معلمات الإجراء الخارجي باستخدام عبارة ALTER PROCEDURE.
بناء الجملة:
ALTER PROCEDURE procname [(<inparam> [, <inparam> ...])] RETURNS (<outparam> [, <outparam> ...]) EXTERNAL NAME <extname> ENGINE <engine> [AS <extbody>]
يمكنك حذف إجراء خارجي باستخدام عبارة DROP PROCEDURE.
بناء الجملة:
DROP PROCEDURE procname
هنا لن نصف بناء جملة معلمات الإدخال والإخراج. يتوافق بشكل كامل مع بناء جملة إجراءات PSQL المعتادة ، الموصوفة بالتفصيل في دليل لغة SQL. بدلاً من ذلك ، نقدم أمثلة لإعلان الإجراءات الخارجية مع التفسيرات.
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;
تنفيذ الوظيفة في وحدة pascaludr. داخل هذه الوحدة ، يتم تسجيل الإجراء باسم gen_rows. يستخدم إجراء خارجي محرك UDR.
create or alter procedure write_log ( message varchar(100) ) external name 'pascaludr!write_log' engine udr;
تنفيذ الوظيفة في وحدة pascaludr. داخل هذه الوحدة ، يتم تسجيل الإجراء تحت اسم write_log. يستخدم إجراء خارجي محرك UDR.
create or alter procedure employee_pgsql (
يتم تنفيذ الدالة في الدالة الثابتة executeQuery للفئة
org.firebirdsql.fbjava.examples.fbjava_example.FbJdbc
. بعد علامة التعجب (!) ، توجد المعلومات للاتصال بقاعدة بيانات خارجية عبر JDBC. تستخدم وظيفة خارجية محرك جافا. هنا ، باعتباره "نصًا" لإجراء خارجي ، يتم تمرير استعلام SQL لاسترداد البيانات.
تعليق
يستخدم هذا الإجراء كعب روتين يتم فيه تمرير معلمة غير مستخدمة. هذا يرجع إلى حقيقة أن في Firebird 3.0 هناك خلل في معالجة الإجراءات الخارجية دون معلمات.
وضع الإجراءات والوظائف الخارجية داخل الحزم
من المناسب وضع مجموعة من الإجراءات والوظائف المترابطة في حزم PSQL. يمكن أن تحتوي الحزم على إجراءات ووظائف PSQL خارجية ومنتظمة.
بناء الجملة {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>]'
بالنسبة إلى الإجراءات والوظائف الخارجية ، يشار إلى اسم الحزمة ومعلمات الإدخال وأنواعها وقيمها الافتراضية ومعلمات الإخراج في رأس الحزمة ، ويكون كل شيء هو نفسه في نص الحزمة باستثناء القيم الافتراضية ، وكذلك الموقع في الوحدة النمطية الخارجية (جملة EXAMEAL NAME) ، واسم المحرك ، وربما "نص" الإجراء / الوظيفة.
افترض أنك كتبت UDR للتعامل مع التعبيرات العادية ، الموجودة في الوحدة الخارجية (المكتبة الديناميكية) الخاصة بـ PCRE ، ولديك العديد من UDRs التي تؤدي مهام أخرى. إذا لم نستخدم حزم PSQL ، فسيتم خلط جميع الإجراءات والوظائف الخارجية مع بعضها البعض ومع الإجراءات والوظائف العادية لـ PSQL. يؤدي هذا إلى تعقيد البحث عن التبعيات وإجراء تغييرات على الوحدات الخارجية ، بالإضافة إلى ذلك يؤدي إلى حدوث ارتباك ويفرض على الأقل استخدام البادئات لتجميع الإجراءات والوظائف. حزم PSQL تجعل هذه المهمة أسهل بكثير بالنسبة لنا.
حزمة RegExp 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 ;^
مشغلات الخارجية
بناء الجملة {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
يمكن تغيير المشغل الخارجي باستخدام عبارة ALTER TRIGGER.
بناء الجملة:
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 }
يمكنك إزالة المشغل الخارجي باستخدام عبارة DROP TRIGGER.
بناء الجملة:
DROP TRIGGER trigname
فيما يلي أمثلة لإعلان المشغلات الخارجية مع التفسيرات.
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;
تطبيق المشغل موجود في الوحدة النمطية udrcpp_example. داخل هذه الوحدة ، يتم تسجيل المشغل تحت اسم النسخ المتماثل. يستخدم المشغل الخارجي محرك UDR.
في الارتباط بالوحدة الخارجية ، ds1
معلمة إضافية ds1
، والتي بموجبها تتم قراءة التكوين من جدول النسخ المتماثل داخل المشغل الخارجي للاتصال بقاعدة البيانات الخارجية.
هيكل UDR
لقد حان الوقت لكتابة UDR الأول. سنقوم بوصف هيكل UDR في باسكال. لشرح الهيكل الأدنى لبناء UDR ، سوف نستخدم أمثلة قياسية من examples/udr/
المترجمة إلى Pascal.
قم بإنشاء مشروع جديد للمكتبة الديناميكية الجديدة ، والتي سوف نسميها MyUdr. نتيجة لذلك ، يجب أن تحصل على الملف MyUdr.dpr
(إذا قمت بإنشاء المشروع في دلفي) أو الملف MyUdr.lpr
(إذا كنت قد أنشأت المشروع في Lazarus). الآن دعونا نغير ملف المشروع الرئيسي بحيث يبدو كالتالي:
library MyUdr; {$IFDEF FPC} {$MODE DELPHI}{$H+} {$ENDIF} uses {$IFDEF unix} cthreads,
في هذه الحالة ، تحتاج إلى تصدير وظيفة firebird_udr_plugin
واحدة فقط ، وهي نقطة إدخال المكونات الإضافية لوحدات UDR الخارجية. سيتم تنفيذ هذه الوظيفة في وحدة UdrInit.
تعليق
إذا كنت تقوم بتطوير UDR في Free Pascal ، فستحتاج إلى توجيهات إضافية. {$mode objfpc}
مطلوب لتمكين وضع Pascal Object. بدلاً من ذلك ، يمكنك استخدام التوجيه {$mode delphi}
لضمان التوافق مع Delphi. نظرًا لأنه ينبغي تجميع الأمثلة الخاصة بي بنجاح في كل من FPC و Delphi ، اخترت {$mode delphi}
.
يتضمن التوجيه {$H+}
دعم سلاسل طويلة. يعد هذا ضروريًا إذا كنت تستخدم سلسلة الأنواع ، وخط النهاية ، وليس فقط السلاسل ذات النهاية الفارغة PChar و PAnsiChar و PWideChar.
بالإضافة إلى ذلك ، سنحتاج إلى توصيل وحدات منفصلة لدعم تعدد مؤشرات الترابط على Linux وأنظمة التشغيل الأخرى المشابهة لـ Unix.
تسجيل الإجراءات أو الوظائف أو المشغلات
أضف الآن وحدة UdrInit ، يجب أن تبدو كما يلي:
unit UdrInit; {$IFDEF FPC} {$MODE DELPHI}{$H+} {$ENDIF} interface uses Firebird;
في وظيفة firebird_udr_plugin
، firebird_udr_plugin
الضروري تسجيل المصانع الخاصة بالإجراءات والوظائف والمشغلات الخارجية الخاصة بنا. لكل وظيفة أو إجراء أو مشغل ، يجب عليك كتابة المصنع الخاص بك. يتم ذلك باستخدام أساليب واجهة IUdrPlugin:
- registerFunction — ;
- 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.
. إلى
Null Null
, NULL,
UDR . : . , .. EXECUTE PROCEDURE .
UdrInit firebird_udr_plugin
.
function firebird_udr_plugin(AStatus: IStatus; AUnloadFlagLocal: BooleanPtr; AUdrPlugin: IUdrPlugin): BooleanPtr; cdecl; begin
تعليق
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
تعليق
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
, . , .
تعليق
Delphi yeild,
while(...) do { ... yield result; }
, open, , fetch. ( SELECT FIRST/ROWS/FETCH FIRST SELECT.)
UDR .
Note
C++ . , . .
UdrInit firebird_udr_plugin
.
function firebird_udr_plugin(AStatus: IStatus; AUnloadFlagLocal: BooleanPtr; AUdrPlugin: IUdrPlugin): BooleanPtr; cdecl; begin
تعليق
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. . , , .
تعليق
, , . IMessageMetadata. , . , , /.
, PSQL
if (:new.B IS NULL) THEN :new.B = :new.A + 1;
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. , . . على سبيل المثال:
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.
تعليق
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);
تعليق
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;
تعليق
, 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;
تعليق
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;
تعليق
isc_random
, .
:
SELECT ids.ID FROM SPLIT((SELECT LIST(ID) FROM MYTABLE), ',') ids
تعليق
, BLOB
,
.
,
.
fetch
.
BLOB
BLOB
BLOB .
تعليق
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.
تعليق
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
.
تعليق
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;
تعليق
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
.
هذا كل شيء. UDR Firebird, .