Generate documentation for Amazon Redshift data warehouse in 5 minutes

Marcin Nagly - Dataedo Team Marcin Nagly 2018-07-13

Table of Contents:

    This tutorial will teach you how to quickly generate documentation for your Amazon Redshift database Dataedo. It will create and export to PDF or HTML a Data Dictionary of your database.

    1. Prepare

    1. Download Dataedo
    2. Install it
    3. Get 30 day free trial key (optional), if you don't have it already, to unlock export to HTML, ER diagrams and more.

    2. Create file repository

    When you start the application you will see this window. To create a file with your first documentation double-click Create file.

    Welcome form

    Choose a location and a file name and click Create.

    New file - location and filename

    You opened your new file and can use repository explorer to navigate sample documentations.

    Dataedo editor

    3. Connect to your database

    Connection requirements

    To connect to Amazon Redshift you need to install ODBC connector:

    Import schema

    Now it is time to connect to your Amazon Redshift database and import schema. On the ribbon click Add documentation and Database connection.

    Add documentation button

    Now you need to provide connection details. First, choose "Amazon Redshift" from DBMS dropdown, then fill the following details:

    1. Host - name or IP of your host/server
    2. Port - change the default port of Amazon Redshift instance if required
    3. User - provide your username
    4. Password - provide your password
    5. Save password (optional) - you can save your password for future updates, when your schema changes and you want to reflect that in your documentation
    6. Database - type in name of the database or choose from the list (click [...] button)

    Click Connect when ready.

    Here is a comparison with connection details in DBeaver.

    Connection to SQL Server

    Dataedo lists objects found in the database. Click Next.

    Now you can change default name (you can always change it in repository explorer). Click Import to start import. Dataedo now imports schema details. When done, close with Finish.

    4. Documentation overview

    You can browse repository explorer to view imported schema objects. You can see in convenient manner the following information:

    1. Table and column descriptions
    2. Table and column relationships (foreign keys)
    3. Table triggers
    4. Object dependencies

    5. Export to PDF

    Now it's time to share the documentation with your colleagues. You can share .dataedo file or send a PDF export.

    To export documentation to PDF select your documentation in repository explorer and click Export documentation button on the ribbon. Then choose PDF and first template and confirm with Next.

    In this step, you may choose to exclude certain elements from the export.

    Now, choose a location and name of your file and finish with Export.

    When export is done, you will be prompted to open generated file.

    Download a sample PDF

    6. Export to HTML (Pro feature)

    HTML is the advised export format - it's much more convenient to browse and search. If you haven't already, get a free trial key to unlock HTML export (and much more).

    Choose HTML in Export documentation option and choose the right template:

    1. Web server – if you want to host it on a web server or open from disk with Firefox (for security reasons doesn't in Chrome and Edge)
    2. Local disk – Worse performance, but works locally in Chrome and Edge.

    This is how HTML export looks like:

    See sample HTML

    Generate documentation for your Redshift database now

    There are no comments. Click here to write the first comment.