この記事では、WindowsおよびmacOSにOceanBaseデスクトップ版のインストール方法について説明します。
注意
OceanBaseデスクトップ版は学習やテスト環境での使用をおすすめです。本番環境での使用は避けてください。
背景
OceanBaseデスクトップ版は、OceanBaseデータベースを管理・操作するためのデスクトップアプリケーションです。グラフィカルなインターフェースを提供し、データベース管理、クエリ実行、データのインポート・エクスポートなどを簡単に行えるようにします。
OceanBaseデスクトップ版の特徴は以下の通りです：
グラフィカルインターフェース：直感的で使いやすいグラフィカルインターフェースにより、データベース管理作業が簡素化されます。
データベース管理：データベースインスタンスの作成および管理をサポートします。
クエリ実行：SQLクエリのコマンドラインを提供します。
監視とログ：データベースの状態をリアルタイムで監視します。
システム要件
まずは、WindowsにOceanBaseデスクトップ版をインストールするための必要条件を満たしているか確認してください：
使用しているオペレーティングシステムはWindows（x86-64チップ）であること。WSL 2を使用する場合、Windows 10バージョン1903以降（ビルド番号18362以上）またはWindows 11が必要です。
2vCPU、6GBのメモリ、10GB以上のディスク空き容量が必要です。
以下の手順で、マシンがこれらの要件を満たしているか確認できます。
Windowsのバージョンを確認
キーボードの「Windowsキー」+「Q」を同時に押して「設定」と入力し、表示されたアプリを開きます。「システム」をクリックし、左側のメニューから「バージョン情報」を選ぶと、Windowsのバージョン情報を確認できます。
メモリおよびCPUを確認
キーボードの「Windowsキー」+「Q」を同時に押して「タスクマネージャー」と入力し、表示された「タスクマネージャー」アプリを開きます。画面上部の「パフォーマンス」タブをクリックすると、「CPU」のセクションでプロセッサのコア数や使用率を確認でき、「メモリ」のセクションでは搭載メモリの容量や使用状況が確認できます。
ディスクの確認
キーボードの「Windowsキー」+「Q」を同時に押して、「エクスプローラー」と入力して、表示されたアプリを開きます。開いたウィンドウの左側メニューから「PC」を選択すると、「デバイスとドライブ」セクションに各ドライブの情報が表示されます。
まずは、macOSにOceanBaseデスクトップ版をインストールするための必要条件を満たしているか確認してください：
使用しているオペレーティングシステムはmacOS（Apple SiliconチップおよびIntelチップ）であること。
2vCPU、6GBのメモリ、10GBのディスク以上の空き容量が必要です。
以下の手順で、マシンがこれらの要件を満たしているか確認できます。
CPUおよびメモリの確認
Finderを開き、「アプリケーション」フォルダを選択し、その中の「ユーティリティ」フォルダから「アクティビティモニタ」をダブルクリックして開きます。「CPU」タブではCPUの使用状況を、「メモリ」タブではメモリの使用状況を確認できます。
ディスクの確認
画面の左上にあるAppleメニューから「このMacについて」を選択します。表示されたウィンドウで「システムレポート」をクリックし、「ストレージ」の項目でディスクの情報を確認できます。
操作手順
ステップ1：依存関係のインストール
OceanBaseデスクトップ版をWindows環境にインストールするには、WSL（Windows Subsystem for Linux、Linux用Windowsサブシステム）に依存します。WSLはMicrosoftが2016年にWindows10向けにリリースした機能で、ELF形式のLinux実行ファイルをWindows上で直接実行できるようにします。
WSLには現在、WSL1とWSL2の2つのバージョンがあります。WSL1はLinuxのシステムコールをWindows NTのシステムコールに変換する互換レイヤー方式。WSL2はHyper-Vを活用し、仮想マシンでLinuxを実行するため、よりネイティブに近い動作が可能です。
注意
OceanBaseデスクトップ版はWSL2のみ対応しています。WSL2はWSL1のアップグレード版ではありません。WSL1をインストールしていなくても、WSL2を直接使用できます。
仮想化が有効になっているか確認する
「Windowsキー」+「Q」キーを同時に押して「タスクマネージャー」を検索・起動し、「パフォーマンス」タブ > 「CPU」を選択します。下図のように、仮想化の項目が有効と表示されていれば、仮想化は有効です。無効の場合は、次の手順でBIOSから仮想化を有効にしてください。
BIOSで仮想化を有効にする
ここではLenovo（ThinkPad）を例に操作手順を説明します。ブランドによってBIOS画面やキー操作が異なるため、該当する公式マニュアルを参照してください。例えば、Dell, Lenovo, ThinkPad, HP, and Huawei.
スタートメニューを開き、電源ボタンをクリックして、再起動をクリックします。
コンピューターの再起動後、すぐにキーボードのF1キーを押してBIOS設定画面にアクセスします。
BIOS画面でSecurityタブを選択し、SecurityページでSecurity Virtualizationをクリックします。
設定ページが表示されたら、Virtualization Technologyの項目を**「no」**に設定します。
設定後、Save and Exitをクリックして変更を保存し、BIOS設定を終了します。その後、システムが再起動するのを待ちます。
説明
前の手順に従ってもう一度仮想化の状態を確認できます。
WSLと仮想マシンプラットフォーム機能の有効化
次のいずれかの方法で、WSLおよび仮想マシンプラットフォームを有効にします。
方法①：コマンドラインから有効化
「[Win] + [Q] でpowershellまたはWindows Powershellを検索し、管理者として実行またはRun As Administratorを選択します。以下のコマンドを順に実行し、完了後にPCを再起動してください。
#WSL機能の有効化 dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart #仮想マシンプラットフォームの有効化 dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart方法②：GUIで有効化
キーボードで [Win] + [R] キーを同時に押し、
optionalfeaturesと入力してOKをクリックするか、または [Win] + [Q] キーを同時に押してWindowsの機能の有効化または無効化を検索し、クリックしてWindowsの機能ウィンドウを開きます。表示された一覧を下にスクロールし、Linux用Windowsサブシステムと仮想マシンプラットフォームにチェックを入れます。最後にOKをクリックし、コンピューターを再起動すれば完了です。
WSL2カーネルのインストール
こちらのダウンロードをクリックして
wsl.2.5.7.0.x64.msiファイルをダウンロードするか、WSLのGitHubリポジトリにアクセスして必要なWSLインストールパッケージをダウンロードしてください。ダウンロード完了後、ダウンロードしたファイルをダブルクリックしてインストーラーを実行し、手順に沿ってNextをクリックしながらインストールを進めます。WSL2をデフォルトバージョンに設定
以下のコマンドをcmdまたはPowerShellで実行してください：
wsl --set-default-version 2インストールの検証
以下のコマンドをcmdまたはPowerShellで実行し、WSLのバージョンを確認します：
wsl --version出力例（WSLバージョンが
2.xxxであればインストール成功です）：WSLバージョン: 2.5.7.0 カーネル バージョン: 6.6.87.1-1 WSLgバージョン: 1.0.66 MSRDCバージョン: 1.2.6074 Direct3Dバージョン: 1.611.1-81528511 DXCoreバージョン: 10.0.26100.1-240331-1435.ge-release Windowsバージョン: 10.0.19045.5854
ステップ2：OceanBaseデスクトップ版のインストール
インストーラーのダウンロード
OceanBaseソフトウェアダウンロードセンターにアクセスし、「OceanBaseデスクトップ版」を検索して、「Windows版」のインストーラーをダウンロードします。
アプリケーションのインストール
ダウンロードした
OceanBase-Desktop-Setup-x.x.x.exeファイルをダブルクリックします。ポップアップウィンドウの「ユーザーアカウント制御」で「はい」をクリックして、アプリケーションがデバイスに変更を加えることを許可します。
アプリケーションのインストール先を選択します。デフォルトではCドライブにインストールされますが、「参照」をクリックして別のフォルダを選択することもできます。確認後、「インストール」をクリックします。
インストールが完了したら、「完了」をクリックして、OceanBaseデスクトップ版が自動的に起動します。
OceanBaseデスクトップ版の起動
インストールが完了すると、
停止中の状態でOceanBaseデータベースが自動的にデプロイされます。画面内の「起動」ボタンをクリックすることで、OceanBaseデータベースを起動できます。
ステップ3：OceanBaseデスクトップ版への接続
OceanBaseデータベースが正常に起動した後、OceanBaseデスクトップ版内の「接続」をクリックして、表示された接続文字列をコピーします。その後、キーボードで「Windowsキー」+「R」を押し、cmd と入力して「OK」をクリックしてコマンドプロンプト（cmd）を開きます。または、「Windowsキー」+「Q」を押して、「PowerShell」または「Windows Powershell」を検索して開きます。コマンドラインにコピーした接続文字列を実行することで、起動したOceanBaseデスクトップ版に接続できます。接続文字列の例は以下の通りです：
wsl.exe -d oceanbase-desktop --exec bash -c "obclient -h127.1 -P2881 -uroot@test -Doceanbase -A"
macOSには2通りのインストール方法があります。Homebrewを使う方法と、dmgインストールパッケージを使う方法です。本セクションでは、それぞれについてご紹介します。
Homebrewのインストール
もしお使いの環境にHomebrewがインストールされていない場合は、以下のコマンドを実行してインストールしてください。
/bin/bash -c "$(curl -fsSL https://gitee.com/cunkai/HomebrewCN/raw/master/Homebrew.sh)"OceanBaseデスクトップ版のTapを追加
OceanBaseデスクトップ版のTapをHomebrewに追加すると、
brew installコマンドでOceanBaseが提供する公式パッケージをインストールできるようになります。brew tap oceanbase/homebrew-oceanbase-desktop https://gitee.com/oceanbase/homebrew-oceanbase-desktop.gitOceanBaseデスクトップ版のインストール
brew install --cask oceanbase-desktopコマンドを実行すると、最新バージョンのOceanBaseデスクトップ版が自動的にダウンロードされます。(もし環境内にOrbStackがインストールされていない場合は)依存関係としてインストールされます。インストールが成功すると、アプリケーションは「アプリケーション」フォルダに格納されます。
アプリケーションの起動
アプリケーションフォルダ内で
OceanBase Desktopを見つけるか、Spotlight検索でOceanBase Desktopを検索し、ダブルクリックして起動します。初回起動時は、プログラムがバックグラウンドで初期化を行うため、しばらくお待ちください。アプリケーションに入ったら、ページ内の起動ボタンをクリックするとOceanBaseデータベースを起動できます。
説明
OceanBaseデスクトップ版をアンインストールする必要がある場合は、brew uninstall --cask oceanbase-desktopコマンドを実行してください。このコマンドは、アプリケーションファイル、アプリケーションサポートデータ、保存されたアプリケーションの状態、およびアプリケーションの仮想マシンを同時にクリーンアップします。
ステップ1：依存関係のインストール
macOSでOceanBaseデスクトップ版をインストールするには、OrbStackというツールが必要です。OrbStackは、macOSユーザー向けに設計されたコンテナおよび仮想マシンの管理ツールで、Dockerコンテナのような高効率なコンテナの実行と、軽量な仮想マシンの利用をサポートします。OrbStackは、Docker Desktopやその他の複雑な仮想化ツールの代替として設計されており、パフォーマンスの向上、システムリソースの節約、そして開発者にとって使いやすい操作環境の提供を目的としています。
説明
OrbStackの公式チュートリアルでは、インストール方法としてインストーラーとbrewコマンドの2通りが紹介されています。ここでは、インストーラーを使ってインストールする方法を紹介します。その他の方法については、公式チュートリアルをご参照ください。
インストーラーのダウンロード
公式ダウンロードリンクにアクセスして、インストーラーをダウンロードします。ダウンロードページには、Apple Siliconチップ用とIntelチップ用の2種類のインストーラーが用意されています。お使いのMacのチップの種類を確認するには、画面左上のAppleアイコンをクリックし、このMacについてを選択してください。
インストール
ダウンロードしたdmgインストーラーをダブルクリックし、アプリケーションのアイコンを「アプリケーション」フォルダにドラッグしてインストールします。
注意
初めてOrbStackをインストールする場合は、必ず初回のセットアップガイドを最後まで完了してください。これを行わないと、イメージの正常なインポートができません。
インストールの検証
OrbStackの「Machines（仮想マシン）」セクションで、最新のUbuntuイメージをインストールします。この処理にはやや時間がかかるため、しばらくお待ちください。
インストールが完了したら、該当する仮想マシンをダブルクリックします。コマンドライン接続の画面に入ることができれば、OrbStackは正常にインストールされています。
ステップ2：OceanBaseデスクトップ版のインストール
インストーラーのダウンロード
OceanBaseソフトウェアダウンロードセンターにアクセスし、「OceanBaseデスクトップ版」を検索して、「Mac版」をクリックして必要なインストーラーをダウンロードします。
アプリケーションのインストール
ダウンロードしたインストーラーをダブルクリックし、アプリケーションのアイコンを「アプリケーション」フォルダにドラッグしてインストールします。
OceanBaseデスクトップ版の起動
インストールが完了すると、
停止中の状態でOceanBaseデータベースが自動的にデプロイされます。画面内の「起動」ボタンをクリックすると、OceanBaseデータベースを起動できます。
OceanBaseデスクトップ版への接続
OceanBaseデータベースが正常に起動した後、OceanBaseデスクトップ版内の接続をクリックすると、自動的にOceanBaseデータベースへ接続されます。また、手動で接続することも可能で、以下のような接続コマンドを実行してください：
mysql -h127.0.0.1 -P2881 -uroot@test -Doceanbase -A
OceanBaseデータベースへの接続については、接続方法の概要をご参照ください。