For older version SQLFlow under Linux
This page is for SQLFlow 5.x.x.x
Please refer to the latest install manual if you are using the latest SQFlow(version > 6.0.0.0):
You can check this page for the SQLFlow berfore version
Prerequisites
A linux server with at least 8GB memory (ubuntu 20.04 is recommended).
Java 8
Nginx web server.
Port needs to be opened. (80, 8761,8081,8083. Only 80 port need to be opened if you setup the nginx reverse proxy as mentioned in the below)
Setup Environment (Ubuntu for example)
CentOS
Upload Files
create a directory :
upload your zip file including backend and frontend file to sqlflow
folder, and unzip like this :
You should get files organized like this:
set folder permissions :
Nginx Reverse Proxy
1. Config Nginx
open your nginx configuration file ( at /etc/nginx/sites-available/default
under ubuntu ), add a server :
note that 8081
in proxy_pass http://127.0.0.1:8081/
should be consistent to gspLive.jar's port.
/api
is mapped to http://127.0.0.1:8081
in the above configration. This is useful if you company doesn't allow access 8081
port from the external.
2. modify frontend configuration file config.private.json
Open the configration file "/wings/sqlflow/frontend/config.private.json"
Modify the ApiPrefix attribute
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
Web port is
80
SQLFlow backend service port:
2. Modify the web port
Change the default web port from 80
to 9000
(or any port you like).
3. Modify java service port
Change the default gspLive port from 8081
to 9001
(or any port you like).
Step 1: Change the port in nginx config file
Step 2: Change the port in gspLive.sh(gspLive.bat)
Start Backend Services
start service in background:
please allow 3-5 minutes to start the service.
use ps -ef|grep java
to check those 3 processing are running.
Start Frontend Services
start your nginx :
or reload :
open http://yourdomain.com/ to see the SQLFlow.
open http://yourdomain.com/api/gspLive_backend/doc.html?lang=en to see the Restful API documention. OR
open http://yourdomain.com:8081/gspLive_backend/doc.html?lang=en to see the Restful API documention.
Gudu SQLFlow License file
If this is the first time you setup the Gudu SQLFlow on a new machine, then, you will see this license UI:
You send us the Gudu SQLFlow Id (6 characters in red).
We will generate a license file for you based on this id.
You upload the license file by click the "upload license file" link.
Backend Services Configuration
sqlflow provides several optioins to control the service analysis logic. Open the sqlservice configuration file(conf/gudu_sqlflow.conf)
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 return error message "Sorry, the service is busy. Please try again later."
Sqlflow client api call
Get userId from gudu_sqlflow.conf
Open the configration file "/wings/sqlflow/backend/conf/gudu_sqlflow.conf"
The value of anonymous_user_id field is webapi userId
Note: on-promise mode, webapi call doesn't need the token parameter
Test webapi by curl
test sql:
curl command:
response:
If the code returns 401, please check the userId is set or the userId is valid.
Enable Regular Job
If you need to enable regular job feature on your sqlflow on-premiser, you will also need to install Clickhouse on your server. Check here for Clickhouse installation:
Last updated