Java で Snowflake のデータ エンティティのオブジェクト リレーショナル マッピング（ORM）を行う

Hibernate を使用して、オブジェクト指向のドメインモデルを従来のリレーショナルデータベースにマッピングできます。以下のチュートリアルでは、CData JDBC Driver for Snowflake を使用して Hibernate で Snowflake リポジトリの ORM を生成する方法を説明します。

本記事では IDE として Eclipse を使用していますが、CData JDBC Driver for Snowflake は Java ランタイム環境をサポートするあらゆる製品で使用できます。Knowledge Base には、IntelliJ IDEA や NetBeans から Snowflake のデータ に接続するためのチュートリアルも用意しています。

はじめに

---

Hibernate のインストール

以下の手順に従って、Eclipse に Hibernate プラグインをインストールします。

1. Eclipse で、Help -> Install New Software を選択します。
2. Work With ボックスに「http://download.jboss.org/jbosstools/neon/stable/updates/」を入力します。
3. フィルタボックスに「Hibernate」と入力します。
4. Hibernate Tools を選択します。

新規プロジェクトの作成

以下の手順に従って、新しいプロジェクトにドライバー JAR を追加します。

1. 新規プロジェクトを作成します。プロジェクトタイプとして Java Project を選択し、Next をクリックします。プロジェクト名を入力して Finish をクリックします。
2. プロジェクトを右クリックして Properties をクリックします。Java Build Path をクリックし、Libraries タブを開きます。
3. Add External JARs をクリックして、インストールディレクトリの lib サブフォルダにある cdata.jdbc.snowflake.jar ライブラリを追加します。

Hibernate 設定ファイルの追加

以下の手順に従って、Snowflake のデータ への接続プロパティを設定します。

1. 新規プロジェクトを右クリックし、New -> Hibernate -> Hibernate Configuration File (cfg.xml) を選択します。
2. src を親フォルダとして選択し、Next をクリックします。

3. 以下の値を入力します:

   • Hibernate version:: 5.2
   • Database dialect: Derby
   • Driver class: cdata.jdbc.snowflake.SnowflakeDriver

   • Connection URL: JDBC URL です。jdbc:snowflake: から始まり、セミコロン区切りの接続プロパティが続きます。

     それでは、Snowflake データベースに接続していきましょう。認証に加えて、以下の接続プロパティを設定します。

     • Url：お使いのSnowflake URL を指定します。例：https://orgname-myaccount.snowflakecomputing.com
       • Legacy URL を使用する場合：https://myaccount.region.snowflakecomputing.com
       • ご自身のURL は以下のステップで確認できます。
         1. Snowflake UI の左下にあるユーザー名をクリックします
         2. Account ID にカーソルを合わせます
         3. Copy Account URL アイコンをクリックして、アカウントURL をコピーします
     • Database（オプション）：CData 製品によって公開されるテーブルとビューを、特定のSnowflake データベースのものに制限したい場合に設定します
     • Schema（オプション）：CData 製品によって公開されるテーブルとビューを、特定のSnowflake データベーススキーマのものに制限したい場合に設定します

     Snowflakeへの認証

     CData 製品では、Snowflake ユーザー認証、フェデレーション認証、およびSSL クライアント認証をサポートしています。認証するには、User とPassword を設定し、AuthScheme プロパティで認証方法を選択してください。

     キーペア認証

     ユーザーアカウントに定義されたプライベートキーを使用してセキュアなトークンを作成し、キーペア認証で接続することも可能です。この方法で接続するには、AuthScheme をPRIVATEKEY に設定し、以下の値を設定してください。

     • User：認証に使用するユーザーアカウント
     • PrivateKey：プライベートキーを含む.pem ファイルへのパスなど、ユーザーに使用されるプライベートキー
     • PrivateKeyType：プライベートキーを含むキーストアの種類（PEMKEY_FILE、PFXFILE など）
     • PrivateKeyPassword：指定されたプライベートキーのパスワード

     その他の認証方法については、ヘルプドキュメントの「Snowflakeへの認証」セクションをご確認ください。

     組み込みの接続文字列デザイナー

     JDBC URL の構築には、Snowflake JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから jar ファイルを実行してください。

     java -jar cdata.jdbc.snowflake.jar
     

     接続プロパティを入力し、接続文字列をクリップボードにコピーします。

     

     一般的な JDBC URL は以下のとおりです:

     jdbc:snowflake:User=Admin;Password=test123;Server=localhost;Database=Northwind;Warehouse=TestWarehouse;Account=Tester1;

Hibernate から Snowflake のデータ に接続

以下の手順に従って、前のステップで作成した設定を選択します。

1. Hibernate Configurations パースペクティブに切り替えます: Window -> Open Perspective -> Hibernate。
2. Hibernate Configurations パネルを右クリックし、Add Configuration をクリックします。
3. Hibernate version を 5.2 に設定します。
4. Browse ボタンをクリックし、プロジェクトを選択します。
5. Configuration file フィールドで、Setup -> Use Existing をクリックし、hibernate.cfg.xml ファイルの場所（このデモでは src フォルダ内）を選択します。
6. Classpath タブで、User Entries の下に何もない場合は、Add External JARS をクリックしてドライバー jar を再度追加します。設定が完了したら OK をクリックします。
7. 新しく作成した Hibernate 設定ファイルの Database ノードを展開します。

Snowflake のデータ のリバースエンジニアリング

以下の手順に従って、reveng.xml 設定ファイルを生成します。オブジェクトとしてアクセスするテーブルを指定します。

1. Package Explorer に戻ります。
2. プロジェクトを右クリックし、New -> Hibernate -> Hibernate Reverse Engineering File (reveng.xml) を選択します。Next をクリックします。
3. src を親フォルダとして選択し、Next をクリックします。
4. Console configuration ドロップダウンメニューで、上記で作成した Hibernate 設定ファイルを選択し、Refresh をクリックします。
5. ノードを展開し、リバースエンジニアリングするテーブルを選択します。完了したら Finish をクリックします。

Hibernate の実行設定

以下の手順に従って、Snowflake テーブルの POJO（Plain Old Java Object）を生成します。

1. メニューバーから、Run -> Hibernate Code Generation -> Hibernate Code Generation Configurations をクリックします。
2. Console configuration ドロップダウンメニューで、前のセクションで作成した Hibernate 設定ファイルを選択します。Output directory の横にある Browse をクリックし、src を選択します。
3. Reverse Engineer from JDBC Connection チェックボックスを有効にします。Setup ボタンをクリックし、Use Existing をクリックして、hibernate.reveng.xml ファイルの場所（このデモでは src フォルダ内）を選択します。
4. Exporters タブで、Domain code (.java) と Hibernate XML Mappings (hbm.xml) をチェックします。
5. Run をクリックします。

前のステップのリバースエンジニアリング設定に基づいて、1 つ以上の POJO が作成されます。

マッピングタグの挿入

生成した各マッピングに対して、hibernate.cfg.xml にマッピングタグを作成し、Hibernate がマッピングリソースを参照できるようにする必要があります。hibernate.cfg.xml を開き、以下のようにマッピングタグを挿入します:

  
    
      cdata.snowflake.SnowflakeDriver
    
    
      jdbc:snowflake:User=Admin;Password=test123;Server=localhost;Database=Northwind;Warehouse=TestWarehouse;Account=Tester1;
    
    
      org.hibernate.dialect.SQLServerDialect
    
    
    
    

SQL の実行

前のステップで作成したエンティティを使用して、Snowflake のデータ のデータの検索と変更が可能になります:

import java.util.*;
import org.hibernate.Session;
import org.hibernate.cfg.Configuration;
import org.hibernate.query.Query;

public class App {
  public static void main(final String[] args) {
    Session session =  new
    Configuration().configure().buildSessionFactory().openSession();
    String SELECT = "FROM Products P WHERE Id = :Id";
    Query q = session.createQuery(SELECT, Products.class);
    q.setParameter("Id","1");
    List<Products> resultList = (List<Products>) q.list();

    for(Products s: resultList){
      System.out.println(s.getId());
      System.out.println(s.getProductName());
    }
  }
}