Boto3を使ってAWS Glue Data Catalogからデータベースの詳細情報を取得する方法

はじめに

この記事では、PythonのBoto3ライブラリを使用して、AWS Glue Data Catalogからデータベースの定義情報を取得する方法を解説します。

具体的な例として、「QA-test」という名前のデータベースの定義を取得するケースを取り上げます。

解決の手順

以下のステップに従って実装を進めます。

ステップ1： boto3とbotocore.exceptionsをインポートし、例外処理に備えます。
ステップ2： database_nameは必須パラメータです。指定したデータベースの定義情報が取得されます。
ステップ3： boto3ライブラリを使ってAWSセッションを作成します。デフォルトプロファイルにregion_nameが設定されていることを確認してください。設定されていない場合は、セッション作成時に明示的にregion_nameを渡す必要があります。
ステップ4： AWS Glue用のクライアントを作成します。
ステップ5： get_database関数を使用し、database_nameをNameパラメータとして渡します。
ステップ6： 指定したデータベースの定義情報が返却されます。
ステップ7： 処理中に問題が発生した場合に備え、汎用的な例外処理を実装しておきます。

サンプルコード

以下のコードでデータベースの定義情報を取得できます。

import boto3
from botocore.exceptions import ClientError

def retrieves_database_details(database_name):
    session = boto3.session.Session()
    glue_client = session.client('glue')
    try:
        response = glue_client.get_database(Name=database_name)
        return response
    except ClientError as e:
        raise Exception("boto3 client error in retrieves_database_details: " + e.__str__())
    except Exception as e:
        raise Exception("Unexpected error in retrieves_database_details: " + e.__str__())

print(retrieves_database_details('QA-test'))

まとめ

Boto3のget_database関数を使えば、AWS Glue Data Catalog上の任意のデータベースの定義情報を簡単に取得できます。例外処理を適切に実装することで、エラー発生時にも原因を特定しやすくなります。実際の運用では、リージョンの設定ミスやIAM権限不足によるエラーも発生するため、ClientErrorの内容を確認しながらトラブルシューティングを行いましょう。