KeyFields Property (BigcommerceCommandBuilder)

In This Topic

Gets or sets string containing list of key field names separated by semicolon. They are used to generate update commands.

Syntax

Visual Basic
C#

'Declaration
 
Public Shadows Property KeyFields As String

public new string KeyFields {get; set;}

Property Value

The string containing list of key field names separated by semicolon.

Remarks

This property is used when the ConflictOption property is set to OverwriteChanges, otherwise all columns will be used in the WHERE clause.

If KeyFields is nonempty, its value is used as the list of columns for the WHERE clause. If KeyFields is empty, the primary key columns are used.

Example

The following example demonstrates how UPDATE and DELETE statements are generated.

csharp

public void UseKeyFields(string connectionString) {

        BigcommerceConnection conn = new BigcommerceConnection(connectionString);
        conn.Open();

        BigcommerceDataAdapter adapter = new BigcommerceDataAdapter("SELECT * FROM customers", conn);
        BigcommerceCommandBuilder commBuilder = new BigcommerceCommandBuilder(adapter);

        commBuilder.ConflictOption = ConflictOption.OverwriteChanges;

        commBuilder.KeyFields = "id, lastname";

        string updateComm = commBuilder.GetUpdateCommand().CommandText;
        string deleteComm = commBuilder.GetDeleteCommand().CommandText;

        Console.WriteLine(updateComm);
        Console.WriteLine(deleteComm);
        conn.Close();
}

Visual Basic

Public Sub UseKeyFields(ByVal connectionString As String)
        Dim conn As BigcommerceConnection = New BigcommerceConnection(connectionString)
        conn.Open()

        Dim adapter As BigcommerceDataAdapter = New BigcommerceDataAdapter("SELECT * FROM customers", conn)
        Dim commBuilder As BigcommerceCommandBuilder = New BigcommerceCommandBuilder(adapter)

        commBuilder.ConflictOption = ConflictOption.OverwriteChanges

        commBuilder.KeyFields = "id, lastname"

        Dim updateComm As String = commBuilder.GetUpdateCommand().CommandText
        Dim deleteComm As String = commBuilder.GetDeleteCommand().CommandText

        Console.WriteLine(updateComm)
        Console.WriteLine(deleteComm)
        conn.Close()
End Sub

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

BigcommerceCommandBuilder Class
BigcommerceCommandBuilder Members

Send Feedback