Setting up the connection with dbForge Documenter

After launching dbForge Documenter, the first thing you need to do is to connect to a SQL Server. You can create a new connection or use or modify the existing one.

To connect to a SQL Server

1. On the Database menu, select New Connection.

2. On the Database Connection Properties > General tab, specify the connection details:

  • Server: Select the server from the drop-down list.
  • Authentication: Choose the authentication mode from the drop-down list.
    • Windows Authentication
    • SQL Server Authentication
    • Active Directory - Universal with MFA authentication
    • Azure Active Directory - Password
    • Azure Active Directory - Integrated

    For more information about how to connect to a database with the Azure Active Directory authentication, see Using Azure Interactive Authentication.

  • Login and Password: Enter the user credential details respectively. By default, the password is saved automatically. If you don’t want to save the password, clear the Allow saving password check box.
  • Database: Enter the name of a SQL database you want to connect to or select the database from the drop-down list.
  • Optional: Connection Name: The connection name is generated automatically from the host name. If you want to create a distinctive name for the connection, type the new name.
  • Optional: Environment Category: Select the document category (Development, Production, Sandbox, and Test) from the drop-down list.

Choose server properties in the Database Connection Properties dialog

3. Optional: On the Advanced tab, configure additional connection properties:

  • Connection timeout: Set the amount of time (in seconds) during which the server should wait to establish a connection. The default value is 15 seconds.
  • Execute timeout: Set the amount of time (in seconds) during which the task should be completed. The default value is 0 seconds.
  • Encrypt connection: Select the check box if you want to use the encrypted connection.
  • Enter additional string connection parameters: Set additional connection properties to the connection string.

4. Optional: To verify the connection, click Test Connection.

5. Click Connect to create the connection.

Note

If you set up a connection in one of the following tools, it will be automatically added to other dbForge SQL tools:

  • dbForge Data Compare for SQL Server
  • dbForge Data Generator for SQL Server
  • dbForge Schema Compare for SQL Server
  • dbForge Query Builder for SQL Server
  • dbForge Event Profiler for SQL Server
  • dbForge Documenter for SQL Server

You can migrate connections and assigned categories between dbForge SQL tools (for example, from dbForge Data Compare for SQL Server, to dbForge Data Generator for SQL Server). To do that, you should create an export settings file with the help of Import and Export Settings Wizard in one tool and then import it in another dbForge SQL tool. For more information, see Import and export settings.

Managing connections

You can establish a new connection, edit or delete existing connections, or view the connection string in the Connection Manager.

To open the Connection Manager, on the Database menu, click Connection Manager.

To edit the connection details, select the required connection and click Edit.

To delete the connection, select the required connection, click Delete, and then click OK.

To create a new connection, click New and specify the connection details.

Manage connections in the Connection Manager of the dbForge database documentation tool

Download dbForge SQL documentation generator and try it absolutely free for 30 days!