Generate documentation for Azure Database for MariaDB in 5 minutes

This tutorial will teach you how to quickly generate documentation for your Azure Database for MariaDB database with Dataedo tool. 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 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 the Create new repository option.

Welcome form

Next, double click the In a file option.

Welcome form

Choose a location and a file name and click Save.

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

a) Make sure you can connect to Azure Database for MariaDB

To find connection details of the Azure Database for MariaDB - check Overview page.

Connection to Azure Database for MariaDB

Make sure your IP is on the allowed list.

  1. Under instance details expand Connection security page and add your IP to the allow list .
  2. Disable SSL connection
  3. Save changes

Connection to Azure Database

b) Import schema

Now it is time to connect to yourAzure Database for MariaDB 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 "MariaDB" from DBMS dropdown, then fill the following details:

  1. Host - name or IP of your host/server
  2. Port - keep the default value here (3306)
  3. User - username
  4. Password - password
  5. Save password (optional) - you can save your password for future documentation updates
  6. Database - type in name of the database or choose from the list (click [...] button)

If you want to filter imported objects, check the Advanced box to define filter on the next screen. For now, just click Connect after providing connection details.

Connect to Azure Database for MariaDB

Here is a comparison with connection details in MySQL Workbench.

Connect to Azure Database for MariaDB

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 Azure MariaDB databases now

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