SqlSugar

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

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

前提条件

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

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

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

  説明

  OceanBase公式ダウンロードセンターのOceanBase Dedicatedページのドライバーとミドルウェアモジュールから、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 を入力して、Next をクリックします。

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

   説明

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

6. 設定の完了後に Finish をクリックし、データソースの追加が完了したら 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メソッド：プログラムのエントリポイントで、プログラムの主要ロジックが含まれます。

      1. try-catch ブロック：
         1. try キーワードを使用して、例外を引き起こす可能性のあるコード、using ステートメント、データベース操作をラップします。
         2. catch キーワードを使用して例外をキャッチし、処理を行います。
      2. 最後に、プログラム終了前に 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 などのプロパティを初期化します。

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

      2. 接続文字列を ConnectionString に設定しました。

      3. 主キータイプを Attribute に設定しました。

      4. 自動接続クローズを設定しました。

      5. 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 という名前のpublicクラスを定義します。

   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を参照してください。