White Rabbit

Rabbit in a Hat

Introduction

WhiteRabbit is a small application that can be used to analyse the structure and contents of a database as preparation for designing an ETL. It comes with RabbitInAHat, an application for interactive design of an ETL to the OMOP Common Data Model with the help of the the scan report generated by White Rabbit.

Features

• Can scan databases in SQL Server, Oracle, PostgreSQL, MySQL, MS Access, Amazon RedShift, Google BigQuery, SAS files and CSV files
• The scan report contains information on tables, fields, and frequency distributions of values
• Cutoff on the minimum frequency of values to protect patient privacy
• WhiteRabbit can be run with a graphical user interface or from the command prompt
• Interactive tool (Rabbit in a Hat) for designing the ETL using the scan report as basis
• Rabbit in a Hat generates ETL specification document according to OMOP template

Screenshots

<table border = ""> <tr valign="top"> <td width = 50%> <img src="https://github.com/OHDSI/WhiteRabbit/blob/master/docs/images/WRScreenshot.png" alt="White Rabbit" title="White Rabbit" /> </td> <td width = 50%> <img src="https://github.com/OHDSI/WhiteRabbit/blob/master/docs/images/RIAHScreenshot.png" alt="Rabbit in a Hat" title="Rabbit in a Hat" /> </td> </tr><tr> <td>White Rabbit</td><td>Rabbit in a Hat</td> </tr> </table>

Technology

White Rabbit and Rabbit in a Hat are pure Java applications. Both applications use Apache's POI Java libraries to read and write Word and Excel files. White Rabbit uses JDBC to connect to the respective databases.

Intended use

Whte Rabbit and Rabbit In A hat were designed and implemented for use within a secure and trusted environment. No efforts have been made to encrypt or otherwise protect the passwords, parameters and results. This should be kept in mind when deploying these tools.

System Requirements

Requires Java 1.8 or higher for running, and read access to the database to be scanned. Java can be downloaded from <a href="http://www.java.com" target="_blank">http://www.java.com</a>.

Dependencies

For the distributable packages, the only requirement is Java 8. For building the package, Java 17+ and Maven are needed. There are exceptions for databases that use a JDBC driver with a license that does not allow distribution of the driver. (BigQuery, Teradata)

BigQuery

If you want to use a BigQuery instance as the source database, after installing WhiteRabbit, you will need to download a zip file with the BigQuery JDBC driver, and unzip it in de repo directory of the WhiteRabbit installation. The latest version tested with WhiteRabbit is 1.5.2.1005 . The zip file can be downloaded here

Teradata

If you want to use a Teradata instance as the source database, after installing WhiteRabbit, you will need to download a zip file with the Teradata JDBC driver, and unzip it in de repo directory of the WhiteRabbit installation. The latest version tested with WhiteRabbit is 20.00.00.16 . The zip file can be downloaded here

Getting Started

WhiteRabbit

1. Under the Releases tab, download WhiteRabbit*.zip
2. Unzip the download
3. Double-click on bin/whiteRabbit.bat on Windows to start White Rabbit, and bin/whiteRabbit on macOS and Linux.

(See the documentation for details on how to run from the command prompt instead)

Rabbit-In-A-Hat

1. Using the files downloaded for WhiteRabbit, double-click on bin/rabbitInAHat.bat to start Rabbit-In-A-Hat on Windows, and bin/rabbitInAHat on macOS and Linux.

Note: on releases earlier than version 0.8.0, open the respective WhiteRabbit.jar or RabbitInAHat.jar files instead.

Getting Involved

• User guide and Help: WhiteRabbit documentation
• Developer questions/comments/feedback: OHDSI Forum
• We use the GitHub issue tracker for all bugs/issues/enhancements
• If you wish to contribute, please read the documentation on contributing

License

WhiteRabbit is licensed under Apache License 2.0

Development status

Production. This program is being used by many people.