OracleCommandBuilder Class

OracleCommandBuilder Class

 
Note: This API is now obsolete.

Automatically generates single-table commands used to reconcile changes made to a DataSet with the associated database. This class cannot be inherited.

Namespace:   System.Data.OracleClient
Assembly:  System.Data.OracleClient (in System.Data.OracleClient.dll)

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Data.Common.DbCommandBuilder
        System.Data.OracleClient.OracleCommandBuilder

<ObsoleteAttribute("OracleCommandBuilder has been deprecated. http://go.microsoft.com/fwlink/?LinkID=144260",
	False)>
Public NotInheritable Class OracleCommandBuilder
	Inherits DbCommandBuilder

NameDescription
System_CAPS_pubmethodOracleCommandBuilder()

Initializes a new instance of the OracleCommandBuilder.

System_CAPS_pubmethodOracleCommandBuilder(OracleDataAdapter)

Initializes a new instance of the OracleCommandBuilder class with the associated OracleDataAdapter object.

NameDescription
System_CAPS_pubpropertyCatalogLocation

Sets or gets the CatalogLocation for an instance of the DbCommandBuilder class.(Overrides DbCommandBuilder.CatalogLocation.)

System_CAPS_pubpropertyCatalogSeparator

Sets or gets a string used as the catalog separator for an instance of the DbCommandBuilder class.(Overrides DbCommandBuilder.CatalogSeparator.)

System_CAPS_pubpropertyConflictOption

Specifies which ConflictOption is to be used by the DbCommandBuilder.(Inherited from DbCommandBuilder.)

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyDataAdapter

Gets or sets an OracleDataAdapter object for which this OracleCommandBuilder object will generate SQL statements.

System_CAPS_pubpropertyQuotePrefix

Gets or sets the beginning character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens.(Inherited from DbCommandBuilder.)

System_CAPS_pubpropertyQuoteSuffix

Gets or sets the ending character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens.(Inherited from DbCommandBuilder.)

System_CAPS_pubpropertySchemaSeparator

Gets or sets the character to be used for the separator between the schema identifier and any other identifiers.(Overrides DbCommandBuilder.SchemaSeparator.)

System_CAPS_pubpropertySetAllValues

Specifies whether all column values in an update statement are included or only changed ones.(Inherited from DbCommandBuilder.)

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

NameDescription
System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodSystem_CAPS_staticDeriveParameters(OracleCommand)

Retrieves parameter information from the stored procedure specified in the OracleCommand and populates the Parameters collection of the specified OracleCommand object.

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetDeleteCommand()

Gets the automatically generated OracleCommand object required to perform deletions on the database.

System_CAPS_pubmethodGetDeleteCommand(Boolean)

Gets the automatically generated OracleCommand object required to perform deletions on the database.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetInsertCommand()

Gets the automatically generated OracleCommand object required to perform insertions on the database.

System_CAPS_pubmethodGetInsertCommand(Boolean)

Gets the automatically generated OracleCommand object required to perform insertions on the database.

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetUpdateCommand()

Gets the automatically generated OracleCommand object required to perform updates on the database.

System_CAPS_pubmethodGetUpdateCommand(Boolean)

Gets the automatically generated OracleCommand object required to perform updates on the database.

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodQuoteIdentifier(String)

Given an unquoted identifier in the correct catalog case, returns the correct quoted form of that identifier, including properly escaping any embedded quotes in the identifier.(Overrides DbCommandBuilder.QuoteIdentifier(String).)

System_CAPS_pubmethodRefreshSchema()

Clears the commands associated with this DbCommandBuilder.(Inherited from DbCommandBuilder.)

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

System_CAPS_pubmethodUnquoteIdentifier(String)

Given a quoted identifier, returns the correct unquoted form of that identifier, including properly un-escaping any embedded quotes in the identifier.(Overrides DbCommandBuilder.UnquoteIdentifier(String).)

NameDescription
System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

This type is deprecated and will be removed in a future version of the .NET Framework. For more information, see Oracle and ADO.NET.

The OracleDataAdapter does not automatically generate the SQL statements required to reconcile changes made to a DataSet associated with the database. However, you can create an OracleCommandBuilder object that generates SQL statements for single-table updates by setting the SelectCommand property of the OracleDataAdapter. Then, the OracleCommandBuilder generates any additional SQL statements that you do not set.

The relationship between an OracleDataAdapter and its corresponding OracleCommandBuilder is always one-to-one. To create this correspondence, you set the OracleDataAdapter property of the OracleCommandBuilder object. This causes the OracleCommandBuilder to register itself as a listener, which produces the output of RowUpdating events that affect the DataSet.

To generate INSERT, UPDATE, or DELETE statements, the OracleCommandBuilder uses the SelectCommand property to retrieve a required set of metadata.

The OracleCommandBuilder also uses the Connection, and Transaction properties referenced by the SelectCommand.

If you call Dispose, the OracleCommandBuilder is disassociated from the OracleDataAdapter, and the generated commands are no longer used.

The following example uses OracleCommand, along with OracleDataAdapter and OracleConnection, to select rows from a database. The example is passed an initialized DataSet, a connection string, a query string that is an SQL SELECT statement, and a string that is the name of the database table. The example then creates an OracleCommandBuilder.

[Visual Basic]

Private Function SelectOracleRows(connection As String, queryString As String, tableName As String) As DataSet

   Dim connection As New OracleConnection(connection)
   Dim dataAdapter As New OracleDataAdapter()
   Dim dataSet As DataSet = New DataSet

   dataAdapter.SelectCommand = New OracleCommand(queryString, connection)

   Dim cmdBuilder As OracleCommandBuilder = New OracleCommandBuilder(dataAdapter)

   connection.Open()
   dataAdapter.Fill(dataSet, tableName)
      ' Code to modify data in DataSet here 
      ' Without the OracleCommandBuilder this line would fail.
   dataAdapter.Update(dataSet, tableName)
   connection.Close()
End Function

[C#]

public static DataSet SelectOracleSrvRows(string myConnection, string mySelectQuery, string myTableName)
{
   OracleConnection myConn = new OracleConnection(myConnection);
   OracleDataAdapter myDataAdapter = new OracleDataAdapter();
   myDataAdapter.SelectCommand = new OracleCommand(mySelectQuery, myConn);
   OracleCommandBuilder cb = new OracleCommandBuilder(myDataAdapter);

   myConn.Open();
   DataSet ds = new DataSet();
   myDataAdapter.Fill(ds, myTableName);

   //Code to modify data in DataSet goes here...

   //Without the OracleCommandBuilder this line would fail.
   myDataAdapter.Update(ds, myTableName);
   myConn.Close();
   return ds;
}

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft