Skip to content

mapcentia/gc2-cli

BranchesTags

Repository files navigation

gc2-cli

CLI tool for GC2

oclif Version Downloads/week License

Usage

$ npm install -g @mapcentia/gc2-cli
$ gc2 COMMAND
running command...
$ gc2 (--version|-v)
@mapcentia/gc2-cli/2026.3.1 linux-x64 node-v24.14.0
$ gc2 --help [COMMAND]
USAGE
  $ gc2 COMMAND
...

Commands

gc2 admin

Run administration task on the GC2 installation.

USAGE
  $ gc2 admin [-t
    mapfiles|mapcachefile|qgisfiles|schema|migrations|diskcleanup|cachestats|cachecleanup|insertmeta]

FLAGS
  -t, --task=<option>  The task to run.
                       <options:
                       mapfiles|mapcachefile|qgisfiles|schema|migrations|diskcleanup|cachestats|cachecleanup|insertmeta>

DESCRIPTION
  Run administration task on the GC2 installation.

See code: src/commands/admin.ts

gc2 client add [NAME]

Create new client.

USAGE
  $ gc2 client add [NAME] [-i <value>] [-n <value>] [-d <value>] [-r <value>] [-H <value>] [-p] [-c] [-t] [-s]
    [-S] [-h]

ARGUMENTS
  [NAME]  Name of new client.

FLAGS
  -H, --homepage=<value>      Homepage of the application.
  -S, --social_signup         Enable users to sign up for a new account with social login.
  -c, --confirm               Client user must confirm the token exchange.
  -d, --description=<value>   Description of new client.
  -h, --help                  Show CLI help.
  -i, --id=<value>            Id of new client.
  -n, --name=<value>          Name of new client.
  -p, --public                Public client. No secret needed.
  -r, --redirect_uri=<value>  Redirect uri. Redirects will only be allowed to an uri in this list.
  -s, --allow_signup          Allow users to sign up for a new account in the web-dialog.
  -t, --two_factor            Client user must authenticate with two factor authentication.

DESCRIPTION
  Create new client.

See code: src/commands/client/add.ts

gc2 client drop [ID]

Drop a client.

USAGE
  $ gc2 client drop [ID] [-h]

ARGUMENTS
  [ID]  Id of client.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Drop a client.

See code: src/commands/client/drop.ts

gc2 client get [ID]

List client(s).

USAGE
  $ gc2 client get [ID] [-h]

ARGUMENTS
  [ID]  Client id

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  List client(s).

See code: src/commands/client/get.ts

gc2 client update [ID]

Update a client.

USAGE
  $ gc2 client update [ID] [-n <value>] [-d <value>] [-r <value>] [-p <value>] [-p] [-c] [-t] [-s] [-S] [-h]

ARGUMENTS
  [ID]  Id of client.

FLAGS
  -S, --social_signup         Enable users to sign up for a new account with social login.
  -c, --confirm               Client user must confirm the token exchange.
  -d, --description=<value>   Description of new client.
  -h, --help                  Show CLI help.
  -n, --name=<value>          New name ofclient.
  -p, --homepage=<value>      Homepage of the application.
  -p, --public                Public client. No secret needed.
  -r, --redirect_uri=<value>  Redirect uri. Redirects will only be allowed to an uri in this list.
  -s, --allow_signup          Allow users to sign up for a new account in the web-dialog.
  -t, --two_factor            Client user must authenticate with two factor authentication.

DESCRIPTION
  Update a client.

See code: src/commands/client/update.ts

gc2 column add [SCHEMA] [TABLE] [COLUMN] [TYPE]

Add a new column to a table.

USAGE
  $ gc2 column add [SCHEMA] [TABLE] [COLUMN] [TYPE] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.
  [COLUMN]  Name of new column.
  [TYPE]    Data type of new column.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Add a new column to a table.

See code: src/commands/column/add.ts

gc2 column default [SCHEMA] [TABLE] [COLUMN] [DEFAULT]

Set default value for column. The default value is set when inserting a new row without a value for the column.

USAGE
  $ gc2 column default [SCHEMA] [TABLE] [COLUMN] [DEFAULT] [-h]

ARGUMENTS
  [SCHEMA]   Name of schema.
  [TABLE]    Name of table.
  [COLUMN]   Name of column.
  [DEFAULT]  Default value. Set to 'null' for removing an already set value.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Set default value for column. The default value is set when inserting a new row without a value for the column.

See code: src/commands/column/default.ts

gc2 column drop [SCHEMA] [TABLE] [COLUMN]

Drop a column from table.

USAGE
  $ gc2 column drop [SCHEMA] [TABLE] [COLUMN] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.
  [COLUMN]  Name of column to drop.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Drop a column from table.

See code: src/commands/column/drop.ts

gc2 column get [SCHEMA] [TABLE] [COLUMN]

Get description of a column.

USAGE
  $ gc2 column get [SCHEMA] [TABLE] [COLUMN] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.
  [COLUMN]  Name of column.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Get description of a column.

See code: src/commands/column/get.ts

gc2 column nullable [SCHEMA] [TABLE] [COLUMN] [NULLABLE]

Set nullable on column. If set the column can't be empty.

USAGE
  $ gc2 column nullable [SCHEMA] [TABLE] [COLUMN] [NULLABLE] [-h]

ARGUMENTS
  [SCHEMA]    Name of schema.
  [TABLE]     Name of table.
  [COLUMN]    Name of column.
  [NULLABLE]  (true|false) Set column to nullable.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Set nullable on column. If set the column can't be empty.

See code: src/commands/column/nullable.ts

gc2 column rename [SCHEMA] [TABLE] [COLUMN] [NAME]

Rename a column.

USAGE
  $ gc2 column rename [SCHEMA] [TABLE] [COLUMN] [NAME] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.
  [COLUMN]  Existing name of column.
  [NAME]    New name for column.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Rename a column.

See code: src/commands/column/rename.ts

gc2 column type [SCHEMA] [TABLE] [COLUMN] [TYPE]

Set the data on column. It might be, the existing data type can't be transformed to the chosen one.

USAGE
  $ gc2 column type [SCHEMA] [TABLE] [COLUMN] [TYPE] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.
  [COLUMN]  Name of column.
  [TYPE]    New data type for column.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Set the data on column. It might be, the existing data type can't be transformed to the chosen one.

See code: src/commands/column/type.ts

gc2 connect [HOST]

Set connection. You can use flags to set host, database and user. If one or more flags are missing, you will be prompted instead.

USAGE
  $ gc2 connect [HOST] [-h] [-r]

ARGUMENTS
  [HOST]  Server host with scheme: http(s)

FLAGS
  -h, --help   Show CLI help.
  -r, --reset  Reset connection.

DESCRIPTION
  Set connection. You can use flags to set host, database and user. If one or more flags are missing, you will be
  prompted instead.

See code: src/commands/connect.ts

gc2 constraint add [SCHEMA] [TABLE] [COLUMNS] [TYPE] [NAME]

Add a constraint.

USAGE
  $ gc2 constraint add [SCHEMA] [TABLE] [COLUMNS] [TYPE] [NAME] [-h] [-t <value>] [-e <value>] [-c <value>]

ARGUMENTS
  [SCHEMA]   Name of schema.
  [TABLE]    Name of table.
  [COLUMNS]  Columns for use in the constraint (comma separated).
  [TYPE]     (primary|unique|foreign|check) Type of constraint.
  [NAME]     Name for constraint.

FLAGS
  -h, --help  Show CLI help.

CHECK OPTIONS FLAGS
  -c, --check=<value>  Check expression

FOREIGN KEY OPTIONS FLAGS
  -e, --referencedColumns=<value>  Referenced columns.
  -t, --referencedTable=<value>    Referenced table.

DESCRIPTION
  Add a constraint.

See code: src/commands/constraint/add.ts

gc2 constraint drop [SCHEMA] [TABLE] [NAME]

Drop a constraint.

USAGE
  $ gc2 constraint drop [SCHEMA] [TABLE] [NAME] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.
  [NAME]    Name of constraint.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Drop a constraint.

See code: src/commands/constraint/drop.ts

gc2 constraint get [SCHEMA] [TABLE] [NAME]

Get constraint details.

USAGE
  $ gc2 constraint get [SCHEMA] [TABLE] [NAME] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.
  [NAME]    Name of constraint.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Get constraint details.

See code: src/commands/constraint/get.ts

gc2 foreign drop SCHEMAS [INCLUDE]

Drop all foreign tables in schema.

USAGE
  $ gc2 foreign drop SCHEMAS [INCLUDE] [-h]

ARGUMENTS
  SCHEMAS    Schemas for dropping (comma separated).
  [INCLUDE]  Only drop named foreign tables. Comma separated.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Drop all foreign tables in schema.

See code: src/commands/foreign/drop.ts

gc2 foreign import SERVER FROM TO [INCLUDE]

Import schema from foreign server.

USAGE
  $ gc2 foreign import SERVER FROM TO [INCLUDE] [-h]

ARGUMENTS
  SERVER     Name of foreign server.
  FROM       Comma separated list of foreign schemas.
  TO         Comma separated list of local schemas.
  [INCLUDE]  Only include named relations in import. Comma separated.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Import schema from foreign server.

See code: src/commands/foreign/import.ts

gc2 foreign materialize FROM [TO] [INCLUDE]

Create materialized views of foreign tables.

USAGE
  $ gc2 foreign materialize FROM [TO] [INCLUDE] [-h] [-p <value>] [-s <value>]

ARGUMENTS
  FROM       Comma separated list of source schemas.
  [TO]       comma separated list of target schemas.
  [INCLUDE]  only include named foreign tables. Comma separated.

FLAGS
  -h, --help            Show CLI help.
  -p, --prefix=<value>  prefix for created foreign tables
  -s, --suffix=<value>  suffix for created foreign tables

DESCRIPTION
  Create materialized views of foreign tables.

See code: src/commands/foreign/materialize.ts

gc2 grid

Add a fishnet grid from an input polygon.

USAGE
  $ gc2 grid -t <value> -e <value> -s <value> [-h]

FLAGS
  -e, --extent=<value>  (required) Polygon table which should be used for extent.
  -h, --help            Show CLI help.
  -s, --size=<value>    (required) Cell size in map units.
  -t, --table=<value>   (required) Name of the new fishnet table.

DESCRIPTION
  Add a fishnet grid from an input polygon.

See code: src/commands/grid.ts

gc2 help [COMMAND]

Display help for gc2.

USAGE
  $ gc2 help [COMMAND...] [-n]

ARGUMENTS
  [COMMAND...]  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for gc2.

See code: @oclif/plugin-help

gc2 import [PATH] [SCHEMA]

Import files. Set path to a file or folder, which will be compressed, uploaded and imported into GC2.

USAGE
  $ gc2 import [PATH] [SCHEMA] [-s <value>] [-t <value>] [-T <value>] [-x <value>] [-y <value>] [-d] [-a]
    [-r] [-p] [-n <value>] [-h]

ARGUMENTS
  [PATH]    [default: .] Input path to file or folder.
  [SCHEMA]  Destination schema.

FLAGS
  -T, --timestamp=<value>         Name of timestamp field. Create a timestamp field in the import table. Omit argument
                                  for no timestamp field.
  -a, --append                    Append to existing table instead of creating new.
  -d, --dry_run                   Dry run. Only analyse files with no import.
  -h, --help                      Show CLI help.
  -n, --table_name=<value>        Name of table. Defaults to the name of the file. Can only be used when importing
                                  single file - not directories unless --append is used
  -p, --p_multi                   Promote single geometries to multi part.
  -r, --truncate                  Truncate table before appending. Only have effect if --append is set.
  -s, --s_srs=<value>             Fallback source SRS. Will be used if file doesn't contain projection information
  -t, --t_srs=<value>             Fallback target SRS. Will be used if no authority name/code is available. Defaults to
                                  EPSG:4326.
  -x, --x_possible_names=<value>  Specify the potential names of the columns that can contain X/longitude. Only effects
                                  CSV. Defaults to "lon*,Lon*,x,X"]
  -y, --y_possible_names=<value>  Specify the potential names of the columns that can contain Y/latitude. Only effects
                                  CSV. Defaults to "lat*,Lat*,y,Y"]

DESCRIPTION
  Import files. Set path to a file or folder, which will be compressed, uploaded and imported into GC2.

See code: src/commands/import.ts

gc2 index add [SCHEMA] [TABLE] [COLUMNS] [METHOD] [NAME]

Add an new index to table.

USAGE
  $ gc2 index add [SCHEMA] [TABLE] [COLUMNS] [METHOD] [NAME] [-h]

ARGUMENTS
  [SCHEMA]   Name of schema.
  [TABLE]    Name of table.
  [COLUMNS]  Columns to index (comma separated).
  [METHOD]   (btree|brin|gin|gist|hash) Index method.
  [NAME]     Name of new index.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Add an new index to table.

See code: src/commands/index/add.ts

gc2 index drop [SCHEMA] [TABLE] [NAME]

Drop an index from table.

USAGE
  $ gc2 index drop [SCHEMA] [TABLE] [NAME] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.
  [NAME]    Name of index.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Drop an index from table.

See code: src/commands/index/drop.ts

gc2 index get [SCHEMA] [TABLE] [NAME]

Get index definition.

USAGE
  $ gc2 index get [SCHEMA] [TABLE] [NAME] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.
  [NAME]    Name of index.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Get index definition.

See code: src/commands/index/get.ts

gc2 login

Sign in to Centia. Use connect to set the host first.

USAGE
  $ gc2 login [-h] [-p <value>] [-u <value>] [-f password|device|code]

FLAGS
  -f, --flow=<option>     [default: code] Authentication flow
                          <options: password|device|code>
  -h, --help              Show CLI help.
  -p, --password=<value>  Password
  -u, --user=<value>      Username/database

DESCRIPTION
  Sign in to Centia. Use `connect` to set the host first.

See code: src/commands/login.ts

gc2 logout

Logout the current user.

USAGE
  $ gc2 logout [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Logout the current user.

See code: src/commands/logout.ts

gc2 privilege get [SCHEMA] [TABLE]

Get user privileges on table.

USAGE
  $ gc2 privilege get [SCHEMA] [TABLE] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Get user privileges on table.

See code: src/commands/privilege/get.ts

gc2 privilege set [SCHEMA] [TABLE] [USER] [PRIVILEGE]

Set user privileges on table.

USAGE
  $ gc2 privilege set [SCHEMA] [TABLE] [USER] [PRIVILEGE] [-h]

ARGUMENTS
  [SCHEMA]     Name of schema.
  [TABLE]      Name of table.
  [USER]       Name of user.
  [PRIVILEGE]  Which privilege.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Set user privileges on table.

See code: src/commands/privilege/set.ts

gc2 rule add

Create a new rule.

USAGE
  $ gc2 rule add [-P <value>] [-u <value>] [-s <value>] [-p <value>] [-c <value>] [-t <value>] [-i <value>]
    [-a <value>] [-f <value>] [-h]

FLAGS
  -P, --priority=<value>  Priority
  -a, --access=<value>    Access
  -c, --schema=<value>    schema
  -f, --filter=<value>    Filter
  -h, --help              Show CLI help.
  -i, --iprange=<value>   Ip range
  -p, --request=<value>   Request
  -s, --service=<value>   Service
  -t, --table=<value>     Table
  -u, --username=<value>  Username

DESCRIPTION
  Create a new rule.

See code: src/commands/rule/add.ts

gc2 rule drop [ID]

Drop a rule.

USAGE
  $ gc2 rule drop [ID] [-h]

ARGUMENTS
  [ID]  Id of rule

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Drop a rule.

See code: src/commands/rule/drop.ts

gc2 rule get [ID]

Get rule(s).

USAGE
  $ gc2 rule get [ID] [-h]

ARGUMENTS
  [ID]  Rule id

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Get rule(s).

See code: src/commands/rule/get.ts

gc2 rule update [ID]

Update a rule.

USAGE
  $ gc2 rule update [ID] [-p <value>] [-u <value>] [-s <value>] [-r <value>] [-c <value>] [-t <value>] [-i
    <value>] [-a <value>] [-f <value>] [-h]

ARGUMENTS
  [ID]  Rule id.

FLAGS
  -a, --access=<value>    Access
  -c, --schema=<value>    schema
  -f, --filter=<value>    Filter
  -h, --help              Show CLI help.
  -i, --iprange=<value>   Ip range
  -p, --priority=<value>  Priority
  -r, --request=<value>   Request
  -s, --service=<value>   Service
  -t, --table=<value>     Table
  -u, --username=<value>  Username

DESCRIPTION
  Update a rule.

See code: src/commands/rule/update.ts

gc2 scheduler start JOB [INCLUDE]

Starts a scheduler job

USAGE
  $ gc2 scheduler start JOB [INCLUDE] [-h] [-n <value>] [-f]

ARGUMENTS
  JOB        Job id to start. Can also be a schema name and all jobs for that schema will be started.
  [INCLUDE]  Only include jobs for named tables. Comma separated. Will only have effect if schema is used in "job"
             option.

FLAGS
  -f, --force         Force table to be recreated.
  -h, --help          Show CLI help.
  -n, --name=<value>  Name the started job(s). The name will be listed in the progress status.

DESCRIPTION
  Starts a scheduler job

See code: src/commands/scheduler/start.ts

gc2 scheduler status

Get jobs in progress.

USAGE
  $ gc2 scheduler status [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Get jobs in progress.

See code: src/commands/scheduler/status.ts

gc2 schema add [SCHEMA]

Create a new schema.

USAGE
  $ gc2 schema add [SCHEMA] [-h]

ARGUMENTS
  [SCHEMA]  Name of new schema.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Create a new schema.

See code: src/commands/schema/add.ts

gc2 schema drop [SCHEMA]

Drop a schema.

USAGE
  $ gc2 schema drop [SCHEMA] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Drop a schema.

See code: src/commands/schema/drop.ts

gc2 schema get [SCHEMA]

Get list of tables in schema.

USAGE
  $ gc2 schema get [SCHEMA] [-R] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.

FLAGS
  -R, --raw   Print raw data.
  -h, --help  Show CLI help.

DESCRIPTION
  Get list of tables in schema.

See code: src/commands/schema/get.ts

gc2 schema rename [SCHEMA] [NAME]

Rename schema.

USAGE
  $ gc2 schema rename [SCHEMA] [NAME] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [NAME]    New name for schema.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Rename schema.

See code: src/commands/schema/rename.ts

gc2 seed list

List running seed jobs.

USAGE
  $ gc2 seed list [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  List running seed jobs.

See code: src/commands/seed/list.ts

gc2 seed log

Get progress of a running job.

USAGE
  $ gc2 seed log -u <value> [-h]

FLAGS
  -h, --help          Show CLI help.
  -u, --uuid=<value>  (required) UUID of seed job.

DESCRIPTION
  Get progress of a running job.

See code: src/commands/seed/log.ts

gc2 seed start

Starts a seed job.

USAGE
  $ gc2 seed start -n <value> -l <value> -g <value> -s <value> -e <value> -x <value> [-h] [-t <value>] [-f]

FLAGS
  -e, --end=<value>      (required) End zoom level (the higher number).
  -f, --force            Force seed job - overwrites existing tiles.
  -g, --grid=<value>     (required) Grid to use.
  -h, --help             Show CLI help.
  -l, --layer=<value>    (required) Layer to seed [schema].[relation]
  -n, --name=<value>     (required) Name of seed job.
  -s, --start=<value>    (required) Start zoom level (the lower number).
  -t, --threads=<value>  Number of parallel threads that should be used to request tiles from the WMS source.
  -x, --extent=<value>   (required) Polygon layer which set the extent for the seeding [schema].[relation]

DESCRIPTION
  Starts a seed job.

See code: src/commands/seed/start.ts

gc2 seed stop

Stops a running seed job.

USAGE
  $ gc2 seed stop -u <value> [-h]

FLAGS
  -h, --help          Show CLI help.
  -u, --uuid=<value>  (required) UUID of seed job.

DESCRIPTION
  Stops a running seed job.

See code: src/commands/seed/stop.ts

gc2 sql

Run SQL statements. If run without --statement inactive mode will be enabled.

USAGE
  $ gc2 sql [-s <value>] [-c <value>] [-f <value>] [-g wkt|geojson] [-p <value>] [-h]

FLAGS
  -c, --srs=<value>         [default: 4326] Output spatial reference system. Use EPSG codes.
  -f, --format=<value>      Output file format.
  -g, --geoformat=<option>  Output geometry in CSV and Excel.
                            <options: wkt|geojson>
  -h, --help                Show CLI help.
  -p, --path=<value>        [default: .] Output path to file. If omitted file is saved in current folder.
  -s, --statement=<value>   SQL statement. Any select, insert, update and delete. No altering of schema is allowed.

DESCRIPTION
  Run SQL statements. If run without --statement inactive mode will be enabled.

See code: src/commands/sql.ts

gc2 stat

Get usage statistics.

USAGE
  $ gc2 stat [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Get usage statistics.

See code: src/commands/stat.ts

gc2 symbol PATH

Create a symbol file from a directory for use in Vidi Symbol extension.

USAGE
  $ gc2 symbol PATH [-h] [-f <value>]

ARGUMENTS
  PATH  Path to directory with SVG files.

FLAGS
  -f, --file=<value>  Output file name. If omitted the content will be printed.
  -h, --help          Show CLI help.

DESCRIPTION
  Create a symbol file from a directory for use in Vidi Symbol extension.

See code: src/commands/symbol.ts

gc2 table add [SCHEMA] [TABLE]

Create a new table.

USAGE
  $ gc2 table add [SCHEMA] [TABLE] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Create a new table.

See code: src/commands/table/add.ts

gc2 table drop [SCHEMA] [TABLE]

Drop a table.

USAGE
  $ gc2 table drop [SCHEMA] [TABLE] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Drop a table.

See code: src/commands/table/drop.ts

gc2 table event [SCHEMA] [TABLE] [EVENT]

Enable emitting of realtime events from tables.

USAGE
  $ gc2 table event [SCHEMA] [TABLE] [EVENT] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.
  [EVENT]   Emit events.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Enable emitting of realtime events from tables.

See code: src/commands/table/event.ts

gc2 table get [SCHEMA] [TABLE]

Get table definition.

USAGE
  $ gc2 table get [SCHEMA] [TABLE] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Get table definition.

See code: src/commands/table/get.ts

gc2 table move [SCHEMA] [TABLE] [DESTINATION]

Move table to another schema.

USAGE
  $ gc2 table move [SCHEMA] [TABLE] [DESTINATION] [-h]

ARGUMENTS
  [SCHEMA]       Name of schema.
  [TABLE]        Name of table.
  [DESTINATION]  Destination schema.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Move table to another schema.

See code: src/commands/table/move.ts

gc2 table rename [SCHEMA] [TABLE] [NAME]

Rename table.

USAGE
  $ gc2 table rename [SCHEMA] [TABLE] [NAME] [-h]

ARGUMENTS
  [SCHEMA]  Name of schema.
  [TABLE]   Name of table.
  [NAME]    New name for table.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Rename table.

See code: src/commands/table/rename.ts

gc2 user add [NAME]

Create new user.

USAGE
  $ gc2 user add [NAME] [-h] [-p <value>] [-e <value>] [-P <value>] [-d]

ARGUMENTS
  [NAME]  Name of new user

FLAGS
  -P, --properties=<value>  Properties for new user
  -d, --default_user        The default user is the user that is used when no token is provided. Use for public
                            applications where users should not be able to access data without a token.
  -e, --email=<value>       E-mail for new user
  -h, --help                Show CLI help.
  -p, --password=<value>    password for new user.

DESCRIPTION
  Create new user.

See code: src/commands/user/add.ts

gc2 user drop [NAME]

Drop existing user.

USAGE
  $ gc2 user drop [NAME] [-h]

ARGUMENTS
  [NAME]  Name of user to drop.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Drop existing user.

See code: src/commands/user/drop.ts

gc2 user get [ID]

Get user(s).

USAGE
  $ gc2 user get [ID] [-h]

ARGUMENTS
  [ID]  User id

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Get user(s).

See code: src/commands/user/get.ts

gc2 user update [NAME]

Update user.

USAGE
  $ gc2 user update [NAME] [-h] [-p <value>] [-d] [-e <value>] [-g <value>]

ARGUMENTS
  [NAME]  Name of user.

FLAGS
  -d, --default_user        The default user is the user that is used when no token is provided. Use for public
                            applications where users should not be able to access data without a token.
  -e, --properties=<value>  New properties.
  -g, --group=<value>       New group.
  -h, --help                Show CLI help.
  -p, --password=<value>    New password for user.

DESCRIPTION
  Update user.

See code: src/commands/user/update.ts

gc2 view backup SCHEMAS

Backup all (mat)views definitions in schema.

USAGE
  $ gc2 view backup SCHEMAS [-h]

ARGUMENTS
  SCHEMAS  Schemas for backup (comma separated).

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Backup all (mat)views definitions in schema.

See code: src/commands/view/backup.ts

gc2 view get SCHEMA

Get "*" definitions from backup for schema.

USAGE
  $ gc2 view get SCHEMA [-h]

ARGUMENTS
  SCHEMA  Get star views for schema.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Get "*" definitions from backup for schema.

See code: src/commands/view/get.ts

gc2 view refresh SCHEMAS [INCLUDE]

Refresh all materialized views in schema.

USAGE
  $ gc2 view refresh SCHEMAS [INCLUDE] [-h]

ARGUMENTS
  SCHEMAS    Comma separated list of schemas.
  [INCLUDE]  Only include named views in restore. Comma separated.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Refresh all materialized views in schema.

See code: src/commands/view/refresh.ts

gc2 view restore FROM [TO] [INCLUDE]

Restore all (mat)views definitions from schema.

USAGE
  $ gc2 view restore FROM [TO] [INCLUDE] [-h]

ARGUMENTS
  FROM       Comma separated list of source schemas.
  [TO]       Comma separated list of target schemas.
  [INCLUDE]  Only include named views in restore. Comma separated.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Restore all (mat)views definitions from schema.

See code: src/commands/view/restore.ts

About

CLI for GC2. Do admin tasks, start MapCache seed jobs and more.

Topics

cli

Resources

Readme

License

GPL-3.0 license
Activity

Stars

1 star

Watchers

2 watching

Forks

1 fork
Report repository

Releases 2

2024.12.3 Latest
Dec 11, 2024
+ 1 release

Packages

 
 
 

Contributors

Languages