@cubos/dataset-cep v1.0.0-rc.1

Conjunto de dados sobre CEPs no Brasil. Este pacote irá gerenciar um conjunto de tabelas no banco de dados e expor funções utilitárias para consultas.

Configurando

Este pacote exporta migrations, um objeto com migrações do Kysely que devem ser incluídas no seu projeto.

Chame a função populate na inicialização do seu projeto, após executar migrações. Esta irá baixar os dados e inserir nas tabelas do seu banco de dados. Também irá verificar atualizações e aplicar se necessário. Considere agendar para chamar estar função ao menos uma vez por mês.

Para que populate funcione é necessário preencher a variável de ambiente CUBOS_DATASET_URL com a URL de onde os dados podem ser consultados e baixados, incluindo credenciais se necessário.