Example Query Stage Plugin
The example query stage plugin contains an example of how a plugin can be implemented as well as information on how to build and deploy the plugin. You’ll find it in the examples/sample-plugin-stage directory.
The sample plugin stage is an example project with two simple querying stages:
-
Update request - Add a new query parameter with a specific value to each query request.
-
Update response - Add a new field with a specific value to each query response.
This is also a demonstration of a basic gradle project that assembles a Fusion query stage plugin .zip.
1. Build the plugin stage
From the main folder, call:
./gradlew -p examples/sample-plugin-stage assemblePlugin
Substitute the path to your project.
This creates a plugin .zip file (with required manifest file) inside the build/libs folder.
2. Deploy the stage
You can choose from several different ways to deploy the sample plugin stage:
After successful deployment, new stages should be visible in the Stages list in the Fusion Query Pipelines UI.
Upload it to the blob store
-
Navigate to System > Blobs.
-
Click Add.
-
Select Query Stage Plugin.
-
Click Browse… and select your plugin file.
-
Click Upload
Deploy it using gradle
./gradlew -p examples/sample-plugin-stage deploy -PfusionUser=[user] -PfusionPassword=[password]Deploy it with the REST API
curl -u [user]:[password] -X PUT -H "Content-Type:application/zip" --data-binary @sample-plugin-stage-0.0.1.zip https://<fusion-host>/api/query-stage-plugins