Importar metadados do SQL Server

Este documento descreve como importar metadados do SQL Server para o Knowledge Catalog (antigo Dataplex Universal Catalog) usando um conector do Knowledge Catalog.

Esse conector oferece suporte a instâncias do SQL Server hospedadas no local, no Cloud SQL ou em outros ambientes de nuvem.

Antes de começar

Antes de importar metadados do SQL Server, conclua as seguintes tarefas:

  1. Conceda os papéis e permissões necessários.
  2. Ative as APIs Knowledge Catalog e serviço de transferência de dados do BigQuery.
  3. Atenda aos pré-requisitos do SQL Server.
  4. Atenda aos pré-requisitos de rede.

Permissões e papéis do IAM

Para criar e gerenciar um job de conector do Knowledge Catalog, você precisa de papéis do Identity and Access Management (IAM) que concedam permissões para o Knowledge Catalog e o serviço de transferência de dados do BigQuery.

Para receber as permissões necessárias para configurar um conector do SQL Server, peça ao administrador para conceder a você os seguintes papéis do IAM:

Além disso, é necessário conceder ao agente de serviço do serviço de transferência de dados do BigQuery (service-PROJECT_NUMBER@gcp-sa-bigquerydatatransfer.iam.gserviceaccount.com) a permissão dataplex.entryGroups.import ou o papel de importador de grupos de entradas do Dataplex (roles/dataplex.entryGroupImporter). É possível conceder esse papel no nível do projeto ou do grupo de entradas.

Para mais informações sobre como conceder papéis, consulte Gerenciar acesso.

Ativar APIs

Ative as APIs Knowledge Catalog e serviço de transferência de dados do BigQuery.

Ativar as APIs

Pré-requisitos do SQL Server

Verifique se você tem uma conta de usuário no banco de dados do Microsoft SQL Server. Para mais informações, consulte Criar um usuário com um login.

A instância do SQL Server precisa atender aos seguintes requisitos:

  • Versão mínima:o Knowledge Catalog oferece suporte ao Microsoft SQL Server versão 14 (2017) ou mais recente.

  • Usuário do banco de dados:verifique se você tem uma conta de usuário no banco de dados do Microsoft SQL Server. Para mais informações, consulte Criar um usuário com um login.

  • Privilégios mínimos:é necessário conceder os seguintes privilégios ao usuário do banco de dados:

    Permissões básicas (necessárias para todas as configurações) :

    GRANT VIEW DATABASE STATE TO USER_NAME;

    Permissões para acessar um esquema específico :

    GRANT VIEW DEFINITION ON SCHEMA::TARGET_SCHEMA TO USER_NAME;

    Permissões para acessar todos os outros esquemas :

    GRANT VIEW DEFINITION ON DATABASE::TARGET_DATABASE TO USER_NAME;

    Substitua:

    • USER_NAME: o usuário do banco de dados que você quer configurar.
    • TARGET_SCHEMA: o nome do esquema do SQL Server que você quer acessar.
    • TARGET_DATABASE: o nome do banco de dados do SQL Server que você quer acessar.

Pré-requisitos de rede

Um anexo de rede para conexão pelo Private Service Connect é necessário ao se conectar com segurança a bancos de dados externos ou fontes de dados de nuvem de terceiros com um endereço IP privado dentro de uma rede privada, para permitir que o serviço de transferência de dados do BigQuery acesse seu banco de dados.

Se você se conectar a um ambiente local ou a uma instância hospedada na nuvem usando um endereço IP público, um anexo de rede não será necessário.

Configurar um conector do SQL Server

Configure um conector do SQL Server usando o Google Cloud console ou a API.

Console

  1. No Google Cloud console, acesse a página Knowledge Catalog.

    Acessar o Knowledge Catalog

  2. No menu de navegação, na seção Gerenciar, clique em Conectores.

  3. Clique em Adicionar conexão.

  4. Na lista Conectores, selecione o card SQL Server.

  5. Na seção Detalhes da fonte de dados, forneça os detalhes da conexão para sua instância do SQL Server:

    • Em Anexo de rede, selecione um anexo de rede existente, se necessário, ou crie um.
    • Insira o host, a porta, o nome do banco de dados, o nome de usuário e a senha.
    • Se você estiver usando o TLS, selecione um modo TLS e forneça um certificado PEM confiável.
    • Em Objetos de metadados do SQL Server a serem importados, clique em Procurar para selecionar objetos.

  6. Na seção Configurações de destino:

    • Clique em Procurar e selecione um grupo de entradas do Knowledge Catalog para armazenar os metadados importados ou clique em Criar novo grupo de entradas.
    • Escolha se quer definir permissões no grupo de entradas agora ou mais tarde. Recomendamos definir permissões para que os usuários possam visualizar os metadados importados. Se você não concedeu o papel de importador de grupos de entradas do Dataplex (roles/dataplex.entryGroupImporter) ou a permissão dataplex.entryGroups.import ao agente de serviço do serviço de transferência de dados do BigQuery (service-PROJECT_NUMBER@gcp-sa-bigquerydatatransfer.iam.gserviceaccount.com) no nível do projeto, conceda-o no nível do grupo de entradas.

  7. No campo Nome de exibição da seção Nome de configuração do conector, insira um nome para o job de importação de metadados.

  8. Na seção Opções de programação, configure a frequência do job de importação de metadados. Se você selecionar Sob demanda, o job será executado apenas quando você o acionar manualmente.

  9. Opcional: na seção Opções de notificação, configure notificações por e-mail ou Pub/Sub para falhas de job.

  10. Opcional: na seção Opções avançadas, configure as configurações de criptografia. Se você selecionar uma chave de criptografia gerenciada pelo cliente (CMEK), observe que a chave será usada para criptografar todos os dados temporários preparados antes de iniciar os jobs de importação de metadados do Knowledge Catalog. Ela não é usada para criptografar os metadados no grupo de entradas de destino do Knowledge Catalog.

  11. Clique em Salvar.

REST

Use o projects.locations.transferConfigs.create método. No TransferConfig recurso, configure os seguintes campos:

  • Defina o campo dataSourceId como "sqlserver".
  • No campo metadataDestination, preencha o objeto dataplexConfiguration com o caminho do recurso do grupo de entradas de destino do Knowledge Catalog: projects/<var>PROJECT_ID</var>/locations/<var>LOCATION</var>/entryGroups/<var>ENTRY_GROUP_ID</var>

Depois de criar o job, o Knowledge Catalog programa a primeira execução de acordo com sua configuração ou você pode iniciá-la manualmente.

Pesquisar e visualizar metadados do SQL Server

  1. No Google Cloud console, acesse a página Pesquisa do Knowledge Catalog.

    Acessar a pesquisa

  2. No painel Filtros, é possível filtrar recursos do SQL Server usando as seções Projeto, Sistema e Alias de tipo. Na seção Sistema, selecione Contexto importado. Ao selecionar esse filtro, uma subseção Conectores gerenciados será aberta. Selecione SQL Server para filtrar todos os metadados do SQL Server.

  3. Você pode usar o campo de pesquisa para realizar consultas de pesquisa. É possível realizar uma pesquisa por palavras-chave ou linguagem natural. Por exemplo, para visualizar todas as tabelas do SQL Server por meio da pesquisa por palavras-chave, insira system=SQLSERVER AND type=TABLE.

    Para saber mais sobre como pesquisar recursos, consulte Pesquisar recursos no Knowledge Catalog. Para saber mais sobre as expressões que podem ser usadas no campo de pesquisa, consulte Sintaxe de pesquisa do Knowledge Catalog.

  4. Também é possível usar a LookupContext para recuperar o contexto do LLM para recursos específicos do SQL Server.

A seguir