Add more doc notes

This commit is contained in:
Paul Reeves 2023-02-06 14:05:48 +01:00
parent 88246f0bda
commit 057af0016d
1 changed files with 26 additions and 2 deletions

View File

@ -3,6 +3,24 @@
Welcome to MyFirstUDRKit. As you can tell from the name, this plugin is not intended for production use. It is just to play with. When you are ready feel free to fork it and give it a new name.
### What is in the kit?
There are currently four functions available. Two `div` and `flagged` are simple smoke test functions. They do very little but they demonstrate two things:
- how to write basic C code in a UDR
- do quick tests to verify the basics of UDR plugin develeopment and testing.
There are two other functions available:
- LoadBlobFromFile
- SaveBlobToFile
These are more ambitious.
- they are written in C++
- they demonstrate how to work with the new Firebird OO API
### Forking the repository
For test purposes you can just clone the repo and try building and testing the code. However, for serious work it is recommended that you clone the repo and give the project a new name. When doing so be sure to search and replace all references to MyFirstUDRKit to your new project name. There are two strings to replace:
@ -65,9 +83,13 @@ TO DO
### Installation
#### run the sql on the target database
#### Run the sql on the target database
In the sql directory there are two scripts.
MyFirstUDRKit.ddl contains the function declarations. You can run the script directly on your database to register the functions.
MyFirstUDRKitPackage.sql, although incomplete, demonstrates how you can declare the functions as part of a package.
@ -83,5 +105,7 @@ Invalid index 1 in function IMetadataBuilder::setType
This error indicates that the parameters in the sql function declaration do not match the parameters in the actual function. Check your sql with the FB_UDR_MESSAGE declarations.
### Debugging