// Copyright (c) 2004-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License version 2 as published by
// the Free Software Foundation
//
// There are special exceptions to the terms and conditions of the GPL
// as it is applied to this software. View the full text of the
// exception in file EXCEPTIONS in the directory of this software
// distribution.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
using System;
using System.Data;
using System.Data.Common;
using MySql.Data.Types;
using System.ComponentModel;
using System.Globalization;
using System.Reflection;
using System.Text;
using System.Collections;
#if !CF
using System.ComponentModel.Design.Serialization;
#endif
namespace MySql.Data.MySqlClient
{
///
/// Represents a parameter to a , and optionally, its mapping to columns. This class cannot be inherited.
///
#if !CF
[TypeConverter(typeof(MySqlParameterConverter))]
#endif
public sealed class MySqlParameter : DbParameter, IDataParameter, IDbDataParameter, ICloneable
{
private const int UNSIGNED_MASK = 0x8000;
private object paramValue;
private ParameterDirection direction = ParameterDirection.Input;
private bool isNullable;
private string paramName;
private string sourceColumn;
private DataRowVersion sourceVersion = DataRowVersion.Current;
private int size;
private byte precision;
private byte scale;
private MySqlDbType mySqlDbType;
private DbType dbType;
private bool inferType;
private bool sourceColumnNullMapping;
private MySqlParameterCollection collection;
IMySqlValue valueObject;
private Encoding encoding;
private IList possibleValues;
#region Constructors
///
/// Initializes a new instance of the MySqlParameter class.
///
public MySqlParameter()
{
inferType = true;
}
///
/// Initializes a new instance of the class with the parameter name and a value of the new MySqlParameter.
///
/// The name of the parameter to map.
/// An that is the value of the .
public MySqlParameter(string parameterName, object value)
: this()
{
ParameterName = parameterName;
Value = value;
}
///
/// Initializes a new instance of the class with the parameter name and the data type.
///
/// The name of the parameter to map.
/// One of the values.
public MySqlParameter(string parameterName, MySqlDbType dbType)
: this(parameterName, null)
{
MySqlDbType = dbType;
}
///
/// Initializes a new instance of the class with the parameter name, the , and the size.
///
/// The name of the parameter to map.
/// One of the values.
/// The length of the parameter.
public MySqlParameter(string parameterName, MySqlDbType dbType, int size)
: this(parameterName, dbType)
{
this.size = size;
}
///
/// Initializes a new instance of the class with the parameter name, the , the size, and the source column name.
///
/// The name of the parameter to map.
/// One of the values.
/// The length of the parameter.
/// The name of the source column.
public MySqlParameter(string parameterName, MySqlDbType dbType, int size, string sourceColumn)
:
this(parameterName, dbType)
{
this.size = size;
direction = ParameterDirection.Input;
this.sourceColumn = sourceColumn;
sourceVersion = DataRowVersion.Current;
}
internal MySqlParameter(string name, MySqlDbType type, ParameterDirection dir, string col,
DataRowVersion ver, object val)
: this(name, type)
{
direction = dir;
sourceColumn = col;
sourceVersion = ver;
Value = val;
}
///
/// Initializes a new instance of the class with the parameter name, the type of the parameter, the size of the parameter, a , the precision of the parameter, the scale of the parameter, the source column, a to use, and the value of the parameter.
///
/// The name of the parameter to map.
/// One of the values.
/// The length of the parameter.
/// One of the values.
/// true if the value of the field can be null, otherwise false.
/// The total number of digits to the left and right of the decimal point to which is resolved.
/// The total number of decimal places to which is resolved.
/// The name of the source column.
/// One of the values.
/// An that is the value of the .
///
public MySqlParameter(string parameterName, MySqlDbType dbType, int size, ParameterDirection direction,
bool isNullable, byte precision, byte scale, string sourceColumn,
DataRowVersion sourceVersion,
object value)
: this(parameterName, dbType, size, sourceColumn)
{
this.direction = direction;
this.sourceVersion = sourceVersion;
Value = value;
}
#endregion
#region Properties
internal MySqlParameterCollection Collection
{
get { return collection; }
set { collection = value; }
}
internal bool TypeHasBeenSet
{
get { return inferType == false; }
}
internal Encoding Encoding
{
get { return encoding; }
set { encoding = value; }
}
///
/// Gets or sets the of the parameter.
///
public override DbType DbType
{
get { return dbType; }
set
{
SetDbType(value);
inferType = false;
}
}
///
/// Gets or sets a value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.
/// As of MySql version 4.1 and earlier, input-only is the only valid choice.
///
#if !CF
[Category("Data")]
#endif
public override ParameterDirection Direction
{
get { return direction; }
set { direction = value; }
}
///
/// Gets or sets a value indicating whether the parameter accepts null values.
///
#if !CF
[Browsable(false)]
#endif
public override Boolean IsNullable
{
get { return isNullable; }
set { isNullable = value; }
}
///
/// Gets or sets the MySqlDbType of the parameter.
///
#if !CF
[Category("Data")]
[DbProviderSpecificTypeProperty(true)]
#endif
public MySqlDbType MySqlDbType
{
get { return mySqlDbType; }
set
{
SetMySqlDbType(value);
inferType = false;
}
}
///
/// Gets or sets the name of the MySqlParameter.
///
#if !CF
[Category("Misc")]
#endif
public override String ParameterName
{
get { return paramName; }
set
{
if (collection != null)
collection.ParameterNameChanged(this, paramName, value);
paramName = value;
}
}
///
/// Gets or sets the maximum number of digits used to represent the property.
///
#if !CF
[Category("Data")]
#endif
public byte Precision
{
get { return precision; }
set { precision = value; }
}
///
/// Gets or sets the number of decimal places to which is resolved.
///
#if !CF
[Category("Data")]
#endif
public byte Scale
{
get { return scale; }
set { scale = value; }
}
///
/// Gets or sets the maximum size, in bytes, of the data within the column.
///
#if !CF
[Category("Data")]
#endif
public override int Size
{
get { return size; }
set { size = value; }
}
///
/// Gets or sets the name of the source column that is mapped to the and used for loading or returning the .
///
#if !CF
[Category("Data")]
#endif
public override String SourceColumn
{
get { return sourceColumn; }
set { sourceColumn = value; }
}
///
/// Gets or sets the to use when loading .
///
#if !CF
[Category("Data")]
#endif
public override DataRowVersion SourceVersion
{
get { return sourceVersion; }
set { sourceVersion = value; }
}
///
/// Gets or sets the value of the parameter.
///
#if !CF
[TypeConverter(typeof (StringConverter))]
[Category("Data")]
#endif
public override object Value
{
get { return paramValue; }
set
{
paramValue = value;
byte[] valueAsByte = value as byte[];
string valueAsString = value as string;
if (valueAsByte != null)
size = valueAsByte.Length;
else if (valueAsString != null)
size = valueAsString.Length;
if (inferType)
SetTypeFromValue();
}
}
private IMySqlValue ValueObject
{
get { return valueObject; }
}
///
/// Returns the possible values for this parameter if this parameter is of type
/// SET or ENUM. Returns null otherwise.
///
public IList PossibleValues
{
get { return possibleValues; }
internal set { possibleValues = value; }
}
#endregion
///
/// Overridden. Gets a string containing the .
///
///
public override string ToString()
{
return paramName;
}
internal int GetPSType()
{
switch (mySqlDbType)
{
case MySqlDbType.Bit:
return (int) MySqlDbType.Int64 | UNSIGNED_MASK;
case MySqlDbType.UByte:
return (int) MySqlDbType.Byte | UNSIGNED_MASK;
case MySqlDbType.UInt64:
return (int) MySqlDbType.Int64 | UNSIGNED_MASK;
case MySqlDbType.UInt32:
return (int) MySqlDbType.Int32 | UNSIGNED_MASK;
case MySqlDbType.UInt24:
return (int) MySqlDbType.Int32 | UNSIGNED_MASK;
case MySqlDbType.UInt16:
return (int) MySqlDbType.Int16 | UNSIGNED_MASK;
default:
return (int) mySqlDbType;
}
}
internal void Serialize(MySqlPacket packet, bool binary, MySqlConnectionStringBuilder settings)
{
if (!binary && (paramValue == null || paramValue == DBNull.Value))
packet.WriteStringNoNull("NULL");
else
{
if (ValueObject.MySqlDbType == MySqlDbType.Guid)
{
MySqlGuid g = (MySqlGuid)ValueObject;
g.OldGuids = settings.OldGuids;
valueObject = g;
}
ValueObject.WriteValue(packet, binary, paramValue, size);
}
}
private void SetMySqlDbType(MySqlDbType mysql_dbtype)
{
mySqlDbType = mysql_dbtype;
valueObject = MySqlField.GetIMySqlValue(mySqlDbType);
switch (mySqlDbType)
{
case MySqlDbType.Decimal:
dbType = DbType.Decimal;
break;
case MySqlDbType.Byte:
dbType = DbType.SByte;
break;
case MySqlDbType.UByte:
dbType = DbType.Byte;
break;
case MySqlDbType.Int16:
dbType = DbType.Int16;
break;
case MySqlDbType.UInt16:
dbType = DbType.UInt16;
break;
case MySqlDbType.Int24:
case MySqlDbType.Int32:
dbType = DbType.Int32;
break;
case MySqlDbType.UInt24:
case MySqlDbType.UInt32:
dbType = DbType.UInt32;
break;
case MySqlDbType.Int64:
dbType = DbType.Int64;
break;
case MySqlDbType.UInt64:
dbType = DbType.UInt64;
break;
case MySqlDbType.Bit:
dbType = DbType.UInt64;
break;
case MySqlDbType.Float:
dbType = DbType.Single;
break;
case MySqlDbType.Double:
dbType = DbType.Double;
break;
case MySqlDbType.Timestamp:
case MySqlDbType.DateTime:
dbType = DbType.DateTime;
break;
case MySqlDbType.Date:
case MySqlDbType.Newdate:
case MySqlDbType.Year:
dbType = DbType.Date;
break;
case MySqlDbType.Time:
dbType = DbType.Time;
break;
case MySqlDbType.Enum:
case MySqlDbType.Set:
case MySqlDbType.VarChar:
dbType = DbType.String;
break;
case MySqlDbType.TinyBlob:
case MySqlDbType.MediumBlob:
case MySqlDbType.LongBlob:
case MySqlDbType.Blob:
dbType = DbType.Object;
break;
case MySqlDbType.String:
dbType = DbType.StringFixedLength;
break;
case MySqlDbType.Guid:
dbType = DbType.Guid;
break;
}
}
private void SetDbType(DbType db_type)
{
dbType = db_type;
switch (dbType)
{
case DbType.Guid:
mySqlDbType = MySqlDbType.Guid;
break;
case DbType.AnsiString:
case DbType.String:
mySqlDbType = MySqlDbType.VarChar;
break;
case DbType.AnsiStringFixedLength:
case DbType.StringFixedLength:
mySqlDbType = MySqlDbType.String;
break;
case DbType.Boolean:
case DbType.Byte:
mySqlDbType = MySqlDbType.UByte;
break;
case DbType.SByte:
mySqlDbType = MySqlDbType.Byte;
break;
case DbType.Date:
mySqlDbType = MySqlDbType.Date;
break;
case DbType.DateTime:
mySqlDbType = MySqlDbType.DateTime;
break;
case DbType.Time:
mySqlDbType = MySqlDbType.Time;
break;
case DbType.Single:
mySqlDbType = MySqlDbType.Float;
break;
case DbType.Double:
mySqlDbType = MySqlDbType.Double;
break;
case DbType.Int16:
mySqlDbType = MySqlDbType.Int16;
break;
case DbType.UInt16:
mySqlDbType = MySqlDbType.UInt16;
break;
case DbType.Int32:
mySqlDbType = MySqlDbType.Int32;
break;
case DbType.UInt32:
mySqlDbType = MySqlDbType.UInt32;
break;
case DbType.Int64:
mySqlDbType = MySqlDbType.Int64;
break;
case DbType.UInt64:
mySqlDbType = MySqlDbType.UInt64;
break;
case DbType.Decimal:
case DbType.Currency:
mySqlDbType = MySqlDbType.Decimal;
break;
case DbType.Object:
case DbType.VarNumeric:
case DbType.Binary:
default:
mySqlDbType = MySqlDbType.Blob;
break;
}
valueObject = MySqlField.GetIMySqlValue(mySqlDbType);
}
private void SetTypeFromValue()
{
if (paramValue == null || paramValue == DBNull.Value) return;
if (paramValue is Guid)
DbType = DbType.Guid;
else if (paramValue is TimeSpan)
DbType = DbType.Time;
else if (paramValue is bool)
DbType = DbType.Byte;
else
{
TypeCode tc = Type.GetTypeCode(paramValue.GetType());
switch (tc)
{
case TypeCode.SByte:
DbType = DbType.SByte;
break;
case TypeCode.Byte:
DbType = DbType.Byte;
break;
case TypeCode.Int16:
DbType = DbType.Int16;
break;
case TypeCode.UInt16:
DbType = DbType.UInt16;
break;
case TypeCode.Int32:
DbType = DbType.Int32;
break;
case TypeCode.UInt32:
DbType = DbType.UInt32;
break;
case TypeCode.Int64:
DbType = DbType.Int64;
break;
case TypeCode.UInt64:
DbType = DbType.UInt64;
break;
case TypeCode.DateTime:
DbType = DbType.DateTime;
break;
case TypeCode.String:
DbType = DbType.String;
break;
case TypeCode.Single:
DbType = DbType.Single;
break;
case TypeCode.Double:
DbType = DbType.Double;
break;
case TypeCode.Decimal:
DbType = DbType.Decimal;
break;
case TypeCode.Object:
default:
DbType = DbType.Object;
break;
}
}
}
#region ICloneable
public MySqlParameter Clone()
{
MySqlParameter clone = new MySqlParameter(paramName, mySqlDbType, direction,
sourceColumn, sourceVersion, paramValue);
// if we have not had our type set yet then our clone should not either
clone.inferType = inferType;
return clone;
}
object ICloneable.Clone()
{
return this.Clone();
}
#endregion
///
/// Resets the DbType property to its original settings.
///
public override void ResetDbType()
{
inferType = true;
}
///
/// Sets or gets a value which indicates whether the source column is nullable.
/// This allows to correctly generate Update statements
/// for nullable columns.
///
public override bool SourceColumnNullMapping
{
get { return sourceColumnNullMapping; }
set { sourceColumnNullMapping = value; }
}
// this method is pretty dumb but we want it to be fast. it doesn't return size based
// on value and type but just on the value.
internal long EstimatedSize()
{
if (Value == null || Value == DBNull.Value)
return 4; // size of NULL
if (Value is byte[])
return (Value as byte[]).Length;
if (Value is string)
return (Value as string).Length * 4; // account for UTF-8 (yeah I know)
if (Value is decimal || Value is float)
return 64;
return 32;
}
}
#if !CF
internal class MySqlParameterConverter : TypeConverter
{
public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType)
{
if (destinationType == typeof(InstanceDescriptor))
{
return true;
}
// Always call the base to see if it can perform the conversion.
return base.CanConvertTo(context, destinationType);
}
public override object ConvertTo(ITypeDescriptorContext context,
CultureInfo culture, object value, Type destinationType)
{
if (destinationType == typeof(InstanceDescriptor))
{
ConstructorInfo ci = typeof(MySqlParameter).GetConstructor(
new Type[]
{
typeof (string), typeof (MySqlDbType), typeof (int), typeof (ParameterDirection),
typeof (bool), typeof (byte), typeof (byte), typeof (string), typeof (DataRowVersion),
typeof (object)
});
MySqlParameter p = (MySqlParameter)value;
return new InstanceDescriptor(ci, new object[]
{
p.ParameterName, p.DbType, p.Size, p.Direction,
p.IsNullable, p.Precision,
p.Scale, p.SourceColumn, p.SourceVersion, p.Value
});
}
// Always call base, even if you can't convert.
return base.ConvertTo(context, culture, value, destinationType);
}
}
#endif
}