Show Sidebar Hide Sidebar

Setup the Database Connector on a Personal Computer

Setup a database connection using Plotly's Database Connector

Step 1

Get To Know The Connector

The Plotly Database Connector is an open source web server and application that provides an interface between the Plotly Chart Creator and your databases and datastores.

Plotly Chart Creator makes HTTP requests directly to the Database Connector from the web browser. The Database Connector listens for these requests and makes queries to your configured databases or datastores.

Step 2

Download the App

If you haven't yet, download the Plotly Database Connector from this web page to get started! Upon clicking on the download button for either Mac or Windows distribution, a file should be added to your Downloads folder.

Download

Step 3

Install the App (Windows)

Visit your Downloads folder. If you are using a Windows machine (Mac instructions will follow), double click on the application executable.

Downloading windows

Double click on the application. Your application will start to install itself. Note that some security settings may require you to install the application as an Administrator (right click and choose the administrator option to do so). The installation process may take up to several minutes.

Installing windows

Once installed, a desktop icon will be created on your desktop. Double click on it to open the application.

Desktop windows

Step 4

Install the App (Mac)

Visit your Downloads folder. If you are using a Mac machine (Windows instructions are in the previous section), double click on the application installer DMG file.

downloading-mac

Drag the Plotly Database Connector icon into the Applications folder when prompted.

Installing mac

Once installed, a desktop icon will be created in your applications folder. Double click on it to open the application. Note that some security settings may require you to open the application as an Administrator (right click and choose the administrator option to do so). The installation process may take up to several minutes.

Desktop mac

Step 5

Authorization

Now that the application is installed you can open it. Here, the connector app may automatically log you in with your Plotly credentials. If not, you will be prompted for your Plotly login credentials.

Next, A new window will open asking for you to confirm authorization by clicking 'Authorize'

Step 6

Automatic SSL

In version 2.0+, the app will now automatically generate an SSL. This may take several minutes!

Let's Encrypt is service for offering free SSL certificates. What we've done is created a server which generates a unique subdomain and a unique Let's Encrypt SSL certificates for that subdomain. We then re-route that subdomain's DNS to localhost:9495.

For example, when you start up your app, your app will make a request to this certificate and domain issuing server. After several minutes (this authorization only needs to be completed once), you'll have a unique subdomain and a unique server. Your application will spin up a server with those certificates and the plotly chart creator web application will be able to make requests to your server, no problem!

In this example below, the domain https://plotly–ab29698f-1b35-420c-881d-6.plotly-connector.com has a unique certificate associated to it. And remember, this domain just re-routes to localhost:9495 on the global DNS network. It's still just loading content from your localhost server - data is not traveling over the network!

Domain address

These certificates are saved locally on your machine in the ~/.plotly/connector folder. They expire every 90 days and the application should automatically generate a new one for you

Step 7

Setup a connection to your databases

The application will open and you can now setup a connection to your databases. For more specific guidance, visit the tutorial for your database visit our full list that includes MySQL, MS SQL, PostgreSQL, MariaDB, Redshift, Apache Drill and Parquet files, S3, Elasticsearch or request a new one if you do not see what you want.

Getting connected

Step 8

Additional information

The Plotly Database Connector stores the credentials to your databases. It can also run queries on a schedule (see tutorial). The Plotly Database Connector will save the results of the queries to user accounts in the Plotly On-Premise server through the Plotly Grids API.

If you would like to run the Plotly Database Connector on a separate server, then you can run it headlessly from the command line (more information).

Still need help?
Contact Us

For guaranteed 24 hour response turnarounds, upgrade to our Premium or Enterprise plans.