CLR スカラー値関数

[アーティクル]
07/04/2024

適用対象: SQL Server

スカラー値関数 (SVF) は、文字列、整数、ビット値などの 1 つの値を返します。任意の .NET Framework プログラミング言語を使用して、マネージドコードでスカラー値のユーザー定義関数を作成できます。これらの関数は、Transact-SQL またはその他のマネージドコードからアクセスできます。 CLR 統合の利点とマネージドコードと Transact-SQL の選択については、「 CLR 統合の概要を参照してください。

CLR スカラー値関数の要件

.NET Framework SVF は、.NET Framework アセンブリのクラスのメソッドとして実装されます。 SVF から返される入力パラメーターと型には、SQL Server でサポートされているスカラーデータ型のいずれかを指定できます。 varchar、 char、 rowversion、 text、 ntext、 image、 timestamp、 table、または cursor を除きます。 SV は、SQL Server データ型と実装メソッドの戻りデータ型の間で一致することを確認する必要があります。型変換の詳細については、「 CLR パラメーターデータのマッピング」を参照してください。

.NET Framework 言語で .NET Framework SVF を実装する場合、 SqlFunction カスタム属性を指定して、関数に関する追加情報を含めることができます。 SqlFunction 属性は、関数がデータにアクセスまたは変更するかどうか、決定論的な場合、および関数に浮動小数点演算が含まれるかどうかを示します。

ユーザー定義スカラー値関数は、決定的関数になる場合と非決定的関数になる場合があります。特定の入力パラメーターのセットを渡して決定的関数を呼び出すと、常に同じ結果が返されます。一方、特定の入力パラメーターのセットを渡して非決定的関数を呼び出すと、異なる結果が返されることがあります。

Note

入力値とデータベースの状態が同じでも、関数が必ずしも常に同じ出力値を生成しない場合は、その関数を決定的関数としてマークしないでください。完全に決定的ではない関数を決定的関数としてマークした場合、インデックス付きビューと計算列が破損する可能性があります。 IsDeterministic プロパティを true に設定して、関数を決定論的としてマークします。

テーブル値パラメーター

テーブル値パラメーター (TVP) とは、プロシージャや関数に渡されるユーザー定義のテーブル型です。TVP を使用すると、複数行のデータを効率的にサーバーに渡すことができます。 TVP はパラメーター配列と同様の機能を提供しますが、Transact-SQL との柔軟性が向上し、より緊密に統合できます。テーブル値パラメーターを使用するとパフォーマンスが向上する可能性もあります。また、サーバーへのラウンドトリップを減らすのにも役立ちます。スカラーパラメーターのリストを使用するなどしてサーバーに複数の要求を送信する代わりに、データを TVP としてサーバーに送信できます。ユーザー定義テーブル型は、SQL Server プロセスで実行されているマネージドストアドプロシージャまたは関数に対して、テーブル値パラメーターとして渡したり、そのパラメーターから返したりすることはできません。 TVP の詳細については、「テーブル値パラメーターの使用 (データベースエンジン)」を参照してください。

CLR スカラー値関数の例

データにアクセスして整数値を返す簡単な SVF を次に示します。

using Microsoft.SqlServer.Server;  
using System.Data.SqlClient;  
  
public class T  
{  
    [SqlFunction(DataAccess = DataAccessKind.Read)]  
    public static int ReturnOrderCount()  
    {  
        using (SqlConnection conn   
            = new SqlConnection("context connection=true"))  
        {  
            conn.Open();  
            SqlCommand cmd = new SqlCommand(  
                "SELECT COUNT(*) AS 'Order Count' FROM SalesOrderHeader", conn);  
            return (int)cmd.ExecuteScalar();  
        }  
    }  
}

Imports Microsoft.SqlServer.Server  
Imports System.Data.SqlClient  
  
Public Class T  
    <SqlFunction(DataAccess:=DataAccessKind.Read)> _  
    Public Shared Function ReturnOrderCount() As Integer  
        Using conn As New SqlConnection("context connection=true")  
            conn.Open()  
            Dim cmd As New SqlCommand("SELECT COUNT(*) AS 'Order Count' FROM SalesOrderHeader", conn)  
            Return CType(cmd.ExecuteScalar(), Integer)  
        End Using  
    End Function  
End Class

コードの最初の行は Microsoft.SqlServer.Server を参照して属性にアクセスし System.Data.SqlClient ADO.NET 名前空間にアクセスします。 (この名前空間には が含まれていますSqlClient、.NET Framework Data Provider for SQL Server)。

次に、この関数は SqlFunction カスタム属性を受け取ります。カスタム属性は、 Microsoft.SqlServer.Server 名前空間にあります。このカスタム属性は、UDF (ユーザー定義関数) がサーバーのデータを読み取るときにインプロセスプロバイダーを使用するかどうかを示します。 SQL Server では、UDF によるデータの更新、挿入、または削除は許可されません。 SQL Server では、インプロセスプロバイダーを使用しない UDF の実行を最適化できます。これは、 DataAccessKind を DataAccessKind.None に設定することによって示されます。その次の行で、対象のメソッドは public static (Visual Basic .NET では shared) になっています。

Microsoft.SqlServer.Server 名前空間にある SqlContext クラスは、既に設定されている SQL Server インスタンスへの接続を使用して、SqlCommand オブジェクトにアクセスできます。ここでは使用しませんが、現在のトランザクションコンテキストは、 System.Transactions アプリケーションプログラミングインターフェイス (API) でも使用できます。

関数本体のコード行のほとんどは、 System.Data.SqlClient 名前空間で見つかった型を使用するクライアントアプリケーションを記述した開発者にとってよく知られているはずです。

[C#]

using(SqlConnection conn = new SqlConnection("context connection=true"))   
{  
   conn.Open();  
   SqlCommand cmd = new SqlCommand(  
        "SELECT COUNT(*) AS 'Order Count' FROM SalesOrderHeader", conn);  
   return (int) cmd.ExecuteScalar();  
}

[Visual Basic]

Using conn As New SqlConnection("context connection=true")  
   conn.Open()  
   Dim cmd As New SqlCommand( _  
        "SELECT COUNT(*) AS 'Order Count' FROM SalesOrderHeader", conn)  
   Return CType(cmd.ExecuteScalar(), Integer)  
End Using

適切なコマンドテキストは、 SqlCommand オブジェクトを初期化することによって指定されます。前の例では、テーブル SalesOrderHeader 内の行数をカウントします。次に、cmd オブジェクトの ExecuteScalar メソッドが呼び出されます。これにより、クエリに基づいて int 型の値が返されます。最後に、注文数が呼び出し側に返されます。

このコードを FirstUdf.cs というファイルに保存すると、次のようにアセンブリとしてコンパイルできます。

[C#]

csc.exe /t:library /out:FirstUdf.dll FirstUdf.cs

[Visual Basic]

vbc.exe /t:library /out:FirstUdf.dll FirstUdf.vb

Note

/t:libraryは、実行可能ファイルではなくライブラリを生成することを示しています。 SQL Server に実行可能ファイルを登録することはできません。

Note

/clr:pure でコンパイルされた Visual C++ データベースオブジェクトは、SQL Server での実行ではサポートされていません。このようなデータベースオブジェクトには、スカラー値関数などがあります。

アセンブリと UDF を登録するための Transact-SQL クエリとサンプル呼び出しは次のとおりです。

CREATE ASSEMBLY FirstUdf FROM 'FirstUdf.dll';  
GO  
  
CREATE FUNCTION CountSalesOrderHeader() RETURNS INT   
AS EXTERNAL NAME FirstUdf.T.ReturnOrderCount;   
GO  
  
SELECT dbo.CountSalesOrderHeader();  
GO

Transact-SQL で公開されている関数名は、ターゲットのパブリック静的メソッドの名前と一致する必要はありません。

参照

CLR パラメーターデータのマッピング
 CLR 統合のカスタム属性の概要
 ユーザー定義関数
 CLR データベースオブジェクトからのデータアクセス

次の方法で共有

CLR スカラー値関数

CLR スカラー値関数の要件

テーブル値パラメーター

CLR スカラー値関数の例

参照

フィードバック

その他のリソース