Gc2 NPM | npm.io

gc2-cli

CLI tool for GC2

Usage

$ npm install -g gc2
$ gc2 COMMAND
running command...
$ gc2 (--version|-v)
gc2/2024.4.3 linux-x64 node-v18.16.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>  (required) 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 column add SCHEMA TABLE COLUMN TYPE`

Add column

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

ARGUMENTS
  SCHEMA  Name of schema
  TABLE   Name of table
  COLUMN  Name of new column
  TYPE    Type of new column

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Add column

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

`gc2 column drop SCHEMA TABLE COLUMN`

Drop column

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 column

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

`gc2 column nullable SCHEMA TABLE COLUMN NULLABLE`

Set column to nullable

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)

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Set column to nullable

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

`gc2 column rename SCHEMA TABLE COLUMN NAME`

Rename 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 column

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

`gc2 connect`

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 [-h] [-r] [-H <value>] [-d <value>] [-u <value>]

FLAGS
  -H, --host=<value>      Host
  -d, --database=<value>  Database
  -h, --help              Show CLI help.
  -r, --reset             Reset connection
  -u, --user=<value>      User

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>]

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

FLAGS
  -h, --help  Show CLI help.

FOREIGN KEY OPTIONS FLAGS
  -e, --referencedColumns=<value>  Referenced column
  -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 for constraint

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Drop a constraint

See code: src/commands/constraint/drop.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 mat views from 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 mat views from 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 [COMMANDS]`

Display help for gc2.

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

ARGUMENTS
  COMMANDS...  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`

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

USAGE
  $ gc2 import -p <value> [-c <value>] [-h]

FLAGS
  -c, --srs=<value>    [default: 4326] Output spatial reference system. Use EPSG codes.
  -h, --help           Show CLI help.
  -p, --input=<value>  (required) Input path to file or folder.

DESCRIPTION
  Import files to GC2. 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 index

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

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

FLAGS
  -h, --help    Show CLI help.
  -u, --unique  Causes the system to check for duplicate values in the table when the index is created

DESCRIPTION
  Add index

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

`gc2 index drop SCHEMA TABLE [NAME]`

Add column

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

ARGUMENTS
  SCHEMA  Name of schema
  TABLE   Name of table
  NAME    Name for index

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Add column

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

`gc2 login`

Sign in to GC2. You can set the connect options beforehand using the connect command. Providing the password on the commandline is considered insecure. It's better to be prompt for the password

USAGE
  $ gc2 login [-h] [-p <value>]

FLAGS
  -h, --help              Show CLI help.
  -p, --password=<value>  Password

DESCRIPTION
  Sign in to GC2. You can set the connect options beforehand using the `connect` command. Providing the password on the
  commandline is considered insecure. It's better to be prompt for the password

See code: src/commands/login.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 id 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 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`

Logs

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

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

DESCRIPTION
  Logs

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 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 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>] [-p <value>] [-h]

FLAGS
  -c, --srs=<value>        [default: 4326] Output spatial reference system. Use EPSG codes.
  -f, --format=<value>     [default: ogr/GPKG] Output file format.
  -h, --help               Show CLI help.
  -p, --path=<value>       Output path to file. If omitted file is saved in current folder.
  -s, --statement=<value>  SQL statement

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

See code: src/commands/sql.ts

`gc2 table add SCHEMA TABLE`

Create new table

USAGE
  $ gc2 table add SCHEMA TABLE [-h]

ARGUMENTS
  SCHEMA  name of schema where the new table should be created
  TABLE   name of new table

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Create new table

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

`gc2 table drop SCHEMA TABLE`

Drop table

USAGE
  $ gc2 table drop SCHEMA TABLE [-h]

ARGUMENTS
  SCHEMA  Name of schema
  TABLE   Name of table to drop

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Drop table

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

`gc2 table get SCHEMA TABLE`

Get table definition.

USAGE
  $ gc2 table get SCHEMA TABLE [-h] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv |
    --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>]

ARGUMENTS
  SCHEMA  Name of schema
  TABLE   Name of table

FLAGS
  -h, --help             Show CLI help.
  -x, --extended         show extra columns
      --columns=<value>  only show provided columns (comma-separated)
      --csv              output is csv format [alias: --output=csv]
      --filter=<value>   filter property by partial string matching, ex: name=foo
      --no-header        hide table header from output
      --no-truncate      do not truncate output to fit screen
      --output=<option>  output in a more machine friendly format
                         <options: csv|json|yaml>
      --sort=<value>     property to sort by (prepend '-' for descending)

DESCRIPTION
  Get table definition.

See code: src/commands/table/get.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 update [CHANNEL]`

update the gc2 CLI

USAGE
  $ gc2 update [CHANNEL] [-a] [-v <value> | -i] [--force]

FLAGS
  -a, --available        Install a specific version.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
      --force            Force a re-download of the requested version.

DESCRIPTION
  update the gc2 CLI

EXAMPLES
  Update to the stable channel:

    $ gc2 update stable

  Update to a specific version:

    $ gc2 update --version 1.0.0

  Interactively select version:

    $ gc2 update --interactive

  See available versions:

    $ gc2 update --available

See code: @oclif/plugin-update

`gc2 user add NAME`

Create user with password and email

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

ARGUMENTS
  NAME  Name of new user

FLAGS
  -e, --email=<value>       (required) email of new user
  -e, --properties=<value>  properties of new user
  -h, --help                Show CLI help.
  -p, --password=<value>    (required) password of new user

DESCRIPTION
  Create user with password and email

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 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

oclif