Conectores
Dados e Armazenamento

Storage

22min

Objetivo/Resumo

O conector Storage da Fluid oferece uma interface simplificada e padronizada para armazenar, recuperar, listar e deletar dados de forma eficiente e escalável no armazenamento dedicado ao seu tenant/workspace. Ele integra-se perfeitamente com as soluções de integração da Fluid, permitindo que você gerencie informações estruturadas por meio de identificadores únicos, sem demandar um armazenamento externo e se preocupar com gerenciamento de banco de dados. Cada identificador pode conter um ou mais conjuntos de dados organizados em pares de chave (key) e valor (value), facilitando a organização e o acesso aos dados conforme necessário.

Criando Conexão para o conector Storage

Para utilizar o conector Storage, é necessário criar uma Conexão e, em seguida, configurar o fluxo. Abaixo estão as instruções detalhadas.

Criando Conexão

Document image

  1. Acessar o Painel Principal:
    • Faça login na plataforma Fluid.
    • No painel à esquerda, navegue até a opção "Conexões" e clique nela.
  2. Iniciar Nova Conexão:
    • No canto superior direito, clique em "Nova Conexão".
  3. Seleção do Tipo de Conexão:
    • Na tela de configuração, localize "Configure uma nova conexão" e selecione "Storage" da lista suspensa.
  4. Nome da Conexão:
    • Forneça um nome descritivo para a conexão no campo "Nome".
  5. Descrição da Conexão:
    • No campo "Descrição", forneça uma breve descrição da conexão.
  6. Chave/key:
    • Insira a chave/key da tabela do storage que será utilizada pela API. Pode ser criada de acordo com o nome que você desejar.

Operações

1. Salvar

Descrição: A operação de salvar permite que você armazene informações novas, atualize informações existentes, ou acrescente novas informações associadas a um identificador específico.

Como funciona: Ao salvar, você fornece um identificador único que será usado para agrupar os conjuntos de informações que deseja armazenar. Cada conjunto consiste em pares de chave (key) e valor (value), que representam os dados que você quer guardar. Ao salvar habilitando o campo Salvar como append os valores que informar serão acrescentados ao identificador caso ele já exista.

Exemplo prático: Imagine que você está salvando informações de clientes. O identificador pode ser o número do cliente, e os pares de key/values podem incluir nome, endereço e e-mail.

Document image

Document image


2. Recuperar Chave

Descrição: A operação de recuperar chave permite que você obtenha uma chave específica que esteja salva no identificador. Se a chave não existir, retornará uma mensagem informando que a chave não existe.\

Como funciona: Ao fornecer o identificador previamente usado para salvar as informações e informar a chave específica que deseja retornar, você pode recuperar o valor salvo para a chave informada dentro do identificador.

Exemplo prático: Se você salvou informações do cliente com o identificador 00001-1 e a chave nome e valor cliente de testes, ao utilizar a operação de recuperar chave com o identificador 00001-1 e a chave nome, você obterá o valor cliente de testes que foi salvo anteriormente para a chave nome.

JSON


3. Verificar Chave

Descrição: A operação de verificar chave, verifica se a chave existe no identificador previamente informado do storage. Retorna true se a chave existir e false se não existir.

Como funciona: Ao fornecer o identificador previamente usado para salvar as informações e informar a chave específica que deseja verificar, será retornado um json informando se a chave existe ou não.

Exemplo prático: Se você salvou informações do cliente com o identificador 00001-1 e a chave nome, ao utilizar a operação verificar chave com o identificador 00001-1 e a chave nome, você obterá dentro da tag exist o valor true.

JS


4. Listar

Descrição: A operação de listar permite que você veja todos os identificadores disponíveis juntamente com seus conjuntos de key/values associados.

Como funciona: Ao utilizar a operação de listar, você receberá uma lista de todos os identificadores armazenados no banco de dados, juntamente com os conjuntos de key/values associados a cada um deles.

Exemplo prático: Se você está gerenciando informações de vários clientes, a operação de listar fornecerá uma visão geral de todos os clientes existentes, cada um com suas respectivas informações armazenadas.

JSON


5. Listar Com Prefixo

Descrição: A operação listar com prefixo verifica no storage todos os identificadores que iniciem com o prefixo informado. Retorna todos os identificadores encontrados e seus respectivos conjuntos de chaves e valores.

Como funciona: Ao fornecer o prefixo do identificador, será retornado um JSON com todos os identificadores que iniciem com esse prefixo.

Exemplo prático: Se você salvou um cliente com o identificador 00001-1 e outro com o identificador 00002-1, e deseja buscar todos os identificadores que iniciem com o prefixo 0000, ao utilizar a operação listar com prefixo, passando o prefixo 0000, serão listados tanto o cliente 00001-1 quanto o cliente 00002-1.

JSON


6. Deletar

Descrição: A operação de deletar permite que você remova completamente um identificador específico e todos os seus conjuntos de key/values associados.

Como funciona: Ao fornecer o identificador que deseja excluir, todos os dados associados a esse identificador serão permanentemente removidos do armazenamento.

Exemplo prático: Se um cliente não é mais ativo e você deseja remover todas as informações dele do sistema, você pode usar a operação de deletar com o identificador desse cliente para eliminar todas as informações associadas.

Document image


7. Deletar Chave

Descrição: A operação deletar chave permite excluir uma chave específica que esteja salva em um identificador. Após a execução, será retornada a quantidade de registros afetados no storage.

Como funciona: Ao fornecer o identificador previamente utilizado para salvar as informações, junto com a chave específica que deseja deletar, a chave será removida do identificador.

Exemplo prático: Se você salvou informações de um cliente com o identificador 00001-1 e a chave nome, ao utilizar a operação deletar chave com o identificador 00001-1 e a chave nome, essa chave será deletada, e será retornada a quantidade de registros afetados.

JSON



Caso de Uso: Gerenciamento de pedidos pendentes no ERP

Cenário

Você está implementando uma integração de pedidos entre o seu e-commerce e ERP. Se o cliente associado ao pedido não estiver cadastrado no ERP, o pedido não pode ser registrado e deve ser salvo temporariamente em um storage até que o cliente seja cadastrado e o pedido reenviado.

Fluxo do caso de uso

1. Cadastro de pedido no ERP

Objetivo: Tentar cadastrar um pedido no ERP.

Passos:

  1. Enviar dados do pedido: O sistema envia dados do pedido para o ERP.
  2. Verificar resposta do ERP:
    • Se o cliente associado ao pedido já estiver cadastrado, o pedido é registrado com sucesso.
    • Se o cliente não estiver cadastrado, o ERP retorna um erro.

Exemplo:

  • Pedido: Pedido123
    • Cliente: Cliente456 (não cadastrado no ERP)
    • Produto: Laptop
    • Quantidade: 1

2. Salvar Pedido no Storage

Objetivo: Se o pedido não puder ser cadastrado no ERP devido ao cliente não estar registrado, salvar o pedido no storage para processamento futuro.

Passos:

  1. Definir Identificador: Use um identificador único para o pedido, como o ID do pedido (Pedido123).
  2. Salvar Dados:
    • Chaves e Valores:
      • Cliente: Cliente456
      • Produto: Laptop
      • Quantidade: 1

Operação: Salvar

3. Listar pedidos salvos no Storage

Objetivo: Recuperar todos os pedidos que foram salvos no storage para tentar reenviá-los ao ERP.

Passos:

  1. Executar Operação de Listar: Liste todos os identificadores e seus pares chave/valor armazenados.

Operação: Listar

Exemplo de Resultado:

  • Identificador: Pedido123
    • Cliente: Cliente456
    • Produto: Laptop
    • Quantidade: 1

Objetivo: Listar os pedidos pendentes de envio e direcionar para o fluxo de reenvio do pedido.

4. Deletar pedido do Storage

Objetivo: Após o pedido ser cadastrado com sucesso no ERP, remova-o do storage para evitar processamento duplicado.

Passos:

  1. Definir Identificador: Use o mesmo identificador do pedido (Pedido123).

Operação: Deletar



Resumo das Funções

  • Salvar: Adiciona ou substitui pares chave/valor para um identificador.
  • Recuperar: Obtém pares chave/valor para um identificador específico.
  • Listar: Mostra todos os identificadores e seus pares chave/valor.
  • Deletar: Remove um identificador e seus dados do storage.

Dicas e Considerações

  • Escolha de Conexão: Certifique-se de selecionar a conexão apropriada para o tipo de dados que está manipulando.
  • Uso de Identificadores: Use identificadores únicos para evitar sobrescrever dados inadvertidamente.


Conclusão

O Conector de Storage da Fluid é uma ferramenta essencial para a gestão eficiente de dados, oferecendo operações intuitivas e robustas para armazenar, recuperar, listar e deletar informações sem se preocupar em gerenciar banco de dados.

Ele se integra perfeitamente com outras soluções da Fluid, proporcionando uma experiência de uso coesa e simplificada. Com sua capacidade de gerenciar dados estruturados através de identificadores únicos, o conector de Storage não apenas facilita a organização dos dados, mas também garante que eles sejam acessíveis e manipuláveis conforme as necessidades de seu aplicativo ou sistema. Independentemente da complexidade dos dados, o Conector de Storage oferece uma solução confiável e escalável para todas as suas necessidades de armazenamento.

Updated 10 Oct 2024
Doc contributor
Doc contributor
Doc contributor
Did this page help you?