OracleCommandBuilder Class

Definition

Namespace:

System.Data.OracleClient

Assembly:

System.Data.OracleClient.dll

Caution

OracleCommandBuilder has been deprecated. http://go.microsoft.com/fwlink/?LinkID=144260

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

public ref class OracleCommandBuilder sealed : System::Data::Common::DbCommandBuilder

[System.Obsolete("OracleCommandBuilder has been deprecated. http://go.microsoft.com/fwlink/?LinkID=144260", false)]
public sealed class OracleCommandBuilder : System.Data.Common.DbCommandBuilder

[<System.Obsolete("OracleCommandBuilder has been deprecated. http://go.microsoft.com/fwlink/?LinkID=144260", false)>]
type OracleCommandBuilder = class
    inherit DbCommandBuilder

Public NotInheritable Class OracleCommandBuilder
Inherits DbCommandBuilder

Inheritance

Object

MarshalByRefObject

Component

DbCommandBuilder

OracleCommandBuilder

Attributes

ObsoleteAttribute

Examples

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.

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  

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;  
}  

Remarks

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.

Constructors

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

Properties

CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component)
CatalogLocation	Gets or sets the CatalogLocation for an instance of the DbCommandBuilder class.
CatalogSeparator	Gets or sets a string used as the catalog separator for an instance of the DbCommandBuilder class.
ConflictOption	Specifies which ConflictOption is to be used by the DbCommandBuilder. (Inherited from DbCommandBuilder)
Container	Gets the IContainer that contains the Component. (Inherited from Component)
DataAdapter	Gets or sets an OracleDataAdapter object for which this OracleCommandBuilder object will generate SQL statements.
DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component)
Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component)
QuotePrefix	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)
QuoteSuffix	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)
SchemaSeparator	Gets or sets the character to be used for the separator between the schema identifier and any other identifiers.
SetAllValues	Specifies whether all column values in an update statement are included or only changed ones. (Inherited from DbCommandBuilder)
Site	Gets or sets the ISite of the Component. (Inherited from Component)

Methods

ApplyParameterInfo(DbParameter, DataRow, StatementType, Boolean)	Allows the provider implementation of the DbCommandBuilder class to handle additional parameter properties. (Inherited from DbCommandBuilder)
CreateObjRef(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)
DeriveParameters(OracleCommand)	Retrieves parameter information from the stored procedure specified in the OracleCommand and populates the Parameters collection of the specified OracleCommand object.
Dispose()	Releases all resources used by the Component. (Inherited from Component)
Dispose(Boolean)	Releases the unmanaged resources used by the DbCommandBuilder and optionally releases the managed resources. (Inherited from DbCommandBuilder)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetDeleteCommand()	Gets the automatically generated OracleCommand object required to perform deletions on the database.
GetDeleteCommand(Boolean)	Gets the automatically generated OracleCommand object required to perform deletions on the database.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetInsertCommand()	Gets the automatically generated OracleCommand object required to perform insertions on the database.
GetInsertCommand(Boolean)	Gets the automatically generated OracleCommand object required to perform insertions on the database.
GetLifetimeService()	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
GetParameterName(Int32)	Returns the name of the specified parameter in the format of @p#. Use when building a custom command builder. (Inherited from DbCommandBuilder)
GetParameterName(String)	Returns the full parameter name, given the partial parameter name. (Inherited from DbCommandBuilder)
GetParameterPlaceholder(Int32)	Returns the placeholder for the parameter in the associated SQL statement. (Inherited from DbCommandBuilder)
GetSchemaTable(DbCommand)	Returns the schema table for the DbCommandBuilder. (Inherited from DbCommandBuilder)
GetService(Type)	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetUpdateCommand()	Gets the automatically generated OracleCommand object required to perform updates on the database.
GetUpdateCommand(Boolean)	Gets the automatically generated OracleCommand object required to perform updates on the database.
InitializeCommand(DbCommand)	Resets the CommandTimeout, Transaction, CommandType, and UpdateRowSource properties on the DbCommand. (Inherited from DbCommandBuilder)
InitializeLifetimeService()	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
QuoteIdentifier(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.
RefreshSchema()	Clears the commands associated with this DbCommandBuilder. (Inherited from DbCommandBuilder)
RowUpdatingHandler(RowUpdatingEventArgs)	Adds an event handler for the RowUpdating event. (Inherited from DbCommandBuilder)
SetRowUpdatingHandler(DbDataAdapter)	Registers the DbCommandBuilder to handle the RowUpdating event for a DbDataAdapter. (Inherited from DbCommandBuilder)
ToString()	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component)
UnquoteIdentifier(String)	Given a quoted identifier, returns the correct unquoted form of that identifier, including properly un-escaping any embedded quotes in the identifier.

Events

Disposed

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

See also

• Generating Commands with CommandBuilders