All Collections
Git Integration - GitHub
Git Integration - GitHub

Enable version control through the GitHub repository

SqlDBM Support avatar
Written by SqlDBM Support
Updated over a week ago

Enterprise-only feature.

The feature is only available to users with Account Admin privileges.

Once the integration has been configured, see the related article on using this feature and the various ways of generating the files themselves.

To enable version control through the GitHub repository, you will need to create a Person Access Token and link it with SqlDBM using the steps below.

Please make sure to initialize your repository by creating at least one file in the main branch ( for example).

Caveat: not all token permissions mentioned in the video are required, see below for the complete details.

1 . Go to GitHub. Create or choose an organization.

2. Create a Personal Access Token.

Go to: Developer settings → Personal Access Tokens→ Generate new token.
Once created, make sure to copy the above token. GitHub doesn't store it, and you will not be able to see it again.

  • The token must have read & write permissions or full access.

  • If you want to create pull requests while pushing, there should be no restrictions on creating a pull request for the user who created the token.

Minimum required permissions for the token:

3. Open the SqlDBM "Integrations" page in a different browser tab.

4. Select the "GitHub" option.

5. Enter your token in the "Personal Access Token" field.

6. Open GitHub again and create and initialize a repository

7. Copy the link with HTTPS.

8. Open SqlDBM "Integrations" with the specified token.

9. Select a project.

10. Specify the repository URL.

11. Select users who will have push permissions (modelers or project owner only.)

12. Unmark the checkbox if you don't need to create pull requests.

13. Click Connect Integration button.

14. Done.

Notice, you can add links only to those repositories that are related to the organization under the specified Personal Acess Token.

Project users will now see a "Push to GitHub" button on the Forward engineering page. It will become active after generating DDL through Create or Alter scripts.

The same behavior in the DataOps page (alter script popup).

After a successful push request, find your script in the repository files:
Code -> Overview -> Your branch -> Branch name -> there should be a commit with your SQL script.

Otherwise, if you selected the 'Create Pull Request' option on the Integration page, go to Pull Requests

See also:

Did this answer your question?