Skip to content

Freemarker

To use a Freemarker Template. Create a folder anywhere: \$HOME/templates/Example Inside that folder create the freemarker template file: ExampleDB.py.ftl

JPortal2 supports freemarker file name substitution. For example ExampleDB${table.name}.py.ftl will generate a ExampleDB{tablename}.py file for all the SI files you gen for.

Inside your template file: 

1
2
3
4
5
6
<#list database.tables as table>
table name: ${table.name}:
    table Fields:
    <#list table.fields as field>${field.name}
    </#list>
</#list>

JPortal2 takes 2 arguments to run freemarker. The template location where all the templates folders are, and what templates you want to run.

Run jportal with the argument: 

1
2
--template-location $HOME/templates/
--template-generator ExampleDB:$HOME/output

When JPortal2 is done. You will have the generated files in the output directory and it will look like this: 

1
2
3
4
5
table name: ExampleTable
    table fields:
    id
    name
    surname

Freemarker Variables

There are a few variables available to you in the freemarker template language for generation: - Database - Table - Proc

The above variables match the hierarchy that is built into the SI structure. A database is a collection of SI files, and each SI file represents a table. Furthermore, each SI table has a collection of procs attached to it.

The above variables are also available in the name component of the free-marker template file. That way one can create a generated file down to the level of each individual proc.

Workflow

A detailed description of the workflow process is mentioned in the Contribution.md Feel free to add any suggestions or any help in the

Documentation

For comprehensive documentation. Refer to the docs