DBCATは軽量なコマンドラインツールで、データベース間のDDL変換やSchema比較などの機能を提供します。ここでは、テーブル構造の移行を例に説明します。
DBCATのインストールパッケージファイル名はdbcat-[バージョン番号]-SNAPSHOT.tar.gzで、ダウンロード後に解凍すれば使用できます。実行可能ファイル名はdbcatです。
注意
DBCATはOMSのコンポーネントです。コミュニティエディション環境では、OMSを使用したエクスポートを推奨します。
環境の準備
DBCATはCentOS、macOS、Windows上で動作します。JDK 1.8以降（含む）をインストールする必要があります。OpenJDKを使用することもできます。インストール後は環境変数JAVA_HOMEを設定してください。
CentOSにOpenJDKをインストールする例：
$sudo yum -y install java-1.8.0-openjdk.x86_64
$which java
/usr/local/java/jdk1.8.0_261/bin/java
echo 'export JAVA_HOME=/usr/local/java/jdk1.8.0_261/' >> ~/.bash_profile
. ~/.bash_profile
インストールファイルを解凍します：
tar zxvf dbcat-1.8.0-SNAPSHOT.tar.gz
cd dbcat-1.8.0-SNAPSHOT/
chmod +x bin/dbcat
$tree -L 3 --filelimit 30
.
├── bin
│ ├── dbcat
│ ├── dbcat.bat
│ └── dbcat-debug
├── conf
│ ├── dbcat.properties
│ └── logback.xml
├── docs
│ ├── README.docx
│ ├── README.md
│ └── README.txt
├── LEGAL.md
├── lib [45 entries exceeds filelimit, not opening dir]
├── LICENSE
├── meta
│ └── README
└── NOTICE
5 directories, 12 files
インストールファイルには、以下のディレクトリが含まれています：
ディレクトリ名 |
説明 |
|---|---|
| bin | 実行ファイルディレクトリ。 |
| conf | ログファイル設定ディレクトリ。 |
| lib | 実行時依存パッケージ。 |
| meta | オフライン変換シナリオで、データディクショナリテーブルをエクスポートします。 |
| ~/output | SQLファイルとレポートファイルは、実行時に生成されます。 |
Oracleデータベースのテーブル構造をエクスポートする
DBCATにはオンライン変換機能があり、これはDBCATがソースデータベースに直接接続し、データベース内のオブジェクトをエクスポートできることを指します。オブジェクトが非常に多い場合（例えば1万個を超える場合）、エクスポートプロセスが遅くなる可能性があります。
dbcatのエクスポートコマンドは以下のとおりです：
bin/dbcat convert -H<host> -P<port> -u<user> -p<******> -D<database> --service-name<service-name> --service-id <service-id> --from <from> --to <to> --all
コマンドbin/dbcat help convertを実行すると、より詳細なパラメータ情報を確認できます。
必須パラメータ：
オプション |
パラメータの有無 |
説明 |
|---|---|---|
| -H/--host | Y | データベースサーバーのIPアドレス |
| -P/--port | Y | データベースサーバーのポート |
| -u/--user | Y | データベースへのログインユーザー名 |
| -t/--tenant | Y | OceanBaseクラスタへの接続にはテナント名が必要 |
| -c/--cluster | Y | OceanBaseクラスタへの接続にはクラスタ名が必要 |
| -p/--password | Y | データベースへのログインパスワード |
| -D/--database | Y | データベース名（ソースデータベース）、DB2ではデータベース名とスキーマ名を区別する必要があります |
| --service-id | Y | Oracleデータベースへの接続にはサービスIDが必要 |
| --service-name | Y | Oracleデータベースへの接続にはサービス名が必要 |
| --as-sysdba | N | Oracleデータベースのsysdbaロールへの接続 |
| --sys-user | Y | OceanBaseクラスタのシステムテナントへの接続ユーザー名 |
| --sys-password | Y | OceanBaseクラスタのシステムテナントへの接続パスワード |
| --schema | Y | スキーマ名（ソースデータベース）、DB2以外ではスキーマ名とデータ名は同じ |
| --from | Y | ソースデータベースのタイプ |
| --to | Y | ターゲットデータベースのタイプ |
| --all | N | すべてのデータベースオブジェクト |
オプションパラメータ：
オプション |
パラメータの有無 |
日本語説明 |
|---|---|---|
| -f/--file | Y | SQLファイルの出力パス |
| --offline | N | オフラインモードを使用します |
| --target-schema | Y | モード名（ターゲットデータベース） |
| --table | Y | エクスポートするテーブル |
| --view | Y | エクスポートするビュー |
| --trigger | Y | エクスポートするトリガー |
| --synonym | Y | エクスポートするシノニム |
| --sequence | Y | エクスポートするシーケンス |
| --function | Y | エクスポートする関数 |
| --procedure | Y | エクスポートするストアドプロシージャ |
| --dblink | Y | すべてのDBLinkをエクスポートします |
| --type | Y | エクスポートするtype |
| --type-body | Y | エクスポートするtype body |
| --package | Y | エクスポートするpackage |
| --package-body | Y | エクスポートするpackage body |
| --no-quote | N | 生成されるDDLには引用符を付けません |
| --no-schema | N | 生成されるDDLにはモード名を含めません |
| --target-schema | Y | 生成されるDDLに指定されたモード名を使用します |
| --exclude-type | Y | --allと組み合わせて使用します。例：--all --exclude-type 'TABLE'はTABLEタイプを除外することを意味します |
ここでは、Oracle 12cバージョンのデータベースtestのすべてのオブジェクト構造をエクスポートし、それを4.0.0バージョンのOceanBaseクラスタ内のOracleテナントに移行する例を説明します。
bin/dbcat convert -H 100.88.xxx.xxx -P 1521 -uxxx -pxxxxxx -D test --service-name xxx --service-id xxx --from oracle12c --to oboracle40 --all
特記事項：
dbcatはデータベースホストに直接インストールする必要はありません。データベースホストに直接接続できるホストにインストールしてください。
パラメータの--fromと--toはソース側とターゲット側のデータベースタイプであり、バージョン番号まで指定する必要があります。現在dbcatがサポートするソース側およびターゲット側のデータベースの詳細は以下のとおりです：
ソースデータベースタイプターゲットデータベースタイプTiDB OBMYSQL PG OBMYSQL SYBASE OBORACLE MYSQL OBMYSQL ORACLE OBORACLE ORACLE OBMYSQL DB2 IBM i OBORACLE DB2 LUW OBORACLE DB2 LUW OBMYSQL OBMYSQL MYSQL OBORACLE ORACLE ここで、OBMYSQLはOceanBaseデータベースのMySQLテナント、OBORACLEはOceanBaseデータベースのOracleテナントを指します。
現在サポートされているソース側およびターゲット側のデータベースの詳細なバージョンは以下のとおりです。
データベースタイプデータベースバージョンTiDB tidb4
tidb5PG pgsql10 SYBASE sybase15 DB2 IBM i db2ibmi71 DB2 LUW db2luw970
db2luw1010
db2luw1050
db2luw111
db2luw115MYSQL mysql56
mysql57
mysql</80>ORACLE oracle9i
oracle10g
oracle11g
oracle12c
oracle18c
oracle19cOBMYSQL obmysql14x
obmysql21x
obmysql22x
obmysql200
obmysql211
obmysql2210
obmysql2230
obmysql2250
obmysql2271 ~ obmysql2277
obmysql30x
obmysql31x
obmysql32x
obmysql322
obmysql40OBORACLE oboracle2220
oboracle2230
oboracle2250
oboracle2270 ~ oboracle2277
oboracle21x
oboracle22x
oboracle30x
oboracle31x
oboracle32x
oboracle322
oboracle40
実行後の出力ファイルは、ユーザーのhomeディレクトリ配下のoutputに保存されます。
$tree ~/output/dbcat-20xx-xx-xx-164533/
/home/qing.meiq/output/dbcat-20xx-xx-xx-164533/
├── tpccdb
│ └── TABLE-schema.sql
└── tpccdb-conversion.html
1 directory, 2 files
OceanBaseデータベースへのインポート
DBCATでエクスポートされたファイル形式はSQLファイルです。ここでは、ODCのインポート機能を使用してテーブル構造をOceanBaseデータベースに一括インポートできます。詳細については、一括エクスポートとインポートを参照してください。
また、source コマンドを使用してSQLファイルのデータをOceanBaseデータベースにインポートすることもできます。例：
obclient [test]> source TABLE-schema.sql
Query OK, 0 rows affected (0.044 sec)
注意
SQLファイルが現在のディレクトリにない場合は、絶対パスを使用する必要があります。
出力結果の検証
例：OracleデータベースとOceanBaseデータベースにおけるテーブル構造を比較します。
ソースデータベースOracleのテーブルbmsql_customerの構造を確認します：
SQL> desc bmsql_customer;
Name Null? Type
----------------------------------------- -------- ----------------------------
C_W_ID NOT NULL NUMBER(38)
C_D_ID NOT NULL NUMBER(38)
C_ID NOT NULL NUMBER(38)
C_DISCOUNT NUMBER(4,4)
C_CREDIT CHAR(2)
C_LAST VARCHAR2(16)
C_FIRST VARCHAR2(16)
C_CREDIT_LIM NUMBER(12,2)
C_BALANCE NUMBER(12,2)
C_YTD_PAYMENT NUMBER(12,2)
C_PAYMENT_CNT NUMBER(38)
C_DELIVERY_CNT NUMBER(38)
C_STREET_1 VARCHAR2(20)
C_STREET_2 VARCHAR2(20)
C_CITY VARCHAR2(20)
C_STATE CHAR(2)
C_ZIP CHAR(9)
C_PHONE CHAR(16)
C_SINCE TIMESTAMP(6)
C_MIDDLE CHAR(2)
C_DATA VARCHAR2(500)
ターゲットデータベースOceanBaseのテーブルbmsql_customerの構造を確認します：
obclient [SYS]> desc bmsql_customer;
+----------------+---------------+------+-----+---------+-------+
| FIELD | TYPE | NULL | KEY | DEFAULT | EXTRA |
+----------------+---------------+------+-----+---------+-------+
| C_W_ID | NUMBER(38) | NO | PRI | NULL | NULL |
| C_D_ID | NUMBER(38) | NO | PRI | NULL | NULL |
| C_ID | NUMBER(38) | NO | PRI | NULL | NULL |
| C_DISCOUNT | NUMBER(4,4) | YES | NULL | NULL | NULL |
| C_CREDIT | CHAR(2) | YES | NULL | NULL | NULL |
| C_LAST | VARCHAR2(16) | YES | NULL | NULL | NULL |
| C_FIRST | VARCHAR2(16) | YES | NULL | NULL | NULL |
| C_CREDIT_LIM | NUMBER(12,2) | YES | NULL | NULL | NULL |
| C_BALANCE | NUMBER(12,2) | YES | NULL | NULL | NULL |
| C_YTD_PAYMENT | NUMBER(12,2) | YES | NULL | NULL | NULL |
| C_PAYMENT_CNT | NUMBER(38) | YES | NULL | NULL | NULL |
| C_DELIVERY_CNT | NUMBER(38) | YES | NULL | NULL | NULL |
| C_STREET_1 | VARCHAR2(20) | YES | NULL | NULL | NULL |
| C_STREET_2 | VARCHAR2(20) | YES | NULL | NULL | NULL |
| C_CITY | VARCHAR2(20) | YES | NULL | NULL | NULL |
| C_STATE | CHAR(2) | YES | NULL | NULL | NULL |
| C_ZIP | CHAR(9) | YES | NULL | NULL | NULL |
| C_PHONE | CHAR(16) | YES | NULL | NULL | NULL |
| C_SINCE | TIMESTAMP(6) | YES | NULL | sysdate | NULL |
| C_MIDDLE | CHAR(2) | YES | NULL | NULL | NULL |
| C_DATA | VARCHAR2(500) | YES | NULL | NULL | NULL |
+----------------+---------------+------+-----+---------+-------+
21 rows in set (0.002 sec)
比較した結果、両者は一致しています。