Skip to content

GIT integration

Team Edition integrates with Git so you can store and version your project scripts, diagrams, datasets, connection settings, bookmarks, and more.

Enable Git service

To start using Git, you need to enable Git service first:

  1. Open the Administration menu
  2. In the Server configuration tab, enable Git service
  3. Save the configuration

Configure global Git settings

Next, set up global Git settings and credentials for the technical user that Team Edition will use to access repositories.

  1. Open the Git settings tab
  2. Enter the technical user’s username, password, and email
  3. Save the configuration

Info

Some Git servers, like GitHub, require a personal access token instead of a password. Others may support both username/password and token authentication, depending on configuration.

Git permissions

To use Git in Team Edition, users must have the appropriate permissions on the remote repository.

Permission type Description
Read Required to clone or pull existing project data from the repository.
Write Required to push commits with changes made in Team Edition.

Test connection

After saving your credentials, you can test them to make sure the connection works.

  1. In the Test Git settings section, enter the repository URL (for example, https://github.com/company/repository)
  2. Click Test to verify access

If the connection is successful, a pop-up message appears confirming that the credentials and repository settings are valid.

Configure project Git settings

Each Project has its own Git configuration. You can enable Git for an existing Project or when creating a new one. It’s recommended to create a separate Git repository for each project.

Important

Project files have priority during initial sync. If conflicts occur, repository files are overwritten.

  1. Open the Projects tab
  2. Select a project or create a new one
  3. Open the Git tab
  4. Configure Git settings as needed
Setting Description
Enabled Turns Git integration on or off for the project.
Repository URL URL of the remote Git repository. Example: https://github.com/company/repository.
Branch name (optional) Branch used to store project changes. If not set, the repository’s default branch is used.
Data to sync with Git Choose what types of project data to store in the repository. Data types not selected remain local only.

Important

Team Edition doesn’t create branches automatically. Create the branch in your repository first if you plan to use a custom one.

When you connect a project to a repository for the first time, Team Edition synchronizes project and repository files.

Data types available for synchronization

You can choose any combination of these elements.

Option Description Reference (Desktop client) Reference (Web client)
Scripts SQL scripts saved in the project. SQL Editor SQL Editor
Datasets Saved query results or sample datasets. Datasets Datasets
Diagrams ER diagrams and visual models. ER Diagrams ER Diagrams
Bookmarks Saved bookmarks for quick access to objects or scripts. Bookmarks Not supported in web client
SSH/SSL configuration Connection security settings such as SSH tunnels or SSL certificates. Network settings Network settings
Data sources Database connection configurations used in the project. Database connections Database connections
Project metadata General project information, including structure and metadata files. Needed to sync script-to-connection links. Projects Projects
Project settings Project name used across clients.

Synchronization process

After setup, any change in project resources is automatically synchronized with the Git repository. Commit messages include the changed resource name, and the commit author matches the user who made the change.

Synchronization in desktop and web clients

Behavior differs between the web and desktop clients:

  • synchronizes project data with the connected Git repository
  • if a conflict occurs, the desktop version downloads the latest version from the repository, giving priority to the web client changes

Handling merge conflicts

When several users edit the same script in one Git-connected project, Team Edition automatically detects conflicts during synchronization. Instead of stopping the sync completely, the product shows a merge dialog where you can resolve the conflict directly in the UI.

Important

Merge conflicts can be resolved only in the web client of Team Edition.

How conflicts are resolved

  1. When Git detects a conflict, Team Edition opens a split-view editor

    • the left panel shows your current version (Keep current)
    • the right panel shows the incoming version from the repository (Accept incoming)

  2. Choose which version to keep or manually edit the file to combine both changes

  3. Save and confirm the resolution
  4. Team Edition commits the merged result and resumes synchronization with the repository