Skip to main content

QuickStart Guide

Here is a quick walkthrough on how to create a workspace, data source, alias, user, run a query and kill a query. Let’s consider the example of two hospitals in town with their data sources named ‘HospitalDB_1’ and ‘HospitalDB_2’. Assume that the goal is to find the COVID positive patients in town. In the traditional ETL method, drawing insight from multiple databases was a tedious task. However, ShardOne allows effortless extraction of insights from multiple data sources.

Create a Workspace​

  1. Click on the 'Create New' button on the dashboard.
  2. Enter the Workspace Name as "COVID Patient Records" and Description as "Workspace for managing COVID patient data."
  3. Save the new Workspace.
  4. For more details about Workspace Management, click here.

image

Create a Data Source​

  1. Click on the 'Create New' button on the data sources page.
  2. For example, let's enter the Data Source Name as "HospitalDB_1" and the Description as "Database for COVID patient records."
  3. Here, the datasource, such as "MySQL" can be chosen for this example.
  4. Similarly, a second Data Source can be created with the name “HospitalDB_2” and the Description as “Database for patients in Hospital 2". “Oracle” can be chosen as the datasource.
  5. Fill in the configuration details, such as the database host, port, credentials, and database name.
  6. Click on 'Test Connection and Save' to verify the connection and save the data source.
  7. For more details on Datasource Management, click here.

image

Create & Map an alias​

  1. Navigate inside a datasource where all the items are listed. For instance, select HospitalDB_1. Assume that the item in it is ‘Users’ indicating the table of records of patients in Hospital 1.
  2. In the Alias column, select the alias from the dropdown list against the corresponding item. Here, it would be ‘Users’.
  3. If the typed alias does not exist, an option to create a new one will appear. Click on the New Alias option to create it. In this case, let's create an alias named "Patients" to represent the patients.
  4. Similarly map the alias ‘Patients’ to the corresponding patient item in HospitalDB_2, let’s assume it to be ‘LA.persons’.
  5. Subsequently, if the fields inside the items are different in both the datasource, field aliases could be mapped to them so that they could be referred to using a single name.
  6. An added alias can be removed by clicking on the ‘x’ button next to it.
  7. To know more about Aliases, click here.

image

Run a query​

  1. Navigate to the Composer in the Query tab.

  2. To reference just a single table, let’s say patient records of HospitalDB_1, use can use the syntax

    SELECT <attributes> FROM <Datasource Name>.<Item Name>

    Hence our query would be

    SELECT * FROM HospitalDB_1.Users

    This approach would retrieve results exclusively from Hospital 1. To obtain results from Hospital 2, a distinct query would be necessary. However, using an Alias enables condensing the process into a single query.

  3. The syntax of the query using an Alias would be

    SELECT <attributes> FROM <Item Alias>

    As both patient entities in both the hospitals are mapped to the alias ‘Patients’, our query would be

    SELECT * FROM Patients

    This action would retrieve all the records from both datasources simultaneously.

  4. Click on the ‘Run’ button to perform the query. The query results will be displayed in the tab below the query composer.

  5. Our goal is to find the patients with the disease COVID, hence our query can be modified into

    SELECT * FROM Patients WHERE disease = ‘COVID’

    Here, ‘disease’ is a field or a field alias inside the items of the datasources.

  6. To know more about Query Management, click here.

image

Kill a query​

  1. To kill/stop a query, open the Query History tab and click on the Kill button.
  2. A pop-up will appear to confirm the process. Click on Kill to complete the action. The query will be stopped or killed.
  3. To know more, click here.

image

Add a User​

  1. Click on the 'Add User' button in the workspace.
  2. One has the option to select from the list of existing users in the dropdown, or a new user can be added by entering the email address and sending them an invitation.
  3. Choose the User role, such as "Workspace Admin".
  4. Click on 'Add' to add the new user to the workspace.
  5. To know more about User Management, click here.

image