Install

Comece baixando o pacote “Microsoft SQL” disponível no Apps Manager.

Assim que a instalação do pacote for concluída, o nó “mssql” estará disponível no seu Data Flow Manager. Arraste e solte o nó em seu fluxo.

Configuration

Dê um duplo clique no nó para abri-lo.

• Node name: Altera o nome do nó conforme exibido no Data Flows Manager. Não tem efeito na consulta nem na conexão.
• Connection: Usado para criar uma configuração de conexão para o servidor MSSQL.
• Request Type: Permite configurar como a consulta é feita ao servidor. Mais documentação sobre como os tipos são configurados e como funcionam está disponível na seção de Ajuda (Help) do nó (indicada por um ícone de livro).

O restante da seção de Configuração Geral é determinado por qual Request Type está selecionado.

• Table Extract: Permite consultar uma tabela específica da base de dados.
• Table: Nome da tabela a ser consultada.
• Ordering column: Qual coluna a tabela será ordenada. (Obrigatório)
• Historical Extract: Se a caixa de seleção estiver ativada, a consulta sempre iniciará a extração a partir da primeira linha da tabela. Caso contrário, ela obterá apenas a última linha.
• Custom SQL Request: Permite que uma consulta SQL personalizada seja executada. No entanto, a consulta é estática e não pode ser modificada.
• Triggered Request: A consulta também pode ser executada passando ao nó um objeto msg com um campo request. Isso permite que a consulta seja alterada dinamicamente usando nós de função JS.

Exemplo de uma configuração de Triggered Request com um nó de função:

A documentação sobre consultas MSSQL pode ser encontrada aqui.

A próxima aba do nó MSSQL é Request Configuration:

• Recover Lines: Permite que a consulta obtenha o último número x de linhas antes das novas linhas. Isso é útil se os campos puderem mudar depois de criados.
• Max Lines: Define um limite para o número de linhas que podem ser solicitadas. Com certas configurações, isso dividirá a solicitação em várias solicitações para obter tudo.
• Override-Timezone: Isso deslocará as datas recebidas de acordo com o fuso horário configurado neste campo. O padrão é UTC, o qual não aplica nenhum deslocamento.

Para conectar o nó ao servidor, certifique-se de que “Add new mssql-server…” esteja selecionado no campo Connection da aba General Configuration, e clique no ícone de lápis ao lado para começar a criar uma nova configuração MSSQL.

• Node name: Determina o nome da configuração. (Opcional)
• Host: O endereço IP ou URL do servidor de onde os dados serão extraídos.
• Port: O número da porta usada pelo servidor para conexão. 1433 é usado como o padrão do protocolo.
• Timeout: Determina quantos segundos o nó aguardará por uma resposta antes de atingir o tempo limite (timeout).
• Username: O nome de usuário da conta de serviço usada para acessar o servidor.
• Domain: O domínio em que o usuário existe se estiver usando uma conta Windows. (Opcional)
• Password: A senha da conta de serviço usada para acessar o servidor.
• Database: O nome do banco de dados de onde os dados serão extraídos.
• Default as UTC: Se não houver informações sobre os dados de data e hora, o padrão será ler seus fusos horários como UTC. (Opcional)
• TDS Version: TDS (Tabular Data Stream) é o protocolo usado para transferir dados entre um banco de dados e o cliente. Isso pode precisar ser alterado se o banco de dados do cliente estiver usando uma versão de TDS antes de 2012. Assim que todas as informações forem preenchidas, clique em “Add” para adicionar a configuração ao nó.

A configuração deve estar pronta. Clique em “Done” para salvar a configuração do nó e depois em “Deploy” no canto superior direito da janela para salvar suas alterações.

Se a conexão tiver sido criada, o nó deverá apresentar um símbolo de status verde e indicar “Connected”.
Se as consultas feitas a ele estiverem retornando dados, o nó exibirá este status, e as saídas poderão ser visualizadas com um nó debug: