Windows

Please check the following page for the old SQLFlow installation:

!!! note "Older Version SQLFlow Under Windows" Click here to view the Older Version SQLFlow Under Windows documentation

If you have SQLFlow 5.x installed on your server and would like to upgrade to SQLFlow 6.x, please refer to this page:

!!! note "Upgrade" Click here to view the Upgrade documentation

Starting from SQLFlow 6.0, we have integrated web packages into the backend service, no Frontend installation and nginx configuration is required!

Prerequisites

• SQLFlow on-premise version
• Server with at least 8GB memory
• install JDK1.8 \ SET JAVA_HOME variable, and then add %JAVA_HOME%\bin to the path variable

Unzip SQLFlow file

• create a folder: c:\wings\sqlflow
• unzip SQLFlow install package to c:\wings\sqlflow, you will get c:\wings\sqlflow\backend

Customize the port

If you don't want to change the default service port you can just ignore this section. Otherwise this section will show you how to customize the port.

1. Default port

1. Web port is 8165
2. SQLFlow backend service port:

File	Port
eureka.jar	8761
gspLive.jar	8165
sqlservice.jar	8083

2. Change the default port in gspLive.sh(gspLive.bat)

You can change the web or backend api port from 8165 to any available port.

Add the following section in gspLive.sh(or gspLive.bat in Windows):

--server.port=<customized_port>

Backend Services Configuration

sqlflow provides several options to control the service analysis logic. Open the sqlservice configuration file(conf/gudu_sqlflow.conf)

• user_token_expire_hours: default value is 24. User can customize the TTL of the token by setting this field. In case user_token_expire_hours less than or equals to 0, the user token would never expire.
• ignore_user_token: default value is false, token auth is skipped in case the value is set to true. When the ignore_user_token option is turned on, users are no longer required to login and account icon will disappear. As a result, the system does not enforce team management since any user can access it without authentication.
• relation_limit: default value is 1000. When the count of selected object relations is greater than relation_limit, sqlflow will fallback to the simple mode, ignore all the record sets. If the relations of simple mode are still greater than relation_limit, sqlflow will only show the summary information.
• big_sql_size: default value is 4096. If the sql length is greater than big_sql_size, sqlflow submit the sql in the work queue and execute it. If the work queue is full, sqlflow throws an exception and returns error message "Sorry, the service is busy. Please try again later."

Start SQLFlow backend

• Open a dos command windows
• cd c:\wings\sqlflow\backend\bin
• run backend.bat
• please wait 3-5 minutes to allow the SQLFlow service to start completely.

You can assign the RAM to SQLFlow by specifying the boot parameter when starting the service.

 backend.bat /m <RAM_VALUE>

The RAM_VALUE could be: 4g 8g 16g 32g or 64g.

SQLFlow will automatically allocate the memory based on the status of the installed server if this parameter is not given. SQLFlow would allocate less than 31 GB memory if that is the case. However, if your total memory is less than 32 GB, SQLFlow would allocate all the remaining memory on your server.

SQLFlow is ready

Open the browser and go to localhost or got to the IP where the SQLFlow is installed.

• Open http://yourIp/ to see the SQLFlow.
• Open http://yourIp/api/gspLive_backend/doc.html?lang=en to see the Restful API document. (Will need to turn on the doc, check this page.)

To login, please check the following default user credentials:

!!! note "Cloud and On-Premise Version" Click here to view the Cloud and On-Premise Version documentation

Stop the SQLFlow

• close the window where the backend.bat is running.
• cd c:\wings\sqlflow\backend\bin
• run stop.bat

SQLFlow client api call

See sqlflow client api call

• Get userId from the account profile page and generate the secrete key

• Generate token by invoking the token generate API

curl --location --request POST 'http://localhost:8165/api/gspLive_backend/user/generateToken?userId=%3CUSER_ID%3E&secretKey=%3CSECRET_KEY%3E' \
--header 'Accept: application/json;charset=utf-8'

• Test webapi by curlAdd commentMore actions

  • test sql:

    select name from user
  

  • curl command:

  curl --location 'http://localhost:8165/api/gspLive_backend/sqlflow/generation/sqlflow' \
  --header 'accept: application/json;charset=utf-8' \
  --form 'userId="<USER ID>"' \
  --form 'dbvendor="dbvoracle"' \
  --form 'sqltext="select name from user"' \
  --form 'token="<TOKEN>"'
  

  • response:

    {
      "code": 200,
      "data": {
        "dbvendor": "dbvoracle",
        "dbobjs": [
          ...
        ],
        "relations": [
          ...
        ]
      },
      "sessionId": ...
    }
  

  • If the code returns 401, please check the userId is set or the userId is valid.

troubleshooting

Hostname error

Make sure the window hostname doesn't include the underscore symbol (_), otherwise, the service will not work properly. please change it to minus symbol (-)

Cannot start

If you have following errors when starting backend.bat

'jps' is not recognized as an internal or external command

Please check the first section of this page, confirm that your JDK environement variable is successfully set. You may need to restart your server to enable the change.

This increases the limit to 200M, if needed you may change this number.