製品をチェック

Cosmos DB ODBC Driver の30日間無償トライアルをダウンロード

 30日間の無償トライアルへ

製品の詳細

Cosmos DB アイコン Cosmos DB ODBC Driver 相談したい

使いやすいUnix 用Cosmos DB ODBC Driver。Unicode 対応32ビットおよび64ビットODBC。

Cosmos DB データにSQL Server のリンクサーバーとして接続する方法

ODBC Driver のSQL Gateway 機能を使ってCosmos DB のリンクサーバーをセットアップ。

兵藤朋代
コンテンツスペシャリスト

最終更新日:2023-09-07
cosmosdb ロゴ

CData

odbc ロゴ画像
SQL Server ロゴ

こんにちは!ドライバー周りのヘルプドキュメントを担当している兵藤です。

本記事では、SQL Server のTDS Remoting 機能を使ってCosmos DB のリンクサーバーをセットアップする方法をご紹介します。リンクサーバーの利用には、CData ODBC ドライバに同梱されているSQL Gateway を使用します。 SQL Server のインターフェースでCosmos DB への読み書き双方向のアクセスが可能になります。

Cosmos DB リンクサーバー利用シナリオ

  • SQL Server に接続しているアプリケーションでCosmos DB データを利用したいがデータ接続を増やしたくない
  • Cosmos DB データをSQL Server のデータや他のリンクサーバーのデータをJOIN などして使いたい
  • 利用したいミドルウェア・BI ツールなどにODBC やJDBC の汎用のインターフェースがないが、SQL Server には接続できる

Cosmos DB DSN の設定

まずは、本記事右側のサイドバーからCosmosDB ODBC Driver の無償トライアルをダウンロード・インストールしてください。ODBC ドライバーのインストール完了時にODBC DSN 設定画面が立ち上がります。または、Microsoft ODBC データソースアドミニストレーターを使ってDSN を作成および設定できます。

CosmosDB 接続プロパティの取得・設定方法

SQL API を使ってCosmos DB アカウントに接続するために必要な接続文字列を取得するには、Azure Portal にログインして「Azure Cosmos DB」を選択し、自分のアカウントを選択します。「Settings」セクションで、「Connection String」をクリックして次の値を設定します。

  • AccountEndpoint:この値は、Cosmos DB アカウントの「Keys」ブレードからのCosmos DB アカウントURL に設定してください。
  • AccountKey:Azure ポータルで、Cosmos DB サービスに移動してAzure Cosmos DB アカウントを選択します。リソースメニューから、 「Keys」ページに移動します。「PRIMARY KEY」値を見つけ、Token をこの値に設定します。

SQL Gateway でのCosmos DB ODBC DSN を設定

CData ODBC ドライバにはSQL Gateway が同梱されています。このSQL Gateway に、Cosmos DB ODBC Driver をサービスとして設定します。

  1. 「スタート」画面から「SQL Gateway」を起動します。青い「C」のSQL Gateway ロゴが右下のインジケータに表示されます。 アプリケーションコンソールが開かない場合には、SQL Gateway アイコンを右クリックして、「Open Application」をクリックしてください。
  2. アプリケーションコンソールの「Service」タブを開いて、「Add」をクリックして、新しいODBC データソースを設定します。
  3. Cosmos DB ODBC の設定を行います。
    Service Name]:任意
    リモーティングDB 選択:SQL Server を選択
    Data Source:ドロップダウンでCData Cosmos DB Source Sys を選択
    Port:使用していないポートを選択
    Setting ODBC Driver
  4. 次に「Users」タブ→「Add」からユーザーを登録します。
    ユーザー毎にFull アクセスか、Readonly か、None の権限を選択できます。
    複数のODBC データソースがある場合には、データソース毎に権限の設定が可能です。
    User setting
    「OK」を押して、ユーザー登録を完了します。 その後「Save Changes」で設定を保存します。
  5. SQL Gateway の「Service」タブで「Start」ボタンを押して、サービスを起動します。サービスの左側の〇が緑色になれば、サービスは起動中です。

SQL Server でCosmos DB リンクサーバーを設定

SQL Gateway 側でサービスの設定が終わったら、SQL Server 側でCosmos DB サービスをリンクサーバーとして使う設定をしましょう。

  1. SQL Server Management Studio (SSMS) を開きます。
    オブジェクトエクスプローラーの「サーバーオブジェクト」で「リンクサーバー」を右クリックして、「新しいリンクサーバー」をクリックします。
  2. 新しいリンクサーバーの設定画面の「全般」で、以下を入力します。
    サーバー種類:その他データソース
    プロバイダー:SQL Server Native _Client 11.0
    データソース:この例の場合、localhost, 1433 を入力
    カタログ:ODBC DSN 名を入力
    Linked Server setting
  3. また、「セキュリティ」では、「このセキュリティコンテキスト」を選択して、リモートログインにSQL Gateway にユーザー設定したUser 名とPassword を入力します。

これで、リンクサーバーの設定は終わりなので、「OK」を押して設定を保存します。

SSMS でデータを見てみる

SSMS のオブジェクトエクスプローラーのリンクサーバー下にCosmos DB のリンクサーバーが作成され、「テーブル」下にCosmos DB のデータがアプリ単位でテーブルが生成されます。
新しいクエリを選択し、Cosmos DB データを取得してみます。

SELECT * from リンクサーバー名.CData Cosmos DB Source Sys(ODBC DSN 名).Cosmos DB.テーブル名

このように、API のリクエストではなく通常のSQL 構文でデータを扱うことが可能になっています

Visual Studio からCosmos DB リンクサーバーを使う

Visual Studio のサーバーエクスプローラーの「データ接続」を右クリックし、「接続の追加」をクリックして、データソースの選択画面を開きます。 データソースの選択画面でデータソースを「Microsoft SQL Server 」に選択して、「続行」を押します。

「接続の追加」画面で、以下を入力します。
サーバー名:SQL Server のサーバー名
認証:任意の認証方式
データベース名の選択または入力:※master など
※リンクサーバーを直接データベース名として入力することはできないようです。なので上位のデータベース名で設定しておきます。

リンクサーバー設定

「テスト接続」をして大丈夫であれば、「OK」を押して設定を完了させます。

「新しいクエリ」で、SQL でSELECT 文を書いてデータを取得してみます。

SELECT * from リンクサーバー名.CData Cosmos DB Source Sys(ODBC DSN 名).Cosmos DB.テーブル名

このように、通常のSQL Server のリンクサーバーと同じようにVisual Studio 内Cosmos DB データを扱うことが可能になります。 他のIDE でもSQL Server にアクセスする方法でCosmos DB データにSQL でアクセスが可能になります。
複数データソースのJOIN などを行う場合には大変便利です。

おわりに

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをSQL Server に連携できます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。