build | ||
docs/images | ||
sql | ||
src | ||
test | ||
.editorconfig | ||
.gitignore | ||
.kateconfig | ||
.kateproject | ||
CMakeLists.txt | ||
compile_flags.txt | ||
Readme.md | ||
VERSION.txt | ||
workspace.code-workspace | ||
write_build_no.sh |
MyFirstUDRKit
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.
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:
MyFirstUDRKit
MY_FIRST_UDR_KIT
Setting up cmake
Run the cmake gui and fill in the path information. Set the source to the root of the location where you have cloned the repo. CMake looks for the file CMakeLists.txt
. Binaries will be built under build/x86_64-win64
and build/x86_64-linux
for linux.
Click on Configure to generate the default config for the current platform. This will open a dialogue. When prompted choose the Unix makefiles
generator for linux. Under Windows choose Visual Studio 15 2017
and be sure to set the Optional platform for generator
to x64 for windows as in the screenshot below:
Click on Finish
and you should then see a screen similar to this:
Under linux the only change needed at this stage is to set CMAKE_BUILD_TYPE to
Debug`. Under Windows there should be nothing further to do.
You can then click on Generate
and you should end up with a screen similar to this:
If you want to start again be sure to click on FILE|DELETE CACHE
Building the kit
cd build/x86_64-linux
make
Installation
run the sql on the target database
Decide whether to install the functions globally or as part of a package
Testing
- create a test db
- add functions
- write some simple tests
Stress testing
- compile fb for valgrind
- stress test for leakage
When things go wrong
Errors when registering a function
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.