SqlSugar による OceanBase データベース接続サンプルプログラム

本記事では、SqlSugarフレームワーク、OceanBase Connector/ODBC、およびOceanBaseデータベースを使用して、テーブルの作成、データの挿入、データのクエリなどの基本的な操作を実現するアプリケーションの構築方法を紹介します。

sqlsugar-oceanbase-odbc サンプルプロジェクトをダウンロード

前提条件

• OceanBaseデータベースをインストール済みで、Oracleモードのユーザーテナントを作成していること。OceanBaseデータベースのインストールに関する詳細は、デプロイの概要を参照してください。

• Visual StudioおよびNuGetパッケージマネージャープラグインと.NET Frameworkコンポーネントをインストール済みであること。

• OceanBase Connector/ODBCドライバーをインストール済みであること。

  説明

  OceanBase公式サイトのリソース > ダウンロードセンター > エンタープライズ版ページのドライバーとミドルウェアモジュールから、OceanBase ODBCドライバーWindows版のインストールパッケージをダウンロードしてください。Windows版OceanBase Connector/ODBCドライバーのインストールパッケージはワンクリックでデプロイできる形式であり、デフォルトの手順に従ってインストールすれば完了します。

手順

1. sqlsugar-oceanbase-odbc プロジェクトを開きます。
2. SqlSugar関連のパッケージをインストールします。
3. データソースを設定します。
4. sqlsugar-oceanbase-odbc プロジェクト内のデータソースを修正します。
5. プロジェクトをビルドします。
6. アプリケーションを実行します。
7. 出力結果を確認します。

ステップ１：sqlsugar-oceanbase-odbcプロジェクトを開く

1. Visual Studio Community 2019を起動します。

2. 既存のプロジェクトを開きます。

   1. Visual Studio Community 2019の開始画面で、使用を開始する前に プロジェクトまたはソリューションを開く(P) ボタンをクリックします。または、Visual Studio Community 2019の開始画面で、使用を開始する前に コードなしで続行(W) ボタンをクリックするか、上部のメニューバーから ファイル -> 開く -> プロジェクト/ソリューション(P) を選択します。

   2. sqlsugar-oceanbase-odbc プロジェクト フォルダに移動し、プロジェクトファイル（sqlsugar-oceanbase-odbc.sln または sqlsugar-oceanbase-odbc.csproj）を選択して 開く をクリックします。

ステップ2：SqlSugar関連のパッケージをインストールする

1. Visual Studio Community 2019の開始画面で、上部のメニューバーから ツール -> NuGetパッケージマネージャー -> ソリューションのNuGetパッケージの管理 を選択します。

2. 参照 の検索ボックスに sqlsugar と入力して、SqlSugarパッケージをダウンロードします。

3. 参照 の検索ボックスに sqlsugar.odbc と入力して、SqlSugar.OdbcおよびSqlSugar.OdbcCoreパッケージをダウンロードします。

4. インストールが完了したら、プロジェクトのコードファイルでSqlSugarの関連名前空間と型を使用できます。

ステップ3：データソースの設定

1. データベースの接続情報を取得します。

   OceanBaseデータベースのデプロイ担当者または管理者から、該当するデータベース接続文字列を取得します。

   例：

   obclient -hxxx.xxx.xxx.xxx -P2881 -usys@oracle001 -p******
   

   パラメータ説明：

   • -h：OceanBaseデータベースへの接続IPアドレスを指定します。ODP接続方式ではODPアドレスを使用し、直接接続方式ではOBServerノードのIPアドレスを使用します。
   • -P：OceanBaseデータベースの接続ポートを指定します。ODP接続方式のデフォルトポートは2883で、ODPデプロイ時にカスタマイズ可能です。直接接続方式のデフォルトポートは2881で、OceanBaseデータベースのデプロイ時にカスタマイズ可能です。
   • -u：テナントの接続アカウントを指定します。ODP接続の一般的な形式はユーザー名@テナント名#クラスタ名またはクラスタ名:テナント名:ユーザー名です。直接接続方式の形式はユーザー名@テナント名です。
   • -p：アカウントのパスワードを指定します。

   接続文字列の詳細については、OBClientを使用してOceanBaseテナントに接続するを参照してください。

2. OceanBase Connector/ODBCドライバが正常にインストールされているか確認します。

   コントロールパネル > システムとセキュリティ > 管理ツール > ODBCデータソース(64ビット) > ドライバー を選択します。OceanBase Connector/ODBCドライバが正常にインストールされている場合、ここに表示されます。

3. 新しいデータソースを作成します。

   ユーザーDSN > 追加 > ドライバーの選択 を選択し、完了 をクリックします。

4. ポップアップウィンドウでデータソース名 Name と説明 Description を入力し、次へ をクリックします。

5. ポップアップウィンドウでデータベース接続情報を入力し、次へ をクリックすると、初期化ステートメント、TLS、カーソル、結果セットなどの情報を設定できます。

   説明

   データベース接続情報の入力後、Test DSN をクリックして、データソースが正常に接続できるか確認できます。

6. 設定完了後、終了 をクリックします。データソースが正常に追加されたら、OK をクリックします。

ステップ4：sqlsugar-oceanbase-odbcプロジェクトのデータソースを修正する

ステップ3：データソースの設定で作成したデータソースに基づいて、Program.cs ファイル内のデータソースを修正します。

例：

your_dsn を ステップ3：データソースの設定で作成したデータソース test_oboracle に置き換えます。

public static string ConnectionString = "DSN=test_oboracle";

ステップ5：プロジェクトをビルドする

ビルド メニューを選択し、ソリューションのビルド を選択します。ビルド中、コンパイラの出力およびエラーや警告情報が表示されます。

ステップ6：アプリケーションを実行する

デバッグ メニューを選択し、デバッグの開始 または 実行の開始(デバッグなし) を選択してアプリケーションを実行します。

ステップ7：出力結果を確認する

出力結果はデバッグコンソールに表示されます。プログラムの設計ロジックとコードに基づいて、出力の処理方法を判断できます。

プロジェクトコードについて

sqlsugar-oceanbase-odbc をクリックしてプロジェクトコードをダウンロードします。これは、sqlsugar-oceanbase-odbc.zip という名前の圧縮ファイルです。

解凍すると、sqlsugar-oceanbase-odbc という名前のフォルダが作成されます。ディレクトリ構造は以下のとおりです：

sqlsugar-oceanbase-odbc
├─ Program.cs
├─ sqlsugar-oceanbase-odbc.csproj
└─ sqlsugar-oceanbase-odbc.sln

ファイルの説明：

• Program.cs：プロジェクトのメインプログラムファイルで、プロジェクトのエントリポイント、データテーブルの構造定義、データテーブル操作を実装したソースコードファイルが含まれます。

• sqlsugar-oceanbase-odbc.csproj：Visual Studioのプロジェクトのメインプロジェクトファイルで、プロジェクトの設定、依存関係、ビルド情報を定義するために使用されます。

• sqlsugar-oceanbase-odbc.sln：Visual Studioのソリューションファイルで、プロジェクトおよび関連プロジェクトの情報が含まれ、複数のプロジェクトの統合管理とビルドに使用されます。

Program.csファイルのコード紹介

Program.cs のコードは、SqlSugarを使用してOceanBaseデータベースを操作する方法を示しており、テーブルの作成、データの挿入、データのクエリなどの基本操作を実装しています。同時に、AopEvents オブジェクトを使用してログ記録などのイベントコールバック関数を設定し、デバッグとトラブルシューティングを容易にします。

本記事の Program.cs ファイルのコードは、主に以下の部分で構成されています：

1. 名前空間の参照。

   using キーワードを使用して、System、SqlSugar、System.Linq、System.Data、System.Data.Odbc の各名前空間を参照します。これにより、関連するデータアクセスクラスやデータベース操作のクラス・メソッドを利用できます。

   コード：

   using System;
   using SqlSugar;
   using System.Linq;
   using System.Data;
   using System.Data.Odbc;
   

2. 名前空間の定義。関連するクラスとメソッドを配置するために使用します。

   GbaseTest という名前の名前空間を定義し、その中に Program と TestEntity の2つのクラスを定義します。

   コード：

   namespace GbaseTest
   {
       internal class Program
       {
           ...
           ...
       }
   
       public class TestEntity
       {
           ...
           ...
       }
   }
   

3. Program という名前のクラスを定義します。プログラムの主要なロジックが含まれます。

Program という名前のクラスを定義し、プログラムの主要なロジックを含みます。具体的な手順は以下の通りです：

1. データベース接続文字列を格納するための、パブリックな静的文字列型の変数 ConnectionString を定義します。この変数は現在のアセンブリ内のどこからでもアクセスできます。ここで、DSN=your_dsn はODBC接続方式を使用し、your_dsn という名前のデータソースを使用することを意味します。

   注意

   プログラムを実行する際は、your_dsn を ステップ3 で作成したデータソース名に置き換えてください。

2. Mainメソッド：プログラムのエントリポイントであり、プログラムの主要なロジックが含まれます。

3. try-catch ブロック：

4. try キーワードで、例外が発生する可能性のあるコード、using ステートメント、データベース操作を囲みます。

5. catch キーワードで例外をキャッチし、処理を行います。

6. 最後に、プログラム終了前に Program End. を出力します。

コード：

    internal class Program
    {
        public static string ConnectionString = "DSN=your_dsn";

        static void Main(string[] args)
        {
            try
            {
                using (...)
                {
                    //データベース操作
                }
            }
            catch (Exception ex)
            {
                ...
                ...
            }

            Console.WriteLine("Program End.");
        }
    }

4. using ステートメント。

   ConnectionConfig を使用してデータベース接続情報やその他のオプションを設定します。データベースタイプはODBC、接続文字列は ConnectionString、主キータイプは Attribute、接続の自動クローズ、ログ実行イベントのコールバック関数の設定などです。SqlSugarClient オブジェクトを使用することで、テーブルの作成、データの挿入、データのクエリなど、データベース操作を簡単に実行できます。using ステートメントを使用することで、データベース接続のクローズを含む関連リソースを自動的に解放できます。具体的な手順は以下の通りです：

   1. SqlSugarClient オブジェクトを作成し、db という名前の変数に代入します。

   2. 接続設定のインスタンスを作成し、オブジェクト初期化子を使用して DbType、ConnectionString、InitKeyType、IsAutoCloseConnection、AopEvents などのプロパティを初期化します。

   3. データベースタイプをODBCに設定します。

   4. 接続文字列を ConnectionString に設定します。

   5. 主キータイプを Attribute に設定します。

   6. 接続の自動クローズを設定します。

   7. AopEvents のログ実行イベントコールバック関数を設定します。ログ実行イベントコールバック関数の実装ロジックを設定します。ここで、sql は実行されるSQLステートメントを表し、p はSQLステートメント内のパラメータリストを表します。実装ロジックでは、SQLステートメントとパラメータリストをコンソールに出力します。

   コード：

                   using (SqlSugarClient db = new SqlSugarClient(new ConnectionConfig()
                   {
                       DbType = SqlSugar.DbType.Odbc,
                       ConnectionString = ConnectionString,
                       InitKeyType = InitKeyType.Attribute,
                       IsAutoCloseConnection = true,
                       AopEvents = new AopEvents
                       {
                           OnLogExecuting = (sql, p) =>
                           {
                               Console.WriteLine(sql);
                               Console.WriteLine(string.Join(",", p?.Select(it => it.ParameterName + ":" + it.Value)));
                           }
                       }
                   }))
   

5. データベース操作。

   SqlSugarClient.Ado.ExecuteCommand メソッドを使用してSQLステートメントを実行し、テーブルの作成とデータの挿入を行います。SqlSugarClient.Ado.SqlQuery メソッドを使用してデータをクエリし、クエリ結果を反復処理して出力します。SqlSugarClient オブジェクトを使用することで、テーブルの作成、データの挿入、データのクエリなど、データベース操作を簡単に実行できます。具体的な手順は以下の通りです：

   1. テーブル作成開始を示すメッセージを出力します。

   2. SQLステートメントを実行して、test_tbl1 という名前のテーブルを作成します。このテーブルには id と name の2つの列が含まれます。

   3. データ挿入開始を示すメッセージを出力します。

   4. 変数 tableName を定義し、test_tbl1 を代入します。この変数はテーブル名を格納するために使用されます。

   5. SQLステートメントを実行して、test_tbl1 という名前のテーブルにデータを挿入します。挿入するレコードは3件で、それぞれ id が 1、2、3、name が John、Jack、Amy です。

   6. データクエリ開始を示すメッセージを出力します。

   7. SQLステートメントを実行して、test_tbl1 という名前のテーブルの全データをクエリし、クエリ結果を変数 data に代入します。TestEntity はクエリ結果のエンティティタイプです。

   8. クエリ結果の反復処理開始を示すメッセージを出力します。

   9. クエリ結果を反復処理し、各行を変数 item に代入します。各行の id と name フィールドを出力します。

   コード：

                   {
                       Console.WriteLine("Create Table:");
                       db.Ado.ExecuteCommand("CREATE TABLE test_tbl1(id NUMBER PRIMARY KEY, name VARCHAR2(50))");
   
                       Console.WriteLine("Insert Data:");
                       string tableName = "test_tbl1";
                       int intValue = db.Ado.ExecuteCommand($"INSERT INTO {tableName} (id, name) VALUES (1, 'John'), (2, 'Jack'), (3, 'Amy')");
   
                       Console.WriteLine("Query Data");
                       var data = db.Ado.SqlQuery<TestEntity>($"SELECT * FROM {tableName}");
                       Console.WriteLine("Query Results:");
                       foreach (var item in data)
                       {
                           Console.WriteLine($"id: {item.id}, name: {item.name}");
                       }
                   }
   

6. catch キーワードを使用して例外をキャッチし、処理を行います。

   プログラムで例外が発生すると、例外に関する情報が出力されます。例外をキャッチして情報を出力することで、デバッグや問題の特定が容易になり、プログラムの堅牢性と信頼性が確保されます。具体的な手順は以下の通りです：

   1. catch キーワードを使用して例外をキャッチし、キャッチした例外オブジェクトを変数 ex に代入します。この例外オブジェクトは Exception 型またはそのサブクラスのインスタンスです。

   2. プログラムで例外が発生したことを示すメッセージを出力します。

   3. キャッチした例外オブジェクトを文字列に変換して出力します。この文字列には、例外のタイプ、メッセージ、スタックトレースなどの情報が含まれます。

   コード：

               catch (Exception ex)
               {
                   Console.WriteLine("Program Exception:");
                   Console.WriteLine(ex.ToString());
               }
   

7. TestEntity クラスを定義します。

   TestEntity という名前のクラスを定義します。このクラスには id と name の2つのプロパティがあり、それぞれエンティティオブジェクトの id フィールドと name フィールドを表します。具体的な手順は以下の通りです：

   1. TestEntity という名前のパブリッククラスを定義します。

   2. エンティティオブジェクトの id フィールドを表すパブリックな整数型プロパティ id を定義します。プロパティの get および set メソッドを使用して、このフィールドの読み取りと設定を行えます。

   3. エンティティオブジェクトの name フィールドを表すパブリックな文字列型プロパティ name を定義します。プロパティの get および set メソッドを使用して、このフィールドの読み取りと設定を行えます。

   コード：

       public class TestEntity
       {
           public int id { get; set; }
           public string name { get; set; }
       }
   

全コード表示

using System;
using SqlSugar;
using System.Linq;
using System.Data;
using System.Data.Odbc;

namespace GbaseTest
{
    internal class Program
    {
        public static string ConnectionString = "DSN=your_dsn";

        static void Main(string[] args)
        {
            try
            {
                using (SqlSugarClient db = new SqlSugarClient(new ConnectionConfig()
                {
                    DbType = SqlSugar.DbType.Odbc,
                    ConnectionString = ConnectionString,
                    InitKeyType = InitKeyType.Attribute,
                    IsAutoCloseConnection = true,
                    AopEvents = new AopEvents
                    {
                        OnLogExecuting = (sql, p) =>
                        {
                            Console.WriteLine(sql);
                            Console.WriteLine(string.Join(",", p?.Select(it => it.ParameterName + ":" + it.Value)));
                        }
                    }
                }))
                {
                    Console.WriteLine("Create Table:");
                    db.Ado.ExecuteCommand("CREATE TABLE test_tbl1(id NUMBER PRIMARY KEY, name VARCHAR2(50))");

                    Console.WriteLine("Insert Data:");
                    string tableName = "test_tbl1";
                    int intValue = db.Ado.ExecuteCommand($"INSERT INTO {tableName} (id, name) VALUES (1, 'John'), (2, 'Jack'), (3, 'Amy')");

                    Console.WriteLine("Query Data");
                    var data = db.Ado.SqlQuery<TestEntity>($"SELECT * FROM {tableName}");
                    Console.WriteLine("Query Results:");
                    foreach (var item in data)
                    {
                        Console.WriteLine($"id: {item.id}, name: {item.name}");
                    }
                }
            }
            catch (Exception ex)
            {
                Console.WriteLine("Program Exception:");
                Console.WriteLine(ex.ToString());
            }

            Console.WriteLine("Program End.");
        }
    }

    public class TestEntity
    {
        public int id { get; set; }
        public string name { get; set; }
    }
}

関連ドキュメント

• OceanBaseデータベースへの接続方法の詳細については、接続方法の概要を参照してください。

• OceanBase Connector/ODBCの詳細については、OceanBase Connector/ODBCを参照してください。