Schema Repository Command Line Reference

The tibschemad command starts the schema repository process.

The schema repository executable is installed in TIBCO_HOME/akd/repo/version/bin/.

Client Communication

Parameter Arguments Description
-l

-listen

interface:port Optional.

The repository listens for requests at this interface and port. It is good practice to direct requests through the FTL server, which redirects the requests to an appropriate schema repository.

If not specified on the command line, the default location is localhost:8081.

-compat loose or strict Optional.

Set compatibility level.

strict (default) - Require strict REST headers including response typing wherever applicable. All TIBCO products use these styles of REST requests.

loose - Relax requirements on client requests and attempt to accommodate a wider range of third-party tools. All TIBCO products operate and provide full functionality using this mode.

FTL Server Back-End Storage

Parameter Arguments Description
-ftl URL Optional.

A list of the FTL server URLs, separated by the pipe character (|).

The schema repository uses the FTL server at this location for schema storage.

If not specified on the command line, the default URL is http://localhost:8080

-u

-user

user Optional; required for communication with a secure FTL server.

The schema repository authenticates itself to the FTL server using this user name.

-p

-password

password Optional; required for communication with a secure FTL server.
The repository authenticates itself to the FTL server using this password. The password can be supplied using one of the following forms:
  • stdin
  • env:environment_var_name
  • file:password_file_path
  • pass:password

For further details, see Password Security.

-trust-file file_path Optional; required for TLS communication with a secure FTL server.

When present, the repository process reads the FTL server's trust file from this file, and uses that trust data in communications with the secure FTL server.

For more information about security, see TIBCO FTL® Security guide.

-trust-everyone Optional; the schema repository trusts any FTL server without verifying trust in the FTL server's certificate.
Warning: Production use of this option except for convenience in development and testing is not recommended because it eliminates all authentication.
-mem Optional; when specified the schema repository stores schemas only in process memory (which is not persistent in the event of a schema repository restart) instead of using the FTL server for backend storage.
Warning: Do not use this mode in production environments as changes are not retained across schema repository restarts.

Configuration

Parameter Arguments Description
-c

-config

file_path Optional; path to a JSON configuration file.

Command line arguments override environment variables, which override configuration file arguments.

When absent, the schema repository first looks for ./.tibschemad, then ~/.tibschemad.

-env Optional; the repository displays the environment variables defining its current configuration and exits.
-show-config Optional; the repository displays the contents of a configuration file that define its current configuration and exits.

Tracing and Logging

Parameter Arguments Description
-debug Optional; when present, display debugging level information from the schema repository.
-q

-quiet

Optional; when present, the schema repository displays minimal output.
-v

-verbose

Optional; when present, display verbose output.
-version Optional; when present, the repository displays version information and exits.