Status
...
Page properties | ||||
---|---|---|---|---|
|
...
...
|
...
|
Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).
...
/v1/info | |
Verb: GET | Response code: 200 OK |
Get meta data for this cluster | |
Request body | {} |
Response body | { "product_name": "Apache Flink", "version": "1.16" # Flink version } |
Get Version
/api_versions | |
Verb: GET | Response code: 200 OK |
Get the current avaliable versions for the Rest Endpoint. The client can choose one of the return version as the protocol for later communicate. | |
Request body | {} |
Response body | { "versions": ["v1", "v2"] # The rest endpoint support version. } |
Options
Please using the following options to configure the REST endpint.
...
Option | Required | Default value | Description |
---|---|---|---|
sql-gateway.session.idle-timeout | No | 5 min | Session will be closed when it's not accessed for this duration, which can be disabled by setting to zero or negative value. |
sql-gateway.session.check-interval | No | 1 min | The check interval for session timeout, which can be disabled by setting to zero or negative value. |
sql-gateway.session.max-num | No | 1000000 | The number of the active sessions. |
sql-gateway.worker.threads.max | No | 500 | Maximum number of worker threads for the gateway workers. |
sql-gateway.worker.threads.min | No | 5 | Minimum number of worker threads for the gateway workers. |
sql-gateway.worker.keepalive-time | No | 5 min | Keepalive time for an idle worker thread. When the number of workers exceeds the min workers, excessive threads are killed after this time interval. |
SQL Gateway
...
Script
Considering many users prefer to use the SqlGateway only, we propose to add a script named the `sql-server.sh` in the bin directory. Users can use the command
Code Block | ||
---|---|---|
| ||
./sql-gateway.sh (start|stop|stop-all) [args] |
to manipulate the sql gateway.
Command | Parmeter | Description |
---|---|---|
start | -Dkey=value | Start the gateway and write the pid of the startted sql gateway into the pid file. Users can specify the -Dkey=value to specify the parameters. For example, users can specify `-Dsql-gateway.endpoint.rest.address=127.0.0.1` |
stop | (none) | Stop the last in the pid file. |
stop-all | (none) | Stop all the server in the running pid file. |
Then users can start the sql client to communicate with the SQL Gateway in the local or remote environment.
...