Using Datasources

CONTENTS

Home

bipp supports a wide range of databases you can use as datasources. All datasources are managed from bipp.

Select Datasources Datasources to open the Datasources page.

Datasource Page

Here are the available datasource controls:

  • New Datasource opens the New Datasource dialog.
  • All displays all of your available datasources.
  • My Space displays the datasources added to your space.
  • Search displays the datasources matching your search string.
  • Delete deletes the selected datasources.
  • Options Menu displays the datasource Options menu.
    Options Menu
    • Run Query opens the Query Editor for the datasource.
    • Ping sends a ping to the datasource to verify connectivity.
    • Edit opens the Edit dialog to change the datasource settings. You must re-enter the password.
    • Roles opens the Add groups/users dialog to share your datasource.
    • Delete deletes the datasource.

Creating a New Datasource

  1. Click New Datasource on the Datasources page.

    New Datasource

  2. Enter a Name. For example, Retail.

  3. Select the Dialect for the SQL used for your database. bipp creates and enforces the rules for the selected dialect.

    Datasource Settings

  4. Enter the connection details and the credentials. The details are different for each dialect. The Connecting Databases section lists the supported databases and known connection details.

  5. Click Test to verify the datasource connectivity. If you have an error, fix the connection or credentials problem and click Test again.

    Test

  6. Click Create to add the datasource.

Searching for a Datasource

Enter all or part of a name in the Search box on the Datasources page to search the list of datasources. The matching datasources are displayed as you type.

Datasource Search

Editing a Datasource

You can edit an existing datasource to update the connection settings:

  1. Select Edit from the Options menu for your datasource and .
  2. Make your changes.
  3. Re-enter the Password for the datasource connection.
  4. Click Update.
  5. Verify the connectivity with the Ping command.

Pinging a Datasource

You can ping a datasource to verify connectivity:

Select Ping from the Options menu for your datasource.

If Ping succeeds, your datasource is ready to go.
Pings
If you have an error, select Edit from the *(Options menu and fix the connection or credentials problem. Remember to re-enter the Password in the Edit dialog.

Sharing a Datasource

You can share your datasources with bipp users in your team, organization or network.

Note: Only existing Users and Groups are listed. Users and Groups must be set up in your tenant before they are available. Refer to Users and Groups.

  1. Select Roles from the Options menu Roles command for your datasource.

    Datasource Groups

The Add groups/users dialog opens on the Groups tab. Click Users to share with specific bipp users.

Datasource Users

  1. Check the groups or users to add. Check the box in the column header to select all.

  2. Select one or more Roles.

    Datasource Roles

  • Datasource Editor permissions:
    • ping the datasource
    • run a query on the datasource
    • read the datasource
    • update the datasource
  • Datasource Owner permissions:
    • full access to datasource
    • grant access on datasource to other users
    • assign roles to users/groups on the datasource
    • delete the datasource
    • view datasource permissions
    • ping the datasource
    • run a query on the datasource
    • read the datasource
    • update the datasource
  • Datasource Query permissions:
    • ping the datasource
    • run a query on the datasource
  • Datasource Reader permissions:
    • ping the datasource
    • run a query on the datasource
    • read the datasource
  1. Click Update.

Deleting a Datasource

The Datasource Owner can delete a datasource. There are two methods:

  • Select one or more datasources on the Datasources page and click Delete.
  • Select Delete from the Options menu for the datasource.

Click Delete on the confirmation prompt or Cancel to keep the datasource.

Run a Query

Select Run a Query from the Options menu to explore the datasource. bipp opens the Query Editor.

Query Editor

Here are the available Query Editor controls:

  • Datasource pane (left side) shows the name of the open datasource, a refresh icon (Query Editor Refresh) to ensure the datasource is up to date, a search function to search the open datasource, and an expandable tree view of the tables and columns in the datasource. You can collapse or expand the Datasource pane (Query Editor Refresh Query Editor Refresh)

  • Query pane is where you write your query. bipp helps you with query shortcuts:

    • Keyword Completion: As you type in the editor, bipp provides the relevant commands to assist you in creating your query. You can enter enough unique characters and use Tab or select it from the list with the mouse.
      Keyword Complete
    • Select *: Click the arrow beside a table to automatically generate the SELECT * statement for a table. Here is the result when you click the arrow beside stocks:
      Auto Select \*
    • Select column: Click the column name to automatically generate the SELECT statement for the column. Here is the result when you click code:
      Auto Select \*
  • Results pane is where results are displayed. Use the display icon to switch between displaying the Query and Results panes side by side or top and bottom. (Query Editor Refresh Query Editor Refresh)

  • Save in a project saves the query into the selected project.

  • Datasource details/selector displays the name of the open datasource. Hover over the name to see the datasource settings. Use the drop down arrow to select a different datasource.

  • Run query runs the query and displays the results in the the Results pane.

  • Options Menu displays the Query Editor Options menu.
    Options Menu

    • View History displays the history for the query.
    • Download Data downloads the results of your query as an Excel file (.xlsx).
  • Close Query Editor (Query Editor Close)

  • Total rows is the number of rows returned in the Results pane.

  • Time (sec) is the time in seconds to execute the query.

When you are ready, click Run query. This example shows the results in the Query Editor.

Query Editor Results