先日、このようなブログを書きました：
"Image to Excel" を REST API 化（xlsx-js-style の使い方）


xlsx-js-style というライブラリを使って、ネットでプチバズった Image to Excel というツール（を REST API 化したもの）を独自実装した、という紹介エントリでした。

この REST API を作る上で xlsx-js-style というエクセルシートやエクセルブックファイルを Node.js で作成・編集するライブラリを使いました。Image to Excel を作るだけであればセルのサイズや背景色を設定する機能を使えばできるので（セルのテキストを読み書きする必要はなかったので）さほど難しくありませんでした。

というわけで、その勉強の続きという意味も含め、より実践的なセルの読み書きを伴うサービスを作ってみようと思い立ち、苦労しながらブログネタになりそうなものを作ることができたので紹介させていただきます。


【作ったサービスの内容】
一言でいうと「データベースとエクセルの相互変換ツール」です。データベースをエクセルファイルに、エクセルファイルはデータベースに、それぞれ変換して記録（保存）するツール。正確にはツールというよりも REST API として実装しているので、別の外部アプリケーションから使うことを想定しています（Swagger API の UI は標準で用意したので、単体でも動かしてみせることはできます）。

作ったサービスをもう少し詳しく説明します。まず「データベースをエクセルにする」部分から、現時点では PostgreSQL か MySQL だけで動くのですが、こんな感じのデータベース接続文字列を指定して API を実行します：
　（PosgreSQL の場合）postgres://username:password@servername:port/dbname
　（MySQL の場合）　　mysql://username:password@servername:port/dbname


PostgreSQL の場合は最初のプロトコル名部分を "postgres" に、MySQL の場合は "mysql" と指定します。"username:password" 部分は接続する際のユーザー名（username）とパスワード（password）を指定します。servername はデータベースサーバー名（または IP アドレス）で、port は接続ポート番号です（PostgreSQL のデフォルト値は 5432 、MySQL のデフォルト値は 3306 です）。そして dbname は接続先のデータベース名を指定します。

例えば localhost の 5432 番ポートで動いている PostgreSQL サーバーの mydb データベースに、ユーザー名 user1 、パスワード pass1 で接続する場合は以下のようなデータベース接続文字列が必要となります：
　postgres://user1:pass1@localhost:5432/mydb


話を戻します。このようなデータベース接続文字列を指定して REST API を実行すると、以下のルールでデータベース内容をまるごと１つのエクセルファイルに変換します：
・データベース内の全テーブルと、各テーブル内のレコードデータを取り出す
・各テーブルが１枚のエクセルシート（タブ）になる　テーブル名がシート名になる
・シートの１行目にテーブルの全列が書き出される
・シートの２行目以降にテーブル内の全レコードデータが１行ずつ格納される（ただし BLOB などのバイナリデータは無視する）
・処理が完了すると、（データベース名）.xlsx という名前のエクセルファイルでダウンロードできる

という誰得（？）な処理を行います。　もう１つの「エクセルをデータベースにする」は基本的にこの逆の処理を行います：

・実行時のパラメータとして（上述の処理と同様に）データベース文字列を指定する
・併せてエクセルファイルをアップロードする形で REST API を実行する
・エクセルファイル内の全シートを１つのテーブル内容としてデータベースに格納する
　・テーブル名はシート名
　・各シートの１行目にテーブルの列名が格納されているとみなす
　・各シートの２行目以降にテーブルのレコードデータが１行ずつ格納されているとみなし、
　　テーブルに１行ずつ追加される（ただし BLOB などのバイナリデータは無視する）
・REST API 実行時のパラメータにより各シートの２行目にある情報はレコード情報ではなく、各列の定義情報とみなすこともできる。その場合、３行目以降にテーブルのレコードデータが格納されているとみなす。
・同様にして REST API 実行時のパラメータによりシート名の既存テーブルを削除（drop table）してから実行するか、新規作成（create table）してから実行するかを選択することができる
・処理が完了するとエクセル内の各シートに定義されていた情報がまるごとデータベース化される


【ソースコード】
作成したサービスのソースコードをこちらで公開しています：
https://github.com/dotnsf/db2xlsx


実際にネット上のどこかでサービスとして公開することも考えたのですが、現実問題としてデータベースがインターネット上に公開されていないと使えないので（普通、公開されていないはずなので）、公開しても使えるものではないと判断しています。　そういうこともあってのソースコードでの公開としました。

サービスとして自分の PC で使ってみたい場合は、Git と Node.js がインストールされた環境で以下の手順を実行してください：

（１）ターミナルやコマンドプロンプトなどの端末を開く

（２）ソースコードをダウンロード

$ git clone https://github.com/dotnsf/db2xlsx

（３）必要なライブラリをインストール

$ cd db2xlsx

$ npm install

（４）実行（終了時は Ctrl+C）

$ npm start

ただ単にサービスとして実行しても対象のデータベースやエクセルファイルが無いと使えないので、より具体的な手順を次のセクションで紹介します。


【Docker と Swagger API で実際に使う手順】
このサービスを実際に使うにはインポートやエクスポートの対象となるデータベースや、エクセルファイルが必要です（そういうサービスです）。エクセルファイルはサンプルを用意できるのですが、データベースはそうはいきません。　実際に使える PostgreSQL や MySQL のデータベースがあればそれをそのまま使っていただいてもいいのですが、そういう人も多くはないと思うので、以下に Docker を使ってデータベースを用意する手順を紹介します。というわけでまずは Docker（個人利用であれば Docker Desktop がお奨めですが、業務利用の場合は有料なので、無料を希望する場合は WSL などを使って Community Edition）をインストールしておいてください。


Docker で PostgreSQL データベースを１つ用意する場合は以下を実行します：

$ docker run -d --name postgres -p 5432:5432 -e POSTGRES_USER=user1 -e POSTGRES_PASSWORD=pass1 -e POSTGRES_DB=db1 postgres

↑このコマンドで作成した場合、ユーザー名 user1 、パスワード pass1 、データベース名 db1、ポート番号 5432 番で postgres という名前の PostgreSQL コンテナが起動します。この例だとデータベース接続文字列は "postgres://user1:pass1@localhost:5432/db1" となります。

データベースを２つ作る必要はないので PostgreSQL で作成した場合はそれを使えばいいのですが、どうしても MySQL を使いたい場合はこちらを実行します：

$ docker run -d --name mysql -e MYSQL_ROOT_PASSWORD=P@ssw0rd -e MYSQL_USER=user1 -e MYSQL_PASSWORD=pass1 -e MYSQL_DATABASE=db1 -p 3306:3306 mysql:5.7 --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci

この場合だとデータベース接続文字列は "mysql://user1:pass1@localhost:3306/db1" となります。ユーザー名部分やパスワードなどは適宜変更して読み替えてください。


この方法を含め、なんらかの方法で接続して読み書き可能なデータベースが用意できているものと仮定して以下の説明を続けます。


データベースが稼働している状態で上述の（４）までを実行して本ツールを起動します（本ツール起動後にデータベース起動でも構いません）：

$ npm start

> db2xlsx@0.0.1 start
> node app.js

server starting on 8080 ...

↑の青字のような表示が出力されれば起動に成功しています。ツールは 8080 番ポートで稼働しているので、ウェブブラウザで http://localhost:8080/_doc にアクセスして Swagger API Document を開きます：



↑のような画面が表示されます。この画面でも "POST /db2xlsx" と "POST /xlsx2db" の２つの REST API が存在していることが確認できます。名前の通りですが、それぞれ「データベースからエクセル」、「エクセルからデータベース」に変換する API になっています。


これらの API をそれぞれ使ってみましょう。順番としてはデータベースは空の状態であると想定して、
（１）まずエクセルファイルの内容をデータベースにインポート（POST /xlsx2db）して、
（２）そのデータベースの内容をエクセルファイルにエクスポート（POST /db2xlsx）する
という順に実行してみることにします。

まずはデータベースにインポートするエクセルファイルを用意します。独自のものを準備いただいてもいいのですが、すぐ使えるようなサンプルを用意しておきました：
https://dotnsf.blog.jp/items-brands.xlsx


↑このリンクからエクセルファイル items-brands.xlsx をダウンロードしてください。エクセルや互換ツールを使って開ける場合は内容を確認してみてください（自由に変更していただいても構いません）：





この items-brands.xlsx ワークブックには items と brands という２つのシート（タブ）があります。それぞれ以下のようなデータが表形式で格納されています：

（items）

id	name	brand_id	price	body	updated
varchar(20) primary key	varchar(100) not null	varchar(20)	integer	text	timestamp
item001	商品１	brand001	100	商品説明１商品説明１商品説明１商品説明１商品説明１商品説明１商品説明１商品説明１商品説明１商品説明１商品説明１商品説明１	2023-12-20
item002	商品２	brand002	1200	商品説明２商品説明２商品説明２商品説明２商品説明２商品説明２商品説明２	2023-12-21
item003	商品３	brand003	500	商品説明３商品説明３商品説明３商品説明３商品説明３商品説明３商品説明３商品説明３商品説明３商品説明３商品説明３商品説明３商品説明３商品説明３	2023-12-22
item004	商品４	brand002	2980	商品説明４商品説明４商品説明４商品説明４商品説明４商品説明４	2023-12-23

（brands）

id	name	body	url	updated
varchar(20) primary key	varchar(100) not null	text	varchar(100)	timestamp
brand01	ブランド１	説明文１説明文１説明文１説明文１説明文１説明文１説明文１説明文１説明文１説明文１説明文１説明文１説明文１	https://www.brand1.com	2023-12-20
brand02	ブランド２	説明文２説明文２説明文２説明文２説明文２説明文２説明文２説明文２説明文２	https://www.brand2.net	2023-12-21
brand03	ブランド３	説明文３説明文３説明文３説明文３説明文３説明文３説明文３説明文３説明文３説明文３説明文３説明文３説明文３説明文３説明文３説明文３説明文３	https://www.brand3.jp/	2023-12-22

エクセルファイルが用意できたらこれをデータベースにインポートしてみましょう。先ほどのブラウザ画面内の "POST /xlsx2db" と書かれた箇所をクリックします：



すると下のような隠れていた画面が展開されます。この API を実行する時に指定するパラメータに関する情報が表示されています。内容を確認し、そのまま実行したいので "Try it out" と書かれたボタンをクリックします：



するとパラメータ部分が編集可能状態に切り替わります。ここに必要な情報を入力していきます：



まず一番上の database_url パラメータは指定が必須になっています。ここにはデータベース接続文字列を入力します。上の方法で PostgreSQL データベースを起動した場合であれば、
　postgres://user1:pass1@localhost:5432/db1
また MySQL データベースを起動した場合であれば、
　mysql://user1:pass1@localhost:3306/db1
を指定してください（別の方法で起動したデータベースの場合はそのデータベースに接続するための接続文字列を指定してください）。


また一番下の「エクセルワークブックファイル」と書かれた file パラメータも必須入力です。ここは「ファイルを選択」ボタンをクリックしてから、先ほど用意したワークブックファイル（ダウンロードしたものを使う場合は items-brands.xlsx ）を指定します。

それ以外の部分は必要に応じて指定するものですが、今回指定したワークブックファイルは各シートの２行目にテーブルの列定義が記載されています。このような場合（シートの２行目がレコード情報ではなく、列定義情報の場合）は col_attr パラメータに "1" という値を指定する必要があります（何も指定しない場合は２行目もデータレコードとみなされて insert into table が実行されます。またテーブルの各列は全て text 型として create table が実行されます）。

また今回は初回実行なのでまだデータベース内にテーブルは何も作成されていません。したがって create table を実行してから insert into table を実行する必要があります。その場合は create_table パラメータに "1" を指定してください。今回は指定しませんが drop_table パラメータに "1" をセットして実行すると create table の前に drop table が実行されます。定義の異なる同名のテーブルが作成されている可能性があって、そちらを削除してから実行する場合や、現在登録済みのデータを削除してから再実行したい場合は drop_table の方にも "1" を指定してください。

パラメータの指定が完了したら最後に青い "Execute" ボタンを実行すると xlsx2db 処理が実行されます：



実行後、ボタンの下のほうに実行結果が表示されます。またこの REST API を実行した時のコマンド内容も表示されるので、この REST API を外部から利用する機会があれば参考にしてください：



とりあえず実行は完了し、成功しているようです。　せっかくなので実際にデータベースにアクセスして成功した結果を確認してみましょう。

ターミナルやコマンドプロンプトなどの端末をもう１つ開いて、CLI からデータベースに接続します。上述のような Docker でデータベースを起動している場合はそのコンテナに直接ログインして調べることができます。

データベースが PostgreSQL の場合は、以下のようなコマンドで確認できます（赤字が入力内容、青字は説明用のコメントです。実際に入力しないでください）：

$ docker exec -it postgres bash　（データベースが動いているコンテナにログイン）

/# psql "postgres://user1:pass1@localhost:5432/db1"　（接続文字列を指定して psql コマンドでログイン）

db1=# \dt　（テーブル一覧を表示、brands テーブルと items テーブルが作成されていることを確認）

        List of relations
 Schema |  Name  | Type  | Owner
--------+--------+-------+-------
 public | brands | table | user1
 public | items  | table | user1

db1=# select * from brands;　（brands テーブルの内容を確認し、エクセルに入力されていた内容が格納されていることを確認）

   id    |    name    |
           body
   |          url           |       updated
---------+------------+--------------------------------------------------------
-------------------------------------------------------------------------------
---+------------------------+---------------------
 brand01 | ブランド１ | 説明文１説明文１説明文１説明文１説明文１説明文１説明文
説明文１説明文１説明文１説明文１説明文１説明文１
  | https://www.brand1.com | 2023-12-20 00:00:00
 brand02 | ブランド２ | 説明文２説明文２説明文２説明文２説明文２説明文２説明文
説明文２説明文２
  | https://www.brand2.net | 2023-12-21 00:00:00
 brand03 | ブランド３ | 説明文３説明文３説明文３説明文３説明文３説明文３説明文
説明文３説明文３説明文３説明文３説明文３説明文３説明文３説明文３説明文３説明文
 | https://www.brand3.jp/ | 2023-12-22 00:00:00
(3 rows)

db1=# select * from items;　（items テーブルも同様に確認する）

（略）

db1=# \q　（psql からログアウトする）

/# exit　（コンテナからもログアウトする）

データベースが MySQL の場合も、コマンドが少し異なりますが同様に確認できます：

$ docker exec -it mysql bash　（データベースが動いているコンテナにログイン）

# mysql -u user1 -ppass1 db1 --default-character-set=utf8mb4"　（接続情報を指定して mysql コマンドでログイン）

mysql> show tables;　（テーブル一覧を表示、brands テーブルと items テーブルが作成されていることを確認）

+--------------+
| Tables_in_db |
+--------------+
| brands       |
| items        |
+--------------+
2 rows in set (0.01 sec)

mysql> select * from brands;　（brands テーブルの内容を確認し、エクセルに入力されていた内容が格納されていることを確認）

（略）

mysql> select * from items;　（items テーブルも同様に確認する）

（略）

mysql> quit　（mysql からログアウトする）

# exit　（コンテナからもログアウトする）

エクセルファイルをアップロードして、データベース化できることが確認できました。


では次に「データベースからエクセル」も試してみましょう。上の作業でエクセルファイルからデータベースを作成した直後だと、アップロードしたものと同じエクセルファイルが作成されるだけ（苦笑）ではあるのですが、データベースの内容がエクセルになる、という部分については体験できると思います。

Swagger API ドキュメントに戻り、今度は "POST /db2xlsx" のボタンをクリックします：



API 実行時のパラメータが展開されます。今回は "POST /xlsx2db" の時よりもシンプルなパラメータになっていることがわかります。"Try it out" ボタンをクリックします：



こちらの API ではエクセルにエクスポートしたいデータベースを database_url パラメータにデータベース接続文字列の形で指定するだけです。先ほどと同様のデータベース接続文字列を入力して "Execute" ボタンをクリックします：



処理が成功すると "Download file" と書かれたリンクが現れます。ここをクリック：



すると、（データベース名）.xlsx というエクセルファイルがダウンロードされます。ダウンロード後に開いてみてください：



ダウンロードしたエクセルファイルを開いてみると、items と brands という２つのワークシート（タブ）が含まれていて、それぞれのワークシート内に items テーブルと brands テーブルの内容がエクスポートされていることが確認できます。日付列は日付情報として取り出しているので少しフォーマットが変わっていますが中身（日付は）正しいはず：





データベースからエクセル、の REST API も正しく動くことが確認できるはずです。


【あとがき的なもの】
一部でエクセルがデータベースの代わりに使われていることを知っている身として、その状況はなんとかならんかという思いで作ってみました。REST API 化したので簡単なプログラムを書けば一括処理もできるはずです（笑）。で、どうしてもまたエクセル化する必要が生じた場合にも対応できるような逆方向の REST API も用意しているので、これでなんとかしてください。


 

タグ ：

#db2xlsx

#xls

#xlsx

#xslx-js-style

#db

#excel

#mysql

#postgres

IBM Cloud から提供されている 30 日間無料 Kubernetes サービス（IBM Kubernetes Service 、以下 "IKS"）環境を使って利用することのできるコンテナイメージを１日に１個ずつ 30 日間連続で紹介していきます。

環境のセットアップや制約事項については Day0 のこちらの記事を参照してください。

Day 6 からは Day 5 までのアプリケーション・サーバー系コンテナではなく、データベース系コンテナとその GUI ツールを中心に紹介していく予定です。その初日は最もメジャーなデータベース・サーバーの１つだと思っている MySQL イメージをデプロイする例を紹介します。




【イメージの概要】
今更改めて説明する必要もないくらい有名で、かつ広く使われているオープンソースのリレーショナル・データベース・サーバーだと思っています。



【イメージのデプロイ】
Day 5 までは（特にパラメータの指定なども不要で動くコンテナばかりだったので）Github 上の YAML ファイルを直接していしてデプロイしていました。が、Day 6 以降では動かすコンテナに向けた設定項目（MySQL でいえば管理者パスワードなど）を自分で指定して動かす方針とします。　というわけで、まずはこちらのファイルを自分の PC にダウンロードしてください：
https://raw.githubusercontent.com/dotnsf/yamls_for_iks/main/mysql.yaml


次にこのファイルをテキストエディタで開いてパラメータを編集します。具体的には "MYSQL_" で始まる４箇所の env.name の value 値を変更してください。それぞれの具体的な意味は以下の通りです（初期値として指定されている値のまま動かすことも可能ですが、安全のためなるべく変更してください）：
・MYSQL_ROOT_PASSWORD : 管理者パスワード（初期値 P@ssw0rd）
・MYSQL_DATABASE : デプロイと同時に作成するデータベースの名前（初期値 mydb）
・MYSQL_USER : デプロイと同時に作成するデータベースを利用するユーザー名（初期値 user1）
・MYSQL_PASSWORD : デプロイと同時に作成するデータベースを利用するパスワード（初期値 password1）

ではこのダウンロード＆編集した mysql.yaml ファイルを指定してデプロイします。以下のコマンドを実行する前に Day 0 の内容を参照して ibmcloud CLI ツールで IBM Cloud にログインし、クラスタに接続するまでを済ませておいてください。

そして以下のコマンドを実行します：

$ kubectl apply -f mysql.yaml

以下のコマンドで MySQL 関連の Deployment, Service, Pod, Replicaset が１つずつ生成されたことと、サービスが 30306 番ポートで公開されていることを確認します：

$ kubectl get all

NAME                        READY   STATUS    RESTARTS   AGE
pod/mysql-5bd77967b-799vp   1/1     Running   0          9s

NAME                  TYPE        CLUSTER-IP     EXTERNAL-IP   PORT(S)          AGE
service/kubernetes    ClusterIP   172.21.0.1     <none>        443/TCP          26d
service/mysqlserver   NodePort    172.21.40.65   <none>        3306:30306/TCP   10s

NAME                    READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/mysql   1/1     1            1           10s

NAME                              DESIRED   CURRENT   READY   AGE
replicaset.apps/mysql-5bd77967b   1         1         1       10s

この後に実際にサービスを利用するため、以下のコマンドでワーカーノードのパブリック IP アドレスを確認します（以下の例であれば 161.51.204.190）：

$ ibmcloud ks worker ls --cluster=mycluster-free
OK
ID                                                       パブリック IP    プライベート IP   フレーバー   状態     状況    ゾーン   バージョン
kube-c3biujbf074rs3rl76t0-myclusterfr-default-000000df   169.51.204.190   10.144.185.144    free         normal   Ready   mil01    1.20.7_1543*

つまりこの時点で（上述の結果であれば）アプリケーションは 169.51.204.190:30306 で稼働している、ということになります。早速確認してみます、と言いたいところなのですが、これまでのようにウェブブラウザで確認できるものではなく、専用の CLI コマンドが使えると確認できるのですが・・・　ここでは動作確認を Day 7 で行うことにして、今回はこのままにしておきます。


【YAML ファイルの解説】
YAML ファイルはこちらを使っています（編集する前の状態です）：

apiVersion: v1
kind: Service
metadata:
  name: mysqlserver
spec:
  selector:
    app: mysql
  ports:
  - port: 3306
    protocol: TCP
    targetPort: 3306
    nodePort: 30306
  type: NodePort
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: mysql
spec:
  replicas: 1
  selector:
    matchLabels:
      app: mysql
  template:
    metadata:
      labels:
        app: mysql
    spec:
      containers:
      - name: mysql
        image: mysql:5.7  # should be 5.7 to avoid password caching error
        env:
        - name: MYSQL_ROOT_PASSWORD
          value: "P@ssw0rd"
        - name: MYSQL_DATABASE
          value: "mydb"
        - name: MYSQL_USER
          value: "user1"
        - name: MYSQL_PASSWORD
          value: "password1"
        ports:
        - containerPort: 3306

Deployment １つと、Service １つのごくごくシンプルな YAML ファイルですが、一応解説を加えておきます。アプリケーションそのものは 3306 番ポートで動作するように作られているため、NodePort 30306 番を指定して、外部からは 30306 番ポートでアクセスできるようにしています（NodePort として指定可能な番号の範囲は 30000 ～ 32767 です、指定しない場合は空いている番号がランダムに割り振られます）。また ReplicaSet は１つだけで作りました（データベースなので、別途クラスタ構成の準備をしない限りはこの数値だけを増やしてもあまり意味ないと思います）。


デプロイしたコンテナイメージを削除する場合はデプロイ時に使った YAML ファイルを再度使って、以下のコマンドを実行します。不要であれば削除しておきましょう（ちなみにこの MySQL コンテナは明日の Day 7 でも使う予定なので、削除するのはそのあとの方がいいかもしれません）：

$ kubectl delete -f mysql.yaml

【紹介したイメージ】
https://hub.docker.com/_/mysql


【紹介記録】

Day	カテゴリー	デプロイ内容
0	準備	準備作業
1	ウェブサーバー	hostname
2		Apache HTTP
3		Nginx
4		Tomcat
5		Websphere Liberty
6	データベース	MySQL
7		phpMyAdmin
8		PostgreSQL
9		pgAdmin4
10		MongoDB
11		Mongo-Express
12		Redis
13		RedisCommander
14		ElasticSearch
15		Kibana
16		CouchDB
17		CouchBase
18		HATOYA
19	プログラミング	Node-RED
20		Scratch
21		Eclipse Orion
22		Swagger Editor
23		R Studio
24		Jenkins
25	アプリケーション	FX
26		2048
27		DOS Box
28		VNC Server(Lubuntu)
29		Drupal
30		WordPress

タグ ：

#mysql

#ibm

#cloud

#k8s

#iks

#30days

タイトルどおりの内容のエラーが発生したので、その原因と解決策を探った記録をブログにまとめました。

環境としては以下の図のようなものです。１台の Windows 10 PC の中に Docker Desktop を導入・起動し、MySQL サーバーのイメージからコンテナを作って 3306 番ポートで公開起動しました。この環境に WSL(2) の MySQL CLI を使って、localhost:3306 の MySQL サーバーにログインする、というだけの内容なのですが、ログイン時にコネクションエラーが発生してしまう、という症状が出ていました：



具体的に紹介します。今回使った MySQL のコンテナイメージはこちらです。厳密には mariadb を使っています。同様の現象が発生すると思うので、他の MySQL 系イメージでも構いません：
https://hub.docker.com/r/linuxserver/mariadb


Docker Desktop を使ってこのイメージからコンテナを作成します。WSL を起動するなどして docker コマンドが使える状態で以下のコマンドを実行します（目的は Docker Desktop 内のコンテナとして起動することなので、このコマンド自体は WSL から実行しなくても構いません）：

$ docker run -d --name=mariadb -e PUID=1000 -e PGID=1000 -e MYSQL_ROOT_PASSWORD=root -e TZ=Asia/Tokyo -e MYSQL_DATABASE=mydb -e MYSQL_USER=user -e MYSQL_PASSWORD=P@ssw0rd -p 3306:3306 --restart unless-stopped linuxserver/mariadb

こんな感じで、Docker Desktop 内のコンテナとして MySQL が起動します：



指定したオプションはコンテナイメージのドキュメントを参考に指定しています。上の例では root のパスワードは root 、利用ユーザーは user 、利用ユーザーのパスワードは P@ssw0rd 、利用データベース名を mydb、コンテナ名は mariadb、などを指定しています（適当に変更いただいても構いません）。ポート番号に -p 3306:3306 を指定しているので、ローカルホストの 3306 番ポートからも（公開されているので）アクセスできるはずです。事前準備はここまで。

ではこの方法で Docker Desktop 内に起動した MySQL(mariadb) に、WSL から MySQL CLI で接続してみます。上述のオプションであれば以下のコマンドで接続できるはずです：

$ mysql -u user -pP@ssw0rd -h localhost mydb

しかし実際には以下のようなエラーが表示されてしまいます：

$ mysql -u user -pP@ssw0rd -h localhost mydb
ERROR 2002 (HY000): Can't connect to local MySQL server through socket '/var/run/mysqld/mysqld.sock' (2 "No such file or directory")

ユーザー名やパスワード、データベース名は間違っておらず、接続先も localhost だから間違えようがないはずです。ポート番号もデフォルトの 3306 のままなので特別なオプションも不要のはず・・・　ではなぜエラーになってしまうのでしょうか？


改めてエラーメッセージをよく見ると "Can't connect to local MySQL server through socket '/var/run/mysqld/mysqld.sock'" と表示されています。ちなみにこのファイルは存在していません（/var/run/mysqld というディレクトリが存在していません）：

$ ls -la /var/run/sqld/mysqld.sock
ls: cannot access '/var/run/sqld/mysqld.sock': No such file or directory

このエラーメッセージでわかる人もいると思うのですが、MySQL コマンドは localhost が対象の場合はデフォルトで「ソケット接続」という方法で接続を試みます。そしてこのソケット接続をする場合の情報を /var/run/sqld/mysqld.sock というファイルで管理しているため、このファイルを読み込もうとしているのでした。

しかし、今回の環境では WSL 内には MySQL サーバーは起動していません。WSL 内からの docker コマンドで起動してはいますが、実体は Windows にインストールされた Docker Desktop のコンテナとして起動しています。要は「WSL と同じマシン上で動いてはいて、ポートも公開されているけど、WSL から直接ソケット接続できる状態で動いていない」のです。これがエラーの原因で、エラーメッセージの理由でもあります。

では、エラーなしに WSL から MySQL に接続するにはどのようなコマンドにすればいいでしょうか？　答はシンプルで「ソケット接続ではなく、TCP 接続するようなオプションを指定」することで解決できます。具体的には以下のように --protocol=TCP オプションを付けて実行します：

$ mysql -u user -pP@ssw0rd --protocol=TCP -h localhost mydb
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 11
Server version: 10.4.18-MariaDB-1:10.4.18+maria~bionic-log mariadb.org binary distribution

Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

MariaDB [mydb]>

今度は無事に接続できました。「localhost の罠」にかかった時の話でした。

タグ ：

#localhost

#docker

#desktop

#mysql

#mariadb

#wsl

#error

#connection

#cli

#protocol