https://github.com/tlux/database_yaml_config_provider

An Elixir 1.9+ config provider to load a Rails style database.yml file
https://github.com/tlux/database_yaml_config_provider

config database ecto elixir hex-package postgresql yaml

Last synced: 5 days ago
JSON representation

An Elixir 1.9+ config provider to load a Rails style database.yml file

• Host: GitHub
• URL: https://github.com/tlux/database_yaml_config_provider
• Owner: tlux
• License: mit
• Created: 2019-09-20T21:00:35.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-24T22:21:24.000Z (about 5 years ago)
• Last Synced: 2024-10-29T08:41:08.046Z (19 days ago)
• Topics: config, database, ecto, elixir, hex-package, postgresql, yaml
• Language: Elixir
• Size: 20.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Database YAML Config Provider

[![Build Status](https://travis-ci.org/tlux/database_yaml_config_provider.svg?branch=master)](https://travis-ci.org/tlux/database_yaml_config_provider)

[![Coverage Status](https://coveralls.io/repos/github/tlux/database_yaml_config_provider/badge.svg?branch=master)](https://coveralls.io/github/tlux/database_yaml_config_provider?branch=master)

[![Hex.pm](https://img.shields.io/hexpm/v/database_yaml_config_provider.svg)](https://hex.pm/packages/database_yaml_config_provider)

An Elixir 1.9+ config provider to load a Rails style database.yml file with the

following structure when booting up the application.

```yaml

production:

  adapter: postgresql

  database: testdb

  username: testuser

  password: myPa$sw0rd

  host: pgsqlhost

  port: 5432

```

The primary intention of this library is to simplify the migration process from

a Rails app to Phoenix Framework.

## Prerequisites

-   Elixir >= 1.9

## Installation

```elixir

def deps do

  [

    {:database_yaml_config_provider, "~> 0.1", only: :prod}

  ]

end

```

## Usage

You need to register this `DatabaseYamlConfigProvider` as config provider in

the releases section of your mix.exs file.

```elixir

releases: [

  my_app: [

    config_providers: [

      {DatabaseYamlConfigProvider,

       repo: MyApp.Repo,

       path: "/production/shared/config/database.yml"}

    ],

    ...

  ]

]

```

By default, this config provider expects an `ENV` environment variable that

contains the current hosting environment name to be present when booting the

application.

Alternatively, you can set the environment directly when defining the config

provider.

```elixir

{DatabaseYamlConfigProvider,

 repo: MyApp.Repo,

 path: "/production/shared/config",

 env: "production"}

```

Or you can speficy another env var containing the particular hosting

environment on application startup:

```elixir

{DatabaseYamlConfigProvider,

 repo: MyApp.Repo,

 path: "/production/shared/config",

 env: {:system, "RAILS_ENV"}}

```

The same works for the location of the database file. You can specify an env

var containing the path to a folder that contains the database.yml file:

```elixir

{DatabaseYamlConfigProvider,

 repo: MyApp.Repo,

 path: {:system, "RELEASE_CONFIG_PATH"}}

```

When the filename deviates from database.yml you can customize it, too:

```elixir

{DatabaseYamlConfigProvider,

 repo: MyApp.Repo,

 path: {:system, "RELEASE_CONFIG_PATH", "my_custom_database.yml"}}

```

## Docs

Documentation can be found at

[HexDocs](https://hexdocs.pm/database_yaml_config_provider).