Files
mono/mcs/class/System.Data/System.Data.Common/DbCommandBuilder.cs
T
Nagappan Alagappan d6b5b3c2df * DbDataAdapter.cs: Added MonoTODO in appropriate place.
* DbCommandBuilder.cs (initializeCommand): Implemented missing API.

svn path=/trunk/mcs/; revision=86517
2007-09-27 17:28:40 +00:00

633 lines
19 KiB
C#

//
// System.Data.Common.DbCommandBuilder
//
// Author:
// Tim Coleman ([email protected])
//
// Copyright (C) Tim Coleman, 2003
//
//
// Copyright (C) 2004 Novell, Inc (http://www.novell.com)
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
#if NET_2_0 || TARGET_JVM
using System.ComponentModel;
using System.Data;
using System.Text;
namespace System.Data.Common {
public abstract class DbCommandBuilder : Component
{
bool _setAllValues = false;
bool _disposed = false;
DataTable _dbSchemaTable;
DbDataAdapter _dbDataAdapter = null;
private CatalogLocation _catalogLocation = CatalogLocation.Start;
private ConflictOption _conflictOption;
private string _tableName;
private string _catalogSeperator = ".";
private string _quotePrefix;
private string _quoteSuffix;
private string _schemaSeperator = ".";
private DbCommand _dbCommand = null;
// Used to construct WHERE clauses
static readonly string clause1 = "({0} = 1 AND {1} IS NULL)";
static readonly string clause2 = "({0} = {1})";
DbCommand _deleteCommand;
DbCommand _insertCommand;
DbCommand _updateCommand;
#region Constructors
protected DbCommandBuilder ()
{
}
#endregion // Constructors
#region Properties
private void BuildCache (bool closeConnection)
{
DbCommand sourceCommand = SourceCommand;
if (sourceCommand == null)
throw new InvalidOperationException ("The DataAdapter.SelectCommand property needs to be initialized.");
DbConnection connection = sourceCommand.Connection;
if (connection == null)
throw new InvalidOperationException ("The DataAdapter.SelectCommand.Connection property needs to be initialized.");
if (_dbSchemaTable == null) {
if (connection.State == ConnectionState.Open)
closeConnection = false;
else
connection.Open ();
DbDataReader reader = sourceCommand.ExecuteReader (CommandBehavior.SchemaOnly | CommandBehavior.KeyInfo);
_dbSchemaTable = reader.GetSchemaTable ();
reader.Close ();
if (closeConnection)
connection.Close ();
BuildInformation (_dbSchemaTable);
}
}
private string QuotedTableName {
get { return GetQuotedString (_tableName); }
}
private string GetQuotedString (string value)
{
if (value == String.Empty || value == null)
return value;
if (_quotePrefix == String.Empty && _quoteSuffix == String.Empty)
return value;
return String.Format ("{0}{1}{2}", _quotePrefix, value, _quoteSuffix);
}
private void BuildInformation (DataTable schemaTable)
{
_tableName = String.Empty;
foreach (DataRow schemaRow in schemaTable.Rows) {
if (schemaRow.IsNull ("BaseTableName") || (string) schemaRow ["BaseTableName"] == String.Empty)
continue;
if (_tableName == String.Empty)
_tableName = (string) schemaRow ["BaseTableName"];
else if (_tableName != (string) schemaRow["BaseTableName"])
throw new InvalidOperationException ("Dynamic SQL generation is not supported against multiple base tables.");
}
if (_tableName == String.Empty)
throw new InvalidOperationException ("Dynamic SQL generation is not supported with no base table.");
_dbSchemaTable = schemaTable;
}
private bool IncludedInInsert (DataRow schemaRow)
{
// If the parameter has one of these properties, then we don't include it in the insert:
// AutoIncrement, Hidden, Expression, RowVersion, ReadOnly
if (!schemaRow.IsNull ("IsAutoIncrement") && (bool) schemaRow ["IsAutoIncrement"])
return false;
// if (!schemaRow.IsNull ("IsHidden") && (bool) schemaRow ["IsHidden"])
// return false;
if (!schemaRow.IsNull ("IsExpression") && (bool) schemaRow ["IsExpression"])
return false;
if (!schemaRow.IsNull ("IsRowVersion") && (bool) schemaRow ["IsRowVersion"])
return false;
if (!schemaRow.IsNull ("IsReadOnly") && (bool) schemaRow ["IsReadOnly"])
return false;
return true;
}
private bool IncludedInUpdate (DataRow schemaRow)
{
// If the parameter has one of these properties, then we don't include it in the insert:
// AutoIncrement, Hidden, RowVersion
if (!schemaRow.IsNull ("IsAutoIncrement") && (bool) schemaRow ["IsAutoIncrement"])
return false;
// if (!schemaRow.IsNull ("IsHidden") && (bool) schemaRow ["IsHidden"])
// return false;
if (!schemaRow.IsNull ("IsRowVersion") && (bool) schemaRow ["IsRowVersion"])
return false;
if (!schemaRow.IsNull ("IsExpression") && (bool) schemaRow ["IsExpression"])
return false;
if (!schemaRow.IsNull ("IsReadOnly") && (bool) schemaRow ["IsReadOnly"])
return false;
return true;
}
private bool IncludedInWhereClause (DataRow schemaRow)
{
if ((bool) schemaRow ["IsLong"])
return false;
return true;
}
private DbCommand CreateDeleteCommand (bool option)
{
// If no table was found, then we can't do an delete
if (QuotedTableName == String.Empty)
return null;
CreateNewCommand (ref _deleteCommand);
string command = String.Format ("DELETE FROM {0}", QuotedTableName);
StringBuilder columns = new StringBuilder ();
StringBuilder whereClause = new StringBuilder ();
string dsColumnName = String.Empty;
bool keyFound = false;
int parmIndex = 1;
foreach (DataRow schemaRow in _dbSchemaTable.Rows) {
if ((bool)schemaRow["IsExpression"] == true)
continue;
if (!IncludedInWhereClause (schemaRow))
continue;
if (whereClause.Length > 0)
whereClause.Append (" AND ");
bool isKey = (bool) schemaRow ["IsKey"];
DbParameter parameter = null;
if (isKey)
keyFound = true;
//ms.net 1.1 generates the null check for columns even if AllowDBNull is false
//while ms.net 2.0 does not. Anyways, since both forms are logically equivalent
//following the 2.0 approach
bool allowNull = (bool) schemaRow ["AllowDBNull"];
if (!isKey && allowNull) {
parameter = _deleteCommand.CreateParameter ();
if (option) {
parameter.ParameterName = String.Format ("@{0}",
schemaRow ["BaseColumnName"]);
} else {
parameter.ParameterName = String.Format ("@p{0}", parmIndex++);
}
String sourceColumnName = (string) schemaRow ["BaseColumnName"];
parameter.Value = 1;
whereClause.Append ("(");
whereClause.Append (String.Format (clause1, parameter.ParameterName,
GetQuotedString (sourceColumnName)));
whereClause.Append (" OR ");
}
int index = 0;
if (option) {
index = CreateParameter (_deleteCommand, schemaRow);
} else {
index = CreateParameter (_deleteCommand, parmIndex++, schemaRow);
}
parameter = _deleteCommand.Parameters [index];
parameter.SourceVersion = DataRowVersion.Original;
whereClause.Append (String.Format (clause2, GetQuotedString (parameter.SourceColumn), parameter.ParameterName));
if (!isKey && allowNull)
whereClause.Append (")");
}
if (!keyFound)
throw new InvalidOperationException ("Dynamic SQL generation for the DeleteCommand is not supported against a SelectCommand that does not return any key column information.");
// We're all done, so bring it on home
string sql = String.Format ("{0} WHERE ({1})", command, whereClause.ToString ());
_deleteCommand.CommandText = sql;
_dbCommand = _deleteCommand;
return _deleteCommand;
}
private DbCommand CreateInsertCommand (bool option)
{
if (QuotedTableName == String.Empty)
return null;
CreateNewCommand (ref _insertCommand);
string command = String.Format ("INSERT INTO {0}", QuotedTableName);
string sql;
StringBuilder columns = new StringBuilder ();
StringBuilder values = new StringBuilder ();
string dsColumnName = String.Empty;
int parmIndex = 1;
foreach (DataRow schemaRow in _dbSchemaTable.Rows) {
if (!IncludedInInsert (schemaRow))
continue;
if (parmIndex > 1) {
columns.Append (", ");
values.Append (", ");
}
int index = -1;
if (option) {
index = CreateParameter (_insertCommand, schemaRow);
} else {
index = CreateParameter (_insertCommand, parmIndex++, schemaRow);
}
DbParameter parameter = _insertCommand.Parameters [index];
parameter.SourceVersion = DataRowVersion.Current;
columns.Append (GetQuotedString (parameter.SourceColumn));
values.Append (parameter.ParameterName);
}
sql = String.Format ("{0} ({1}) VALUES ({2})", command, columns.ToString (), values.ToString ());
_insertCommand.CommandText = sql;
_dbCommand = _insertCommand;
return _insertCommand;
}
private void CreateNewCommand (ref DbCommand command)
{
DbCommand sourceCommand = SourceCommand;
if (command == null) {
command = sourceCommand.Connection.CreateCommand ();
command.CommandTimeout = sourceCommand.CommandTimeout;
command.Transaction = sourceCommand.Transaction;
}
command.CommandType = CommandType.Text;
command.UpdatedRowSource = UpdateRowSource.None;
command.Parameters.Clear ();
}
private DbCommand CreateUpdateCommand (bool option)
{
// If no table was found, then we can't do an update
if (QuotedTableName == String.Empty)
return null;
CreateNewCommand (ref _updateCommand);
string command = String.Format ("UPDATE {0} SET ", QuotedTableName);
StringBuilder columns = new StringBuilder ();
StringBuilder whereClause = new StringBuilder ();
int parmIndex = 1;
string dsColumnName = String.Empty;
bool keyFound = false;
// First, create the X=Y list for UPDATE
foreach (DataRow schemaRow in _dbSchemaTable.Rows) {
if (!IncludedInUpdate (schemaRow))
continue;
if (columns.Length > 0)
columns.Append (", ");
int index = -1;
if (option) {
index = CreateParameter (_updateCommand, schemaRow);
} else {
index = CreateParameter (_updateCommand, parmIndex++, schemaRow);
}
DbParameter parameter = _updateCommand.Parameters [index];
parameter.SourceVersion = DataRowVersion.Current;
columns.Append (String.Format ("{0} = {1}", GetQuotedString (parameter.SourceColumn), parameter.ParameterName));
}
// Now, create the WHERE clause. This may be optimizable, but it would be ugly to incorporate
// into the loop above. "Premature optimization is the root of all evil." -- Knuth
foreach (DataRow schemaRow in _dbSchemaTable.Rows) {
if ((bool) schemaRow ["IsExpression"] == true)
continue;
if (!IncludedInWhereClause (schemaRow))
continue;
if (whereClause.Length > 0)
whereClause.Append (" AND ");
bool isKey = (bool) schemaRow ["IsKey"];
DbParameter parameter = null;
if (isKey)
keyFound = true;
//ms.net 1.1 generates the null check for columns even if AllowDBNull is false
//while ms.net 2.0 does not. Anyways, since both forms are logically equivalent
//following the 2.0 approach
bool allowNull = (bool) schemaRow ["AllowDBNull"];
int index;
if (!isKey && allowNull) {
parameter = _updateCommand.CreateParameter ();
if (option) {
parameter.ParameterName = String.Format ("@{0}",
schemaRow ["BaseColumnName"]);
} else {
parameter.ParameterName = String.Format ("@p{0}", parmIndex++);
}
parameter.Value = 1;
whereClause.Append ("(");
whereClause.Append (String.Format (clause1, parameter.ParameterName,
GetQuotedString ((string) schemaRow ["BaseColumnName"])));
whereClause.Append (" OR ");
}
if (option) {
index = CreateParameter (_updateCommand, schemaRow);
} else {
index = CreateParameter (_updateCommand, parmIndex++, schemaRow);
}
parameter = _updateCommand.Parameters [index];
parameter.SourceVersion = DataRowVersion.Original;
whereClause.Append (String.Format (clause2, GetQuotedString (parameter.SourceColumn), parameter.ParameterName));
if (!isKey && allowNull)
whereClause.Append (")");
}
if (!keyFound)
throw new InvalidOperationException ("Dynamic SQL generation for the UpdateCommand is not supported against a SelectCommand that does not return any key column information.");
// We're all done, so bring it on home
string sql = String.Format ("{0}{1} WHERE ({2})", command, columns.ToString (), whereClause.ToString ());
_updateCommand.CommandText = sql;
_dbCommand = _updateCommand;
return _updateCommand;
}
private int CreateParameter (DbCommand _dbCommand, int parmIndex, DataRow schemaRow)
{
DbParameter parameter = _dbCommand.CreateParameter ();
parameter.ParameterName = String.Format ("@p{0}", parmIndex);
parameter.SourceColumn = (string) schemaRow ["BaseColumnName"];
parameter.Size = (int) schemaRow ["ColumnSize"];
return _dbCommand.Parameters.Add (parameter);
}
private int CreateParameter (DbCommand _dbCommand, DataRow schemaRow)
{
DbParameter parameter = _dbCommand.CreateParameter ();
parameter.ParameterName = String.Format ("@{0}",
schemaRow ["BaseColumnName"]);
parameter.SourceColumn = (string) schemaRow ["BaseColumnName"];
parameter.Size = (int) schemaRow ["ColumnSize"];
return _dbCommand.Parameters.Add (parameter);
}
[DefaultValue (CatalogLocation.Start)]
public virtual CatalogLocation CatalogLocation {
get { return _catalogLocation; }
set { _catalogLocation = value; }
}
[DefaultValue (".")]
public virtual string CatalogSeparator {
get { return _catalogSeperator; }
set { if (value != null) _catalogSeperator = value; }
}
[DefaultValue (ConflictOption.CompareAllSearchableValues)]
public virtual ConflictOption ConflictOption {
get { return _conflictOption; }
set { _conflictOption = value; }
}
[DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
[Browsable (false)]
public DbDataAdapter DataAdapter {
get { return _dbDataAdapter; }
set { if (value != null) _dbDataAdapter = value; }
}
[DefaultValue ("")]
public virtual string QuotePrefix {
get { return _quotePrefix; }
set { if (value != null) _quotePrefix = value; }
}
[DefaultValue ("")]
public virtual string QuoteSuffix {
get { return _quoteSuffix; }
set { if (value != null) _quoteSuffix = value; }
}
[DefaultValue (".")]
public virtual string SchemaSeparator {
get { return _schemaSeperator; }
set { if (value != null) _schemaSeperator = value; }
}
[DefaultValue (false)]
public bool SetAllValues {
get { return _setAllValues; }
set { _setAllValues = value; }
}
private DbCommand SourceCommand {
get {
if (_dbDataAdapter != null)
return _dbDataAdapter.SelectCommand;
return null;
}
}
#endregion // Properties
#region Methods
protected abstract void ApplyParameterInfo (DbParameter parameter,
DataRow row,
StatementType statementType,
bool whereClause);
protected override void Dispose (bool disposing)
{
if (!_disposed) {
if (disposing) {
if (_insertCommand != null)
_insertCommand.Dispose ();
if (_deleteCommand != null)
_deleteCommand.Dispose ();
if (_updateCommand != null)
_updateCommand.Dispose ();
if (_dbSchemaTable != null)
_dbSchemaTable.Dispose ();
}
_disposed = true;
}
}
public DbCommand GetDeleteCommand ()
{
BuildCache (true);
if (_deleteCommand == null)
return CreateDeleteCommand (false);
return _deleteCommand;
}
public DbCommand GetDeleteCommand (bool option)
{
BuildCache (true);
if (_deleteCommand == null)
return CreateDeleteCommand (option);
return _deleteCommand;
}
public DbCommand GetInsertCommand ()
{
BuildCache (true);
if (_insertCommand == null)
return CreateInsertCommand (false);
return _insertCommand;
}
public DbCommand GetInsertCommand (bool option)
{
BuildCache (true);
if (_insertCommand == null)
return CreateInsertCommand (option);
return _insertCommand;
}
public DbCommand GetUpdateCommand ()
{
BuildCache (true);
if (_updateCommand == null)
return CreateUpdateCommand (false);
return _updateCommand;
}
public DbCommand GetUpdateCommand (bool option)
{
BuildCache (true);
if (_updateCommand == null)
return CreateUpdateCommand (option);
return _updateCommand;
}
protected virtual DbCommand InitializeCommand (DbCommand command)
{
if (_dbCommand == null) {
_dbCommand = SourceCommand;
} else {
_dbCommand.CommandTimeout = 30;
_dbCommand.Transaction = null;
_dbCommand.CommandType = CommandType.Text;
_dbCommand.UpdatedRowSource = UpdateRowSource.None;
}
return _dbCommand;
}
public virtual string QuoteIdentifier (string unquotedIdentifier)
{
if (unquotedIdentifier == null) {
throw new ArgumentNullException("Unquoted identifier parameter cannot be null");
}
return String.Format ("{0}{1}{2}", this.QuotePrefix, unquotedIdentifier, this.QuoteSuffix);
}
public virtual string UnquoteIdentifier (string quotedIdentifier)
{
if (quotedIdentifier == null) {
throw new ArgumentNullException ("Quoted identifier parameter cannot be null");
}
string unquotedIdentifier = quotedIdentifier.Trim ();
if (unquotedIdentifier.StartsWith (this.QuotePrefix)) {
unquotedIdentifier = unquotedIdentifier.Remove (0, 1);
}
if (unquotedIdentifier.EndsWith (this.QuoteSuffix)) {
unquotedIdentifier = unquotedIdentifier.Remove (unquotedIdentifier.Length - 1, 1);
}
return unquotedIdentifier;
}
public virtual void RefreshSchema ()
{
_tableName = String.Empty;
_dbSchemaTable = null;
CreateNewCommand (ref _deleteCommand);
CreateNewCommand (ref _updateCommand);
CreateNewCommand (ref _insertCommand);
}
protected void RowUpdatingHandler (RowUpdatingEventArgs args)
{
if (args.Command != null)
return;
try {
switch (args.StatementType) {
case StatementType.Insert:
args.Command = GetInsertCommand ();
break;
case StatementType.Update:
args.Command = GetUpdateCommand ();
break;
case StatementType.Delete:
args.Command = GetDeleteCommand ();
break;
}
} catch (Exception e) {
args.Errors = e;
args.Status = UpdateStatus.ErrorsOccurred;
}
}
protected abstract string GetParameterName (int parameterOrdinal);
protected abstract string GetParameterName (String parameterName);
protected abstract string GetParameterPlaceholder (int parameterOrdinal);
protected abstract void SetRowUpdatingHandler (DbDataAdapter adapter);
protected virtual DataTable GetSchemaTable (DbCommand cmd)
{
using (DbDataReader rdr = cmd.ExecuteReader ())
return rdr.GetSchemaTable ();
}
#endregion // Methods
}
}
#endif