lv-server
LiveView Server — the LiveView server
SYNOPSIS
lv-server {run | compile | define-service |
install-service | remove-service} [OPTIONS] {liveview-project-directory}
lv-server generate [liveview-project-directoryOPTIONS]
lv-server --help
lv-server --version
DESCRIPTION
lv-server
runs a LiveView project as a server. You can compile and run a LiveView Project on
all supported operating systems.
You can define the LiveView Server as a service using the define-service argument on Linux platforms and install-service on Windows platforms.
ARGUMENTS
-
run -
Compile and run a LiveView project.
- [--background-mode]
-
Run LiveView Server as a background process. This starts an sbd process with the background mode switch, -b. See the TIBCO StreamBase CEP Administration Guide's article on StreamBase Logging for more information on background mode logging settings.
-
[--sbconf-file]
sbconf-file-fsbconf-file -
Specify a StreamBase configuration file. Default value is sbd.sbconf.
- [--environment-copy] true/false (-e true/false)
-
Copy the environment variables so StreamBase Server will see them. Defaults value is true.
-
[--streambase-port]
sbconf-file-fsbconf-file -
Port to connect to StreamBase CEP. Env: liveview.streambase.connection.pool.port. Default value is 10000.
-
[--liveview-port]
sbconf-file-fsbconf-file -
Liveview Port. This option will override port settings in either the system properties or the environment variable liveview.port. Default value is 10080.
- compile [--java-vm default]
-
Compile a LiveView project. The
java-vm defaultoption is only applicable to custom LiveView installations. StreamBase Systems may ask you to use this option if you have a custom application. The option does not change anything for standard installations. - generate
-
Generate an interface and EventFlow application for use with a LiveView table.
- --list
-
List all the applications and tables in a project and show the available application types for every project table.
- --type [customidgeneration | datasource | preprocessor | publisher | tableschemas | transform]
-
Type of interface to generate.
-
--tables
TableName1, TableName2,... -
LiveView tables for which to create interfaces.
- --force
-
Overwrite an existing interface file, if present.
-
--out
filename -
Specify the name of the generated interface file.
- define-service (Linux only)
-
Compile a LiveView project with specified parameters.
-
--service-file
script-file -
Specifies the location of the server configuration file.
-
--service-name
short,description -
Create an init.d-compatible command file for a LiveView instance.
- --service-type init.d
-
Run LiveView Server as a background service.
-
--service-user
username -
Run LiveView Server as a specific user.
-
--service-file
- install-service (Windows only)
-
--service-name
short,description - remove-service (Windows only)
-
--service-name
short,description -
--help -
Displays a syntax reminder message, then exits.
-
--version -
Prints version information and exits.
EXAMPLES
Example 1. Run lv-server as a background service as user username on a Linux system.
-
Navigate to the default Studio workspace:
$HOME/streambase-studio-
n.m-workspace -
Use a command like the following to run LiveView Server if your current directory is $HOME:
/opt/streambase/liveview/tools/lv-server define-service --service-user
username
Example 2. Run the sample_lv-helloliveview project on
a Windows system.
-
Open a StreamBase Command Prompt from → → menu.
-
For the Windows username username, launch LiveView Server running the sample_lv-helloliveview as follows. (This single command is shown on two lines for clarity.)
lv-server run "C:\Users\
username\Documents\ StreamBase Studio 7.4 Workspace\sample_lv-helloliveview"The StreamBase Command Prompt opens at the root of
%STREAMBASE_HOME%.