Creating a VDB

Owned by Aryn Wiebe
Last updated: Sept 06, 2024
3 min read

There are two ways to create a VDB:

  1. Build the VDB database table schemas using the Iguana GUI editor

  2. Have Iguana import your database table schemas directly from your database

You can follow along the steps below for each method:

Note: It is recommended that column names do not contain spaces (ex. First Name). If column names have spaces, db.merge will not be able to be used and instead will have to write and execute SQL statements from the Translator.

Building a VDB in Iguana:

  1. Click Add File in the Project pane (see if this is your first time)

  2. Enter a filename, choose the .vdb file type, and click create.

Screen Shot 2024-02-08 at 1.48.48 PM.png

  1. In the VDB viewer, click the ellipsis button to edit, and then + Add Table Definition.

Screen Shot 2024-02-08 at 1.56.36 PM.png

  1. A table editor window will appear, click the ellipsis to edit the table definition.

  1. Build your table schema and click Save:

    • Enter a Table Name and Description.

    • Click Add Column and enter your the Name, Description, Data Type, and identify key fields.

    • You can also re-order your columns by dragging the column to the desired position.

You should see your new patient table in the VDB viewer. Add more table definitions as needed.

Import Database Table Schemas:

  1. Click Add File in the Project pane (see if this is your first time)

  2. Enter a filename, choose the .vdb file type, and click create.

  1. In the VDB viewer, Edit then click Import.

  2. Follow the three steps outlined by the VDB Importer. First, click the DB button to pull up the Database Query card.

  1. Choose your Database and provide the connectivity information for IguanaX to query the table definitions:

    • Type: Select the database and API connection method you want to create tables in.

    • Data Source: If the database does not exist in the path provided, the export tool will create the database and associated tables.

      • For ODBC database connections, use the system data source name as specified in ODBC.

      • For Oracle OCI, use the OCI TNS Alias (database server name).

      • For MySQL use the database name.

      • For SQLite, browse to the path of the .sqlite target database file.

    • Database (for ODBC): The name of the target database.

    • Username and Password: If required, enter your database login credentials.

  2. Click Confirm to view the tables from the database.

 

Â