4 // Part of the Mono class libraries at
5 // mcs/class/System.Data.OracleClient/System.Data.OracleClient
7 // Assembly: System.Data.OracleClient.dll
8 // Namespace: System.Data.OracleClient
11 // Daniel Morgan <danielmorgan@verizon.net>
12 // Tim Coleman <tim@timcoleman.com>
14 // Copyright (C) Daniel Morgan, 2002, 2004-2005
15 // Copyright (C) Tim Coleman , 2003
17 // Licensed under the MIT/X11 License.
21 using System.ComponentModel;
23 using System.Data.OracleClient.Oci;
24 using System.Drawing.Design;
27 namespace System.Data.OracleClient {
28 [Designer ("Microsoft.VSDesigner.Data.VS.OracleCommandDesigner, " + Consts.AssemblyMicrosoft_VSDesigner)]
30 public sealed class OracleCommand : Component, ICloneable, IDbCommand
34 CommandBehavior behavior;
36 CommandType commandType;
37 OracleConnection connection;
38 bool designTimeVisible;
39 OracleParameterCollection parameters;
40 OracleTransaction transaction;
41 UpdateRowSource updatedRowSource;
43 private OciStatementHandle preparedStatement;
44 OciStatementType statementType;
50 public OracleCommand ()
51 : this (String.Empty, null, null)
55 public OracleCommand (string commandText)
56 : this (commandText, null, null)
60 public OracleCommand (string commandText, OracleConnection connection)
61 : this (commandText, connection, null)
65 public OracleCommand (string commandText, OracleConnection connection, OracleTransaction tx)
67 preparedStatement = null;
68 CommandText = commandText;
69 Connection = connection;
71 CommandType = CommandType.Text;
72 UpdatedRowSource = UpdateRowSource.Both;
73 DesignTimeVisible = false;
75 parameters = new OracleParameterCollection (this);
78 #endregion // Constructors
83 [RefreshProperties (RefreshProperties.All)]
84 [Editor ("Microsoft.VSDesigner.Data.Oracle.Design.OracleCommandTextEditor, " + Consts.AssemblyMicrosoft_VSDesigner, typeof(UITypeEditor))]
85 public string CommandText {
86 get { return commandText; }
87 set { commandText = value; }
90 [RefreshProperties (RefreshProperties.All)]
91 [DefaultValue (CommandType.Text)]
92 public CommandType CommandType {
93 get { return commandType; }
95 if (value == CommandType.TableDirect)
96 throw new ArgumentException ("OracleClient provider does not support TableDirect CommandType.");
101 [DefaultValue (null)]
102 [Editor ("Microsoft.VSDesigner.Data.Design.DbConnectionEditor, " + Consts.AssemblyMicrosoft_VSDesigner, typeof(UITypeEditor))]
103 public OracleConnection Connection {
104 get { return connection; }
105 set { connection = value; }
108 [DefaultValue (true)]
111 public bool DesignTimeVisible {
112 get { return designTimeVisible; }
113 set { designTimeVisible = value; }
116 internal OciEnvironmentHandle Environment {
117 get { return Connection.Environment; }
120 internal OciErrorHandle ErrorHandle {
121 get { return Connection.ErrorHandle; }
124 int IDbCommand.CommandTimeout {
129 [Editor ("Microsoft.VSDesigner.Data.Design.DbConnectionEditor, " + Consts.AssemblyMicrosoft_VSDesigner, typeof(UITypeEditor))]
130 [DefaultValue (null)]
131 IDbConnection IDbCommand.Connection {
132 get { return Connection; }
134 if (!(value is OracleConnection))
135 throw new InvalidCastException ("The value was not a valid OracleConnection.");
136 Connection = (OracleConnection) value;
140 IDataParameterCollection IDbCommand.Parameters {
141 get { return Parameters; }
144 IDbTransaction IDbCommand.Transaction {
145 get { return Transaction; }
147 if (!(value is OracleTransaction))
148 throw new ArgumentException ();
149 Transaction = (OracleTransaction) value;
153 [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
154 public OracleParameterCollection Parameters {
155 get { return parameters; }
159 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
160 public OracleTransaction Transaction {
161 get { return transaction; }
162 set { transaction = value; }
165 [DefaultValue (UpdateRowSource.Both)]
166 public UpdateRowSource UpdatedRowSource {
167 get { return updatedRowSource; }
168 set { updatedRowSource = value; }
175 private void AssertCommandTextIsSet ()
177 if (CommandText == String.Empty || CommandText == null)
178 throw new InvalidOperationException ("The command text for this Command has not been set.");
181 private void AssertConnectionIsOpen ()
183 if (Connection == null || Connection.State == ConnectionState.Closed)
184 throw new InvalidOperationException ("An open Connection object is required to continue.");
187 private void AssertNoDataReader ()
189 if (Connection.DataReader != null)
190 throw new InvalidOperationException ("There is already an open DataReader associated with this Connection which must be closed first.");
193 private void AssertTransactionMatch ()
195 if (Connection.Transaction != null && Transaction != Connection.Transaction)
196 throw new InvalidOperationException ("Execute requires the Command object to have a Transaction object when the Connection object assigned to the command is in a pending local transaction. The Transaction property of the Command has not been initialized.");
199 private void BindParameters (OciStatementHandle statement)
201 foreach (OracleParameter p in Parameters)
202 p.Bind (statement, Connection);
206 public void Cancel ()
208 throw new NotImplementedException ();
212 public object Clone ()
214 // create a new OracleCommand object with the same properties
216 OracleCommand cmd = new OracleCommand ();
218 cmd.CommandText = this.CommandText;
219 cmd.CommandType = this.CommandType;
221 // FIXME: not sure if I should set the same object here
222 // or get a clone of these too
223 cmd.Connection = this.Connection;
224 cmd.Transaction = this.Transaction;
226 foreach (OracleParameter parm in this.Parameters) {
228 OracleParameter newParm = cmd.CreateParameter ();
230 newParm.DbType = parm.DbType;
231 newParm.Direction = parm.Direction;
232 newParm.IsNullable = parm.IsNullable;
233 newParm.Offset = parm.Offset;
234 newParm.OracleType = parm.OracleType;
235 newParm.ParameterName = parm.ParameterName;
236 newParm.Precision = parm.Precision;
237 newParm.Scale = parm.Scale;
238 newParm.SourceColumn = parm.SourceColumn;
239 newParm.SourceVersion = parm.SourceVersion;
240 newParm.Value = parm.Value;
242 cmd.Parameters.Add (newParm);
245 //cmd.Container = this.Container;
246 cmd.DesignTimeVisible = this.DesignTimeVisible;
247 //cmd.DesignMode = this.DesignMode;
248 cmd.Site = this.Site;
249 //cmd.UpdateRowSource = this.UpdateRowSource;
254 internal void CloseDataReader ()
256 Connection.DataReader = null;
257 if ((behavior & CommandBehavior.CloseConnection) != 0)
261 public OracleParameter CreateParameter ()
263 return new OracleParameter ();
266 private int ExecuteNonQueryInternal (OciStatementHandle statement, bool useAutoCommit)
268 if (preparedStatement == null)
269 PrepareStatement (statement);
271 bool isNonQuery = IsNonQuery (statement);
273 BindParameters (statement);
274 if (isNonQuery == true)
275 statement.ExecuteNonQuery (useAutoCommit);
277 statement.ExecuteQuery ();
279 int rowsAffected = statement.GetAttributeInt32 (OciAttributeType.RowCount, ErrorHandle);
284 public int ExecuteNonQuery ()
286 AssertConnectionIsOpen ();
287 AssertTransactionMatch ();
288 AssertCommandTextIsSet ();
289 bool useAutoCommit = false;
291 if (Transaction != null)
292 Transaction.AttachToServiceContext ();
294 useAutoCommit = true;
296 OciStatementHandle statement = GetStatementHandle ();
298 return ExecuteNonQueryInternal (statement, useAutoCommit);
301 SafeDisposeHandle (statement);
305 public int ExecuteOracleNonQuery (out OracleString rowid)
307 AssertConnectionIsOpen ();
308 AssertTransactionMatch ();
309 AssertCommandTextIsSet ();
310 bool useAutoCommit = false;
312 if (Transaction != null)
313 Transaction.AttachToServiceContext ();
315 useAutoCommit = true;
317 OciStatementHandle statement = GetStatementHandle ();
320 int retval = ExecuteNonQueryInternal (statement, useAutoCommit);
322 OciRowIdDescriptor descriptor = (OciRowIdDescriptor) Environment.Allocate (OciHandleType.RowId);
323 descriptor.SetHandle (statement.GetAttributeIntPtr (OciAttributeType.RowId, ErrorHandle));
325 rowid = new OracleString (descriptor.GetRowId (ErrorHandle));
330 SafeDisposeHandle (statement);
335 public object ExecuteOracleScalar ()
337 object output = DBNull.Value;
339 AssertConnectionIsOpen ();
340 AssertTransactionMatch ();
341 AssertCommandTextIsSet ();
343 if (Transaction != null)
344 Transaction.AttachToServiceContext ();
346 OciStatementHandle statement = GetStatementHandle ();
348 if (preparedStatement == null)
349 PrepareStatement (statement);
351 bool isNonQuery = IsNonQuery (statement);
353 BindParameters (statement);
355 if (isNonQuery == true)
356 ExecuteNonQueryInternal (statement, false);
358 statement.ExecuteQuery ();
360 if (statement.Fetch ()) {
361 OciDefineHandle defineHandle = (OciDefineHandle) statement.Values [0];
362 if (!defineHandle.IsNull)
363 output = defineHandle.GetOracleValue ();
364 switch (defineHandle.DataType) {
365 case OciDataType.Blob:
366 case OciDataType.Clob:
367 ((OracleLob) output).connection = Connection;
376 SafeDisposeHandle (statement);
380 private bool IsNonQuery (OciStatementHandle statementHandle)
\r
382 // assumes Prepare() has been called prior to calling this function
384 OciStatementType statementType = statementHandle.GetStatementType ();
385 if (statementType.Equals (OciStatementType.Select))
391 public OracleDataReader ExecuteReader ()
393 return ExecuteReader (CommandBehavior.Default);
396 public OracleDataReader ExecuteReader (CommandBehavior behavior)
398 AssertConnectionIsOpen ();
399 AssertTransactionMatch ();
400 AssertCommandTextIsSet ();
401 AssertNoDataReader ();
402 bool hasRows = false;
404 this.behavior = behavior;
406 if (Transaction != null)
407 Transaction.AttachToServiceContext ();
409 OciStatementHandle statement = GetStatementHandle ();
410 OracleDataReader rd = null;
413 if (preparedStatement == null)
414 PrepareStatement (statement);
416 preparedStatement = null; // OracleDataReader releases the statement handle
418 bool isNonQuery = IsNonQuery (statement);
420 BindParameters (statement);
423 ExecuteNonQueryInternal (statement, false);
425 hasRows = statement.ExecuteQuery ();
427 rd = new OracleDataReader (this, statement, hasRows);
430 if (statement != null && rd == null)
437 public object ExecuteScalar ()
439 object output = DBNull.Value;
441 AssertConnectionIsOpen ();
442 AssertTransactionMatch ();
443 AssertCommandTextIsSet ();
445 if (Transaction != null)
446 Transaction.AttachToServiceContext ();
448 OciStatementHandle statement = GetStatementHandle ();
450 if (preparedStatement == null)
451 PrepareStatement (statement);
453 bool isNonQuery = IsNonQuery (statement);
455 BindParameters (statement);
457 if (isNonQuery == true)
458 ExecuteNonQueryInternal (statement, false);
460 statement.ExecuteQuery ();
462 if (statement.Fetch ()) {
463 OciDefineHandle defineHandle = (OciDefineHandle) statement.Values [0];
464 if (defineHandle.IsNull)
465 output = DBNull.Value;
467 switch (defineHandle.DataType) {
468 case OciDataType.Blob:
469 case OciDataType.Clob:
470 OracleLob lob = (OracleLob) defineHandle.GetValue ();
471 lob.connection = Connection;
476 output = defineHandle.GetValue ();
482 output = DBNull.Value;
486 SafeDisposeHandle (statement);
492 private OciStatementHandle GetStatementHandle ()
494 AssertConnectionIsOpen ();
495 if (preparedStatement != null)
496 return preparedStatement;
498 OciStatementHandle h = (OciStatementHandle) Connection.Environment.Allocate (OciHandleType.Statement);
499 h.ErrorHandle = Connection.ErrorHandle;
500 h.Service = Connection.ServiceContext;
505 private void SafeDisposeHandle (OciStatementHandle h)
507 if (h != null && h != preparedStatement)
511 IDbDataParameter IDbCommand.CreateParameter ()
513 return CreateParameter ();
516 IDataReader IDbCommand.ExecuteReader ()
518 return ExecuteReader ();
521 IDataReader IDbCommand.ExecuteReader (CommandBehavior behavior)
523 return ExecuteReader (behavior);
526 void PrepareStatement (OciStatementHandle statement)
528 if (commandType == CommandType.StoredProcedure) {
529 StringBuilder sb = new StringBuilder ();
530 if (Parameters.Count > 0)
\r
531 foreach (OracleParameter parm in Parameters) {
\r
534 sb.Append (":" + parm.ParameterName);
\r
537 string sql = "call " + commandText + "(" + sb.ToString() + ")";
\r
538 statement.Prepare (sql);
541 statement.Prepare (commandText);
544 public void Prepare ()
546 AssertConnectionIsOpen ();
547 OciStatementHandle statement = GetStatementHandle ();
548 PrepareStatement (statement);
549 preparedStatement = statement;
552 #endregion // Methods