SqlSugar を使用して OB Cloud クラウドデータベースに接続するサンプルプログラム|OceanBase Cloud|ドキュメント|分散データベース

SqlSugar を使用して OB Cloud クラウドデータベースに接続するサンプルプログラム

最終更新日：2026-06-09 02:55:39 更新

本稿では、SqlSugar フレームワーク、OceanBase Connector/ODBC、および OB Cloud クラウドデータベースを使用してアプリケーションを構築し、テーブルの作成、データの挿入、データのクエリなどの基本操作を実装する方法について説明します。

      sqlsugar-oceanbase-odbc サンプルプロジェクトをダウンロード
  </a>
  <a role='video' href='https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/video-center/video/video/08%20sqlsugar-oceanbase-odbc%2001.mp4'>
      
      SqlSugar を使用して OceanBase データベースに接続するサンプルプログラム
  </a>

前提条件

OB Cloud クラウドデータベースのアカウントを登録し、クラスタインスタンスと OB Cloud Oracleテナントを作成していること。詳細は、クラスタインスタンスの作成およびテナントの作成をご参照ください。
Visual Studio、NuGet パッケージマネージャープラグイン、および .Net Framework コンポーネントをインストールしていること。
OceanBase Connector/ODBC ドライバをインストールしていること。

説明

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

操作手順

説明

本稿で説明する操作手順は、Windows 環境で Visual Studio Community 2019 を使用してプロジェクトをコンパイルおよび実行する手順です。他のオペレーティングシステム環境やコンパイラを使用している場合、操作手順が若干異なる場合があります。

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

手順 1: sqlsugar-oceanbase-odbc プロジェクトを開く

Visual Studio Community 2019 を起動します。
既存のプロジェクトを開きます。
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 関連のパッケージをインストールする

Visual Studio Community 2019 のスタート画面で、上部のメニューバーから ツール -> NuGet パッケージマネージャー -> ソリューションの NuGet パッケージの管理 を選択します。
参照の下の検索ボックスに sqlsugar と入力し、SqlSugar パッケージをダウンロードします。
参照の下の検索ボックスに sqlsugar.odbc と入力し、SqlSugar.Odbc および SqlSugar.OdbcCore パッケージをダウンロードします。
インストールが完了すると、プロジェクトのコードファイル内で SqlSugar 関連の名前空間と型を使用できるようになります。

手順 3: データソースを設定する

OB Cloud クラウドデータベースコンソールにログインします。インスタンス一覧ページで、対象インスタンスの情報を展開し、対象テナントの下で接続 > 接続文字列の取得 を選択します。

詳細な操作については、接続文字列の取得をご参照ください。
作成済みの OB Cloud クラウドデータベースに基づいて、以下の URL の対応する情報を入力します。

例は以下の通りです。
```
obclient -h t********.********.oceanbase.cloud` -P1521 -u oracle001 -p******
```
パラメータの説明:
- -h: OB Cloud クラウドデータベースの接続アドレスを指定します。例: t********.********.oceanbase.cloud。
- -P: OB Cloud クラウドデータベースの接続ポートを指定します。デフォルトは 1521 です。
- -u: データベースにアクセスするためのアカウントを指定します。
- -p: アカウントのパスワードを指定します。
接続文字列の詳細については、OBClient を使用した OceanBase テナントへの接続をご参照ください。
OceanBase Connector/ODBC ドライバが正常にインストールされたかを確認します。

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

ユーザー DSN > 追加 > ドライバーの選択 を選択し、完了をクリックします。
ポップアップウィンドウでデータソース名 Name と説明 Description を入力し、Next をクリックします。
ポップアップウィンドウでデータベース接続情報を入力します。その後 Next をクリックすると、初期化文、TLS、カーソル、結果セットなどの情報を設定できます。

説明

データベース接続情報の入力後、まず Test DSN をクリックして、データソースに正常に接続できるかを確認できます。
設定が完了したら 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 を使用して OB Cloud クラウドデータベースを操作する方法を示しており、テーブルの作成、データの挿入、データのクエリなどの基本操作を実装しています。また、AopEvents オブジェクトを通じてログ記録などのイベントコールバック関数を設定し、デバッグやトラブルシューティングを容易にします。

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

名前空間の参照。

using キーワードを使用して、名前空間 System、SqlSugar、System.Linq、System.Data、および System.Data.Odbc を参照します。これらは、関連するデータアクセスクラスやデータベース操作のクラスおよびメソッドを参照するために使用されます。

コードは以下の通りです。
```
using System;
using SqlSugar;
using System.Linq;
using System.Data;
using System.Data.Odbc;
```
関連するクラスやメソッドを配置するための名前空間を定義します。

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

コードは以下の通りです。
```
namespace GbaseTest
{
    internal class Program
    {
        ...
        ...
    }

    public class TestEntity
    {
        ...
        ...
    }
}
```
プログラムのメインロジックを含む 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.");
        }
    }
```
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)));
                        }
                    }
                }))
```
データベース操作。

SqlSugarClient.Ado.ExecuteCommand メソッドを使用して SQL 文を実行し、テーブルの作成とデータの挿入を行います。SqlSugarClient.Ado.SqlQuery メソッドを使用してデータをクエリし、クエリ結果を反復処理して出力します。SqlSugarClient オブジェクトを通じて、テーブルの作成、データの挿入、データのクエリなどのデータベース操作を簡単に実行できます。具体的な手順は以下の通りです。
1. テーブルの作成を開始することを示すプロンプト情報を出力します。
2. SQL 文を実行して、id と name の 2 つの列を含む test_tbl1 という名前のテーブルを作成します。
3. データの挿入を開始することを示すプロンプト情報を出力します。
4. 変数 tableName を定義し、test_tbl1 を代入します。この変数はテーブル名を格納するために使用されます。
5. SQL 文を実行して、test_tbl1 という名前のテーブルにデータを挿入します。id が 1、2、3、name がそれぞれ John、Jack、Amy である 3 つのレコードが含まれます。
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}");
                    }
                }
```
catch キーワードを使用して例外をキャッチし、処理します。

プログラムで例外が発生した場合、例外の関連情報が出力されます。例外をキャッチして情報を出力することで、デバッグや問題の特定に役立ち、プログラムの堅牢性と信頼性をある程度保証できます。具体的な手順は以下の通りです。
1. catch キーワードを使用して例外をキャッチし、キャッチした例外オブジェクトを変数 ex に代入します。この例外オブジェクトは Exception 型またはそのサブクラスのインスタンスです。
2. プログラムで例外が発生したことを示すプロンプト情報を出力します。
3. キャッチした例外オブジェクトを文字列に変換して出力します。この文字列には、例外のタイプ、メッセージ、スタックトレースなどの情報が含まれます。
コードは以下の通りです。
```
            catch (Exception ex)
            {
                Console.WriteLine("Program Exception:");
                Console.WriteLine(ex.ToString());
            }
```
クラス 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; }
    }
```

完全なコードの表示

Program.cs

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

顧客事例