Modules
Descriptor

Descriptor Bundle Module

This module contains Virtual Database descriptors as well as actions and queries definitions. The bundle must include a meta-configuration file, which the Engine uses to interpret the contents of this descriptor.

Kubling provides extensive flexibility in configuration options. As your project scales, maintaining a well-organized structure becomes increasingly important.

The following tree shows the recommended internal directory and file organization:

  • bundle-info.yaml
  • 📄 bundle-info.yaml

    This is the only file whose location must be the root directory of the module. See here the schema of the file.

    📂 vdb directory

    We suggest to use this directory to put all Virtual Database related files, including the Virtual Database information file.

    The example above uses the following directories:

    • 📂 datasource: Contains the config objects for each data source.
    • 📂 ddl: Contains the DDL files used to create the schemas.
    • 📂 translator: Contains the translation capabilities configurations.

    📂 endpoint directory

    Since endpoints can grow exponentially in number, we do suggest having them in a separate directory.