Oracle DBMS_METADATA.GET_DDLでオブジェクト定義DDLを取得する方法と使い方を解説

Oracle Databaseでは、既存オブジェクトの作成文（DDL）を確認したい場面があります。例えば、テーブル構造の確認、環境移行、バックアップ用スクリプト作成、開発環境と本番環境の差分確認などでは、実際に登録されている定義情報を取得できると便利です。

OracleにはDBMS_METADATA.GET_DDLという標準パッケージが用意されており、テーブルやインデックス、ビュー、ユーザーなど多くのデータベースオブジェクトのDDLを取得できます。この記事では、DBMS_METADATA.GET_DDLの基本的な使い方や注意点について解説します。

DBMS_METADATA.GET_DDLとは何か

DBMS_METADATA.GET_DDLは、Oracle Databaseに保存されているオブジェクトのメタデータから、作成用DDL文を生成して取得するためのPL/SQLパッケージです。

例えば、すでに存在しているテーブルのCREATE TABLE文を確認したい場合、通常は手作業で定義を調べる必要があります。しかしDBMS_METADATA.GET_DDLを利用すると、Oracleが管理している正確な定義情報からDDLを自動生成できます。

取得できる代表的なオブジェクトには以下のようなものがあります。

DBMS_METADATA.GET_DDLは、取得したいオブジェクト種類、オブジェクト名、所有者（スキーマ名）を指定して使用します。

例えば、EMPLOYEEというテーブルのDDLを取得する場合は、以下のようなSQLを実行します。

SELECT DBMS_METADATA.GET_DDL('TABLE','EMPLOYEE','SCOTT') FROM DUAL;

このSQLを実行すると、SCOTTスキーマに存在するEMPLOYEEテーブルのCREATE TABLE文が返されます。

第1引数にはオブジェクト種類、第2引数にはオブジェクト名、第3引数には所有者を指定します。所有者を省略すると、現在接続しているユーザーのオブジェクトが対象になります。

DBMS_METADATA.GET_DDLで取得される内容は、単純なCREATE文だけではありません。Oracleの設定によっては、表領域指定やストレージ設定、制約情報なども含まれる場合があります。

例えば、以下のような情報が含まれることがあります。

そのため、取得したDDLを別環境へ移行する場合は、そのまま実行できるか内容を確認することが重要です。

DBMS_METADATA.GET_DDLを実行しても結果が取得できない場合、主に権限や指定ミスが原因です。

例えば、別ユーザーのテーブル定義を取得する場合、そのユーザーのオブジェクトを参照する権限やメタデータ取得権限が必要になります。

また、オブジェクト名の大文字・小文字の扱いにも注意が必要です。通常のOracleオブジェクト名は大文字で管理されるため、小文字で指定すると取得できない場合があります。

取得したDDLを移行用スクリプトとして利用する場合、不要な情報を除外したいことがあります。その場合はDBMS_METADATA.SET_TRANSFORM_PARAMを利用します。

例えば、表領域情報を除外したい場合は以下のような設定を行います。

BEGIN
DBMS_METADATA.SET_TRANSFORM_PARAM(DBMS_METADATA.SESSION_TRANSFORM,'SQLTERMINATOR',TRUE);
END;
/

SQLTERMINATORを有効にすると、取得されるDDLの末尾にセミコロンが付与されるため、SQLスクリプトとして利用しやすくなります。

1つのオブジェクトだけではなく、スキーマ内の複数オブジェクトを取得したい場合は、DBMS_METADATA.GET_DDLを繰り返し実行したり、DBMS_METADATA.GET_DEPENDENT_DDLなどを利用します。

例えば、テーブルに関連するインデックスや制約を取得したい場合は、DEPENDENT_OBJECTとして関連DDLを取得できます。

システム移行やバックアップ作成では、テーブル本体だけでなく関連オブジェクトも取得する必要があるため、目的に応じて使い分けることが重要です。

DBMS_METADATA.GET_DDLは非常に便利な機能ですが、取得したDDLが現在の環境と完全に同じ状態で再作成できるとは限りません。

例えば、表領域名、ユーザー権限、ディレクトリオブジェクトなど環境依存の情報が含まれている場合、別環境では修正が必要になることがあります。

そのため、本番環境から開発環境へ移行する場合などは、取得したDDLを確認してから実行することをおすすめします。

OracleのDBMS_METADATA.GET_DDLを利用すると、既存のテーブルやビューなどのオブジェクト定義DDLを簡単に取得できます。

データベース移行、構造確認、設計書作成、トラブル調査など、Oracle運用ではさまざまな場面で役立つ機能です。

ただし、取得結果には環境依存の情報が含まれる場合があるため、別環境で利用する際は内容を確認しながら活用すると安全です。