Skip to content

For older version SQLFlow under MacOS

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

MacOS Installation

Click here to view the MacOS Installation documentation

You can check this page for the SQLFlow berfore version

Old version installation

Click here to view old version page documentation

Installation Guide - MacOS (YouTube)

Prerequisites

  • SQLFlow on-premise version
  • 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)
  • At least 8GB memory

Setup Environment

1
2
3
# setup java environment
echo export "JAVA_HOME=\$(/usr/libexec/java_home)" >> ~/.bash_profile
source ~/.bash_profile

Install Nginx

Upload Files

create a directory :

1
2
# example you can use other path
sudo mkdir -p /wings/sqlflow

upload your backend and frontend file to sqlflow folder, like this :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/wings/
└── sqlflow
    ├── backend
    │   ├── bin
    │   │   ├── backend.sh
    │   │   ├── stop.sh
    │   │   ├── monitor.sh 
    │   │   ├── sqlservice.sh 
    │   │   ├── gspLive.sh  
    │   │   ├── eureka.sh
    │   │   ├── backend.bat
    │   │   ├── stop.bat
    │   │   ├── monitor.bat
    │   │   ├── sqlservice.bat
    │   │   ├── gspLive.bat
    │   │   ├── eureka.bat
    │   │   ├── sqlservice.vbs
    │   │   ├── gspLive.vbs  
    │   │   ├── eureka.vbs
    │   ├── lib
    │   │   ├── sqlservice.jar  
    │   │   ├── gspLive.jar  
    │   │   ├── eureka.jar
    │   ├── conf
    │   │   ├── gudu_sqlflow_license.txt     
    │   │   ├── gudu_sqlflow.conf     
    │   ├── data
    │   │   ├── job  
    │   │   │   ├── task     
    │   │   │   ├── {userid}   
    │   │   ├── session     
    │   ├── log
    │   │   ├── sqlservice.log 
    │   │   ├── gspLive.log  
    │   │   ├── eureka.log 
    │   │   ├── slow                   (slow query records)
    │   │   ├── sqlflow                (sqlflow access records)
    │   ├── tmp
    │   │   └── cache  
    └── frontend
        ├── 1.app.b95fd285b4e8a1af563a.js
        ├── 1.index.b95fd285b4e8a1af563a.css
        ├── app.b95fd285b4e8a1af563a.js
        ├── config.private.json
        ├── font
        │   ├── Roboto-Regular.ttf
        │   ├── segoeui-light.woff2
        │   └── segoeui-semilight.woff2
        ├── images
        │   ├── check.svg
        │   ├── Join.svg
        │   ├── pic_Not logged in.png
        │   └── visualize.svg
        ├── index.b95fd285b4e8a1af563a.css
        └── index.html

set scripts permissions :

1
chmod +x /wings/sqlflow/backend/bin

Start Backend Services

If your computer has more than 8G of memory, you can change the boot parameters to recommended

Please use the gspLive.sh, eureka.sh and sqlservice.sh under mac directory instead of the original one.

  • /wings/sqlflow/backend/bin/gspLive.sh
1
2
3
4
#  defult and less than or equal to 8G recommended
heapsize="2g";
# greater than 8G  recommended
# heapsize="3g";
  • /wings/sqlflow/backend/bin/eureka.sh
1
2
3
4
#  defult and less than or equal to 8G recommended
heapsize="256m";
# greater than 8G  recommended
# heapsize="512m";
  • /wings/sqlflow/backend/bin/sqlservice.sh
1
2
3
4
#  defult and less than or equal to 8G recommended
heapsize="4g";
# greater than 8G  recommended
# heapsize="10g";

start service in background:

1
sh /wings/sqlflow/backend/bin/backend.sh

please allow 1-2 minutes to start the service.

use jps to check those 3 processing are running.

1
2
3
58497 sqlservice.jar
58516 gspLive.jar
58477 eureka.jar

Java service port

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

Nginx Reverse Proxy

If we set the reverse proxy path of gspLive restful service to /api

1. Config Nginx

open your nginx configuration file ( at /usr/local/etc/ngin/nginx.conf ), add a server :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
server {
    listen 80 default_server;
    listen [::]:80 default_server;


    root /wings/sqlflow/frontend/;
    index index.html;

    location ~* ^/index.html {
        add_header X-Frame-Options deny;
        add_header Cache-Control no-store;
    }

    location / {
        try_files $uri $uri/ =404;
    }

    location /api/ {
        proxy_pass http://127.0.0.1:8081/;
        proxy_connect_timeout 600s ;
        proxy_read_timeout 600s;
        proxy_send_timeout 600s;

        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header User-Agent $http_user_agent;  
    }
}

2. modify frontend configuration file config.private.json

  • Open the configration file "/wings/sqlflow/frontend/config.private.json"
  • Modify the ApiPrefix attribute
1
  "ApiPrefix": "/api"

Start Frontend Services

start your nginx :

1
sudo nginx

or reload :

1
sudo nginx -s 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.

Sqlflow client api call

See sqlflow client api call

  1. Get userId from gudu_sqlflow.conf

  2. Open the configration file "/wings/sqlflow/backend/conf/gudu_sqlflow.conf"

  3. The value of anonymous_user_id field is webapi userId
1
  anonymous_user_id=xxx

  • Note: on-promise mode, webapi call doesn't need the token parameter

  • Test webapi by curl

    • test sql:
    1
      select name from user
    • curl command:
    1
    curl -X POST "http://yourdomain.com/api/gspLive_backend/sqlflow/generation/sqlflow" -H "accept:application/json;charset=utf-8" -F "userId=YOUR USER ID HERE" -F  "dbvendor=dbvoracle" -F "sqltext=select name from user"
    • response:
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
      {
    "code": 200,
    "data": {
      "dbvendor": "dbvoracle",
      "dbobjs": [
        ...
      ],
      "relations": [
        ...
      ]
    },
    "sessionId": ...
  }
    • If the code returns 401, please check the userId is set or the userId is valid.