れこです。今回はRailsネタです。
\n作ったアプリをHerokuにデプロイするときに、各種アドオンで
XXX_URL=pg://xxx:yyy@zzz/hogeのような文字列を環境変数で指定して使うというパターンが有ると思うのですが、
\nconfig/database.ymlに一切触らず に、この文字列でDB接続したい…
と思ったのでRailsのソースやドキュメントを読み漁ってみました。
\n\n先に結論を書くと、何もせずともDATABASE_URLという名前の環境変数を定義すればOKでした。
\nconfig/database.ymlを書き換えたり消したりする必要はなく、環境変数が優先されます。
以下はこの結論に至った経緯とおまけです。
\nまずは何事にも公式ドキュメント。
\n\n\nYou can connect to the database by setting an environment variable
\nENV['DATABASE_URL']or by using a configuration file calledconfig/database.yml.
\n3.14 Configuring a Database
とあるように、DATABASE_URLという環境変数が使用可能らしいということがわかりました。
\nここで気になったのは、 config/database.ymlと環境変数どちらが優先されるのか 。
\nドキュメントだけでは解消しないので詳しく追ってみます。
試してみた系記事ないかなーと探してみたらこんな記事が。
\n\n\n\n
結局どっちなのかわからん。
\nまずはそれっぽいテストがないか確認。
\nGithubのRailsのソースを検索してみた。
このテストとこのファイルのテストをみる限り、config/database.ymlよりも環境変数が優先されそうな気がする。
\nソースを読んでみるとそれっぽい（？）記述が。
\n# Returns fully resolved connection hashes.\n# Merges connection information from `ENV['DATABASE_URL']` if available.\ndef resolve\n ConnectionAdapters::ConnectionSpecification::Resolver.new(config).resolve_all\nend\n\nprivate\n def config\n @raw_config.dup.tap do |cfg|\n if url = ENV[\"DATABASE_URL\"]\n cfg[@env] ||= {}\n cfg[@env][\"url\"] ||= url\n end\n end\n end該当ファイルはrails/activerecord/lib/active_record/connection_handling.rb。
\nもしDATABASE_URLという環境変数があれば設定ファイルでいうところの
development: # ※ここは実行時の環境による\n url: <%%= ENV['DATABASE_URL'] %>に相当する処理を内部でやってくれる模様。
\nただ、設定ファイルを見てみると
# On Heroku and other platform providers, you may have a full connection URL\n# available as an environment variable. For example:\n#\n# DATABASE_URL=\"postgres://myuser:mypass@localhost/somedatabase\"\n#\n# You can use this database configuration with:\n#\n# production:\n# url: <%%= ENV['DATABASE_URL'] %>\n#と設定ファイルを書き換えるようコメントが書かれていたり、いまいちどっちを信じればよいのかわからない。
\n英語とRuby力が足らず決定打が見つからなかったので試してみました。
\n参考記事のコマンドをお借りして試してみます。
という状態で下記コマンドを実行して、ポスグレで接続しようとすれば接続エラーになるはず。
\nもしconfig/database.ymlが優先されるならSQLiteの接続になるので正しく接続できてしまう
# 接続エラー（ポスグレで接続しようとしている）\nDATABASE_URL=postgresql://localhost/app_development bundle exec rails s\n\n# 接続できた（config/database.ymlは間違ってない）\nbundle exec rails sということで試してみた結果、
\nconfig/database.ymlが存在しようと、環境変数が指定されていればそちらが優先される
\nということがわかりました。
この形式は環境変数１個で事足りるし、.env等に逃がせば接続情報をGit管理しなくて良くなるので、とても好きです。
\nデータベースにかぎらず、RedisやSMTPサーバなんかもこの書式で表現できます。
\n各DBドライバによって必要な設定のキー名が変わるとか面倒くさくて覚えたくないので、接続系の処理はこの書き方に統一されてしまえばいいのに、なんて思ってます。
RailsアプリはHerokuにデプロイされることが多いからなのか、デフォルトで対応してくれていて助かりました。
\nさすがRails。といったところなんでしょうか。
ちなみにこの書き方ってなんて名称なんでしょう。
\n私はurl stringとかconnection stringなんて検索をしているのですが、正しい名前があれば知りたい。。。
私がよく触る言語たちの対応状況を調べてみました。
\nCakePHPだと対応している模様。
\nhttp://book.cakephp.org/3.0/en/development/configuration.html#environment-variables
Laravelだと、この形式でDB接続するのに対応してないので、
\nこの記事のように設定ファイルにPHPの処理を書き加えてLaravelの設定に互換性があるようにパース処理を自前で実装しなきゃいけなかったりクソ面倒です。
FuelPHPも探してみたものの、それらしい記事が見つからず。
\n新進気鋭のフレームワークAdonisや個人的に好きなO/Rマッパーのobjectionが内部で使用しているknexはもちろん対応しています。
\nNodeはフルスタックなフレームワークが少ない（流行ってない）ので、内部的にknexを使ってればOKくらいの認識で居ます
\nGoは別格です。
\nあらゆるDBのドライバの根っこになっているdatabase/sqlパッケージがデフォルトで対応しています。
\nなのでdatabase/sqlパッケージを使わずにオレオレ実装でもしていない限り対応してます。
昔に作ったGoのデモアプリでもこの方式を利用しています。
","timeToRead":7,"frontmatter":{"title":"Railsでconfig/database.ymlを使わずURL文字列でDB接続したい","tags":["Go","Nodejs","Ruby","Ruby on Rails"],"date":"September 30, 2016","featuredImage":null}}},"pageContext":{"slug":"/how-to-connect-database-with-database-uri-without-config/","previous":{"fields":{"slug":"/automate-deploy-to-rubygems-with-circleci/"},"frontmatter":{"title":"RubygemsへのデプロイをCircleCIで自動化してみた","tags":["CircleCI","Ruby","Rubygems"]}},"next":{"fields":{"slug":"/learn-makefile/"},"frontmatter":{"title":"Makefile初めて触った。めっちゃ簡単だった","tags":["CLI"]}}}}, "staticQueryHashes": ["2585454260","2954598359"]}