Use Dash to Build to Web Apps on Quickbase 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 Quickbase, the pandas module, and the Dash framework, you can build Quickbase-connected web applications for Quickbase data. This article shows how to connect to Quickbase with the CData Connector and use pandas and Dash to build a simple web app for visualizing Quickbase data.
With built-in, optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Quickbase data in Python. When you issue complex SQL queries from Quickbase, the driver pushes supported SQL operations, like filters and aggregations, directly to Quickbase and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).
Connecting to Quickbase Data
Connecting to Quickbase 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.
User Authentication Method
To authenticate with user credentials, specify the following connection properties:
- Set the User and Password.
- If your application requires an ApplicationToken;, you must provide it otherwise an error will be thrown. You can find the ApplicationToken under SpecificApp > Settings > App management > App properties > Advanced settings > Security options > Manage Application Token.
User Token Authentication
To authenticate with a user token, specify the following connection properties:
- Set UserToken and you are ready to connect. You can find the UserToken under Quick Base > My Preferences > My User Information > Manage User Tokens.
After installing the CData Quickbase Connector, follow the procedure below to install the other required modules and start accessing Quickbase 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 Quickbase 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.quickbase as mod import plotly.graph_objs as go
You can now connect with a connection string. Use the connect function for the CData Quickbase Connector to create a connection for working with Quickbase data.
cnxn = mod.connect("[email protected];Password=password;Domain=myinstance.quickbase.com;ApplicationToken=bwkxrb5da2wn57bzfh9xn24")
Execute SQL to Quickbase
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, Column1 FROM SampleTable_1 WHERE Column2 = '100'", 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-quickbaseedataplot' 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 Quickbase data and configure the app layout.
trace = go.Bar(x=df.Id, y=df.Column1, 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='Quickbase SampleTable_1 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 Quickbase data.
python quickbase-dash.py
Free Trial & More Information
Download a free, 30-day trial of the CData Python Connector for Quickbase to start building Python apps with connectivity to Quickbase 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.quickbase as mod
import plotly.graph_objs as go
cnxn = mod.connect("[email protected];Password=password;Domain=myinstance.quickbase.com;ApplicationToken=bwkxrb5da2wn57bzfh9xn24")
df = pd.read_sql("SELECT Id, Column1 FROM SampleTable_1 WHERE Column2 = '100'", cnxn)
app_name = 'dash-quickbasedataplot'
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.Column1, 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='Quickbase SampleTable_1 Data', barmode='stack')
})
], className="container")
if __name__ == '__main__':
app.run_server(debug=True)