> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> Luzmo é uma plataforma de analytics embutida com integração nativa com o ClickHouse, desenvolvida especificamente para aplicações de software e SaaS.

# Integrando o Luzmo ao ClickHouse

export const CommunityMaintainedBadge = () => {
  return <div className="CommunityMaintainedBadge">
            <div className="CommunityMaintainedIcon">
            <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="currentColor" viewBox="0 0 256 256">
                <path d="M244.8,150.4a8,8,0,0,1-11.2-1.6A51.6,51.6,0,0,0,192,128a8,8,0,0,1-7.37-4.89,8,8,0,0,1,0-6.22A8,8,0,0,1,192,112a24,24,0,1,0-23.24-30,8,8,0,1,1-15.5-4A40,40,0,1,1,219,117.51a67.94,67.94,0,0,1,27.43,21.68A8,8,0,0,1,244.8,150.4ZM190.92,212a8,8,0,1,1-13.84,8,57,57,0,0,0-98.16,0,8,8,0,1,1-13.84-8,72.06,72.06,0,0,1,33.74-29.92,48,48,0,1,1,58.36,0A72.06,72.06,0,0,1,190.92,212ZM128,176a32,32,0,1,0-32-32A32,32,0,0,0,128,176ZM72,120a8,8,0,0,0-8-8A24,24,0,1,1,87.24,82a8,8,0,1,0,15.5-4A40,40,0,1,0,37,117.51,67.94,67.94,0,0,0,9.6,139.19a8,8,0,1,0,12.8,9.61A51.6,51.6,0,0,1,64,128,8,8,0,0,0,72,120Z"></path>
            </svg>
        </div>
            Mantido pela comunidade
        </div>;
};

export const Image = ({img, alt, size = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </Frame>
    </div>;
};

<CommunityMaintainedBadge />

<Steps>
  <Step title="Configure uma conexão com o ClickHouse" id="1-setup-a-clickhouse-connection">
    Para se conectar ao ClickHouse, acesse a **página Connections**, selecione **New Connection** e, em seguida, escolha o ClickHouse no modal **New Connection**.

    <Image img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/luzmo_01.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=967e6102cd8c64b737019bc319980003" size="md" alt="Interface do Luzmo mostrando a caixa de diálogo Create a New Connection com o ClickHouse selecionado" border width="720" height="497" data-path="images/integrations/data-visualization/luzmo_01.webp" />

    Será solicitado que você informe um **host**, **nome de usuário** e **senha**:

    <Image img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/luzmo_02.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=0441f2efee476fc353d914bc808a73e8" size="md" alt="Formulário de configuração de conexão do Luzmo mostrando campos para host, nome de usuário e senha do ClickHouse" border width="462" height="454" data-path="images/integrations/data-visualization/luzmo_02.webp" />

    * **Host**: este é o host em que seu banco de dados ClickHouse está exposto. Observe que apenas `https` é aceito aqui para transferir dados com segurança pelo wire. A estrutura esperada da URL do host é: `https://url-to-clickhouse-db:port/database`
      Por padrão, o plugin se conectará ao banco de dados 'default' e à porta 443. Ao informar um banco de dados após a '/', você pode configurar a qual banco de dados se conectar.
    * **Username**: o nome de usuário que será usado para se conectar ao seu cluster ClickHouse.
    * **Password**: a senha para se conectar ao seu cluster ClickHouse

    Consulte os exemplos em nossa documentação para desenvolvedores para saber como [criar uma conexão com o ClickHouse](https://developer.luzmo.com/api/createAccount?exampleSection=AccountCreateClickhouseRequestBody) por meio da nossa API.
  </Step>

  <Step title="Adicionar datasets" id="2-add-datasets">
    Depois de conectar o ClickHouse, você pode adicionar datasets conforme explicado [aqui](https://academy.luzmo.com/article/ldx3iltg). Você pode selecionar um ou mais datasets disponíveis no ClickHouse e [vinculá-los](https://academy.luzmo.com/article/gkrx48x5) no Luzmo para garantir que possam ser usados juntos em um dashboard. Confira também este artigo sobre [Como preparar seus dados para analytics](https://academy.luzmo.com/article/u492qov0).

    Para saber como adicionar datasets usando nossa API, consulte [este exemplo em nossa documentação para desenvolvedores](https://developer.luzmo.com/api/createDataprovider?exampleSection=DataproviderCreateClickhouseRequestBody).

    Agora você pode usar seus datasets para criar dashboards bonitos (embutidos) ou até mesmo viabilizar um analista de dados com IA ([Luzmo IQ](https://luzmo.com/iq)) capaz de responder às perguntas dos seus clientes.

    <Image img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/luzmo_03.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=4b66ae70e426978f43f8d82e1abed64c" size="md" alt="Exemplo de dashboard do Luzmo mostrando várias visualizações de dados do ClickHouse" border width="956" height="693" data-path="images/integrations/data-visualization/luzmo_03.webp" />
  </Step>
</Steps>

<div id="usage-notes">
  ## Notas de uso
</div>

1. O conector ClickHouse do Luzmo usa a interface da API HTTP (normalmente executada na porta 8123) para se conectar.
2. Se você usar tabelas com o mecanismo de tabela `Distributed`, alguns gráficos do Luzmo poderão falhar quando `distributed_product_mode` estiver definido como `deny`. No entanto, isso só deve ocorrer se você vincular a tabela com outra tabela e usar esse vínculo em um gráfico. Nesse caso, defina `distributed_product_mode` como outra opção que faça sentido no seu cluster ClickHouse. Se estiver usando ClickHouse Cloud, você pode ignorar essa configuração com segurança.
3. Para garantir que, por exemplo, somente o aplicativo Luzmo possa acessar sua instância do ClickHouse, é altamente recomendável **incluir na lista de permissões** a [faixa de endereços IP estáticos do Luzmo](https://academy.luzmo.com/article/u9on8gbm). Também recomendamos usar um usuário técnico somente leitura.
4. Atualmente, o conector ClickHouse oferece suporte aos seguintes tipos de dados:

   | Tipo do ClickHouse | Tipo do Luzmo |
   | ------------------ | ------------- |
   | UInt               | numeric       |
   | Int                | numeric       |
   | Float              | numeric       |
   | Decimal            | numeric       |
   | Date               | datetime      |
   | DateTime           | datetime      |
   | String             | hierarchy     |
   | Enum               | hierarchy     |
   | FixedString        | hierarchy     |
   | UUID               | hierarchy     |
   | Bool               | hierarchy     |
