Connection Management

Connection Management

This section explains how to create, test, save, and manage database connections in OpenEdge DataDigger. It covers the connection settings used in both the VS Code extension and the native application, so you can quickly connect to the right database and switch between saved connections when needed.

Good connection management makes it easier to work with different environments such as development, test, and production, while keeping your connection details organized and easy to reuse. In the sections below, you will learn how to add a new connection, choose where it should be saved, work with user names and passwords, test whether a connection is valid, and manage existing connections after they have been created.

Whether you use DataDigger inside VS Code or as a native desktop application, the overall connection flow is designed to stay familiar and straightforward.

Choosing Where to Save a Connection

When you create a connection, you can choose where it should be stored.

• User settings
  • Best when the connection is only meant for your own use.
• Workspace settings
  • Useful when the connection should be available in the current workspace.
• Folder settings
  • Useful when one specific folder needs its own connection settings.

Choose the save location carefully, because it determines where the connection will be available later.

Password and Security Notes

If your connection requires a password, DataDigger allows you to choose how it should be stored.

• Save as secret
  • Recommended for normal use.
  • Helps keep the password stored more securely.
• Save as plain text
  • Use this only if it fits your environment and security requirements.

If you are not sure which option to use, choose Save as secret. This is done by leaving the Save password as plain text checkbox unchecked.

Switching Between Contexts and Databases

DataDigger lets you switch between different connection sources and then choose the database you want to work with.

• Switching context changes where DataDigger reads available connections from, such as User settings, Workspace settings, Folder settings, or a Project.

• Switching database changes the active database within the currently selected context.

When you switch to a project context, you may also need to select a project profile. If you switch to a folder context, you may need to choose the correct folder first. These selections affect which connections and databases are shown in the database list.

To switch databases, use the database selector in the header and choose the connection or database you want to open. If the database you expect is missing, first check whether the selected context, folder, or project profile is correct.

If you recently changed your saved connections, refreshing or reopening DataDigger may be needed before the updated list is shown.

Adding Database connections

In this step by step guide you can follow along to learn how to add a new database connection. A full demonstration video is available below.

Step 1: Open the Connection Manager

• Click on the Connection Settings gear icon in the top right corner of the DataDigger window.

  

Step 2: Click "Add Connection"

• A window will open displaying a list of all the current connections. Click the "Add Connection" button at the bottom to open the connection creation form.

  

Step 3: Fill in Connection Details

• Select a context you want to save your connection to (User settings, Folder settings or workspace settings).
• Enter a connection string (Example -db mydb -S 10001).
• Enter a name for the connection (if left blank the name of the database will be used).
• If required enter your user credentials (user and password).
• Choose how you want to save your user password (Save as secret is recommended).

  

Step 4: Test the Connection

• Before we can add a connection we need to test it to make sure it is valid.
• Click the "Test Connection" button to verify that the connection details are correct and the database is accessible.

  

Step 5: Save the Connection

• Click the Add button to save the connection.
• Click Done to close the connection manager.
• The new connection should now appear in the connection list.

  

Full Demo Video

Editing Database Connections

Editing an existing database connection is just as simple as adding one. You can edit a connection by clicking on the edit button next to the connection name in the connections list.

Step 1: Open the Connection Manager

• Click on the Connection Settings gear icon in the top right corner of the DataDigger window.

  

Step 2: Click "Edit Connection"

• A window will open displaying a list of all the current connections. Click the Edit Connection pencil icon to the right of the connection name to open the connection editing form.
• Here you can edit the connection details and test the connection again.

Step 3: Update the Connection

• Update the connection details as needed.
• Click the Update button to save the changes.
• Click Done to close the connection manager.
• The updated connection should now appear in the connection list.

  

Full Demo Video

Duplicating Database Connections

An existing database connection can be easily duplicated, saving you time and effort. You can duplicate a connection by clicking on the duplicate icon in between the pencil icon and the trashcan icon.

Step 1: Open the Connection Manager

• Click on the Connection Settings gear icon in the top right corner of the DataDigger window.

  

• A window will open displaying a list of all the current connections.

Step 2: Click "Duplicate Connection"

• Click the Duplicate Connection duplicate icon to the right of the connection name in between the pencil icon and the trashcan icon to open the connection duplication form.
• Here you can edit the copied connection details and test the connection.

Step 3: Update the Connection

• Update the copied connection details as needed.
• Click the Add button to save the changes.
• Click Done to close the connection manager.
• The duplicated connection should now appear in the connection list.

Full Demo Video

Removing Database Connections

You can remove a connection by clicking on the trashcan icon to the right of the connection name.

Step 1: Open the Connection Manager

• Click on the Connection Settings gear icon in the top right corner of the DataDigger window.

  

• A window will open displaying a list of all the current connections.

Step 2: Click "Delete Connection"

• Click the Remove Connection trashcan icon to the right of the connection name after the pencil and duplicate icons.
• Click Done to close the connection manager.
• The connection is now removed.

  

Full Demo Video

Using Project Profiles

If your project uses the openedge-project.json, you can manually define profiles with different database connection sets. This is useful when one project needs separate connections for different situations, such as development, testing, or customer-specific environments.

At the moment, these profile definitions need to be added manually in your openedge-project.json.

Working with Profiles

To use profiles, your project configuration should contain:

• a top-level dbConnections section for the default project connections
• a profiles array
• a name for each profile
• an optional inherits property if the profile should inherit the default connections
• a value.dbConnections section when the profile should define its own connections

NOTE: a restart may be required before the new profile is available.

Example Structure

{
  "dbConnections": [
    {
      "name": "Sports DEV",
      "connect": "-db sports_dev -H server1 -S 10001"
    }
  ],
  "profiles": [
    {
      "name": "Development",
      "inherits": "default"
    },
    {
      "name": "Test",
      "value": {
        "dbConnections": [
          {
            "name": "Sports TEST",
            "connect": "-db sports_test -H server2 -S 10002"
          }
        ]
      }
    },
    {
      "name": "Inherited",
      "inherits": "default"
    }
  ]
}

How DataDigger Uses This

• When you select a profile, DataDigger applies that profile's resolved connection list.
• If a profile defines value.dbConnections, those connections are used.
• If a profile does not define its own connections but has "inherits": "default", DataDigger uses the top-level dbConnections.
• If a profile has no valid connections, selecting it may not show any project connections.

If you do not see the connections you expect, check whether the currently selected project profile is the correct one and whether the profile contains valid dbConnections.

Demo Video

Additional Information

Choosing the Right Save Location

The save location determines where the connection will be available later.

• User settings are best when the connection is only meant for your own use.
• Workspace settings are useful when the connection should be available in the current workspace.
• Folder settings are useful when a specific project folder needs its own connection configuration.

Choosing the correct save location helps avoid confusion when a connection does not appear where you expect it.

Notes

• A connection can only be added after it has been tested.
• If you leave the connection name empty, DataDigger will use the database name instead.
• If you change connection details, it is a good idea to test the connection again before saving the update.

Troubleshooting Tips

• The connection test fails
  • Verify the connection string and credentials.
  • Confirm that the database is accessible.
• The connection does not appear where expected
  • Check to which context (User settings, Folder settings or Workspace settings) the connection was saved to.