|
|
|
Uma vez que o projeto foi instalado ele precisa ser configurado. Para isso dentro do diretório `config` da sua instalação deve-se criar um arquivo `config.yaml`.
|
|
|
|
|
|
|
|
Existe um arquivo `config.yaml.example` que pode ser copiado para se obter uma base de como o arquivo deve ser.
|
|
|
|
|
|
|
|
Uma vez que o arquivo foi criado basta preenchê-lo.
|
|
|
|
|
|
|
|
## *connection*
|
|
|
|
|
|
|
|
O primeiro campo do arquivo de configuração é o *connection* que descreve a conexão do Blendb com o banco de dados. Os seguintes parâmetros devem ser preenchidos
|
|
|
|
|
|
|
|
* **user**: Usuário do banco de dados
|
|
|
|
* **database**: Nome do banco de dados
|
|
|
|
* **password**: Senha do banco de dados
|
|
|
|
* **host**: Máquina *host* do banco de dados. Em caso local pode ser utilizado *localhost* como valor
|
|
|
|
* **port**: Porta na qual o serviço do banco de dados está executando. Normalmente para o PostgresSQL esse valor é 5432
|
|
|
|
* **max**: Máximo de conexões na Pool de conexões
|
|
|
|
* **idleTimeoutMillis**: Tempo que uma conexão com o banco de dados deve ficar inativa para ser encerrada.
|
|
|
|
|
|
|
|
## *struct*
|
|
|
|
|
|
|
|
Essa seção é relacionada a estrutura do banco de dados. A principio essas opções são utilizadas apenas para testes.
|
|
|
|
|
|
|
|
* **create**: Cria tabelas no banco de dados.
|
|
|
|
* **insert**: Insere dados a partir de planílias CSV nas respectivas tabelas.
|
|
|
|
|
|
|
|
Utiliando esse guia, você deve colocar o valor de ambos os campos como `false`.
|
|
|
|
|
|
|
|
## *schema*
|
|
|
|
|
|
|
|
Essa é a seção mais importante e mais trabalhosa do processo. O objetivo dela é ensinar ao Blendb quais são as agregações disponíveis, quais são as métricas e quais são as dimensões.
|
|
|
|
|
|
|
|
### *metrics*
|
|
|
|
|
|
|
|
Nessa seção é informada as métricas do Blendb. Essa seção é uma lista de objetos, onde cada objeto descreve uma métrica. Para um exemplo visualize o arquivo *ci_test.yalm.example*.
|
|
|
|
|
|
|
|
* **name**: Nome da métrica
|
|
|
|
* **dataType**: O tipo de dados da métrica. Tipos possíveis são
|
|
|
|
* *float*: Para números em ponto flutuante
|
|
|
|
* *integer*: Para números inteiros
|
|
|
|
* **agregation**: Qual função de agregação será utilizada por essa métrica. As opções são:
|
|
|
|
* *avg*: Média
|
|
|
|
* *sum*: Soma
|
|
|
|
* *max*: Máximo
|
|
|
|
* *min*: Mínimo
|
|
|
|
* *count*: Quantos
|
|
|
|
* **description**: Explicação da métrica. É uma descrição mais detalhada sobre o que é essa métrica.
|
|
|
|
Todas essas informações são fornescidas pela API. Ajuda na realização de consultas saber o que esse dado é.
|
|
|
|
|
|
|
|
|
