Tethys Platform
Table Of Contents
Table Of Contents

app_settings command

Manage app settings.

usage: tethys app_settings [-h] {list,create,remove} ...

Sub-commands:

list

List all settings for a specified app

tethys app_settings list [-h] app

Positional Arguments

app

The app ("<app_package>") to list the Settings for.

create

Create a Setting for an app.

tethys app_settings create [-h] -a APP -n NAME [-d DESCRIPTION] [-r]
                           [-i INITIALIZER] [-z]
                           {ps_database} ...

Named Arguments

-a, --app

The app ("<app_package>") to create the Setting for.

-n, --name

The name of the Setting to create.

-d, --description

A description for the Setting to create.

-r, --required

Include this flag if the Setting is required for the app.

Default: False

-i, --initializer

The function that initializes the PersistentStoreSetting database.

-z, --initialized

Include this flag if the database is already initialized.

Default: False

Sub-commands:

ps_database

Create a PersistentStoreDatabaseSetting

tethys app_settings create ps_database [-h] [-s] [-y]
Named Arguments
-s, --spatial

Include this flag if the database requires spatial capabilities.

Default: False

-y, --dynamic

Include this flag if the database should be considered to be dynamically created.

Default: False

remove

Remove a Setting for an app.

tethys app_settings remove [-h] -n NAME [-f] app

Positional Arguments

app

The app ("<app_package>") to remove the Setting from.

Named Arguments

-n, --name

The name of the Setting to remove.

-f, --force

Force removal without confirming.

Default: False