|
|
Segue uma descrição detalhada do arquivo de configuração do Blendb, explicando as principais caracteristicas de cada campo. Esse arquivo se encontra em `config/config.yaml`. Esse arquivo não é enviado ao git por conter informações restritas, como senhas do banco de dados.
|
|
|
O Blendb possui dois arquivos de configuração, o arquivo `config/config.yaml` e o arquivo `config/config.env`
|
|
|
|
|
|
Segue uma descrição detalhada dos arquivos de configuração do Blendb, explicando as principais caracteristicas de cada campo.
|
|
|
|
|
|
O arquivo `config/config.env` não deve ser enviado ao git, por conter informações sensíveis como senhas para acesso ao Banco de dados.
|
|
|
|
|
|
Se você está trabalhando em um projeto compartilhado, obtenha uma cópia desse arquivo com outro desenvolvedor. Para criar esse arquivo do zero, pode-se seguir este [guia](passos/configuração).
|
|
|
|
|
|
Um exemplo desse arquivo pode ser encontrado em `config/config.yaml/example` e o arquivo `config/ci_test.yaml.example` descreve o banco de dados utilizado no processo de build e é um arquivo `config.yaml` válido e também pode ser usado como exemplo.
|
|
|
O arquivo `config/config.yaml` é um arquivo que descreve o esquema do banco de dados. Ele não deve ser enviado para o repositório do Blendb, pois é uma característica de cada instância e não do projeto Blendb em sí. O ideal é que o projeto que utilzia o Blendb coloque esse arquivo em seu próprio repositório.
|
|
|
|
|
|
Esse arquivo é em formato YAML, a seguir são descritos cada um dos campos nesse arquivo.
|
|
|
Um exemplo desses arquivos pode ser encontrado em `config/config.yaml,example`, `config/config.env.example`.
|
|
|
|
|
|
## *connection*
|
|
|
O arquivo `config/ci_test.yaml.example` descreve o banco de dados utilizado no processo de build e é um arquivo `config.yaml` válido e também pode ser usado como exemplo.
|
|
|
|
|
|
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
|
|
|
O arquivo `config/ci_test.env.example` descreve as configuração do banco de dados e do adaptador utilizado e é um arquivo `config.env` válido e também pode ser usado como exemplo.
|
|
|
|
|
|
* **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.
|
|
|
## config.env
|
|
|
|
|
|
## *struct*
|
|
|
Esse arquivo descreve uma sequencia de váriaveis de ambiente, uma váriável por linha.
|
|
|
As variáveis disponíveis são:
|
|
|
|
|
|
Essa seção é relacionada a estrutura do banco de dados. A principio essas opções são utilizadas apenas para testes.
|
|
|
* **BLENDB_DB_USER**: Usuário do banco de dados.
|
|
|
* **BLENDB_DB_NAME**: Nome do banco de dados.
|
|
|
* **BLENDB_DB_PASSWORD**: Senha do banco de dados.
|
|
|
* **BLENDB_DB_HOST**: Máquina *host* do banco de dados. Em caso local pode ser utilizado *localhost* como valor.
|
|
|
* ***BLENDB_DB_PORT*: Porta na qual o serviço do banco de dados está executando. Normalmente para o PostgresSQL esse valor é 5432.
|
|
|
* **BLENDB_ST_CREATE**: Cria tabelas no banco de dados. Valor verdadeiro/falso. o valor verdadeiro normalmente só é utilizando no banco de dados de teste
|
|
|
* **BLENDB_ST_INSERT**: Insere dados a partir de planílias CSV nas respectivas tabelas. Valor verdadeiro/falso. O valor verdadeito normalmente só é utilizado no banco de dados de teste.
|
|
|
* **BLENDB_ADAPTER**: Qual adaptador de banco de dados deve ser utilizado, Atualmente apenas o valor **postgres** pode ser utilizado
|
|
|
* **PORT**: Qual porta o serviço executa
|
|
|
|
|
|
* **create**: Cria tabelas no banco de dados.
|
|
|
* **insert**: Insere dados a partir de planílias CSV nas respectivas tabelas.
|
|
|
## config.yaml
|
|
|
|
|
|
## *schema*
|
|
|
Esse arquivo é em formato YAML, a seguir são descritos cada um dos campos nesse arquivo.
|
|
|
|
|
|
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.
|
|
|
O objetivo desse arquivo é 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*
|
|
|
|
... | ... | |