This document describes how to import metadata from SQL Server into Knowledge Catalog (formerly Dataplex Universal Catalog) using a Knowledge Catalog connector.
This connector supports SQL Server instances hosted on-premises, in Cloud SQL, or in other cloud environments.
Before you begin
Before you can import metadata from SQL Server, complete the following tasks:
- Grant the required roles and permissions.
- Enable the Knowledge Catalog and BigQuery Data Transfer Service APIs.
- Meet the SQL Server prerequisites.
- Meet the networking prerequisites.
IAM roles and permissions
To create and manage a Knowledge Catalog connector job, you need Identity and Access Management (IAM) roles that grant permissions for Knowledge Catalog and BigQuery Data Transfer Service.
To get the permissions that you need to configure a SQL Server connector, ask your administrator to grant you the following IAM roles:
- To create and manage entry groups: Dataplex Catalog Admin
(
roles/dataplex.catalogAdmin), Dataplex Catalog Editor (roles/dataplex.catalogEditor), or Dataplex Entry Group Owner (roles/dataplex.entryGroupOwner) on the project. - To create and manage BigQuery Data Transfer Service transfer jobs: BigQuery Admin
(
roles/bigquery.admin) on the project. - To view logs in Cloud Logging: Logs Viewer
(
roles/logging.viewer) on the project.
Additionally, you must grant the BigQuery Data Transfer Service service agent
(service-PROJECT_NUMBER@gcp-sa-bigquerydatatransfer.iam.gserviceaccount.com) the
dataplex.entryGroups.import permission or the Dataplex Entry Group
Importer
(roles/dataplex.entryGroupImporter) role. You can grant this role at either
the project level or the entry group level.
For more information about granting roles, see Manage access.
Enable APIs
Enable the Knowledge Catalog and BigQuery Data Transfer Service APIs.