Merge branch 'master' of github.com:tgiphil/mono
[mono.git] / mcs / class / System.Data / System.Data.SqlClient / SqlCommand.cs
1 //
2 // System.Data.SqlClient.SqlCommand.cs
3 //
4 // Author:
5 //   Rodrigo Moya (rodrigo@ximian.com)
6 //   Daniel Morgan (danmorg@sc.rr.com)
7 //   Tim Coleman (tim@timcoleman.com)
8 //   Diego Caravana (diego@toth.it)
9 //
10 // (C) Ximian, Inc 2002 http://www.ximian.com/
11 // (C) Daniel Morgan, 2002
12 // Copyright (C) Tim Coleman, 2002
13 //
14
15 //
16 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
17 //
18 // Permission is hereby granted, free of charge, to any person obtaining
19 // a copy of this software and associated documentation files (the
20 // "Software"), to deal in the Software without restriction, including
21 // without limitation the rights to use, copy, modify, merge, publish,
22 // distribute, sublicense, and/or sell copies of the Software, and to
23 // permit persons to whom the Software is furnished to do so, subject to
24 // the following conditions:
25 // 
26 // The above copyright notice and this permission notice shall be
27 // included in all copies or substantial portions of the Software.
28 // 
29 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
33 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
34 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
35 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
36 //
37
38 using Mono.Data.Tds;
39 using Mono.Data.Tds.Protocol;
40 using System;
41 using System.IO;
42 using System.Collections;
43 using System.Collections.Specialized;
44 using System.ComponentModel;
45 using System.Data;
46 using System.Data.Common;
47 #if NET_2_0
48 using System.Data.Sql;
49 #endif
50 using System.Runtime.InteropServices;
51 using System.Text;
52 using System.Xml;
53
54 namespace System.Data.SqlClient {
55         [DesignerAttribute ("Microsoft.VSDesigner.Data.VS.SqlCommandDesigner, "+ Consts.AssemblyMicrosoft_VSDesigner, "System.ComponentModel.Design.IDesigner")]
56         [ToolboxItemAttribute ("System.Drawing.Design.ToolboxItem, "+ Consts.AssemblySystem_Drawing)]
57 #if NET_2_0
58         [DefaultEventAttribute ("RecordsAffected")]
59         public sealed class SqlCommand : DbCommand, IDbCommand, ICloneable
60 #else
61         public sealed class SqlCommand : Component, IDbCommand, ICloneable
62 #endif // NET_2_0
63         {
64                 #region Fields
65
66                 const int DEFAULT_COMMAND_TIMEOUT = 30;
67
68                 int commandTimeout;
69                 bool designTimeVisible;
70                 string commandText;
71                 CommandType commandType;
72                 SqlConnection connection;
73                 SqlTransaction transaction;
74                 UpdateRowSource updatedRowSource;
75                 CommandBehavior behavior = CommandBehavior.Default;
76                 SqlParameterCollection parameters;
77                 string preparedStatement;
78 #if NET_2_0
79                 bool disposed;
80                 SqlNotificationRequest notification;
81                 bool notificationAutoEnlist;
82 #endif
83
84                 #endregion // Fields
85
86                 #region Constructors
87
88                 public SqlCommand() 
89                         : this (String.Empty, null, null)
90                 {
91                 }
92
93                 public SqlCommand (string cmdText)
94                         : this (cmdText, null, null)
95                 {
96                 }
97
98                 public SqlCommand (string cmdText, SqlConnection connection)
99                         : this (cmdText, connection, null)
100                 {
101                 }
102
103                 public SqlCommand (string cmdText, SqlConnection connection, SqlTransaction transaction) 
104                 {
105                         this.commandText = cmdText;
106                         this.connection = connection;
107                         this.transaction = transaction;
108                         this.commandType = CommandType.Text;
109                         this.updatedRowSource = UpdateRowSource.Both;
110
111                         this.commandTimeout = DEFAULT_COMMAND_TIMEOUT;
112 #if NET_2_0
113                         notificationAutoEnlist = true;
114 #endif
115                         designTimeVisible = true;
116                         parameters = new SqlParameterCollection (this);
117                 }
118
119                 private SqlCommand(string commandText, SqlConnection connection, SqlTransaction transaction, CommandType commandType, UpdateRowSource updatedRowSource, bool designTimeVisible, int commandTimeout, SqlParameterCollection parameters)
120                 {
121                         this.commandText = commandText;
122                         this.connection = connection;
123                         this.transaction = transaction;
124                         this.commandType = commandType;
125                         this.updatedRowSource = updatedRowSource;
126                         this.designTimeVisible = designTimeVisible;
127                         this.commandTimeout = commandTimeout;
128                         this.parameters = new SqlParameterCollection(this);
129                         for (int i = 0;i < parameters.Count;i++)
130                                 this.parameters.Add(((ICloneable)parameters[i]).Clone());
131                 }
132
133                 #endregion // Constructors
134
135                 #region Properties
136
137                 internal CommandBehavior CommandBehavior {
138                         get { return behavior; }
139                 }
140
141 #if !NET_2_0
142                 [DataSysDescription ("Command text to execute.")]
143 #endif
144                 [DefaultValue ("")]
145                 [EditorAttribute ("Microsoft.VSDesigner.Data.SQL.Design.SqlCommandTextEditor, "+ Consts.AssemblyMicrosoft_VSDesigner, "System.Drawing.Design.UITypeEditor, "+ Consts.AssemblySystem_Drawing )]
146                 [RefreshProperties (RefreshProperties.All)]
147                 public
148 #if NET_2_0
149                 override
150 #endif //NET_2_0
151                 string CommandText {
152                         get {
153                                 if (commandText == null)
154                                         return string.Empty;
155                                 return commandText;
156                         }
157                         set {
158                                 if (value != commandText && preparedStatement != null)
159                                         Unprepare ();
160                                 commandText = value;
161                         }
162                 }
163
164 #if !NET_2_0
165                 [DataSysDescription ("Time to wait for command to execute.")]
166                 [DefaultValue (DEFAULT_COMMAND_TIMEOUT)]
167 #endif
168                 public
169 #if NET_2_0
170                 override
171 #endif //NET_2_0
172                 int CommandTimeout {
173                         get { return commandTimeout; }
174                         set { 
175                                 if (value < 0)
176 #if NET_2_0
177                                         throw new ArgumentException ("The property value assigned is less than 0.",
178                                                 "CommandTimeout");
179 #else
180                                         throw new ArgumentException ("The property value assigned is less than 0.");
181 #endif
182                                 commandTimeout = value; 
183                         }
184                 }
185
186 #if !NET_2_0
187                 [DataSysDescription ("How to interpret the CommandText.")]
188 #endif
189                 [DefaultValue (CommandType.Text)]
190                 [RefreshProperties (RefreshProperties.All)]
191                 public
192 #if NET_2_0
193                 override
194 #endif //NET_2_0
195                 CommandType CommandType {
196                         get { return commandType; }
197                         set { 
198                                 if (value == CommandType.TableDirect)
199 #if NET_2_0
200                                         throw new ArgumentOutOfRangeException ("CommandType.TableDirect is not supported " +
201                                                 "by the Mono SqlClient Data Provider.");
202 #else
203                                         throw new ArgumentException ("CommandType.TableDirect is not supported by the Mono SqlClient Data Provider.");
204 #endif
205
206                                 ExceptionHelper.CheckEnumValue (typeof (CommandType), value);
207                                 commandType = value; 
208                         }
209                 }
210
211                 [DefaultValue (null)]
212 #if !NET_2_0
213                 [DataSysDescription ("Connection used by the command.")]
214 #endif
215                 [EditorAttribute ("Microsoft.VSDesigner.Data.Design.DbConnectionEditor, "+ Consts.AssemblyMicrosoft_VSDesigner, "System.Drawing.Design.UITypeEditor, "+ Consts.AssemblySystem_Drawing )]                
216                 public
217 #if NET_2_0
218                 new
219 #endif //NET_2_0
220                 SqlConnection Connection {
221                         get { return connection; }
222                         set
223                         {
224 #if ONLY_1_1
225                                 if (connection != null && connection.DataReader != null)
226                                         throw new InvalidOperationException ("The connection is busy fetching data.");
227 #endif
228                                 connection = value;
229                         }
230                 }
231
232                 [Browsable (false)]
233                 [DefaultValue (true)]
234                 [DesignOnly (true)]
235 #if NET_2_0
236                 [EditorBrowsable (EditorBrowsableState.Never)]
237 #endif
238                 public
239 #if NET_2_0
240                 override
241 #endif //NET_2_0
242                 bool DesignTimeVisible {
243                         get { return designTimeVisible; } 
244                         set { designTimeVisible = value; }
245                 }
246
247 #if !NET_2_0
248                 [DataSysDescription ("The parameters collection.")]
249 #endif
250                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Content)]
251                 public
252 #if NET_2_0
253                 new
254 #endif //NET_2_0
255                 SqlParameterCollection Parameters {
256                         get { return parameters; }
257                 }
258
259                 internal Tds Tds {
260                         get { return Connection.Tds; }
261                 }
262
263 #if !NET_2_0
264                 IDbConnection IDbCommand.Connection {
265                         get { return Connection; }
266                         set { 
267                                 if (!(value == null || value is SqlConnection))
268                                         throw new InvalidCastException ("The value was not a valid SqlConnection.");
269                                 Connection = (SqlConnection) value;
270                         }
271                 }
272
273                 IDataParameterCollection IDbCommand.Parameters {
274                         get { return Parameters; }
275                 }
276
277                 IDbTransaction IDbCommand.Transaction {
278                         get { return Transaction; }
279                         set {
280                                 if (!(value == null || value is SqlTransaction))
281                                         throw new ArgumentException ();
282                                 Transaction = (SqlTransaction) value; 
283                         }
284                 }
285 #endif
286
287                 [Browsable (false)]
288 #if !NET_2_0
289                 [DataSysDescription ("The transaction used by the command.")]
290 #endif
291                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
292                 public new SqlTransaction Transaction {
293                         get {
294                                 if (transaction != null && !transaction.IsOpen)
295                                         transaction = null;
296                                 return transaction;
297                         }
298                         set
299                         {
300 #if ONLY_1_1
301                                 if (connection != null && connection.DataReader != null)
302                                         throw new InvalidOperationException ("The connection is busy fetching data.");
303 #endif
304                                 transaction = value;
305                         }
306                 }
307
308 #if !NET_2_0
309                 [DataSysDescription ("When used by a DataAdapter.Update, how command results are applied to the current DataRow.")]
310 #endif
311                 [DefaultValue (UpdateRowSource.Both)]
312                 public
313 #if NET_2_0
314                 override
315 #endif // NET_2_0
316                 UpdateRowSource UpdatedRowSource {
317                         get { return updatedRowSource; }
318                         set {
319                                 ExceptionHelper.CheckEnumValue (typeof (UpdateRowSource), value);
320                                 updatedRowSource = value;
321                         }
322                 }
323
324 #if NET_2_0
325                 [Browsable (false)]
326                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
327                 public SqlNotificationRequest Notification {
328                         get { return notification; }
329                         set { notification = value; }
330                 }
331
332                 [DefaultValue (true)]
333                 public bool NotificationAutoEnlist {
334                         get { return notificationAutoEnlist; }
335                         set { notificationAutoEnlist = value; }
336                 }
337 #endif
338                 #endregion // Fields
339
340                 #region Methods
341
342                 public
343 #if NET_2_0
344                 override
345 #endif // NET_2_0
346                 void Cancel ()
347                 {
348                         if (Connection == null || Connection.Tds == null)
349                                 return;
350                         Connection.Tds.Cancel ();
351                 }
352
353 #if NET_2_0
354                 public SqlCommand Clone ()
355                 {
356                         return new SqlCommand (commandText, connection, transaction, commandType, updatedRowSource, designTimeVisible, commandTimeout, parameters);
357                 }
358 #endif // NET_2_0
359
360                 internal void CloseDataReader ()
361                 {
362                         if (Connection != null) {
363                                 Connection.DataReader = null;
364
365                                 if ((behavior & CommandBehavior.CloseConnection) != 0)
366                                         Connection.Close ();
367
368                                 if (Tds != null)
369                                         Tds.SequentialAccess = false;
370                         }
371
372                         // Reset the behavior
373                         behavior = CommandBehavior.Default;
374                 }
375
376                 public new SqlParameter CreateParameter ()
377                 {
378                         return new SqlParameter ();
379                 }
380
381                 private string EscapeProcName (string name, bool schema)
382                 {
383                         string procName;
384                         string tmpProcName = name.Trim ();
385                         int procNameLen = tmpProcName.Length;
386                         char[] brkts = new char [] {'[', ']'};
387                         bool foundMatching = false;
388                         int start = 0, count = procNameLen;
389                         int sindex = -1, eindex = -1;
390                         
391                         // We try to match most of the "brackets" combination here, however
392                         // there could be other combinations that may generate a different type
393                         // of exception in MS.NET
394                         
395                         if (procNameLen > 1) {
396                                 if ((sindex = tmpProcName.IndexOf ('[')) <= 0)
397                                         foundMatching = true;
398                                 else
399                                         foundMatching = false;
400                         
401                                 if (foundMatching == true && sindex > -1) {
402                                         eindex = tmpProcName.IndexOf (']');
403                                         if (sindex > eindex && eindex != -1) {
404                                                 foundMatching = false;
405                                         } else if (eindex == procNameLen-1) {
406                                                 if (tmpProcName.IndexOfAny (brkts, 1, procNameLen-2) != -1) {
407                                                         foundMatching = false;
408                                                 } else {
409                                                         start = 1;
410                                                         count = procNameLen - 2;
411                                                 }
412                                         } else if (eindex == -1 && schema) {
413                                                 foundMatching = true;
414                                         } else {
415                                                 foundMatching = false;
416                                         }
417                                 }
418                         
419                                 if (foundMatching)
420                                         procName = tmpProcName.Substring (start, count);
421                                 else
422                                         throw new ArgumentException (String.Format ("SqlCommand.CommandText property value is an invalid multipart name {0}, incorrect usage of quotes", CommandText));
423                         } else {
424                                 procName = tmpProcName;
425                         }
426                         
427                         return procName;
428                 }
429                 internal void DeriveParameters ()
430                 {
431                         if (commandType != CommandType.StoredProcedure)
432                                 throw new InvalidOperationException (String.Format ("SqlCommand DeriveParameters only supports CommandType.StoredProcedure, not CommandType.{0}", commandType));
433                         ValidateCommand ("DeriveParameters", false);
434
435                         string procName = CommandText;
436                         string schemaName = String.Empty;
437                         int dotPosition = procName.IndexOf ('.');
438                         if (dotPosition >= 0) {
439                                 schemaName = procName.Substring (0, dotPosition);
440                                 procName = procName.Substring (dotPosition + 1);
441                         }
442                         
443                         procName = EscapeProcName (procName, false);
444                         schemaName = EscapeProcName (schemaName, true);
445                         
446                         SqlParameterCollection localParameters = new SqlParameterCollection (this);
447                         localParameters.Add ("@procedure_name", SqlDbType.NVarChar, procName.Length).Value = procName;
448                         if (schemaName.Length > 0)
449                                 localParameters.Add ("@procedure_schema", SqlDbType.NVarChar, schemaName.Length).Value = schemaName;
450                         
451                         string sql = "sp_procedure_params_rowset";
452
453                         try {
454                                 Connection.Tds.ExecProc (sql, localParameters.MetaParameters, 0, true);
455                         } catch (TdsTimeoutException ex) {
456                                 Connection.Tds.Reset ();
457                                 throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
458                         } catch (TdsInternalException ex) {
459                                 Connection.Close ();
460                                 throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
461                         }
462
463                         SqlDataReader reader = new SqlDataReader (this);
464                         parameters.Clear ();
465                         object[] dbValues = new object[reader.FieldCount];
466
467                         while (reader.Read ()) {
468                                 reader.GetValues (dbValues);
469                                 parameters.Add (new SqlParameter (dbValues));
470                         }
471                         reader.Close ();
472
473                         if (parameters.Count == 0)
474                                 throw new InvalidOperationException ("Stored procedure '" + procName + "' does not exist.");
475                 }
476
477                 private void Execute (bool wantResults)
478                 {
479                         int index = 0;
480                         Connection.Tds.RecordsAffected = -1;
481                         TdsMetaParameterCollection parms = Parameters.MetaParameters;
482                         foreach (TdsMetaParameter param in parms) {
483                                 param.Validate (index++);
484                         }
485
486                         if (preparedStatement == null) {
487                                 bool schemaOnly = ((behavior & CommandBehavior.SchemaOnly) > 0);
488                                 bool keyInfo = ((behavior & CommandBehavior.KeyInfo) > 0);
489
490                                 StringBuilder sql1 = new StringBuilder ();
491                                 StringBuilder sql2 = new StringBuilder ();
492
493                                 if (schemaOnly || keyInfo)
494                                         sql1.Append ("SET FMTONLY OFF;");
495                                 if (keyInfo) {
496                                         sql1.Append ("SET NO_BROWSETABLE ON;");
497                                         sql2.Append ("SET NO_BROWSETABLE OFF;");
498                                 }
499                                 if (schemaOnly) {
500                                         sql1.Append ("SET FMTONLY ON;");
501                                         sql2.Append ("SET FMTONLY OFF;");
502                                 }
503                                 
504                                 switch (CommandType) {
505                                 case CommandType.StoredProcedure:
506                                         try {
507                                                 if (keyInfo || schemaOnly)
508                                                         Connection.Tds.Execute (sql1.ToString ());
509                                                 Connection.Tds.ExecProc (CommandText, parms, CommandTimeout, wantResults);
510                                                 if (keyInfo || schemaOnly)
511                                                         Connection.Tds.Execute (sql2.ToString ());
512                                         } catch (TdsTimeoutException ex) {
513                                                 // If it is a timeout exception there can be many reasons:
514                                                 // 1) Network is down/server is down/not reachable
515                                                 // 2) Somebody has an exclusive lock on Table/DB
516                                                 // In any of these cases, don't close the connection. Let the user do it
517                                                 Connection.Tds.Reset ();
518                                                 throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
519                                         } catch (TdsInternalException ex) {
520                                                 Connection.Close ();
521                                                 throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
522                                         }
523                                         break;
524                                 case CommandType.Text:
525                                         string sql;
526                                         if (sql2.Length > 0) {
527                                                 sql = String.Format ("{0}{1};{2}", sql1.ToString (), CommandText, sql2.ToString ());
528                                         } else {
529                                                 sql = String.Format ("{0}{1}", sql1.ToString (), CommandText);
530                                         }
531                                         try {
532                                                 Connection.Tds.Execute (sql, parms, CommandTimeout, wantResults);
533                                         } catch (TdsTimeoutException ex) {
534                                                 Connection.Tds.Reset ();
535                                                 throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
536                                         } catch (TdsInternalException ex) {
537                                                 Connection.Close ();
538                                                 throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
539                                         }
540                                         break;
541                                 }
542                         }
543                         else {
544                                 try {
545                                         Connection.Tds.ExecPrepared (preparedStatement, parms, CommandTimeout, wantResults);
546                                 } catch (TdsTimeoutException ex) {
547                                         Connection.Tds.Reset ();
548                                         throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
549                                 } catch (TdsInternalException ex) {
550                                         Connection.Close ();
551                                         throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
552                                 }
553                         }
554                 }
555
556                 public
557 #if NET_2_0
558                 override
559 #endif // NET_2_0
560                 int ExecuteNonQuery ()
561                 {
562                         ValidateCommand ("ExecuteNonQuery", false);
563                         int result = 0;
564                         behavior = CommandBehavior.Default;
565
566                         try {
567                                 Execute (false);
568                                 result = Connection.Tds.RecordsAffected;
569                         } catch (TdsTimeoutException e) {
570                                 Connection.Tds.Reset ();
571                                 throw SqlException.FromTdsInternalException ((TdsInternalException) e);
572                         }
573
574                         GetOutputParameters ();
575                         return result;
576                 }
577
578                 public new SqlDataReader ExecuteReader ()
579                 {
580                         return ExecuteReader (CommandBehavior.Default);
581                 }
582
583                 public new SqlDataReader ExecuteReader (CommandBehavior behavior)
584                 {
585                         ValidateCommand ("ExecuteReader", false);
586                         if ((behavior & CommandBehavior.SingleRow) != 0)
587                                 behavior |= CommandBehavior.SingleResult;
588                         this.behavior = behavior;
589                         if ((behavior & CommandBehavior.SequentialAccess) != 0)
590                                 Tds.SequentialAccess = true;
591                         try {
592                                 Execute (true);
593                                 Connection.DataReader = new SqlDataReader (this);
594                                 return Connection.DataReader;
595                         } catch {
596                                 if ((behavior & CommandBehavior.CloseConnection) != 0)
597                                         Connection.Close ();
598                                 throw;
599                         }
600                 }
601
602                 public
603 #if NET_2_0
604                 override
605 #endif // NET_2_0
606                 object ExecuteScalar ()
607                 {
608                         try {
609                                 object result = null;
610 #if NET_2_0
611                                 ValidateCommand ("ExecuteScalar", false);
612 #else
613                                 ValidateCommand ("ExecuteReader", false);
614 #endif
615                                 behavior = CommandBehavior.Default;
616                                 Execute (true);
617
618                                 try {
619                                         if (Connection.Tds.NextResult () && Connection.Tds.NextRow ())
620                                                 result = Connection.Tds.ColumnValues[0];
621
622                                         if (commandType == CommandType.StoredProcedure) {
623                                                 Connection.Tds.SkipToEnd ();
624                                                 GetOutputParameters ();
625                                         }
626                                 } catch (TdsTimeoutException ex) {
627                                         Connection.Tds.Reset ();
628                                         throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
629                                 } catch (TdsInternalException ex) {
630                                         Connection.Close ();
631                                         throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
632                                 }
633
634                                 return result;
635                         } finally {
636                                 CloseDataReader ();
637                         }
638                 }
639
640                 public XmlReader ExecuteXmlReader ()
641                 {
642                         ValidateCommand ("ExecuteXmlReader", false);
643                         behavior = CommandBehavior.Default;
644                         try {
645                                 Execute (true);
646                         } catch (TdsTimeoutException e) {
647                                 Connection.Tds.Reset ();
648                                 throw SqlException.FromTdsInternalException ((TdsInternalException) e);
649                         }
650
651                         SqlDataReader dataReader = new SqlDataReader (this);
652                         SqlXmlTextReader textReader = new SqlXmlTextReader (dataReader);
653                         XmlReader xmlReader = new XmlTextReader (textReader);
654                         return xmlReader;
655                 }
656
657                 internal void GetOutputParameters ()
658                 {
659                         IList list = Connection.Tds.OutputParameters;
660
661                         if (list != null && list.Count > 0) {
662
663                                 int index = 0;
664                                 foreach (SqlParameter parameter in parameters) {
665                                         if (parameter.Direction != ParameterDirection.Input &&
666                                             parameter.Direction != ParameterDirection.ReturnValue) {
667                                                 parameter.Value = list [index];
668                                                 index += 1;
669                                         }
670                                         if (index >= list.Count)
671                                                 break;
672                                 }
673                         }
674                 }
675
676                 object ICloneable.Clone ()
677                 {
678                         return new SqlCommand (commandText, connection, transaction, commandType, updatedRowSource, designTimeVisible, commandTimeout, parameters);
679
680                 }
681
682 #if !NET_2_0
683                 IDbDataParameter IDbCommand.CreateParameter ()
684                 {
685                         return CreateParameter ();
686                 }
687
688                 IDataReader IDbCommand.ExecuteReader ()
689                 {
690                         return ExecuteReader ();
691                 }
692
693                 IDataReader IDbCommand.ExecuteReader (CommandBehavior behavior)
694                 {
695                         return ExecuteReader (behavior);
696                 }
697 #endif
698
699 #if NET_2_0
700                 protected override void Dispose (bool disposing)
701                 {
702                         if (disposed) return;
703                         if (disposing) {
704                                 parameters.Clear();
705                         }
706                         base.Dispose (disposing);
707                         disposed = true;
708                 }
709 #endif
710
711                 public
712 #if NET_2_0
713                 override
714 #endif // NET_2_0
715                 void Prepare ()
716                 {
717 #if NET_2_0
718                         if (Connection == null)
719                                 throw new NullReferenceException ();
720 #endif
721
722                         if (CommandType == CommandType.StoredProcedure || CommandType == CommandType.Text && Parameters.Count == 0)
723                                 return;
724
725                         ValidateCommand ("Prepare", false);
726
727                         try {
728                                 foreach (SqlParameter param in Parameters)
729                                         param.CheckIfInitialized ();
730                         } catch (Exception e) {
731                                 throw new InvalidOperationException ("SqlCommand.Prepare requires " + e.Message);
732                         }
733
734                         preparedStatement = Connection.Tds.Prepare (CommandText, Parameters.MetaParameters);
735                 }
736
737                 public void ResetCommandTimeout ()
738                 {
739                         commandTimeout = DEFAULT_COMMAND_TIMEOUT;
740                 }
741
742                 private void Unprepare ()
743                 {
744                         Connection.Tds.Unprepare (preparedStatement);
745                         preparedStatement = null;
746                 }
747
748                 private void ValidateCommand (string method, bool async)
749                 {
750                         if (Connection == null)
751                                 throw new InvalidOperationException (String.Format ("{0}: A Connection object is required to continue.", method));
752                         if (Transaction == null && Connection.Transaction != null)
753                                 throw new InvalidOperationException (String.Format (
754                                         "{0} requires a transaction if the command's connection is in a pending transaction.",
755 #if NET_2_0
756                                         method));
757 #else
758                                         "Execute"));
759 #endif
760                         if (Transaction != null && Transaction.Connection != Connection)
761                                 throw new InvalidOperationException ("The connection does not have the same transaction as the command.");
762                         if (Connection.State != ConnectionState.Open)
763                                 throw new InvalidOperationException (String.Format ("{0} requires an open connection to continue. This connection is closed.", method));
764                         if (CommandText.Length == 0)
765                                 throw new InvalidOperationException (String.Format ("{0}: CommandText has not been set for this Command.", method));
766                         if (Connection.DataReader != null)
767                                 throw new InvalidOperationException ("There is already an open DataReader associated with this Connection which must be closed first.");
768                         if (Connection.XmlReader != null)
769                                 throw new InvalidOperationException ("There is already an open XmlReader associated with this Connection which must be closed first.");
770 #if NET_2_0
771                         if (async && !Connection.AsyncProcessing)
772                                 throw new InvalidOperationException ("This Connection object is not " + 
773                                         "in Asynchronous mode. Use 'Asynchronous" +
774                                         " Processing = true' to set it.");
775 #endif // NET_2_0
776                 }
777
778 #if NET_2_0
779                 protected override DbParameter CreateDbParameter ()
780                 {
781                         return CreateParameter ();
782                 }
783
784                 protected override DbDataReader ExecuteDbDataReader (CommandBehavior behavior)
785                 {
786                         return ExecuteReader (behavior);
787                 }
788
789                 protected override DbConnection DbConnection {
790                         get { return Connection; }
791                         set { Connection = (SqlConnection) value; }
792                 }
793
794                 protected override DbParameterCollection DbParameterCollection {
795                         get { return Parameters; }
796                 }
797
798                 protected override DbTransaction DbTransaction {
799                         get { return Transaction; }
800                         set { Transaction = (SqlTransaction) value; }
801                 }
802 #endif // NET_2_0
803
804                 #endregion // Methods
805
806 #if NET_2_0
807                 #region Asynchronous Methods
808
809                 internal IAsyncResult BeginExecuteInternal (CommandBehavior behavior, 
810                                                                                                         bool wantResults,
811                                                                                                         AsyncCallback callback, 
812                                                                                                         object state)
813                 {
814                         IAsyncResult ar = null;
815                         Connection.Tds.RecordsAffected = -1;
816                         TdsMetaParameterCollection parms = Parameters.MetaParameters;
817                         if (preparedStatement == null) {
818                                 bool schemaOnly = ((behavior & CommandBehavior.SchemaOnly) > 0);
819                                 bool keyInfo = ((behavior & CommandBehavior.KeyInfo) > 0);
820
821                                 StringBuilder sql1 = new StringBuilder ();
822                                 StringBuilder sql2 = new StringBuilder ();
823
824                                 if (schemaOnly || keyInfo)
825                                         sql1.Append ("SET FMTONLY OFF;");
826                                 if (keyInfo) {
827                                         sql1.Append ("SET NO_BROWSETABLE ON;");
828                                         sql2.Append ("SET NO_BROWSETABLE OFF;");
829                                 }
830                                 if (schemaOnly) {
831                                         sql1.Append ("SET FMTONLY ON;");
832                                         sql2.Append ("SET FMTONLY OFF;");
833                                 }
834                                 switch (CommandType) {
835                                 case CommandType.StoredProcedure:
836                                         string prolog = "";
837                                         string epilog = "";
838                                         if (keyInfo || schemaOnly)
839                                                 prolog = sql1.ToString ();
840                                         if (keyInfo || schemaOnly)
841                                                 epilog = sql2.ToString ();
842                                         try {
843                                                 Connection.Tds.BeginExecuteProcedure (prolog,
844                                                                                       epilog,
845                                                                                       CommandText,
846                                                                                       !wantResults,
847                                                                                       parms,
848                                                                                       callback,
849                                                                                       state);
850                                         } catch (TdsTimeoutException ex) {
851                                                 Connection.Tds.Reset ();
852                                                 throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
853                                         } catch (TdsInternalException ex) {
854                                                 Connection.Close ();
855                                                 throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
856                                         }
857                                         break;
858                                 case CommandType.Text:
859                                         string sql = String.Format ("{0}{1};{2}", sql1.ToString (), CommandText, sql2.ToString ());
860                                         try {
861                                                 if (wantResults)
862                                                         ar = Connection.Tds.BeginExecuteQuery (sql, parms, callback, state);
863                                                 else
864                                                         ar = Connection.Tds.BeginExecuteNonQuery (sql, parms, callback, state);
865                                         } catch (TdsTimeoutException ex) {
866                                                 Connection.Tds.Reset ();
867                                                 throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
868                                         } catch (TdsInternalException ex) {
869                                                 Connection.Close ();
870                                                 throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
871                                         }
872                                         break;
873                                 }
874                         }
875                         else {
876                                 try {
877                                         Connection.Tds.ExecPrepared (preparedStatement, parms, CommandTimeout, wantResults);
878                                 } catch (TdsTimeoutException ex) {
879                                         Connection.Tds.Reset ();
880                                         throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
881                                 } catch (TdsInternalException ex) {
882                                         Connection.Close ();
883                                         throw SqlException.FromTdsInternalException ((TdsInternalException) ex);
884                                 }
885                         }
886                         return ar;
887                 }
888
889                 internal void EndExecuteInternal (IAsyncResult ar)
890                 {
891                         SqlAsyncResult sqlResult = ( (SqlAsyncResult) ar);
892                         Connection.Tds.WaitFor (sqlResult.InternalResult);
893                         Connection.Tds.CheckAndThrowException (sqlResult.InternalResult);
894                 }
895
896                 public IAsyncResult BeginExecuteNonQuery ()
897                 {
898                         return BeginExecuteNonQuery (null, null);
899                 }
900
901                 public IAsyncResult BeginExecuteNonQuery (AsyncCallback callback, object stateObject)
902                 {
903                         ValidateCommand ("BeginExecuteNonQuery", true);
904                         SqlAsyncResult ar = new SqlAsyncResult (callback, stateObject);
905                         ar.EndMethod = "EndExecuteNonQuery";
906                         ar.InternalResult = BeginExecuteInternal (CommandBehavior.Default, false, ar.BubbleCallback, ar);
907                         return ar;
908                 }
909
910                 public int EndExecuteNonQuery (IAsyncResult asyncResult)
911                 {
912                         ValidateAsyncResult (asyncResult, "EndExecuteNonQuery");
913                         EndExecuteInternal (asyncResult);
914
915                         int ret = Connection.Tds.RecordsAffected;
916
917                         GetOutputParameters ();
918                         ((SqlAsyncResult) asyncResult).Ended = true;
919                         return ret;
920                 }
921
922                 public IAsyncResult BeginExecuteReader ()
923                 {
924                         return BeginExecuteReader (null, null, CommandBehavior.Default);
925                 }
926
927                 public IAsyncResult BeginExecuteReader (CommandBehavior behavior)
928                 {
929                         return BeginExecuteReader (null, null, behavior);
930                 }
931
932                 public IAsyncResult BeginExecuteReader (AsyncCallback callback, object stateObject)
933                 {
934                         return BeginExecuteReader (callback, stateObject, CommandBehavior.Default);
935                 }
936
937                 public IAsyncResult BeginExecuteReader (AsyncCallback callback, object stateObject, CommandBehavior behavior)
938                 {
939                         ValidateCommand ("BeginExecuteReader", true);
940                         this.behavior = behavior;
941                         SqlAsyncResult ar = new SqlAsyncResult (callback, stateObject);
942                         ar.EndMethod = "EndExecuteReader";
943                         IAsyncResult tdsResult = BeginExecuteInternal (behavior, true, 
944                                 ar.BubbleCallback, stateObject);
945                         ar.InternalResult = tdsResult;
946                         return ar;
947                 }
948
949                 public SqlDataReader EndExecuteReader (IAsyncResult asyncResult)
950                 {
951                         ValidateAsyncResult (asyncResult, "EndExecuteReader");
952                         EndExecuteInternal (asyncResult);
953                         SqlDataReader reader = null;
954                         try {
955                                 reader = new SqlDataReader (this);
956                         } catch (TdsTimeoutException e) {
957                                 throw SqlException.FromTdsInternalException ((TdsInternalException) e);
958                         } catch (TdsInternalException e) {
959                                 // if behavior is closeconnection, even if it throws exception
960                                 // the connection has to be closed.
961                                 if ((behavior & CommandBehavior.CloseConnection) != 0)
962                                         Connection.Close ();
963                                 throw SqlException.FromTdsInternalException ((TdsInternalException) e);
964                         }
965
966                         ((SqlAsyncResult) asyncResult).Ended = true;
967                         return reader;
968                 }
969
970                 public IAsyncResult BeginExecuteXmlReader (AsyncCallback callback, object stateObject)
971                 {
972                         ValidateCommand ("BeginExecuteXmlReader", true);
973                         SqlAsyncResult ar = new SqlAsyncResult (callback, stateObject);
974                         ar.EndMethod = "EndExecuteXmlReader";
975                         ar.InternalResult = BeginExecuteInternal (behavior, true, 
976                                 ar.BubbleCallback, stateObject);
977                         return ar;
978                 }
979
980                 public IAsyncResult BeginExecuteXmlReader ()
981                 {
982                         return BeginExecuteXmlReader (null, null);
983                 }
984                 
985
986                 public XmlReader EndExecuteXmlReader (IAsyncResult asyncResult)
987                 {
988                         ValidateAsyncResult (asyncResult, "EndExecuteXmlReader");
989                         EndExecuteInternal (asyncResult);
990                         SqlDataReader reader = new SqlDataReader (this);
991                         SqlXmlTextReader textReader = new SqlXmlTextReader (reader);
992                         XmlReader xmlReader = new XmlTextReader (textReader);
993                         ((SqlAsyncResult) asyncResult).Ended = true;
994                         return xmlReader;
995                 }
996
997                 internal void ValidateAsyncResult (IAsyncResult ar, string endMethod)
998                 {
999                         if (ar == null)
1000                                 throw new ArgumentException ("result passed is null!");
1001                         if (! (ar is SqlAsyncResult))
1002                                 throw new ArgumentException (String.Format ("cannot test validity of types {0}",
1003                                         ar.GetType ()));
1004                         SqlAsyncResult result = (SqlAsyncResult) ar;
1005                         if (result.EndMethod != endMethod)
1006                                 throw new InvalidOperationException (String.Format ("Mismatched {0} called for AsyncResult. " + 
1007                                         "Expected call to {1} but {0} is called instead.",
1008                                         endMethod, result.EndMethod));
1009                         if (result.Ended)
1010                                 throw new InvalidOperationException (String.Format ("The method {0} cannot be called " + 
1011                                         "more than once for the same AsyncResult.", endMethod));
1012                 }
1013
1014                 #endregion // Asynchronous Methods
1015
1016                 public event StatementCompletedEventHandler StatementCompleted;
1017 #endif // NET_2_0
1018         }
1019 }