SQL Server で R 開発用のデータサイエンスクライアントをセットアップする

[アーティクル]
06/02/2023

適用対象: SQL Server 2016 (13.x)、 SQL Server 2017 (14.x)、 SQL Server 2019 (15.x)、 SQL Server 2019 (15.x) - Linux

SQL Server 2016 R Services または SQL Server Machine Learning Services (データベース内) のインストール時に R 言語オプションを含めた場合、SQL Server 2016 以降で R 統合を使用できます。

注意

現在、この記事は、SQL Server 2016 (13.x)、SQL Server 2017 (14.x)、SQL Server 2019 (15.x)、SQL Server 2019 (15.x) (Linux のみ) に適用されます。

SQL Server 用の R ソリューションを開発してデプロイするには、Microsoft R Client を開発ワークステーションにインストールし、RevoScaleR やその他の R ライブラリを入手します。リモート SQL Server インスタンスでも必要な RevoScaleR ライブラリは、両方のシステム間での計算要求を調整します。

この記事では、R クライアント開発ワークステーションを構成して、機械学習と R 統合のために有効になっているリモート SQL Server と対話できるようにする方法について説明します。この記事の手順を完了すると、SQL Server にあるものと同じ R ライブラリが得られます。また、ローカル R セッションから SQL Server 上のリモート R セッションに計算をプッシュする方法についても説明します。

クライアントサーバーコンポーネント

インストールを検証するには、この記事で説明されているように組み込みの RGUI ツールを使用するか、または RStudio もしくは通常使用する他の IDE にライブラリをリンクすることができます。

一般的に使用されるツール

SQL を初めて使用する R 開発者、または R とデータベース内分析を初めて使用する SQL 開発者である場合、データベース内分析のすべての機能を実行するには、R 開発ツールと SQL Server Management Studio (SSMS) などの T-SQL クエリエディターの両方が必要になります。

単純な R 開発シナリオでは、RGUI 実行可能ファイルを使用できます。これは、MRO および SQL Server の R 基本ディストリビューションにバンドルされています。この記事では、ローカルとリモートの R セッションの両方で RGUI を使用する方法について説明します。生産性を向上させるには、RStudio や Visual Studio などの完全な機能を備えた IDE を使用する必要があります。

SSMS は個別にダウンロードします。これは、R コードが含まれているものを含め、SQL Server でストアドプロシージャを作成および実行する場合に便利です。開発環境で記述する R コードは、ほとんどすべてストアドプロシージャに埋め込むことができます。他のチュートリアルでは、SSMS と埋め込み R について学習できます。

1 - R パッケージをインストールする

Microsoft の R パッケージは、複数の製品およびサービスで利用できます。ローカルワークステーションでは、Microsoft R Client をインストールすることをお勧めします。 R Client には、RevoScaleR、MicrosoftML、SQLRUtils、およびその他の R パッケージが用意されています。

Microsoft R Client をダウンロードします。
インストールウィザードで、既定のインストールパスに同意するかまたは変更し、コンポーネントの一覧に同意するかまたは変更し、Microsoft R Client ライセンス条項に同意します。

インストールが完了すると、ようこそ画面に製品とドキュメントが紹介されます。
Intel Math Kernel Library (MKL) 計算での一貫性のある出力を保証するために、MKL_CBWR システム環境変数を作成します。
- コントロールパネルで、[システムとセキュリティ]>[システム]>[システムの詳細設定]>[環境変数] の順に選択します。
- MKL_CBWR という名前の新しいシステム変数を作成し、値を AUTO に設定します。

2 - 実行可能ファイルの検索

インストールフォルダーの内容を見つけ出して一覧表示し、R.exe、RGUI、およびその他のパッケージがインストールされていることを確認します。

エクスプローラーで %ProgramFiles%\Microsoft\R Client\R_SERVER\bin フォルダーを開いて、R.exe の場所を確認します。
x64 サブフォルダーを開き、RGUI を確認します。このツールは次の手順で使用します。
%ProgramFiles%\Microsoft\R Client\R_SERVER\library を開き、RevoScaleR、MicrosoftML などを含む、R Client と共にインストールされたパッケージのリストを確認します。

3 - RGUI を開始する

SQL Server と共に R をインストールすると、RGui、Rterm などの、すべての R の基本インストールで標準となる R ツールと同じものが得られます。これらのツールは軽量で、パッケージとライブラリの情報をチェックしたり、アドホックコマンドやスクリプトを実行したり、チュートリアルを実行したりするのに便利です。これらのツールを使用して R バージョン情報を取得し、接続性を確認することができます。

%ProgramFiles%\Microsoft\R Client\R_SERVER\bin\x64 を開いて [RGui] をダブルクリックし、R コマンドプロンプトを使用して R セッションを開始します。

Microsoft プログラムフォルダーから R セッションを開始すると、RevoScaleR を含むいくつかのパッケージが自動的に読み込まれます。
RevoScaleR パッケージのバージョン情報を返すには、コマンドプロンプトで「print(Revo.version)」と入力します。 RevoScaleR のバージョン 9.2.1 または 9.3.0 が必要です。
インストールされているパッケージの一覧については、R プロンプトで「search ()」と入力してください。

4 - SQL のアクセス許可を取得する

R クライアントでは、R の処理は 2 つのスレッドとメモリ内データで制限されています。複数のコアと大規模なデータセットを使用するスケーラブルな処理の場合は、リモート SQL Server インスタンスのデータセットと計算能力に実行をシフト (コンピューティングコンテキストと呼ばれます) できます。これは、実稼働 SQL Server インスタンスとクライアントの統合のために推奨される方法です。この方法を使用するには、アクセス許可と接続情報が必要です。

スクリプトを実行してデータをアップロードするために SQL Server のインスタンスに接続するには、データベースサーバーでの有効なログインが必要です。 SQL ログインまたは統合 Windows 認証を使用できます。一般的には Windows 統合認証を使用することをお勧めしますが、一部のシナリオでは、特にスクリプトに外部データへの接続文字列が含まれている場合は、SQL ログインを使用する方が簡単です。

少なくとも、コードの実行に使用するアカウントには、操作するデータベースから読み取るためのアクセス許可に加え、特別なアクセス許可である EXECUTE ANY EXTERNAL SCRIPT が必要です。ほとんどの開発者には、ストアドプロシージャを作成し、トレーニングデータまたはスコア付きデータを含むテーブルにデータを書き込むためのアクセス許可も必要です。

R を使用するデータベースでアカウントに次のアクセス許可を構成するように、データベース管理者に依頼してください。

EXECUTE ANY EXTERNAL SCRIPT - サーバー上で R スクリプトを実行します。
db_datareader 特権 - モデルのトレーニングに使用するクエリを実行します。
db_datawriter - トレーニングデータまたはスコア付きデータを書き込みます。
db_owner - ストアドプロシージャ、テーブル、関数などのオブジェクトを作成します。サンプルを作成し、データベースをテストする場合は、db_owner も必要です。

SQL Server と共に既定でインストールされないパッケージをコードが必要とする場合は、データベース管理者に連絡して、インスタンスと共にパッケージがインストールされるようにしてください。 SQL Server はセキュリティで保護された環境であり、パッケージをインストールできる場所に制限があります。詳細については、「SQL Server に新しい R パッケージをインストールする」に関するページを参照してください。

5 - 接続のテスト

検証手順として、RGUI と RevoScaleR を使用して、リモートサーバーへの接続性を確認します。 SQL Server がリモート接続に対して有効になっている必要があります。また、接続先のユーザーログインやデータベースなどのアクセス許可が必要です。

次の手順では、NYCTaxi_Sample のデモデータベース、および Windows 認証を想定しています。

クライアントワークステーションで RGUI を開きます。たとえば、~\Program Files\Microsoft SQL Server\140\R_SERVER\bin\x64 にアクセスし、RGui.exe をダブルクリックして起動します。
RevoScaleR は自動的に読み込まれます。コマンド「print(Revo.version)」を実行して、RevoScaleR が動作可能であることを確認します。

リモートサーバーで実行するデモスクリプトを入力します。次のサンプルスクリプトを変更して、リモート SQL Server インスタンスの有効な名前を含める必要があります。このセッションはローカルセッションとして開始されますが、rxSummary 関数はリモート SQL Server インスタンスで実行されます。

# Define a connection. Replace server with a valid server name.
connStr <- "Driver=SQL Server;Server=<your-server-name>;Database=NYCTaxi_Sample;Trusted_Connection=true"

# Specify the input data in a SQL query.
sampleQuery <-"SELECT DISTINCT TOP(100) tip_amount FROM [dbo].nyctaxi_sample ORDER BY tip_amount DESC;"

# Define a remote compute context based on the remote server.
cc <-RxInSqlServer(connectionString=connStr)

# Execute the function using the remote compute context.
rxSummary(formula = ~ ., data = RxSqlServerData(sqlQuery=sampleQuery, connectionString=connStr), computeContext=cc)

結果:

このスクリプトは、リモートサーバー上のデータベースに接続し、クエリを提供し、リモートコードの実行のためにコンピューティングコンテキスト cc 命令を作成します。次に、RevoScaleR 関数 rxSummary を提供して、クエリ結果の統計サマリーを返します。

  Call:
rxSummary(formula = ~., data = RxSqlServerData(sqlQuery = sampleQuery, 
    connectionString = connStr), computeContext = cc)

Summary Statistics Results for: ~.
Data: RxSqlServerData(sqlQuery = sampleQuery, connectionString = connStr) (RxSqlServerData Data Source)
Number of valid observations: 100 

Name       Mean   StdDev   Min Max ValidObs MissingObs
tip_amount 63.245 31.61087 36  180 100      0

コンピューティングコンテキストを取得して設定します。コンピューティングコンテキストを設定すると、セッションの間は有効なままになります。計算がローカルとリモートのどちらなのかわからない場合は、次のコマンドを実行して確認します。結果に接続文字列が明示されていれば、リモートのコンピューティングコンテキストを示しています。
```
# Return the current compute context.
rxGetComputeContext()

# Revert to a local compute context.
rxSetComputeContext("local")
rxGetComputeContext()

# Switch back to remote.
connStr <- "Driver=SQL Server;Server=<your-server-name>;Database=NYCTaxi_Sample;Trusted_Connection=true"
cc <-RxInSqlServer(connectionString=connStr)
rxSetComputeContext(cc)
rxGetComputeContext()
```
名前と型を含む、データソース内の変数に関する情報を返します。
```
rxGetVarInfo(data = inDataSource)
```
結果には 23 個の変数が含まれます。

散布図を生成して、2 つの変数の間に依存関係があるかどうかを調べます。

# Set the connection string. Substitute a valid server name for the placeholder.
connStr <- "Driver=SQL Server;Server=<your database name>;Database=NYCTaxi_Sample;Trusted_Connection=true"

# Specify a query on the nyctaxi_sample table.
# For variables on each axis, remove nulls. Use a WHERE clause and <> to do this.
sampleQuery <-"SELECT DISTINCT TOP 100 * from [dbo].[nyctaxi_sample] WHERE fare_amount <> '' AND  tip_amount <> ''"
cc <-RxInSqlServer(connectionString=connStr)

# Generate a scatter plot.
rxLinePlot(fare_amount ~ tip_amount, data = RxSqlServerData(sqlQuery=sampleQuery, connectionString=connStr, computeContext=cc), type="p")

次のスクリーンショットでは、入力と散布図の出力が示されています。

RGUI の散布図

6 - R.exe にリンクするツール

継続的かつ本格的な開発プロジェクトの場合は、統合開発環境 (IDE) をインストールする必要があります。 SQL Server ツールと組み込みの R ツールは、大型の R 開発を行うための機能を備えていません。動作するコードを作成したら、それを SQL Server で実行するためのストアドプロシージャとして配置できます。

IDE からベース R、RevoScaleR などのローカル R ライブラリを参照します。リモート SQL Server でのワークロードの実行は、スクリプトの実行中にスクリプトが SQL Server でリモートのコンピューティングコンテキストを呼び出し、そのサーバー上でデータと処理にアクセスするときに発生します。

RStudio

RStudio を使用する場合は、リモート SQL Server 上の R ライブラリと実行可能ファイルに対応するそれらを使用するように、環境を構成できます。

SQL Server でインストールされている R パッケージのバージョンを確認します。詳細については、「R パッケージ情報の取得」を参照してください。
Microsoft R Client をインストールして、RevoScaleR、および SQL Server インスタンスで使用されているベース R ディストリビューションを含む、その他の R パッケージを追加します。同じ、もしくはより低いバージョンを選択してください (パッケージは下位互換性があります)。それはサーバーと同じバージョンのパッケージを提供します。サーバーにインストールされているパッケージのバージョンを確認するには、「インストールされているすべての R パッケージの列挙」を参照してください。
RStudio で R パスを更新して、RevoScaleR、Microsoft R Open、およびその他の Microsoft パッケージを提供する R 環境を参照するようにします。 %ProgramFiles%\Microsoft\R Client\R_SERVER\bin\x64を参照してください。
RStudio を閉じ、その後すぐに開きます。

RStudio を再度開くと、R クライアントの R 実行可能ファイルが既定の R エンジンになります。

R Tools for Visual Studio (RTVS)

希望する R 用の IDE がまだない場合は、R Tools for Visual Studio をお勧めします。

R Tools for Visual Studio (RTVS) をダウンロードする
インストール手順 - RTVS は、いくつかのバージョンの Visual Studio で使用できます。
R Tools for Visual Studio の概要

RTVS から SQL Server への接続

この例では、データサイエンスワークロードがインストールされた Visual Studio 2017 Community Edition を使用します。

[ファイル] メニューの [新規作成] を選択し、[プロジェクト] を選択します。
左側のウィンドウには、プレインストールされたテンプレートの一覧が表示されます。 [R] を選択し、[R プロジェクト] を選択します。 [名前] ボックスに「dbtest」と入力し、[OK] を選択します。

Visual Studio によって、新しいプロジェクトフォルダーと既定のスクリプトファイル Script.R が作成されます。
スクリプトファイルの最初の行に「.libPaths()」を入力し、CTRL + ENTER キーを押します。

現在の R ライブラリのパスは、[R インタラクティブ] ウィンドウに表示されます。
[R Tools] メニューを選択し、[ウィンドウ] を選択して、ワークスペースに表示できる他の R 固有のウィンドウのリストを表示します。
- CTRL + 3 キーを押すと、現在のライブラリのパッケージに関するヘルプを表示します。
- CTRL + 8 キーを押すと、変数エクスプローラーの R 変数を確認します。

次の手順

2 つの異なるチュートリアルでは、コンピューティングコンテキストをローカルからリモート SQL Server インスタンスに切り替える練習を行うことができます。

SQL Server で R 開発用のデータサイエンスクライアントをセットアップする

一般的に使用されるツール

1 - R パッケージをインストールする

2 - 実行可能ファイルの検索

3 - RGUI を開始する

4 - SQL のアクセス許可を取得する

5 - 接続のテスト

6 - R.exe にリンクするツール

RStudio

R Tools for Visual Studio (RTVS)

RTVS から SQL Server への接続

次の手順

フィードバック

フィードバック

その他のリソース

SQL Server で R 開発用のデータ サイエンス クライアントをセットアップする

一般的に使用されるツール

1 - R パッケージをインストールする

2 - 実行可能ファイルの検索

3 - RGUI を開始する

4 - SQL のアクセス許可を取得する

5 - 接続のテスト

6 - R.exe にリンクするツール

RStudio

R Tools for Visual Studio (RTVS)

RTVS から SQL Server への接続

次の手順

フィードバック

フィードバック

その他のリソース

SQL Server で R 開発用のデータサイエンスクライアントをセットアップする