GA

2022/02/28

MySQL Shellのプロンプトをゼロからカスタマイズしてみんとす(classとsegment)

TL;DR


前回作ったところから。


$ mysqlsh -S /usr/mysql/8.0.28/data/mysql.sock -uroot --database d1

root@150-95-141-50 [d1] (READ_WRITE)>

root@150-95-141-50 [d1] (READ_WRITE)> SHOW TABLES;
SyntaxError: Unexpected identifier

( ゚д゚) そう、何も指定していないのでこれはJavaScriptモードなのである。

メインで使う時はSQLモードなので、「SQLモードの時はこのまま、それ以外のモードの時はなんか出したい」と思う。

$ cat ~/.mysqlsh/prompt.json
{
  "variables":
  {
    "read_only_str":
    {
      "match":
      {
        "pattern": "OFF",
        "value": "%sysvar:read_only%"
      },
      "if_true": "READ_WRITE",
      "if_false": "READ_ONLY"
    },
    "base_prompt":
    {
      "match":
      {
        "pattern": "",
        "value": ""
      },
      "if_true": "%user%@%sysvar:hostname% [%schema%] (%read_only_str%)"
    },
    "mode_based_prompt":
    {
      "match":
      {
        "pattern": "SQL",
        "value": "%Mode%"
      },
      "if_true": "%base_prompt%> ",
      "if_false": "%base_prompt%\n%Mode%> "
    }
  },
  "prompt": { "text": "%mode_based_prompt%" }
}

$ mysqlsh -S /usr/mysql/8.0.28/data/mysql.sock -uroot --database d1
root@150-95-141-50 [d1] (READ_WRITE)
JS> \py
Switching to Python mode...
root@150-95-141-50 [d1] (READ_WRITE)
Py> \sql
Switching to SQL mode... Commands end with ;
Fetching table and column names from `d1` for auto-completion... Press ^C to stop.
root@150-95-141-50 [d1] (READ_WRITE)>

うん、想像通りに動いてはいそう。
はい次、 READ_ONLY の場合は赤文字とかにしたい。

$ cat ~/.mysqlsh/prompt.json
{
  "variables":
  {
    "read_only_str":
    {
      "match":
      {
        "pattern": "OFF",
        "value": "%sysvar:read_only%"
      },
      "if_true": "READ_WRITE",
      "if_false": "READ_ONLY"
    },
    "read_only_color":
    {
      "match":
      {
        "pattern": "OFF",
        "value": "%sysvar:read_only%"
      },
      "if_true": "green",
      "if_false": "red"
    },
    "base_prompt":
    {
      "match":
      {
        "pattern": "",
        "value": ""
      },
      "if_true": "%user%@%sysvar:hostname% [%schema%] (%read_only_str%)"
    },
    "mode_based_prompt":
    {
      "match":
      {
        "pattern": "SQL",
        "value": "%Mode%"
      },
      "if_true": "%base_prompt%> ",
      "if_false": "%base_prompt%\n%Mode%> "
    }
  },
  "prompt": { "text": "%mode_based_prompt%", "fg": "%read_only_color%" }
}

長くなってきた…。

$ mysqlsh -S /usr/mysql/8.0.28/data/mysql.sock -uroot --database d1 --sqlc

Error loading prompt theme '/home/yoku0825/.mysqlsh/prompt.json': Error loading prompt theme: Invalid color value %read_only_color%

あれ、食えない…。
固定文字列で “red” とか “green” って入れると通るんだけどなあ。

色々納得はいかないけれど、何パターンかトライアンドエラーで頑張ってようやく classsegment の招待に行きついた。

classは俺が思っているclassとはちょっと違って textfg とかの要素を全部持たせてしまうものみたいな気がする(他のサンプルを見るに)

ということは、表示用の要素がそのまま詰まった変数みたいなものってことになる。まあ、そういうものだと思うことにしよう。。

そして segments の方は、理屈はわからないけれどどうも「 segments に列挙されたものを順番に並べて、最後に prompt に指定されたものを添えることでプロンプトを作る」みたいになっている。

たとえば segments から先だけを

  "segments":
  [
    { "classes": ["%read_only_str%"] },
    { "text": "%mode_based_prompt%" },
    { "text": "hogehoge" },
  ],
  "prompt": { "text": "pro" }

みたいにすると、

$ mysqlsh -S /usr/mysql/8.0.28/data/mysql.sock -uroot --database d1 --sqlc
READ_ONLY root@150-95-141-50 [d1] (READ_ONLY)>  hogehogepro

みたいになる。

こういうものだとわかれば、まあ、

  • class に表示したいものを詰める
  • segments にそれを列挙する
  • 今までさんざん頑張ってきたけど、 prompt はたぶんおまけ
    こういう風になるだろうか…。

話がひっくり返るけれど、 segments の中で class を展開するには

    { "classes": ["%read_only_str%"] },

こんな風にすると、カスタム変数 "class": "read_only_str" に対応する要素が展開される、っぽい。

$ cat ~/.mysqlsh/prompt.json
{
  "variables":
  {
    "read_only_str":
    {
      "match":
      {
        "pattern": "OFF",
        "value": "%sysvar:read_only%"
      },
      "if_true": "READ_WRITE",
      "if_false": "READ_ONLY"
    },
    "base_prompt":
    {
      "match":
      {
        "pattern": "",
        "value": ""
      },
      "if_true": "%user%@%sysvar:hostname% [%schema%] "
    },
    "mode_based_prompt":
    {
      "match":
      {
        "pattern": "SQL",
        "value": "%Mode%"
      },
      "if_true": "%base_prompt% ",
      "if_false": "%base_prompt%\n%Mode% "
    }
  },
  "classes":
  {
    "READ_ONLY":
    {
      "text": "(READ_ONLY)",
      "fg": "red"
    },
    "READ_WRITE":
    {
      "text": "(READ_WRITE)",
      "fg": "green"
    }
  },
  "segments":
  [
    { "text": "%mode_based_prompt%" },
    { "classes": ["%read_only_str%"] },
  ],
  "prompt": { "text": "> " }
}

というわけでこうすると

こうなった。

2022/02/27

MySQL Shellのプロンプトをゼロからカスタマイズしてみんとす(サーバー変数&カスタム変数を使ってみる)

TL;DR


取り敢えず、 mysqlsh が最初に食おうとするプロンプト用のJSONファイルは ~/.mysqlsh/prompt.json, それが無ければデフォルトというかビルトインのJSONファイルのパスを探して(termの色数とか勘案しつつ)開くっぽい。


$ strace -f mysqlsh 2>&1 | grep json

open("/home/yoku0825/.mysqlsh/options.json", O_RDONLY) = 3

[pid 10699] stat("/home/yoku0825/.mysqlsh/prompt.json", 0x7fffae727880) = -1 ENOENT (No such file or directory)

[pid 10699] open("/usr/share/mysqlsh/prompt/prompt_256.json", O_RDONLY) = 4

カスタマイズしたいので、とりあえず ~/.mysqlsh/prompt.json を作ることにする。


$ touch /home/yoku0825/.mysqlsh/prompt.json

$ mysqlsh

Error loading prompt theme '/home/yoku0825/.mysqlsh/prompt.json': Can't parse ''
mysql-js>

JSONとしてパースできなさそうなファイルを作るとフォールバックする。

mysql-shell/prompt_nocolor.json at master · mysql/mysql-shell など参考にすると、おそらく最小のコンフィグは↓のような感じ。

$ cat ~/.mysqlsh/prompt.json
{
  "prompt": { "text": "mysqlsh> " }
}

$ mysqlsh

mysqlsh>

OK, 固定文字列はこれで出せる。

mysql コマンドでいう \h\u みたいな シーケンス はREADMEに Supported variables are: で書かれているやつで、 % でくくられたやつ。

ざっと user@hostname [database]> みたいなやつにするにはこうかな。

$ cat ~/.mysqlsh/prompt.json
{
  "prompt": { "text": "%user%@%host% [%schema%]> " }
}

$ mysqlsh
@ []>

接続してないから軒並み空っぽになってしまった。。
ちゃんと mysqld に接続すれば出る。

$ mysqlsh -S /usr/mysql/8.0.28/data/mysql.sock -uroot --database d1
root@localhost [d1]>

root@localhost [d1]> \use mysql
Default schema set to `mysql`.
root@localhost [mysql]>

OK。
ところでこの %host% は飽くまでも mysqlsh から見て指定した接続先ホストで、localhostになっている(これは mysql\h も同じ)

俺はこれが嫌いで、 mysql コマンドでも「クライアントから見た先じゃなくてサーバーサイドから取得したホスト名を表示したい」みたいなパッチも投げているくらいなので、ここをカスタマイズしたい。

サーバーサイドのホスト名は SHOW GLOBAL VARIABLES LIKE 'hostname' で取れて、MySQL Shellのプロンプトには SHOW GLOBAL VARIABLES の値を取ってくるための %sysvar:*% パラメーターがあるので、これを使ってみる。

$ cat ~/.mysqlsh/prompt.json
{
  "prompt": { "text": "%user%@%sysvar:hostname% [%schema%]> " }
}

$ mysqlsh -S /usr/mysql/8.0.28/data/mysql.sock -uroot --database d1

root@150-95-141-50 [d1]>

よし行けた。

ついでによく見たくなる、「そのホストが read_only かどうか」も積んでみる。

$ cat ~/.mysqlsh/prompt.json
{
  "prompt": { "text": "%user%@%sysvar:hostname% [%schema%] (%sysvar:read_only%)> " }
}

$ mysqlsh -S /usr/mysql/8.0.28/data/mysql.sock -uroot --database d1
root@150-95-141-50 [d1] (OFF)>

0か1になると思ったら案外OFF表記だった。
このままだと何が何だかわからないので、 read_only だったら「READ_ONLY」、そうでなければ「READ_WRITE」とか表示させたい。

カスタム変数とかいうのがあるのでそれを使う。

$ cat ~/.mysqlsh/prompt.json
{
  "variables":
  {
    "read_only_str":
    {
      "match":
      {
        "pattern": "OFF",
        "value": "%sysvar:read_only%"
      },
      "if_true": "READ_WRITE",
      "if_false": "READ_ONLY"
    }
  },

  "prompt": { "text": "%user%@%sysvar:hostname% [%schema%] (%read_only_str%)> " }
}

パッと他のサンプルのJSONファイルを覗いて見るに、条件分岐に使えるのは match しかなさそう。
取り敢えず read_only_str というカスタム変数を、 OFF にマッチしたら READ_WRITE, マッチしなければ READ_ONLY にセットする。
prompt からは %read_only_str% を呼び出すようにしてトライ。

$ mysqlsh -S /usr/mysql/8.0.28/data/mysql.sock -uroot --database d1

root@150-95-141-50 [d1] (READ_WRITE)>

上手くいった。
ところでこれ、途中で値を変えたらどうなるんだろ。

root@150-95-141-50 [d1] (READ_WRITE)> \sql SET GLOBAL read_only = 1;
Fetching table and column names from `d1` for auto-completion... Press ^C to stop.
Query OK, 0 rows affected (0.0003 sec)
root@150-95-141-50 [d1] (READ_ONLY)>

おお、読み直した。
他のセッションから値を変えたらどうかな?

mysql80 22> SET GLOBAL read_only = OFF;  -- 別ターミナルのmysqlコマンドラインクライアントから
Query OK, 0 rows affected (0.00 sec)

root@150-95-141-50 [d1] (READ_ONLY)>  
root@150-95-141-50 [d1] (READ_WRITE)>   /* 空Enter打ったタイミングで変わった */
root@150-95-141-50 [d1] (READ_WRITE)>

プロンプトを描画するたびに毎回フェッチしてるっぽい。
よしよし、良いんではないか。

と思いつつ今日はここまで。


【2022/03/03 00:38】

続き -> 日々の覚書: MySQL Shellのプロンプトをゼロからカスタマイズしてみんとす(classとsegment)