lv-util
LiveView Server — Generates interfaces for EventFlow applications.
SYNOPSIS
lv-util
generate {liveview-project-directory
} [OPTIONS
]
lv-util
upgrade [OPTIONS
]
lv-util
--help
lv-util
--version
DESCRIPTION
lv-util is used to generate a StreamBase interface file on which an EventFlow application can be based for use with a LiveView data table.
ARGUMENTS
- generate
-
Generates a StreamBase interface file on which an EventFlow application can be based for use with a specified LiveView data table or set of tables. All interface files are generated into the
src/main/eventflow/lv-interfaces
folder of the specified project.- --list
-
Lists all the applications and tables in the specified project and shows example lv-util generate command lines for all LiveView data tables in the project.
- --type tableschemas |datasource | preprocessor | publisher | transform
-
Specifies the type of interface to generate, using one of the exact keywords as shown. The middle four types correspond to the four types of EventFlow applications that can be associated with a LiveView data table, as described on EventFlow Module Types for LiveView in the LiveView Developer's Guide. Each
generate
command generates one StreamBase interface file into thesrc/main/eventflow/lv-interfaces
folder per specified data table.- tableschemas
-
Specify this type to generate named schemas for the incoming and outgoing streams in each specified data table. Run this generate command along with any of the following generate commands. Interface files generated with this
tableschemas
keyword are included by reference in the interface files generated by the other keywords, and must exist for the other interface files to be valid. - datasource
-
Generates an interface that defines the DataOut output stream for each specified data table.
- preprocessor
-
Generates an interface that defines the DataIn input stream and DataOut output stream and for each specified data table.
- publisher
-
Generates an interface file that defines streams and named schemas to form the basis for publishing data into each specified data table.
- transform
-
Generates an interface file that defines the DataIn input stream and DataOut output stream to form the basis for transforming data before loading into each specified data table.
- --tables
TableName1,TableName2, ...
-
Specifies one or more LiveView data tables for which to create the specified interface type. To specify more than one table, separate table names with a comma but no space.
- --force
-
Specifies overwriting an existing interface file, if present. By default, interface file names are taken from their parent lvconf files.
- --out
filename
-
Specifies the name of the interface file to be generated. Use this option with caution, because interface files generated with various
--type
options presume default interface names.
- upgrade
-
One-time use tool to upgrade a project using the deprecated static aggregation to author-time aggregation.
- --static
-
Upgrades and overwrites the existing lvconf files.
- --outdir {name}
-
Writes upgraded files to a different directory.
--help
-
Displays a syntax reminder message, then exits.
--version
-
Prints version information and exits.