The Collibra integration lets you push model metadata from SqlDBM directly into your Collibra environment. Instead of maintaining definitions in two places, you model in SqlDBM and publish the results to Collibra as governed assets.
Also note:
- The Collibra integration requires Model Governance to be enabled for your account. If it is not, the Collibra options are unavailable.
- Creating mappings, editing mappings, and pushing to Collibra require a Governance role.
- Collibra credentials are managed on the account level, use of service account is recommended
- For projects with concurrent working enabled, Push to Collibra is available on the main branch only.
Before you begin
Make sure the following are in place:
| Requirement | Where to set it |
|---|---|
| Model Governance is enabled for your account | Contact your account manager |
| The Collibra add-on is enabled for your account | Contact your account manager |
| A Model Governance role in SqlDBM | See the article on Roles |
| Your Collibra credentials | Dashboard → Integrations → Collibra |
| A target Community and Domain in Collibra | Your Collibra environment |
| The attributes you want to populate already exist in Collibra | Your Collibra environment |
Without Model Governance enabled at the account level, the Collibra integration is not available anywhere in the product — the connection cannot be created and the Collibra options do not appear in a project.
Important: SqlDBM maps to attributes that already exist in Collibra — it does not create new ones. If an attribute you want to sync does not exist in Collibra yet, create it there first.
Step 1: Connect your Collibra account
The connection is configured once per user from the Dashboard. The Collibra integration page only appears if Model Governance is enabled for your account.
- From the SqlDBM Dashboard, open the Integrations menu and select Data Governance.
- Select Collibra section and click Connect
- Enter your Username, Password, and Collibra URL (the path to your Collibra instance).
- Select Save.
The Save button becomes available once all three fields are filled. Use Delete account to clear the stored credentials; you will be asked to confirm.
Step 2: Open Collibra settings and mappings
There are two ways to reach the configuration:
From Settings and conventions — open Settings and conventions and select Collibra settings.
From the project toolbar — in Database Documentation, open the Collibra integration menu in the top toolbar and select Settings and mappings.
Until a mapping has been configured, Push to Collibra and Status in this menu are disabled. Hover over a disabled item to see what is still missing.
If the Collibra add-on is not enabled for your account, the menu item is disabled and the tooltip will direct you to contact sales.
Step 3: Create a mapping
A mapping is a saved configuration that defines where your metadata goes in Collibra and what gets sent. You can create several mappings per project — for example, one per target domain or environment.
On the Settings tab:
- Enter a Name for the mapping.
- Select a Community from the dropdown. The list is retrieved from your Collibra instance.
- Select a Domain. If you selected a community, this list is filtered to domains within it.
Use the Refresh link to re-request communities, domains, and attributes from Collibra if something has changed on the Collibra side. Hover over Refresh to see when the lists were last retrieved.
At minimum, a Domain and one attribute must be defined for the integration to work.
Step 4: Map attributes
The Attribute mapping tab controls which SqlDBM fields populate which Collibra attributes.
The table has two columns:
- SqlDBM — any available SqlDBM field, including Model Governance fields and content fields.
- Collibra — the attributes available in your Collibra instance.
To build the mapping:
- Select a SqlDBM field and its Collibra counterpart on the same row. A new empty row appears automatically once both are selected.
- Start typing to find attribute faster.
- Select + Add new to add a row manually.
- Use the trash icon to remove a row.
Values already used are excluded from the dropdowns on new rows, so each field can only be mapped once.
Step 5: Map physical objects
Step 4 defined which fields are sent to Collibra. The Objects tab defines which objects those fields are sent for.
Check an object to include it in the mapping, or clear its checkbox to exclude it.
An unchecked object is never sent to Collibra. If an object is unchecked, none of its Model Governance fields are pushed — regardless of how those fields are mapped on the Attribute mapping tab, and regardless of whether the object has been edited since the last push. For a specific object's metadata to reach Collibra, that object must be checked here.
This selection is a property of the mapping, not a one-time choice for a single push. It is saved with the mapping and applies to every push that uses it. Unchecking an object excludes it permanently until you come back to this tab and check it again.
Working with the object list:
- Objects are grouped the same way they appear in the Database Explorer (Schemas, Tables, Views, and so on), with matching icons.
- All objects are selected by default. Clear the checkboxes for anything you want to exclude.
- Use Select all to include everything at once. When a filter is active, the Select all checkbox displays a dash to indicate a partial selection.
- Use the search field to find objects by any part of their name. Search is not case-sensitive. If nothing matches, the panel shows No results.
The right-hand panel shows the corresponding physical objects from Collibra, so you can see how your selection lines up with what already exists in the target domain.
Tip: If you maintain more than one mapping, each keeps its own object selection. This lets you push a broad set of objects to one domain and a narrower set to another from the same project.
Step 6: Push to Collibra
Select Push to Collibra. This saves your settings and starts the job in one action.
If you have pushed before, selecting Push to Collibra from the toolbar shows a short confirmation first:
- Active mapping — the mapping to use, with Edit and + Add new available.
- Target domain — the Community and Domain the metadata will be written to.
- Scope — how many objects are included.
Confirm to run the push with the saved settings, or select Edit to change them first.
Note: If you make changes and try to close the modal without saving, a Leave without saving? prompt appears. Select Leave to discard your changes or Cancel to go back.
Monitoring a push
Pushes run asynchronously as an import job in Collibra. You can close the modal and keep working while a job runs.
To check progress, open the Collibra integration menu in the toolbar and select Status.
Current run shows the mapping being pushed, a percentage complete, and an object count (for example, 123 out of 260 objects). Select Cancel to stop the job.
Recent pushes lists the last 5 runs with the mapping name, job type, timestamp, and result:
| Result | Meaning |
|---|---|
| Success | The job completed and the metadata is in Collibra |
| Error | The job did not complete — open it for the error details |
When no job is running, the Status modal shows the Recent pushes list on its own.
Managing mappings
Once you have more than one mapping, they appear in a list on the left of the settings modal.
- Select a mapping to view or change its settings.
- Select + at the top of the list to create a new one.
- Use the ⋮ menu on any mapping for Edit and Delete.