georoxy - Convenience command

This command allows you to manage queryproxy server that provides POST-based Query API Endpoint.

If you request too long URL, then it may give “414 Request URI too large” error message. The reason for those "really long URLs" are the URI parameters such as coords, q, attrs for GET /v2/entities. The command solves this problem by POST-based Query POST /v2/ex/entities.

Server

This command allows you to start up a queryproxy server.

ngsi queryproxy server [options]

Options

Options Description
--host VALUE, -h VALUE context broker (required)
--replaceURL VALUE, -u VALUE replace URL
--qhost VALUE host for queryproxy
--port VALUE, -p VALUE port for queryproxy
--https, -s start in https (default: false)
--key VALUE, -k VALUE key file (only needed if https is enabled)
--cert VALUE, -c VALUE cert file (only needed if https is enabled)
--verbose, -v verbose (default: false)
--help show help (default: true)

Example

ngsi --stderr info queryproxy server \
 --host orion \
 --verbose
curl http://localhost:1030/v2/ex/entities --data "type=Device"

Sanity check

This command allows you to check a queryproxy server healthy.

ngsi queryproxy health [options]

Options

Options Description
--host VALUE, -h VALUE queryproxy server host (required)
--pretty, -P pretty format (default: false)
--help show help (default: true)

Example

ngsi server add --host queryproxy --serverType queryproxy --serverHost http://localhost:1030
ngsi queryproxy health --host queryproxy
{
  "ngsi-go": "queryproxy",
  "version": "0.12.0 (git_hash:06a13ec2347c05c9fae96106577c06371b7c6bf5)",
  "health": "OK",
  "orion": "http://orion:1026/v2/entities",
  "verbose": true,
  "uptime": "0 d, 0 h, 0 m, 1 s",
  "timesent": 0,
  "success": 0,
  "failure": 0
}