Use Dash to Build to Web Apps on Suadeo Data

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Python Connector for Suadeo, the pandas module, and the Dash framework, you can build Suadeo-connected web applications for Suadeo data. This article shows how to connect to Suadeo with the CData Connector and use pandas and Dash to build a simple web app for visualizing Suadeo data.

With built-in, optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Suadeo data in Python. When you issue complex SQL queries from Suadeo, the driver pushes supported SQL operations, like filters and aggregations, directly to Suadeo and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Suadeo Data

Connecting to Suadeo data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

The driver uses the OAuth 2.0 Resource Owner Password Credentials (ROPC) grant to authenticate to Suadeo. Authentication occurs directly using your credentials; there is no browser-based authorization flow or refresh token.

Set the following connection properties:

• URL: The base URL of your Suadeo instance.
• User: Your Suadeo username.
• Password: Your Suadeo password.
• AuthenticationName: The name identifier for the authentication configuration in your Suadeo instance. Different authentication names can be configured for different environments or use cases.

When you connect, the driver sends your credentials to the Suadeo OAuth token endpoint, receives an access token, and uses it for all subsequent requests. A new access token is obtained automatically when needed during the session.

After installing the CData Suadeo Connector, follow the procedure below to install the other required modules and start accessing Suadeo through Python objects.

Install Required Modules

Use the pip utility to install the required modules and frameworks:

pip install pandas
pip install dash
pip install dash-daq

Visualize Suadeo Data in Python

Once the required modules and frameworks are installed, we are ready to build our web app. Code snippets follow, but the full source code is available at the end of the article.

First, be sure to import the modules (including the CData Connector) with the following:

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.suadeo as mod
import plotly.graph_objs as go

You can now connect with a connection string. Use the connect function for the CData Suadeo Connector to create a connection for working with Suadeo data.

cnxn = mod.connect("URL=https://mysuadeoinstance;User=username;Password=password;AuthenticationName=your_auth_name;")

Execute SQL to Suadeo

Use the read_sql function from pandas to execute any SQL statement and store the result set in a DataFrame.

df = pd.read_sql("SELECT Id, Name FROM Customers WHERE Status = 'Active'", cnxn)

Configure the Web App

With the query results stored in a DataFrame, we can begin configuring the web app, assigning a name, stylesheet, and title.

app_name = 'dash-suadeoedataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'

Configure the Layout

The next step is to create a bar graph based on our Suadeo data and configure the app layout.

trace = go.Bar(x=df.Id, y=df.Name, name='Id')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='Suadeo Customers Data', barmode='stack')
		})
], className="container")

Set the App to Run

With the connection, app, and layout configured, we are ready to run the app. The last lines of Python code follow.

if __name__ == '__main__':
    app.run_server(debug=True)

Now, use Python to run the web app and a browser to view the Suadeo data.

python suadeo-dash.py

Free Trial & More Information

Download a free, 30-day trial of the CData Python Connector for Suadeo to start building Python apps with connectivity to Suadeo data. Reach out to our Support Team if you have any questions.

Full Source Code

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.suadeo as mod
import plotly.graph_objs as go

cnxn = mod.connect("URL=https://mysuadeoinstance;User=username;Password=password;AuthenticationName=your_auth_name;")

df = pd.read_sql("SELECT Id, Name FROM Customers WHERE Status = 'Active'", cnxn)
app_name = 'dash-suadeodataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'
trace = go.Bar(x=df.Id, y=df.Name, name='Id')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='Suadeo Customers Data', barmode='stack')
		})
], className="container")

if __name__ == '__main__':
    app.run_server(debug=True)