Django REST Frameworkをバックエンドに、Next.js+MUIをフロントエンドにして、Markdown形式で記事を投稿するブログを作成しました。【Part 1】

ブログ作成についてまとめました。

Django REST Framework + Next.js (MUI) + Markdownでブログを作る【Part 1】

HerokuのDB操作を学んでみました。

## はじめに
以前からHerokuに関する記事をいくつか作成していますが、今回は諸般の事情でDBのテーブルを削除する作業が発生しました。誤って消すと面倒なのでDBは必要に応じてしか触ったことがなかったのですが、せっかくの機会なので色々な操作を学び直してみました。

## Heroku Postgres
Herokuが公式にサポートしているDBは[<strong>「Heroku Postgres」</strong>](https://jp.heroku.com/postgres)という<strong>Herokuのプラットフォーム上で動くPostgreSQL</strong>だけなので、その前提でDBを操作していきます。Heroku Postgresは、Heroku SchedulerやCloudinaryと同様に[add-ons](https://elements.heroku.com/addons/heroku-postgresql)から追加可能です。追加後、環境変数には自動でPostgreSQLのURLが追加されます。

## 操作
今回はDB操作だけでなく、Heroku CLI操作の基本も含めてまとめていきます。順序としては、ログイン〜DB情報表示〜DBバックアップの表示・作成〜DBバックアップのダウンロード〜DBテーブルのエクスポート・削除という流れで説明していきます。

### Herokuログイン〜DB情報表示
`heroku login`でログイン後、まずは`heroku pg:info`でDBの情報を確認しましょう。一部、数字をいじっていますが、こんな感じで表示されていると思います。
<script src="https://gitlab.com/-/snippets/2579216.js"></script>

### DBバックアップ表示
続いてバックアップ関連情報一覧の表示です。`heroku pg:backups`から確認できます。利用できる機能は以下の通りです。
* `=== Backups`・・・バックアップの作成履歴
* `=== Restores`・・・バックアップのリストア履歴
* `=== Copies`・・・バックアップのコピー履歴

バックアップの作成・リストアは実施履歴がないので、実施日時には何も表示されません。3行目の通り、バックアップ作成のために`capture`を利用しましょう。

<script src="https://gitlab.com/-/snippets/2579215.js"></script>

### DBバックアップ〜ダウンロード
それでは`heroku pg:backups:capture`でバックアップを作成します。8行目のように、`b002`というIDでバックアップが作成されたというメッセージが出ています。バックアップ作成後、再度`heroku pg:backups`でバックアップ情報を確認すると、`=== Backups`の欄に先ほどのIDが表示されていることが分かりますね。また同じテーブルに実施日時が表示されていますが、クソデカデータではないので2秒ぐらいで完了しているようです。

その後、`heroku pg:backups:download`で作成したバックアップをダウンロードします。コマンド実行後、デフォルトではコマンド実行時と同じ階層で、`latest.dump`という名前のファイルでダウンロードされます。

<script src="https://gitlab.com/-/snippets/2579217.js"></script>

### DBエクスポート（CSVファイル）
上の章ではDB自体のダウンロードをしましたが、こちらではより実践的にDB内のテーブルをCSVにエクスポートしてみます。
エクスポートする前に、CSVに落としたいデータがどのテーブル内にあるか確認しましょう。エクスポートしたいテーブルは`sample_group`テーブルに入っていそうです。
※なお今回は使用しませんが、SQLコマンドを操作するためには`heroku pg:psql`の他に、`$ heroku config`でHerokuで設定済みの環境変数を表示し`DATABASE_URL`の値を取得した後、`$ psql [DATABASE_URL]`でDBにアクセスする方法もあります。

<script src="https://gitlab.com/-/snippets/2579220.js"></script>
<details>
<summary>「一行解説」を見る</summary>
<ol type="1">
<li>(l.1) まずは<code>heroku pg:psql</code>でDBをSQLコマンドで操作できるようにします。今回は<code>psql</code>の後に、<code>[App Name]</code>と同時に<code>-c</code>を加えることでDBと接続させます。さらに、<code>"\d"</code>を追記することでデータベース内の全テーブルを表示します。</li>
<li>(l.10) <code>（4 rows）</code>とあるように、このDB内に4つのテーブルがあることが分かりました。エクスポートしたいテーブルは<code>sample_group</code>テーブルに入っていそうです。※ なお今回は使用しませんが、SQLコマンドを操作するためには<code>heroku pg:psql</code>の他に、<code>$ heroku config</code>でHerokuで設定済みの環境変数を表示し<code>DATABASE_URL</code>の値を取得した後、<code>$ psql [DATABASE_URL]</code>でDBにアクセスする方法もあります。</li>
<li>(l.12) 続いてエクスポートを実施します。(l.1) 同様に<code>heroku pg:psql</code>でSQLコマンドを操作できるようにします。</li>
<li>(l.18) すると今度は<code>[App Name]::DATABASE=></code>と表示されSQLが書けるようになります。ここで<code>\copy</code>を使ってテーブルを全選択した状態で最後にHEADERを加え列名が入った形でCSV出力を指示しましょう。コマンド実行時と同じ階層で<code>sample.csv</code>が作られているはずなのでこれで完了です。</li>
<li>(l.19) <code>COPY 10</code>は、列名含めて10行のデータが存在することを示しています。</li>
</ol>
</details>

#### 列を指定してエクスポートする
今回は(l.18) の通り`SELECT * FROM public.sample_group`としているのでテーブルがそのまま出力されてしまっていますが、先ほど出力した`sample.csv`を見ると`player`という名前の列があることが分かりました。そこで、`*`として全列を選択している部分について`player`に変更して改めてCSVエクスポートを実行すると`player`列の全値が出力できます。また同時に`WHERE`句を使えば、列内で条件に合った値のみを出力可能です。このあたりは一般的なSQLの構文ですので、[こちらの記事](https://qiita.com/tatsuya4150/items/69c2c9d318e5b93e6ccd)を参考にしてもらうと分かりやすいと思います。

#### Heroku Dataclipsを使用する場合
またCSVにエクスポートするだけならHerokuの[<strong>「Dataclips」</strong>](https://data.heroku.com/dataclips/)を使ってみても良いと思います。
詳しくは下の記事を参考にしてみてください。
* [HerokuのDataclips使ってみた。](https://techblog.futosh1.com/blogs/heroku-dataclips-howto)


### DBテーブル削除
バックアップ作成+CSVエクスポートの両方が完了したので最後にテーブルを削除します。
<script src="https://gitlab.com/-/snippets/2579222.js"></script>
上のコマンドを実行するだけですが、その際`ERROR:  cannot drop table sample_group because other objects depend on it`というエラーが出ることがあります。これは、他のテーブルを参照しているために発生するエラーですので、関連するテーブルを削除する必要があります。問題なく任意のテーブルが消せていたら、再度`DROP`すると`ERROR:  table "sample_group" does not exist`（=対象のテーブルが削除できたため）というエラーが出るはずですので、これで完了です。
## まとめ
DB削除は注意しましょう。バックアップだけは忘れないように実施しておきましょう。
### 参考
* [Heroku Postgres](https://jp.heroku.com/postgres)
* [Qiita - 【これだけ覚えてたらOK！】SQL構文まとめ](https://qiita.com/tatsuya4150/items/69c2c9d318e5b93e6ccd)