Documentation

Table of Contents:


    Importing schema from database

    2018-02-13 2018-06-08
    Applies to: 6.x, Article available also for: 5.x
    You are looking at documentation for an older release.
    Switch to the documentation for Dataedo 7.x (current).

    To create new documentation click add documentation button on ribbon. This will open wizard that imports database schema and creates new documentation in your repository.

    Add documentation button

    First choose DBMS system you are trying to connect to from the list: SQL Server, Oracle or MySQL.

    Connection

    Connecting to SQL Server database

    Connection to SQL Server

    Connecting to SQL Server requires providing host name.

    You can log in to SQL Server using Windows Authentication where your Windows credentials will be used or SQL Server Authentication where you will have to provide username and password. You can save password for later connections by checking Save password option.

    After you provided server connection data, you may select database name from the list using [...] button or enter database name manually.

    Learn more: SQL Server connection requirements.

    Connecting to Oracle schema

    Connection to Oracle database

    Connecting to Oracle databases requires Oracle client software to be installed on user workstation, but tnsnames.ora entries are not used. User must specify database host name, port number and service name (if you don't know those details, look into network\admin\tnsnames.ora file).

    By default, Dataedo reads only objects from the user's schema, but you can choose a different schema or even multiple ones.

    Check Use different schema option and choose the schemas you want to import from through the the list displayed when clicking the [...] button.

    You can save password for later connections by checking Save password option.

    Learn more: Oracle connection requirements.

    Connecting to MySQL (or compatibile) database

    Connect to MySQL database

    To connect to MySQL database provide host name, port number (by default it is 3306 - a default MySQL port number), username and password. After providing those details, you will be able to select database name from the list using [...] button or enter it manually.

    Filtering and selecting objects

    To narrow down list of objects that will be read from the database you may provide pattern that all object names must match. By default this is set to '%' which means all objects will be read. If you enter 'GL%' then only objects with names that start with 'GL' would be read. If you enter '%TAB', only objects ending with 'TAB' will be read. And so on.

    Filter

    Once read, all objects, before imported, will be presented in a list for further selection. You may choose to further exclude some objects from importing. To do this you may browse and filter the list and uncheck objects you don't want to import to your documentation.

    Selecting objects to import

    To learn more about Ignoring and deleting objects.

    Choose title

    After objects are chosen you may change default documentation title. By default it is set to '@'.

    It is advised to change it to something that makes is easy to identify what database it documents and that suitable for document and page title.

    You can later change this title simply selecting documentation and pressing F2 key or choosing Rename option from context menu (right click).

    Add documentation

    Importing schema and creating documentation

    You are ready to start importing schema - click Import button.

    Importing documentation

    Import succeeded

    Your database schema has been imported to new documentation in the repository. Now you are ready to export your documentation to PDF, HTML or Excel. This is also a beginning of your documentation process.

    Imported database schema

    Found issue with this article? Comment below
    0
    There are no comments. Click here to write the first comment.