Class DataTypeManager

Namespace

CMS.DataEngine

Assembly

CMS.DataEngine.dll

Provides management of SQL data types

public class DataTypeManager

Inheritance

object

DataTypeManager

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Fields

CODE_VALUE_FORMAT_STRING

Represents the format string for a string value in C# code

public const string CODE_VALUE_FORMAT_STRING = "\"{0}\""

Field Value

string

MAX_DATETIME

Minimum DateTime value for date time data type

public static readonly DateTime MAX_DATETIME

Field Value

DateTime

MIN_DATETIME

Minimum DateTime value for date time data type

public static readonly DateTime MIN_DATETIME

Field Value

DateTime

PLAIN

Represents the format string for a plain SQL value

public const string PLAIN = "{0}"

Field Value

string

UNICODE

Represents the format string for a unicode text on SQL server

public const string UNICODE = "N'{0}'"

Field Value

string

Properties

DataTypes

Registered data types

public static IEnumerable<DataType> DataTypes { get; }

Property Value

IEnumerable<DataType>

FieldTypes

Registered data types

[Obsolete("Member is deprecated and will be removed in next version.")]
[ObsoleteSince(28, 0)]
public static IEnumerable<string> FieldTypes { get; }

Property Value

IEnumerable<string>

VisibleFieldTypes

Registered data types

[Obsolete("Member is deprecated and will be removed in next version.")]
[ObsoleteSince(28, 0)]
public static IEnumerable<string> VisibleFieldTypes { get; }

Property Value

IEnumerable<string>

Methods

ConvertToSystemType(TypeEnum, string, object, CultureInfo, bool)

Converts the value to a proper data type

public static object ConvertToSystemType(TypeEnum typeEnum, string typeValue, object value, CultureInfo culture = null, bool nullIfDefault = false)

Parameters

typeEnum TypeEnum

Type to use

typeValue string

Data type

value object

Value to convert

culture CultureInfo

Culture to use for conversion

nullIfDefault bool

If true, and the resulting value is the default value, returns null

Returns

object

GetDataType(TypeEnum, string)

Gets the data type settings by its SQL type

public static DataType GetDataType(TypeEnum typeEnum, string typeValue)

Parameters

typeEnum TypeEnum

Type to use

typeValue string

Data type name

Returns

DataType

GetDataType(Type)

Gets the data type by the system type.

public static DataType GetDataType(Type type)

Parameters

type Type

System type

Returns

DataType

See Also

IsAssignableFrom(Type)

GetDataTypes(Func<DataType, bool>)

Gets the data types matching the given condition

public static IEnumerable<DataType> GetDataTypes(Func<DataType, bool> condition = null)

Parameters

condition Func<DataType, bool>

Data type condition

Returns

IEnumerable<DataType>

GetFieldType(string, int, bool)

Returns form field data type from database column data type. Some sql types map to multiple field types that differ by size, e.g. nvarchar has more field data types that differ by size. Specify size to get more accurate result. By default max size for given sql type is used.

public static string GetFieldType(string sqlType, int size = -1, bool throwException = false)

Parameters

sqlType string

Database column data type

size int

Specify the size of sql type to get accurate result

throwException bool

Indicates if exception should be thrown for unsupported SQL data type

Returns

string

GetFieldTypes(DataClassInfo, bool)

Returns collection of all field types for the given data class.

public static IEnumerable<string> GetFieldTypes(DataClassInfo dataClassInfo = null, bool onlyVisible = true)

Parameters

dataClassInfo DataClassInfo

DataClassInfo, if not specified, all field types are returned.

onlyVisible bool

If true, only visible field types are provided.

Returns

IEnumerable<string>

GetSqlType(string, int, int)

Gets column type for defined data type and size.

public static string GetSqlType(string dataType, int size, int precision)

Parameters

dataType string

Data type

size int

Size of the type

precision int

Precision of the type

Returns

string

GetSqlValue(object)

Gets the value representation for a SQL query text.

public static string GetSqlValue(object value)

Parameters

value object

Value to be converted.

Returns

string

GetStringValue(TypeEnum, string, object, CultureInfo)

Converts the value to a string value

public static string GetStringValue(TypeEnum typeEnum, string typeValue, object value, CultureInfo culture = null)

Parameters

typeEnum TypeEnum

Type to use

typeValue string

Data type

value object

Value to convert

culture CultureInfo

Culture to use for conversion

Returns

string

GetSystemType(TypeEnum, string)

Gets the system type by the field type

public static Type GetSystemType(TypeEnum typeEnum, string typeValue)

Parameters

typeEnum TypeEnum

Type to search

typeValue string

Field type

Returns

Type

IsInteger(TypeEnum, string)

Returns true, if the given type is an integer type

public static bool IsInteger(TypeEnum typeEnum, string typeValue)

Parameters

typeEnum TypeEnum

Type enum

typeValue string

Type value

Returns

bool

IsNumber(TypeEnum, string)

Returns true, if the given type is a number type

public static bool IsNumber(TypeEnum typeEnum, string typeValue)

Parameters

typeEnum TypeEnum

Type enum

typeValue string

Type value

Returns

bool

IsString(TypeEnum, string)

Returns true, if the given type is a string type

public static bool IsString(TypeEnum typeEnum, string typeValue)

Parameters

typeEnum TypeEnum

Type enum

typeValue string

Type value

Returns

bool

IsType<T>(TypeEnum, string)

Returns true, if the given type is a GUID type

public static bool IsType<T>(TypeEnum typeEnum, string typeValue)

Parameters

typeEnum TypeEnum

Type enum

typeValue string

Type value

Returns

bool

Type Parameters

T

RegisterDataTypes(params DataType[])

Registers the given data type to the system

public static void RegisterDataTypes(params DataType[] types)

Parameters

types DataType[]