DataAdapter パラメーター

[アーティクル]
05/10/2023

DbDataAdapter には 4 つのプロパティがあり、データソースからデータを取得したりデータソースのデータを更新したりするために使用されます。SelectCommand プロパティは、データソースのデータを返します。InsertCommand、UpdateCommand、および DeleteCommand の各プロパティは、データソースの変更を管理するために使用されます。 SelectCommand プロパティは、Fill の DataAdapter メソッドを呼び出す前に設定しておく必要があります。 InsertCommand、UpdateCommand、DeleteCommand の各プロパティは、Update 内のデータに加えられた変更に応じて、DataAdapter の DataTable メソッドを呼び出す前に設定する必要があります。たとえば、行が追加された場合には、InsertCommand を呼び出す前に Update を設定する必要があります。 Update によって挿入行、更新行、または削除行が処理されるとき、DataAdapter でそれぞれの Command プロパティが使用され、アクションが処理されます。変更された行に関する現在の情報が Command コレクションを経由して Parameters オブジェクトに渡されます。

データソースの行を更新するときは、一意識別子を使用してテーブル内の更新する列を識別する UPDATE ステートメントを呼び出します。一意識別子は、一般には主キーフィールドの値です。 UPDATE ステートメントでは、次の Transact-SQL ステートメントに示すように、一意識別子と更新する列および値の両方を含むパラメーターを使用します。

UPDATE Customers SET CompanyName = @CompanyName
  WHERE CustomerID = @CustomerID

Note

パラメーターのプレースホルダーの構文はデータソースに依存します。次に、SQL Server のデータソースのプレースホルダーの例を示します。 System.Data.OleDb パラメーターおよび System.Data.Odbc パラメーターのプレースホルダーとして、疑問符 (?) を使用します。

この Visual Basic の例では、CustomerID が @CustomerID パラメーターの値と等しい行の @CompanyName パラメーターの値で CompanyName フィールドが更新されます。これらのパラメーターでは、SqlParameter オブジェクトの SourceColumn プロパティを使用して、変更された行から情報が取得されます。前のサンプル UPDATE ステートメントのパラメーターを次に示します。このコードは、変数 adapter が有効な SqlDataAdapter オブジェクトを表すことを前提としています。

adapter.Parameters.Add( _  
  "@CompanyName", SqlDbType.NChar, 15, "CompanyName")  
Dim parameter As SqlParameter = _  
  adapter.UpdateCommand.Parameters.Add("@CustomerID", _  
  SqlDbType.NChar, 5, "CustomerID")  
parameter.SourceVersion = DataRowVersion.Original

Parameters コレクションの Add メソッドは、パラメーター名、データ型、サイズ (その型に適用可能な場合)、および SourceColumn の名前を DataTable から受け取ります。 SourceVersion パラメーターの @CustomerID が Original に設定されることに注意してください。この設定により、変更された DataRow で 1 つまたは複数の識別列の値が変更されている場合に、データソース内の既存の行が確実に更新されます。識別列の値が変更されている場合、Original 行の値がデータソースの現在の値と一致し、Current 行の値に更新済みの値が格納されます。 SourceVersion パラメーターの @CompanyName は設定されていないため、既定値である Current の行の値が使用されます。

Note

DataAdapter の Fill 操作と DataReader の Get メソッドのどちらの場合も、.NET Framework の型は .NET Framework データプロバイダーから返された型から推論されます。 Microsoft SQL Server、OLE DB、および ODBC のデータ型から推論される .NET Framework の型およびアクセサーメソッドについては、「ADO.NET でのデータ型のマッピング」を参照してください。

Parameter.SourceColumn、Parameter.SourceVersion

SourceColumn および SourceVersion が、引数として Parameter コンストラクターに渡されるか、既存の Parameter のプロパティとして設定されます。 SourceColumn は、DataColumn の値の取得先である DataRow の Parameter の名前です。 SourceVersion により、DataRow で値の取得に使用される DataAdapter のバージョンを指定します。

DataRowVersion で使用できる SourceVersion 列挙型の値を次の表に示します。

DataRowVersion 列挙定数	説明
`Current`	このパラメーターは列の現在の値を使用します。既定値です。
`Default`	このパラメーターには列の `DefaultValue` を使用します。
`Original`	このパラメーターは列の元の値を使用します。
`Proposed`	このパラメーターは提示された値を使用します。

次のセクションの SqlClient コードサンプルでは、UpdateCommand 列を 2 つのパラメーター CustomerID (SourceColumn) および @CustomerID (SET CustomerID = @CustomerID) の @OldCustomerID として使用する WHERE CustomerID = @OldCustomerID のパラメーターを定義します。 @CustomerID パラメーターを使用して、CustomerID 列を DataRow の現在の値に更新します。そのため、SourceVersion が Current である CustomerID の SourceColumn が使用されます。 @OldCustomerID パラメーターは、データソースの現在の行を識別するために使用されています。一致する列の値がその行の Original バージョンで見つかったため、SourceColumn が CustomerID である同じ SourceVersion (Original) が使用されます。

SqlClient パラメーターの使用

次のコードサンプルでは、データベースから追加のスキーマ情報を取得するために SqlDataAdapter を作成し、MissingSchemaAction を AddWithKey に設定する方法を示します。 SelectCommand プロパティ、InsertCommand プロパティ、UpdateCommand プロパティ、および DeleteCommand プロパティが設定され、各プロパティに対応する SqlParameter オブジェクトが Parameters コレクションに追加されます。このメソッドは SqlDataAdapter オブジェクトを返します。

public static SqlDataAdapter CreateSqlDataAdapter(SqlConnection connection)
{
    SqlDataAdapter adapter = new()
    {
        MissingSchemaAction = MissingSchemaAction.AddWithKey,

        // Create the commands.
        SelectCommand = new SqlCommand(
        "SELECT CustomerID, CompanyName FROM CUSTOMERS", connection),
        InsertCommand = new SqlCommand(
        "INSERT INTO Customers (CustomerID, CompanyName) " +
        "VALUES (@CustomerID, @CompanyName)", connection),
        UpdateCommand = new SqlCommand(
        "UPDATE Customers SET CustomerID = @CustomerID, CompanyName = @CompanyName " +
        "WHERE CustomerID = @oldCustomerID", connection),
        DeleteCommand = new SqlCommand(
        "DELETE FROM Customers WHERE CustomerID = @CustomerID", connection)
    };

    // Create the parameters.
    adapter.InsertCommand.Parameters.Add("@CustomerID",
        SqlDbType.Char, 5, "CustomerID");
    adapter.InsertCommand.Parameters.Add("@CompanyName",
        SqlDbType.VarChar, 40, "CompanyName");

    adapter.UpdateCommand.Parameters.Add("@CustomerID",
        SqlDbType.Char, 5, "CustomerID");
    adapter.UpdateCommand.Parameters.Add("@CompanyName",
        SqlDbType.VarChar, 40, "CompanyName");
    adapter.UpdateCommand.Parameters.Add("@oldCustomerID",
        SqlDbType.Char, 5, "CustomerID").SourceVersion =
        DataRowVersion.Original;

    adapter.DeleteCommand.Parameters.Add("@CustomerID",
        SqlDbType.Char, 5, "CustomerID").SourceVersion =
        DataRowVersion.Original;

    return adapter;
}

Public Function CreateSqlDataAdapter( _
    ByVal connection As SqlConnection) As SqlDataAdapter

    Dim adapter As New SqlDataAdapter()
    adapter.MissingSchemaAction = MissingSchemaAction.AddWithKey

    ' Create the commands.
    adapter.SelectCommand = New SqlCommand( _
        "SELECT CustomerID, CompanyName FROM CUSTOMERS", connection)
    adapter.InsertCommand = New SqlCommand( _
        "INSERT INTO Customers (CustomerID, CompanyName) " & _
         "VALUES (@CustomerID, @CompanyName)", connection)
    adapter.UpdateCommand = New SqlCommand( _
        "UPDATE Customers SET CustomerID = @CustomerID, CompanyName = " & _
        "@CompanyName WHERE CustomerID = @oldCustomerID", connection)
    adapter.DeleteCommand = New SqlCommand( _
        "DELETE FROM Customers WHERE CustomerID = @CustomerID", connection)

    ' Create the parameters.
    adapter.InsertCommand.Parameters.Add("@CustomerID", _
        SqlDbType.Char, 5, "CustomerID")
    adapter.InsertCommand.Parameters.Add("@CompanyName", _
        SqlDbType.VarChar, 40, "CompanyName")

    adapter.UpdateCommand.Parameters.Add("@CustomerID", _
        SqlDbType.Char, 5, "CustomerID")
    adapter.UpdateCommand.Parameters.Add("@CompanyName", _
        SqlDbType.VarChar, 40, "CompanyName")
    adapter.UpdateCommand.Parameters.Add("@oldCustomerID", _
        SqlDbType.Char, 5, "CustomerID").SourceVersion = _
        DataRowVersion.Original

    adapter.DeleteCommand.Parameters.Add("@CustomerID", _
        SqlDbType.Char, 5, "CustomerID").SourceVersion = _
        DataRowVersion.Original

    Return adapter
End Function

OleDb パラメーターのプレースホルダー

OleDbDataAdapter オブジェクトと OdbcDataAdapter オブジェクトの場合は、疑問符 (?) のプレースホルダーを使用してパラメーターを特定する必要があります。

Dim selectSQL As String = _  
  "SELECT CustomerID, CompanyName FROM Customers " & _  
  "WHERE CountryRegion = ? AND City = ?"  
Dim insertSQL AS String = _  
  "INSERT INTO Customers (CustomerID, CompanyName) VALUES (?, ?)"  
Dim updateSQL AS String = _  
  "UPDATE Customers SET CustomerID = ?, CompanyName = ? " & _  
  WHERE CustomerID = ?"  
Dim deleteSQL As String = "DELETE FROM Customers WHERE CustomerID = ?"

string selectSQL =
  "SELECT CustomerID, CompanyName FROM Customers " +  
  "WHERE CountryRegion = ? AND City = ?";  
string insertSQL =
  "INSERT INTO Customers (CustomerID, CompanyName) " +  
  "VALUES (?, ?)";  
string updateSQL =
  "UPDATE Customers SET CustomerID = ?, CompanyName = ? " +  
  "WHERE CustomerID = ? ";  
string deleteSQL = "DELETE FROM Customers WHERE CustomerID = ?";

パラメーターとして使用されるクエリステートメントは、作成する必要のある入力パラメーターおよび出力パラメーターを定義します。パラメーターを作成するには、Parameters.Add メソッドまたは Parameter コンストラクターを使用して、列名、データ型、およびサイズを指定します。 Integer などの組み込みのデータ型の場合は、サイズを指定する必要はありません。サイズを指定する場合、既定のサイズを指定することになります。

次のコードサンプルでは、SQL ステートメントのパラメーターを作成した後、DataSet にデータを格納します。

OleDb の例

' Assumes that connection is a valid OleDbConnection object.  
Dim adapter As OleDbDataAdapter = New OleDbDataAdapter
  
Dim selectCMD AS OleDbCommand = New OleDbCommand(selectSQL, connection)  
adapter.SelectCommand = selectCMD  
  
' Add parameters and set values.  
selectCMD.Parameters.Add( _  
  "@CountryRegion", OleDbType.VarChar, 15).Value = "UK"  
selectCMD.Parameters.Add( _  
  "@City", OleDbType.VarChar, 15).Value = "London"  
  
Dim customers As DataSet = New DataSet  
adapter.Fill(customers, "Customers")

// Assumes that connection is a valid OleDbConnection object.  
OleDbDataAdapter adapter = new OleDbDataAdapter();  
  
OleDbCommand selectCMD = new OleDbCommand(selectSQL, connection);  
adapter.SelectCommand = selectCMD;  
  
// Add parameters and set values.  
selectCMD.Parameters.Add(  
  "@CountryRegion", OleDbType.VarChar, 15).Value = "UK";  
selectCMD.Parameters.Add(  
  "@City", OleDbType.VarChar, 15).Value = "London";  
  
DataSet customers = new DataSet();  
adapter.Fill(customers, "Customers");

Odbc パラメーター

' Assumes that connection is a valid OdbcConnection object.  
Dim adapter As OdbcDataAdapter = New OdbcDataAdapter  
  
Dim selectCMD AS OdbcCommand = New OdbcCommand(selectSQL, connection)  
adapter.SelectCommand = selectCMD  
  
' Add Parameters and set values.  
selectCMD.Parameters.Add("@CountryRegion", OdbcType.VarChar, 15).Value = "UK"  
selectCMD.Parameters.Add("@City", OdbcType.VarChar, 15).Value = "London"  
  
Dim customers As DataSet = New DataSet  
adapter.Fill(customers, "Customers")

// Assumes that connection is a valid OdbcConnection object.  
OdbcDataAdapter adapter = new OdbcDataAdapter();  
  
OdbcCommand selectCMD = new OdbcCommand(selectSQL, connection);  
adapter.SelectCommand = selectCMD;  
  
//Add Parameters and set values.  
selectCMD.Parameters.Add("@CountryRegion", OdbcType.VarChar, 15).Value = "UK";  
selectCMD.Parameters.Add("@City", OdbcType.VarChar, 15).Value = "London";  
  
DataSet customers = new DataSet();  
adapter.Fill(customers, "Customers");

Note

パラメーターにパラメーター名が指定されない場合、"Parameter1" から始まり数字が増分される既定名 ParameterNが割り当てられます。パラメーター名を指定するときには、ParameterN という名前付け規則を使用しないことをお勧めします。これは、指定した名前が ParameterCollection 内の既存の既定パラメーター名と競合しないようにするためです。指定した名前が既に存在する場合は、例外がスローされます。

DataAdapter パラメーター

Parameter.SourceColumn、Parameter.SourceVersion

SqlClient パラメーターの使用

OleDb パラメーターのプレースホルダー

OleDb の例

Odbc パラメーター

関連項目

その他のリソース