Connection Template

Example

# All template definitions (independent of their kind) go into the templates section
templates:
  default_connection:
    # The template is a connection template  
    kind: connection
    parameters:
      - name: dir
        type: string
    template:
      # This is now a normal connection definition, which can also access the parameters as variables 
      kind: jdbc
      driver: "org.apache.derby.jdbc.EmbeddedDriver"
      url: $String.concat('jdbc:derby:', $dir, '/logdb;create=true')
      username: "some_user"
      password: "secret"

# Now you can create instances of the template in the corresponding entity section or at any other place where
# a connection is allowed
connections:
  frontend:
    kind: template/default_connection
    dir: /opt/flowman/derby
    
relations:
  rel_1:
    kind: jdbc
    connection:
      kind: template/default_connection
      dir: /opt/flowman/derby_new
    table: "advertiser_setting"
    schema:
      kind: inline
      fields:
        - name: id
          type: Integer
        - name: business_rule_id
          type: Integer
        - name: rtb_advertiser_id
          type: Integer

  rel_2:
    kind: jdbc
    connection: frontend
    query: "
      SELECT
        *
      FROM line_item li
    "

Once a relation template is defined, you can create instances of the template at any place where a connection can be specified. You need to use the special syntax template/<template_name> when creating an instance of the template. The template instance then can also contain values for all parameters defined in the template.

Fields

• kind (mandatory) (type: string): connection

• parameters (optional) (type: list[parameter]): list of parameter definitions.

• template (mandatory) (type: mapping): The actual definition of a connection.