Chapter 33. LogicBlox Command Reference

The main tool for manipulating your LogicBlox database is lb. The various subcommands of lb allow you to interact with the database, manipulate and inspect the state of ServiceBlox services, create build configurations for projects, and execute tests. The sections in this chapter provide detailed descriptions of how to use these commands. You can also retrieve the same information by typing lb --help, and lb subcommand --help at the command line.

Note

Invoking just lb puts the tool in interactive mode: it prints a prompt, and you can enter individual commands. (The prompt is lb, followed by the name of the current workspace, if there is one, followed by >).

If you type the command help, you will get the list of commands, as well as a list of additional commands, which are different from the additional commands listed when you type lb --help. The additional commands of interactive mode are not documented in this manual.

If you invoke lb filename, the tool will interpret the commands in the file one by one: the available additional commands are those from the interactive mode. The name of the file must end with the suffix .lb .

33.1. Database Services Management

33.1.1. lb services

Syntax

lb services [-h]  ...

Description

manage lb services

Optional Arguments

-h --help

show this help message and exit

Commands

print

list processes of running services

processes

list processes related to running services by heuristic

restart

stop and start a service

start

start a service

status

print the status of services

stop

stop a running service

33.1.2. lb services print

Syntax

lb services print [-h]

Description

list processes of running services

Optional Arguments

-h --help

show this help message and exit

33.1.3. lb services processes

Syntax

lb services processes [-h]

Description

list processes related to running services by heuristic

Optional Arguments

-h --help

show this help message and exit

33.1.4. lb services restart

Syntax

lb services restart [-h]

Description

start a service

Optional Arguments

-h --help

show this help message and exit

33.1.5. lb services start

Syntax

lb services start [-h]

Description

start a service

Optional Arguments

-h --help

show this help message and exit

33.1.6. lb services status

Syntax

lb services status [-h]

Description

print the status of services

Optional Arguments

-h --help

show this help message and exit

33.1.7. lb services stop

Syntax

lb services stop [-h]

Description

stop a running service

Optional Arguments

-h --help

show this help message and exit

33.2. Workspace Commands

33.2.1. lb addblock

Syntax

lb addblock [-h] [-f FILE] [--name NAME] [--inactive]
            [--language LANGUAGE] [--loglevel LOGLEVEL] [-L]
            [--cwd [DIR]] [--timeout TIMEOUT] [--exclusive]
            [--commit-mode {diskcommit,softcommit}] [--branch [NAME]]
            [-m PREDICATE] [--readonly]
            WORKSPACE [LOGIC]

Description

add active or inactive block to workspace

Positional Arguments

workspace

name of workspace

logic

logic to add

Optional Arguments

-h --help

show this help message and exit

-f --file

logic file to add

--name

name of block (default: unique name)

--inactive

add block as inactive block

--language

source language of block: lb (default) or lb0

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.2.2. lb addlib

Syntax

lb addlib [-h] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
          [--timeout TIMEOUT] [--exclusive]
          [--commit-mode {diskcommit,softcommit}] [--branch [NAME]]
          [-m PREDICATE] [--readonly]
          WORKSPACE NAME

Description

add library to workspace

Positional Arguments

workspace

name of workspace

name

name of library to add

Optional Arguments

-h --help

show this help message and exit

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.2.3. lb addproject

Syntax

lb addproject [-h] [--norecurse] [--nocopy] [--libpath LIBPATH]
              [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
              [--timeout TIMEOUT] [--exclusive]
              [--commit-mode {diskcommit,softcommit}] [--branch [NAME]]
              [-m PREDICATE] [--readonly]
              WORKSPACE DIR

Description

add project to workspace

Positional Arguments

workspace

name of workspace

dir

project directory path

Optional Arguments

-h --help

show this help message and exit

--norecurse

avoid finding libraries recursively

--nocopy

skip copy of level 1 workspace

--libpath

the path for lb libraries that this project depends on

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.2.4. lb aborttransaction

Syntax

lb aborttransaction [-h] [WORKSPACE] TID

Description

abort a transaction

Positional Arguments

workspace

workspace

tid

transaction id

Optional Arguments

-h --help

show this help message and exit

33.2.5. lb branch

Syntax

lb branch [-h] [--parent PARENT] [--overwrite] [--loglevel LOGLEVEL]
          [-L] [--cwd [DIR]]
          WORKSPACE BRANCH

Description

create a new named branch

Positional Arguments

workspace

name of workspace

name

name of new branch

Optional Arguments

-h --help

show this help message and exit

--parent

branch to create new named branch from, if not default

--overwrite -o

overwrite if the branch already exists

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.2.6. lb branches

Syntax

lb branches [-h] [--all] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
            WORKSPACE

Description

list named branches

Positional Arguments

workspace

name of workspace

Optional Arguments

-h --help

show this help message and exit

--all

also list branches created for automatic backups

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.2.7. lb copy-remote

Syntax

lb copy-remote [-h] [--remote-workspace REMOTE-WORKSPACE]
               [--remote-port REMOTE-PORT]
               NAME HOST

Description

make a copy of a remote workspace

Positional Arguments

name

name of the local workspace

host

host name of the remote LogicBlox server

Optional Arguments

-h --help

show this help message and exit

--remote-workspace

name of the remote workspace

--remote-port

port of the remote LogicBlox server

33.2.8. lb compileblock

Syntax

lb compileblock [-h] [-f FILE] [--name NAME] [--inactive]
                [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
                [--timeout TIMEOUT] [--exclusive]
                [--commit-mode {diskcommit,softcommit}]
                [--branch [NAME]] [-m PREDICATE] [--readonly]
                WORKSPACE [LOGIC]

Description

test compiling active or inactive block

Positional Arguments

workspace

name of workspace

logic

logic to compile

Optional Arguments

-h --help

show this help message and exit

-f --file

logic file to compile

--name

name of block (default: unique name)

--inactive

active or inactive block

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.2.9. lb create

Syntax

lb create [-h] [--unique] [--overwrite] [--libs LIBS]
          [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
          [NAME]

Description

create new workspace

Positional Arguments

name

name or prefix of the new workspace

Optional Arguments

-h --help

show this help message and exit

--unique

create a workspace with a unique name

--overwrite

delete existing workspace with the same name, if it exists

--libs

comma separated list of libs to load

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.2.10. lb delete

Syntax

lb delete [-h] [-f] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
          NAME [NAME ...]

Description

delete workspace

Positional Arguments

name

name of workspace to delete

Optional Arguments

-h --help

show this help message and exit

-f --force

ignore non-existent workspaces

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.2.11. lb delete-branch

Syntax

lb delete-branch [-h] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
                 WORKSPACE BRANCH

Description

create a new named branch

Positional Arguments

workspace

name of workspace

name

name of branch to delete

Optional Arguments

-h --help

show this help message and exit

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.2.12. lb exec

Syntax

lb exec [-h] [--blockname BLOCKNAME] [--bind-branch BIND-BRANCH]
        [-f FILE] [--raw] [--exclude-ids] [--csv]
        [--delimiter DELIMITER] [--print [PRED]] [--language LANGUAGE]
        [--loglevel LOGLEVEL] [-L] [--cwd [DIR]] [--timeout TIMEOUT]
        [--exclusive] [--commit-mode {diskcommit,softcommit}]
        [--branch [NAME]] [-m PREDICATE] [--readonly]
        WORKSPACE [LOGIC]

Description

execute logic and optionally print results

Positional Arguments

workspace

name of workspace

logic

logic to add. If logic starts with a '-', please use '--' before the logic to get correct parsing behavior

Optional Arguments

-h --help

show this help message and exit

--blockname

name of block

--bind-branch

string with a list of branch bindings. Example: 'branch1=x123, branch2=y456'

-f --file

logic file to execute

--raw

print query result without escaping

--exclude-ids

output only refmode values of entities

--csv

print query result to csv files

--delimiter

delimiter when printing query result to csv files

--print

print local predicate PRED. Default '_'

--language

source language of block: lb (default) or lb0

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.2.13. lb execblock

Syntax

lb execblock [-h] [--raw] [--exclude-ids] [--csv]
             [--delimiter DELIMITER] [--print [PRED]] [--input INPUT]
             [--bind-branch BIND-BRANCH] [--loglevel LOGLEVEL] [-L]
             [--cwd [DIR]] [--timeout TIMEOUT] [--exclusive]
             [--commit-mode {diskcommit,softcommit}] [--branch [NAME]]
             [-m PREDICATE] [--readonly]
             WORKSPACE NAME

Description

execute inactive block and optionally print results

Positional Arguments

workspace

name of workspace

name

name of inactive block to execute

Optional Arguments

-h --help

show this help message and exit

--raw

print query result without escaping

--exclude-ids

output only refmode values of entities

--csv

print query result to csv files

--delimiter

delimiter when printing query result to csv files

--print

print local predicate PRED. Default '_'

--input

string with a list of bindings for local variables in the block. Only strings are supported. Example: '_in1=string1, _in2=string2'

--bind-branch

string with a list of branch bindings. Example: 'branch1=x123, branch2=y456'

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.2.14. lb export-protobuf

Syntax

lb export-protobuf [-h] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
                   [--timeout TIMEOUT] [--exclusive]
                   [--commit-mode {diskcommit,softcommit}]
                   [--branch [NAME]] [-m PREDICATE] [--readonly]
                   WORKSPACE PROTOCOL MSGTYPE FILE

Description

export protobuf message to a file

Positional Arguments

workspace

name of workspace

protocol

name of the protocol to use

msgType

protobuf message type of the data file

file

protobuf message data file

Optional Arguments

-h --help

show this help message and exit

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.2.15. lb export-protobuf-schema

Syntax

lb export-protobuf-schema [-h] [--protocol PROTOCOL] [-i [INCLUDE]]
                          [-e [EXCLUDE]] [--loglevel LOGLEVEL] [-L]
                          [--cwd [DIR]] [--timeout TIMEOUT]
                          [--exclusive]
                          [--commit-mode {diskcommit,softcommit}]
                          [--branch [NAME]] [-m PREDICATE] [--readonly]
                          WORKSPACE

Description

get installed protocol descriptors

Positional Arguments

workspace

name of workspace

Optional Arguments

-h --help

show this help message and exit

--protocol

save descriptor for selected protocols. Multiple OK

-i --include

regular expression of protocol names to include

-e --exclude

regular expression of protocol names to exclude

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.2.16. lb filepath

Syntax

lb filepath [-h] [-i] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
            WORKSPACE

Description

find file system path of workspace

Positional Arguments

workspace

name of workspace

Optional Arguments

-h --help

show this help message and exit

-i --inverse

find workspace name from path of workspace

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.2.17. lb import-protobuf

Syntax

lb import-protobuf [-h] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
                   [--timeout TIMEOUT] [--exclusive]
                   [--commit-mode {diskcommit,softcommit}]
                   [--branch [NAME]] [-m PREDICATE] [--readonly]
                   WORKSPACE PROTOCOL MSGTYPE FILE

Description

import protobuf message from a file

Positional Arguments

workspace

name of workspace

protocol

name of the protocol to use

msgType

protobuf message type of the data file

file

protobuf message data file

Optional Arguments

-h --help

show this help message and exit

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.2.18. lb import-protobuf-schema

Syntax

lb import-protobuf-schema [-h] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
                          [--timeout TIMEOUT] [--exclusive]
                          [--commit-mode {diskcommit,softcommit}]
                          [--branch [NAME]] [-m PREDICATE] [--readonly]
                          WORKSPACE NAME FILE

Description

protobuf add specification from a file

Positional Arguments

workspace

name of workspace

name

name of message protocol to add

file

protobuf message descriptor file

Optional Arguments

-h --help

show this help message and exit

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.2.19. lb import-xml

Syntax

lb import-xml [-h] [--schema SCHEMA] [--loglevel LOGLEVEL] [-L]
              [--cwd [DIR]] [--timeout TIMEOUT] [--exclusive]
              [--commit-mode {diskcommit,softcommit}] [--branch [NAME]]
              [-m PREDICATE] [--readonly]
              WORKSPACE FILE

Description

import XML document

Positional Arguments

workspace

name of workspace

file

the /path/to/XML/file

Optional Arguments

-h --help

show this help message and exit

--schema

name of schema (optional)

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.2.20. lb import-xml-schema

Syntax

lb import-xml-schema [-h] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
                     [--timeout TIMEOUT] [--exclusive]
                     [--commit-mode {diskcommit,softcommit}]
                     [--branch [NAME]] [-m PREDICATE] [--readonly]
                     WORKSPACE NAME FILE

Description

add XML schema specification from a file

Positional Arguments

workspace

name of workspace

name

name for the schema

file

binary schema descriptor file, generated by importexport

Optional Arguments

-h --help

show this help message and exit

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.2.21. lb info

Syntax

lb info [-h] [--json] NAME

Description

print information about a workspace

Positional Arguments

name

name of the workspace

Optional Arguments

-h --help

show this help message and exit

--json

print information in JSON format

33.2.22. lb list-blocks

Syntax

lb list-blocks [-h] [--inactive | --active] [--loglevel LOGLEVEL] [-L]
               [--cwd [DIR]]
               WORKSPACE

Description

list blocks in a workspace

Positional Arguments

workspace

name of workspace

Optional Arguments

-h --help

show this help message and exit

--inactive

list only inactive blocks

--active

list only active blocks

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.2.23. lb list

Syntax

lb list [-h] [--kind KIND] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
        [--timeout TIMEOUT] [--exclusive]
        [--commit-mode {diskcommit,softcommit}] [--branch [NAME]]
        [-m PREDICATE]
        WORKSPACE

Description

list predicates in workspace

Positional Arguments

workspace

name of workspace

Optional Arguments

-h --help

show this help message and exit

--kind

kind of predicate. The basic kinds are: "edb", "idb", "built-in" and "runtime-internal". Additionally, "predefined" stands for the disjunction "built-in ; runtime-internal". The kind can be specified by a disjunction of conjunctions, where each conjunct can be negated. For example, "edb ; idb" shows only EDB and IDB predicates: this specification is equivalent to "! predefined" (a negation). "!edb , !runtime internal , !built-in" (a conjunction) is equivalent to "idb". The default is "edb; idb".

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

33.2.24. lb popcount

Syntax

lb popcount [-h] [-p PREDICATE] [-i [INCLUDE]] [-e [EXCLUDE]] [-d]
            [--estimate] [--include-default] [--kind KIND]
            [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
            [--timeout TIMEOUT] [--exclusive]
            [--commit-mode {diskcommit,softcommit}] [--branch [NAME]]
            [-m PREDICATE]
            WORKSPACE [NAME [NAME ...]]

Description

print popcount for all, or specified, predicates

Positional Arguments

workspace

name of workspace

name

name of predicate

Optional Arguments

-h --help

show this help message and exit

-p --predicate

print popcount for specific predicate

-i --include

regular expression [Perl-syntax] for predicates to include

-e --exclude

regular expression [Perl-syntax] for predicates to exclude

-d --density

print density when available

--estimate

print estimated rather than actual size

--include-default

for default-valued predicates, use size of default layer

--kind

kind of predicate. The basic kinds are: "edb", "idb", "built-in" and "runtime-internal". Additionally, "predefined" stands for the disjunction "built-in ; runtime-internal". The kind can be specified by a disjunction of conjunctions, where each conjunct can be negated. For example, "edb ; idb" shows only EDB and IDB predicates: this specification is equivalent to "! predefined" (a negation). "!edb , !runtime internal , !built-in" (a conjunction) is equivalent to "idb". The default is "edb; idb".

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

33.2.25. lb predinfo

Syntax

lb predinfo [-h] [--transitive] [--omit PREDICATE] [--all]
            [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
            [--timeout TIMEOUT] [--exclusive]
            [--commit-mode {diskcommit,softcommit}] [--branch [NAME]]
            [-m PREDICATE]
            WORKSPACE [NAME [NAME ...]]

Description

print information about a workspace

Positional Arguments

workspace

name of workspace

name

name of predicate

Optional Arguments

-h --help

show this help message and exit

--transitive

include predicates that use this predicate

--omit

predicates to not include

--all

return info for all user-predicates. [Deprecated]

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

33.2.26. lb print-block

Syntax

lb print-block [-h] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
               WORKSPACE BLOCK

Description

print the logic for a block

Positional Arguments

workspace

name of workspace

block

name of block

Optional Arguments

-h --help

show this help message and exit

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.2.27. lb print-rules

Syntax

lb print-rules [-h] [--branch [NAME]] [--dependent] [--internal]
               [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
               WORKSPACE PREDICATE

Description

print the rules defining a predicate

Positional Arguments

workspace

name of workspace

predicate

name of predicate

Optional Arguments

-h --help

show this help message and exit

--branch

named workspace branch to use

--dependent

print rules that use the predicate in the body

--internal

print rules in internal runtime format

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.2.28. lb print

Syntax

lb print [-h] [--exclude-ids] [--raw] [--loglevel LOGLEVEL] [-L]
         [--cwd [DIR]] [--timeout TIMEOUT] [--exclusive]
         [--commit-mode {diskcommit,softcommit}] [--branch [NAME]]
         [-m PREDICATE]
         WORKSPACE NAME

Description

print facts of predicate

Positional Arguments

workspace

name of workspace

name

name of predicate

Optional Arguments

-h --help

show this help message and exit

--exclude-ids

output only refmode values of entities

--raw

print results without escaping

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

33.2.29. lb query

Syntax

lb query [-h] [-f FILE] [--raw] [--exclude-ids] [--csv]
         [--delimiter DELIMITER] [--print [PRED]] [--language LANGUAGE]
         [--loglevel LOGLEVEL] [-L] [--cwd [DIR]] [--timeout TIMEOUT]
         [--exclusive] [--commit-mode {diskcommit,softcommit}]
         [--branch [NAME]] [-m PREDICATE]
         WORKSPACE [LOGIC]

Description

execute logic and print results

Positional Arguments

workspace

name of workspace

logic

logic to add. If logic starts with a '-', please use '--' before the logic to get correct parsing behavior

Optional Arguments

-h --help

show this help message and exit

-f --file

logic file to execute

--raw

print query result without escaping

--exclude-ids

output only refmode values of entities

--csv

print query result to csv files

--delimiter

delimiter when printing query result to csv files

--print

print local predicate PRED. Default '_'

--language

source language of block: lb (default) or lb0

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

33.2.30. lb raw

Syntax

lb raw [-h] [-v] [--is-admin] REQUEST

Description

send raw request to server [for debugging]

Positional Arguments

request

string representation of Request message

Optional Arguments

-h --help

show this help message and exit

-v --verbose

print Request and Response

--is-admin

admin-request

33.2.31. lb removeblock

Syntax

lb removeblock [-h] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
               [--timeout TIMEOUT] [--exclusive]
               [--commit-mode {diskcommit,softcommit}]
               [--branch [NAME]] [-m PREDICATE] [--readonly]
               WORKSPACE BLOCKNAME [BLOCKNAME ...]

Description

remove a block from the workspace

Positional Arguments

workspace

name of workspace

blockname

name of block to remove

Optional Arguments

-h --help

show this help message and exit

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.2.32. lb status

Syntax

lb status [-h] [--active] [--all] [--debug] [WORKSPACE [WORKSPACE ...]]

Description

server status

Positional Arguments

workspace

workspace(s) to be queried

Optional Arguments

-h --help

show this help message and exit

--active

show active requests

--all

show all requests (active and queued)

--debug

show debug details

33.2.33. lb version

Syntax

lb version [-h] [-d] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
           [WORKSPACE]

Description

print version

Positional Arguments

workspace

name of workspace

Optional Arguments

-h --help

show this help message and exit

-d --detail

print detailed version

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.2.34. lb workspaces

Syntax

lb workspaces [-h] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]

Description

list workspaces

Optional Arguments

-h --help

show this help message and exit

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.3. Replication

33.3.1. lb promote-mirror

Syntax

lb promote-mirror [-h] NAME

Description

promote a mirror workspace to master

Positional Arguments

name

name of the local workspace

Optional Arguments

-h --help

show this help message and exit

33.3.2. lb start-mirror

Syntax

lb start-mirror [-h] [--remote-workspace REMOTE-WORKSPACE]
                [--remote-port REMOTE-PORT]
                NAME HOST

Description

start or resume mirroring a remote workspace

Positional Arguments

name

name of the local workspace

host

host name of the remote LogicBlox server

Optional Arguments

-h --help

show this help message and exit

--remote-workspace

name of the remote workspace

--remote-port

port of the remote LogicBlox server

33.3.3. lb stop-mirror

Syntax

lb stop-mirror [-h] NAME

Description

stop mirroring a remote workspace

Positional Arguments

name

name of the local workspace

Optional Arguments

-h --help

show this help message and exit

33.4. Unit Testing

33.4.1. lb unit

Syntax

lb unit [-h] [--suite SUITE [SUITE ...]]
        [--suite-dir SUITEDIR [SUITEDIR ...]] [--test TEST [TEST ...]]
        [--progress] [--list] [--time] [--sequential]
        [--threads THREADS]
        [--exclude-test EXCLUDETEST [EXCLUDETEST ...]]
        [--exclude EXCLUDE [EXCLUDE ...]] [--no-ignore] [--no-cleanup]
        [--default-fixtures]

Description

lb unit

Optional Arguments

-h --help

show this help message and exit

--suite

list of test suites to run

--suite-dir

directory containing suites

--test

list of tests to run

--progress -p

print each test name as it runs

--list -l

display list of tests without running them

--time

use measure engine for this workspace

--sequential -s

run tests sequentially

--threads -t

set number of threads, default to 1

--exclude-test

list of tests to exclude

--exclude -e

list of suites to exclude

--no-ignore

do not ignore suites that have 'suite.ignore' files

--no-cleanup

do not run teardown after each test

--default-fixtures

run default test fixtures if no setup or teardown files exists

33.5. Other Commands

33.5.1. lb batch-script

Syntax

lb batch-script [-h] [--branch [NAME]] [-t] [-r] [-f FILE]
                [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
                WORKSPACE [SCRIPT]

Description

execute a dlbatch script on the server

Positional Arguments

workspace

name of workspace

script

script commands to be executed

Optional Arguments

-h --help

show this help message and exit

--branch

named workspace branch to use for script

-t --transactional

execute commands inside a transaction

-r --return-data

return data created by server

-f --file

file containing script commands to execute

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.5.2. lb compile

Syntax

lb compile [-h]  ...

Description

compile LogicBlox logic

Optional Arguments

-h --help

show this help message and exit

Compile Commands

file

Compile an individual file for testing.

project

Compile a LogicBlox project.

33.5.3. lb compile file

Syntax

lb compile file [-h] [--serialize SERIALIZE]
                [--out-format {logiql,proto,xml}]
                [--stage {final,initial}]
                [--lifetime {database,transaction}]
                [LOGIC-FILE]

Description

Compile an individual file for testing.

Positional Arguments

logic-file

logic (.logic) file to compile

Optional Arguments

-h --help

show this help message and exit

--serialize

serialize binary protobuf ouput to a file. (Requires --output-format proto.)

--out-format

select the format for pretty-printing the compiled output

--stage

select the transaction stage used when compiling

--lifetime

select the logic lifetime used when compiling

33.5.4. lb compile project

Syntax

lb compile project [-h] [--out-dir OUT-DIR] [--libpath LIBPATH]
                   [--progress] [--explain] [--clean]
                   [--max-problems MAX-PROBLEMS]
                   PROJECT-FILE

Description

Compile a LogicBlox project.

Positional Arguments

project-file

project (.project) file to compile

Optional Arguments

-h --help

show this help message and exit

--out-dir

directory to place compiled binaries

--libpath

library path to search

--progress

print the progress of separate compilation

--explain

print explanations as to why certain compilation decisions were made

--clean

separately compile all files in project from scratch

--max-problems

the maximum number of compilations errors and warnings to print

33.5.5. lb compiler-server

Syntax

lb compiler-server [-h]  ...

Description

manage a LogicBlox compilation server

Optional Arguments

-h --help

show this help message and exit

Daemon Commands

start

Start a LogicBlox compilation server

status

Ask a running LogicBlox compilation server for its status.

stop

Stop a running LogicBlox compilation server.

33.5.6. lb compiler-server start

Syntax

lb compiler-server start [-h] [--port PORT] [--console]

Description

Start a LogicBlox compilation server

Optional Arguments

-h --help

show this help message and exit

--port

port number to communicate with the compiler server. Otherwise the default specified in 'lb-server.config' will be used

--console

open an administrative console for the compilation server

33.5.7. lb compiler-server status

Syntax

lb compiler-server status [-h] [--port PORT]

Description

Ask a running LogicBlox compilation server for its status.

Optional Arguments

-h --help

show this help message and exit

--port

port number to communicate with the compiler server. Otherwise the default specified in 'lb-server.config' will be used

33.5.8. lb compiler-server stop

Syntax

lb compiler-server stop [-h] [--port PORT]

Description

Stop a running LogicBlox compilation server.

Optional Arguments

-h --help

show this help message and exit

--port

port number to communicate with the compiler server. Otherwise the default specified in 'lb-server.config' will be used

33.5.9. lb config

Syntax

lb config [-h] [-f FILE] [-e EXTENSION] [-p PREFIX]

Description

creates a Makefile for building LogicBlox projects

Optional Arguments

-h --help

show this help message and exit

-f --file

the configuration file to execute. Defaults to "config.py"

-e --extension

a python file that contains the lbconfig extensions. Will automatically load a file name "lbconfig_local.py"

-p --prefix

the installation prefix. In other words, where to put the output of "make install". Defaults to "out"

33.5.10. lb disassemble

Syntax

lb disassemble [-h] [--out-format {lb0,protobuf}] [--header]
               FILES [FILES ...]

Description

disassemble LogicBlox project summary (lbp) and bytecode (lbb) files

Positional Arguments

files

lbp and lbb files to disassemble

Optional Arguments

-h --help

show this help message and exit

--out-format

selects output format for lbb inputs files. Either pretty printed LB0 or the text serialization of the Google protocol representation. Defaults to lb0. Protocol buffer output must be used with lbp files

--header

attempts to parse out the header of an lbb or lbp file. Useful for debugging invalid or corrupt files

33.5.11. lb export-workspace

Syntax

lb export-workspace [-h] [--overwrite] [--loglevel LOGLEVEL] [-L]
                    [--cwd [DIR]]
                    NAME DEST

Description

export workspace

Positional Arguments

name

name of workspace to export

dest

destination (file path)

Optional Arguments

-h --help

show this help message and exit

--overwrite

overwrite if the destination already exists

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.5.12. lb import-workspace

Syntax

lb import-workspace [-h] [--unique] [--overwrite] [--loglevel LOGLEVEL]
                    [-L] [--cwd [DIR]]
                    [NAME] SRC

Description

import existing unmanaged workspace

Positional Arguments

name

name or prefix of the new workspace

src

location of unmanaged workspace to import

Optional Arguments

-h --help

show this help message and exit

--unique

create a workspace with a unique name

--overwrite

delete existing workspace with the same name, if it exists

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

33.5.13. lb insert-log-message

Syntax

lb insert-log-message [-h] [--loglevel LOGLEVEL] [-L] [--cwd [DIR]]
                      [--timeout TIMEOUT] [--exclusive]
                      [--commit-mode {diskcommit,softcommit}]
                      [--branch [NAME]] [-m PREDICATE] [--readonly]
                      WORKSPACE MESSAGE

Description

insert a message in the log

Positional Arguments

workspace

name of workspace

message

message text

Optional Arguments

-h --help

show this help message and exit

--loglevel

log level to change to. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

-L --log

transfer log from server and print

--cwd

use current working directory. Used to resolve file predicate paths

--timeout -t

transaction timeout (in milliseconds)

--exclusive

set this flag if this request should be the only one running in the workspace

--commit-mode

set to either softcommit or diskcommit

--branch

named workspace branch to use for transaction

-m --monitor

print assertions and retractions for predicate at end of transaction

--readonly

execute this command in a read-only transaction

33.5.14. lb libraries

Syntax

lb libraries [-h] [--libpath LIBPATH] [--dependencies] [--quiet]
             [LIBRARIES [LIBRARIES ...]]

Description

search for LogicBlox libraries

Positional Arguments

libraries

libraries to locate

Optional Arguments

-h --help

show this help message and exit

--libpath

library path to search

--dependencies -d

print the libraries upon which a library depends

--quiet -q

do not display any information. Used when simply querying the exit code

33.5.15. lb measure-service

Syntax

lb measure-service

Description

interact with the measure service

33.5.16. lb translate

Syntax

lb translate [-h]

Description

dummy translate

Optional Arguments

-h --help

show this help message and exit

33.5.17. lb server

Syntax

lb server [-h]  ...

Description

lb server

Optional Arguments

-h --help

show this help message and exit

Server Commands

loglevel

change the server's default log level

start

start an lb-server

status

inquire status of running lb-server

stop

stop a running lb-server

33.5.18. lb server loglevel

Syntax

lb server loglevel [-h] LOGLEVEL

Description

change the server's default log level

Positional Arguments

loglevel

log level to assign. Basic levels are 'error', 'warning', 'info', 'debug'. The lb-server component supports 'perf', 'perf_detail' levels as well. An lb-server level may refer to a specific scope using @, and multiple specifications may be concatenated by colons. Examples: 'info', 'error@transport', 'info:debug@EvaluateRules'

Optional Arguments

-h --help

show this help message and exit

33.5.19. lb server start

Syntax

lb server start [-h] [-p PORT] [--workspace-folder WORKSPACE-FOLDER]
                [--daemonize {false,true}] [--systemd {false,true}]
                [--logfile LOGFILE] [--pidfile PIDFILE]

Description

start an lb-server

Optional Arguments

-h --help

show this help message and exit

-p --port

the port to connect to

--workspace-folder

the folder containing the workspace to connect to

--daemonize

start server in background mode (default: %(default)s)

--systemd

if true, log to stderr, use systemd log levels (e.g. <3>) and omit timestamps (default: lb-server.config)

--logfile

log file (default: lb-server.config)

--pidfile

when started as a daemon, write pid of daemon process in file given as parameter. Similar to nohup x; echo $! > $pidfile. The file will not be removed when the daemon finishes (default: %(default)s)

33.5.20. lb server status

Syntax

lb server status [-h] [--active] [--all] [--debug]
                 [WORKSPACE [WORKSPACE ...]]

Description

inquire status of running lb-server

Positional Arguments

workspace

workspace(s) to be queried

Optional Arguments

-h --help

show this help message and exit

--active

show active requests

--all

show all requests (active and queued)

--debug

show debug details

33.5.21. lb server stop

Syntax

lb server stop [-h]

Description

stop a running lb-server

Optional Arguments

-h --help

show this help message and exit

33.5.22. lb state-dump

Syntax

lb state-dump [-h] [--full-journal]
              [--log-level {CRITICAL,DEBUG,ERROR,INFO,NOTSET,WARN,WARNING}]
              [DIR]

Description

dump whole server state

Positional Arguments

directory

the directory to dump the server state into

Optional Arguments

-h --help

show this help message and exit

--full-journal

whether to dump the full journal state

--log-level

the logging level