Uso do Esquema¶

Introdução¶

Os esquemas são usados para representar as estruturas de solicitação e resposta em uma transformação. Esses esquemas podem ser herdados de atividades inicialmente adjacentes à transformação ou podem ser definidos diretamente em uma transformação. Esta página descreve quando os esquemas são usados e como os esquemas são definidos.

Quando um Esquema é Usado¶

O uso de um esquema depende da atividade e se ele está sendo usado como origem ou destino de uma transformação.

Fontes¶

Uma atividade de origem é qualquer atividade que fornece dados em uma operação, que pode então ser transferido para um destino inalterado ou alterado por uma transformação antes de atingir um alvo.

As atividades de origem requerem um esquema de dados apenas se forem usadas como entrada em uma transformação:

• Se a atividade de origem estiver fornecendo dados que serão transformados, ela deve ter um esquema de dados de resposta, que é fornecido automaticamente ou pode ser definido durante a configuração da atividade ou transformação.
• Se a atividade de origem estiver fornecendo dados que não serão transformados, não é necessário definir um esquema de resposta, pois o esquema de resposta não é usado na operação.

As atividades que são normalmente (mas não necessariamente) usadas como fontes incluem aquelas com uma destas palavras no nome da atividade:

• Download
• Pegar
• Ler
• Solicitar
• Consulta

Alvos¶

Uma atividade de destino é qualquer atividade que recebe dados em uma operação. Esses dados podem vir de uma atividade de origem, de uma transformação ou de outra entrada, como variáveis ou scripts.

As atividades de destino requerem um esquema de dados apenas se estiverem recebendo dados que foram transformados ou se fornecerem uma resposta que você deseja gravar em outro destino:

• Se a atividade de destino estiver recebendo dados que foram transformados, ela deve ter um esquema de dados de solicitação, que é fornecido automaticamente ou pode ser definido durante a configuração da atividade ou transformação.
• Se a atividade de destino estiver recebendo dados que não foram transformados, não é necessário definir um esquema de solicitação, pois o esquema de solicitação não é usado na operação.
• Se um tipo específico de atividade de destino fornecer uma resposta, você também poderá ter um esquema de dados de resposta. Se você deseja gravar a resposta em outro destino, o esquema de dados de resposta é fornecido automaticamente ou pode ser definido durante a configuração da atividade ou transformação. Se o tipo de destino fornecer uma resposta, não será necessária uma operação para gravar a resposta em outro destino; ou seja, um esquema de resposta pode ser fornecido, mas pode ser ignorado na operação se não for necessário.

As atividades que são normalmente (mas não necessariamente) usadas como alvos incluem aquelas com uma destas palavras no nome da atividade:

• Adicionar
• Criar
• Excluir
• Inserir
• Publicar
• Colocar
• Resposta
• Carregar
• Atualizar
• Upsert
• Escrever

Como os Esquemas São Definidos¶

Os esquemas são definidos em uma atividade ou em uma transformação. Em uma operação, um esquema fornecido em uma atividade adjacente (ou uma atividade inicialmente adjacente que já foi removida) tem precedência sobre um esquema definido em uma transformação.

Este diagrama mostra uma operação cuja transformação herda seu esquema de origem de uma atividade adjacente anterior e tem um esquema de destino definido pela transformação:

Os esquemas definidos em uma atividade podem ser gerados pelo conector ou definidos pelo usuário:

• Gerado pelo conector: Os esquemas gerados pelo conector são fixados no conector ou gerados diretamente do endpoint. Dependendo da atividade específica, pode ser fornecido um esquema de solicitação ou resposta, ou um esquema de solicitação e resposta. Os esquemas gerados pelo conector têm um nome gerado automaticamente que depende se o esquema é uma solicitação ou resposta:

  User-defined Endpoint Name→User-defined Activity Name→Request
  

  User-defined Endpoint Name→User-defined Activity Name→Response
  

  Esta transformação mostra os nomes dos esquemas gerados pelo conector sendo herdados das atividades em ambos os lados de origem e destino:

  

  Dependendo do conector, a estrutura de alguns esquemas gerados pelo conector pode ser editada pelo usuário ou a estrutura pode mudar dinamicamente com base na entrada do usuário fornecida durante a configuração da atividade ou com base nas alterações no próprio endpoint.

  Os nomes dos esquemas gerados pelo conector não podem ser editados por um usuário.

• Definido pelo usuário: os esquemas definidos pelo usuário são fornecidos pelo usuário, seja criando um esquema personalizado, fazendo upload de um arquivo ou URL ou inserindo manualmente o esquema. Dependendo da atividade específica, pode ser definido um esquema de solicitação ou resposta, um esquema de solicitação e resposta ou nenhum esquema.

  Os nomes dos esquemas definidos pelo usuário são baseados no nome do arquivo fornecido ou são definidos pelo usuário.

Quando usadas em uma operação, as atividades que possuem um esquema de requisição não precisam necessariamente ser precedidas por uma transformação. Da mesma forma, as atividades que possuem um esquema de resposta não precisam necessariamente ser seguidas por uma transformação. Em alguns casos, como uma operação projetada para arquivar arquivos de uma fonte de dados para um destino sem uma transformação, nenhum esquema é necessário; se forem especificados, serão simplesmente ignorados.

Em uma operação, se uma transformação exigir um esquema de origem, ela deverá ser precedida por uma atividade que forneça um esquema de resposta. Outras regras e padrões para a construção de uma operação válida são abordadas em Validade da operação.

A resposta fornecida pela atividade e os esquemas de solicitação sempre substituem os esquemas de origem e destino fornecidos pela transformação, se presentes:

• esquema de resposta fornecido pela atividade: Quando uma atividade do conector com um esquema de resposta é colocada antes de uma transformação, o esquema de resposta da atividade é herdado pela transformação como o esquema de origem e substitui qualquer esquema fornecido pela transformação.
• esquema de solicitação fornecido pela atividade: Quando uma atividade de conector com um esquema de solicitação é colocada após uma transformação, o esquema de solicitação de atividade é herdado pela transformação anterior como o esquema de destino e substitui qualquer esquema fornecido pela transformação.

Todas as transformações são reutilizáveis, independentemente da origem de seus esquemas. No entanto, há considerações especiais ao referenciar em outra operação uma transformação que possui um esquema fornecido por uma atividade, conforme descrito em Reutilização da Transformação.

Se um esquema fornecido pela transformação estava presente antes da configuração de uma atividade adjacente, esse esquema não pode ser limpo diretamente. Embora um esquema fornecido pela transformação permaneça referenciado pela transformação, ele não é usado no processamento. Para limpar um esquema fornecido pela transformação nessas circunstâncias, você pode remover temporariamente a atividade adjacente primeiro. Depois que a atividade adjacente é removida, um esquema fornecido pela transformação pode ser limpo usando o menu de ações do esquema para selecionar Limpar esquema. Depois de limpar o esquema fornecido pela transformação, você pode substituir a atividade na operação.