User Connections allow secure storage of database and git credentials for easy access in SqlDBM projects. Multiple connections can be defined when working on multiple engagements to allow discrete storage of environment credentials.
Plan: Small and Standard Enterprise
Databases:
Snowflake
more CDPs coming soon...
User Connections are currently available for all modelers and those with Data Preview add-on. For those who do not have Data Preview enabled, please note that "Managing connections from a project" is currently unavailable for a git connection. (coming soon)
Create and manage User Connections
Connections can be accessed from the Dashboard or inside the project menu.
Managing connections from the Dashboard
Navigate to the "Account" menu from the Dashboard and click on "User connections" to manage user connections.
From here, create new connections or maintain existing ones
Managing connections from a project
Connections can also be managed from inside a project. To access, click on the blue SqlDBM menu on the top left of the screen and select "Settings and conventions." Next, select "User connections."
Next, select "User connections."
On this screen, you will be able to set an active connection from a list of existing connections or create a new one.
Create a new User Connection
To create a new connection, click the "Create connection" button in the "User connections" Account menu or project settings.
Name your connection and add database and git credentials.
Adding database credentials
Provide the (development) credentials to your account
SqlDBM is a metadata-driven tool and does not require read access to any user or information schema tables for Reverse Engineering or any data modeling-related features. The "Warehouse" parameter in the User Connection is used only for Tx projects and the Data Preview feature (see the related article at the end of this post for more information on either of these).
Next, select the default database and schema.
These will be used to determine a default location for project objects but can be changed as part of project settings.
Adding a git repository
On this screen, provide the repository type, URL, and personal token and click "Create".
Edit a User Connection
From the "three-dot" menu to the right of each connection, connections can be edited or deleted.
Edit - allows users to edit the database and git credentials for connections, similar to creating a new connection.
Delete - permanently removes the connections.
Using connections in a project
User connections provide quick access to database credentials and git integrations in the relevant parts of a project.
Reverse Engineering Direct Connect (coming soon)
Forward Engineering push to git (coming soon)
Diagram data preview
Please explore the related articles below for in-depth details of how these features work in conjunction with user connections.
See also: