Optional features

The extension framework supports a number of features that are optional to implement. Optional features are typically a little bit more advanced and can take a bit of extra effort to implement, or niche - simply not required for every type of extension.

Support for a specific feature by an extension is declared in the extension header file (.pyplugin/.netplugin).

Features=KvStorage, QueryPreview, ConfigurationParameters

Query Preview

The query preview feature enables query extensions to provide a limited set of preview records to the builder when the query is configured. If this feature is not supported by the extension, preview records will be synthesized by the builder UI, but a preview including real live data provides a much better user experience, so if you are developing a query extension you should aim to support this feature.

Key-Value Storage

The key-value storage feature provides configurable named string values that are maintained by an administrator and transparent to the end user. Named values are typically used to define API base URL and other properties that differ between environments. Values can also be declared as secret, which is useful for API tokens and other sensitive information that you don't want to expose to end users.

Configuration Parameters

Configuration parameters can be described as base configuration collected from the user by a query extension prior to any other interaction. This can be used e.g. to configure API base URL or a root file directory before the extension before the extension is requested to provide metadata or parameter information. Typical usage is to have the user select a table or entity from a list, which is then investigated to provide columns and parameters.