Creating a new database

The workbench does not provide a dedicated space for storing your data; you should connect it to an existing SQL-based database or data store.

  1. Click Setting in the top right corner.
  2. Click Database Connections under the Data section. 

     
  3. Click +DATABASE to create a new database. 

     
  4. Select a database to connect or click Supported Databases and choose from the dropdown list.
    1. Common database types include, 
      1. PostgreSQL: A powerful, open-source relational database system commonly used with Workbench for analytics.
      2. SQLite: A lightweight, serverless database used for small-scale data storage and quick analytics in Workbench.
    2. Other databases we support include,
      1. Amazon Redshift – A cloud-based data warehouse solution optimized for big data analytics.
      2. Aurora PostgreSQL (Data API) – A serverless PostgreSQL-compatible database with API access via AWS Aurora.
      3. Google Sheets – Use spreadsheets as a lightweight data source for querying and reporting.
      4. PostgreSQL – An open-source, feature-rich relational database widely used for structured data.
      5. Shillelagh – An SQLite-based connector allowing you to query various APIs and services using SQL.
      6. SQLite – A self-contained, serverless, file-based SQL database engine ideal for testing or lightweight use.
      7. Other – Allows manual configuration of a custom or unsupported database connection. 

         
  5. Click SQLite from the resulting model.
  6. Under the BASIC tab, provide the Display Name and SQLALCHEMY URI
  7. Click TEST CONNECTION to test the connection. 
    Note: If the Test Connection fails, it means the credentials entered are incorrect.
  8. Click CONNECT to connect to the database. Otherwise, click Back to return to the previous screen. 

     
  9. Click on the Advanced tab to modify settings for SQL Lab, performance, security, and other additional options as needed. 


    1. Click the icon to expand the SQL Lab and interact with the database in SQL Lab. 

       
    2. Click the icon to expand Performance to adjust performance settings of this database. 

       
    3. Click the icon to expand Security to add extra connection information. 

       
    4. Click the icon to expand Others to add additional settings. 

       

Note: After adding the database, you can view it in SQL Lab to execute queries.

View and Manage Databases

  1. Click Setting in the top right corner.
  2. Click Database Connections under the Data section. 

     
  3. Search or filter the list by entering the Name, or select Expose In SQL Lab, AQE, or Modified By.
  4. Search columns include:
    1. Name: The identifier or label for a dataset or table in Workbench.
    2. Backend: The underlying database or data source connected to Workbench.
    3. AQE (Adaptive Query Execution): A feature to optimize query execution dynamically based on runtime conditions.
    4. DML (Data Manipulation Language): SQL commands for querying, inserting, updating, or deleting data.
    5. CSV upload: The ability to upload CSV files as a data source into Workbench.
    6. Expose in SQL Lab: Option to make a dataset available for querying in SQL Lab.
    7. Last modified: The most recent date and time a dataset or resource was updated.
    8. Actions: A set of operations that can be performed on datasets, such as exporting, editing, or deleting. 

       
  5. Under the Actions column, you can delete, export, or edit a database.
    • Click Delete icon to delete the added database.
    • Click Export icon to export it into a CSV file.
    • Click Edit to edit the database.


Edit a database

  1. From the Database page, under the Actions column, click the Edit icon to edit the database. 

     
  2. Under the BASIC tab, you can change the Display Name and SQLALCHEMY URI.
  3. Click TEST CONNECTION to test the connection. 
    Note: If the Test Connection fails, it means the credentials entered are incorrect.
  4. Click FINISH to finish to save and exit. 

     
  5. To configure advanced settings in the database, click on the Advanced section. Here, you can modify settings for SQL Lab, performance, security, and other additional options as needed. 

 

Was this article helpful?