app

go-eliona App

The go-eliona App package provides handy methods to handle app in an eliona environment. This package uses the Eliona API to access Eliona.

Installation

To use the apps package you must import the package.

import "github.com/eliona-smart-building-assistant/go-eliona/app"

The package needs an Api server address. To configure this have a look at api package.

Usage

After installation, you can initialize and patch apps in an eliona environment.

import "github.com/eliona-smart-building-assistant/go-eliona/app"

Initialize your app

For the first start the app should be initialized. You can create your own schema and database tables to persist configuration data for the app. Or you create example data that shows users how your app works. To do this, you can use the Init function. This function is called only one time. After this the Init function skips all executions.

apps.Init(db.Pool(), common.AppName(),
    apps.ExecSqlFile("database/init.sql"),
    apps.ExecSqlFile("database/defaults.sql"))

You should call the Init at top in main() function.

Patching your app

If you need to change data models, configuration tables or other things, you have to patch your app. That guarantees that installed apps can always be updated even though they have already been initialized. To do this, you can use the Patch function. This function is called once for each patch. After this the Patch function skips all executions for this patch.

apps.Patch(db.Pool(), common.AppName(), "010100",
    apps.ExecSqlFile("database/patches/010100.sql"))

You should call the Patch at top in main() after the Init function.