RelationalPropertyExtensions Class

Definition

Namespace:

Microsoft.EntityFrameworkCore

Assembly:

Microsoft.EntityFrameworkCore.Relational.dll

Package:

Microsoft.EntityFrameworkCore.Relational v8.0.0

Property extension methods for relational database metadata.

public static class RelationalPropertyExtensions

type RelationalPropertyExtensions = class

Public Module RelationalPropertyExtensions

Inheritance

Object

RelationalPropertyExtensions

Remarks

See Modeling entity types and relationships for more information and examples.

Methods

FindColumn(IProperty, StoreObjectIdentifier)	Returns the column corresponding to this property if it's mapped to the given table-like store object.
FindOverrides(IConventionProperty, StoreObjectIdentifier)	Returns the property facet overrides for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
FindOverrides(IMutableProperty, StoreObjectIdentifier)	Returns the property facet overrides for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
FindOverrides(IProperty, StoreObjectIdentifier)	Returns the property facet overrides for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
FindOverrides(IReadOnlyProperty, StoreObjectIdentifier)	Returns the property facet overrides for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
FindRelationalTypeMapping(IReadOnlyProperty)	Returns the RelationalTypeMapping for the given property on a finalized model.
FindRelationalTypeMapping(IReadOnlyProperty, StoreObjectIdentifier)	Returns the RelationalTypeMapping for the given property on a finalized model.
FindSharedStoreObjectRootProperty(IConventionProperty, StoreObjectIdentifier)	Finds the first IProperty that is mapped to the same column in a shared table-like object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
FindSharedStoreObjectRootProperty(IMutableProperty, StoreObjectIdentifier)	Finds the first IProperty that is mapped to the same column in a shared table-like object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
FindSharedStoreObjectRootProperty(IProperty, StoreObjectIdentifier)	Finds the first IProperty that is mapped to the same column in a shared table-like object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
FindSharedStoreObjectRootProperty(IReadOnlyProperty, StoreObjectIdentifier)	Finds the first IProperty that is mapped to the same column in a shared table-like object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetCollation(IReadOnlyProperty)	Returns the collation to be used for the column.
GetCollation(IReadOnlyProperty, StoreObjectIdentifier)	Returns the collation to be used for the column.
GetCollationConfigurationSource(IConventionProperty)	Gets the ConfigurationSource for the column collation.
GetColumnBaseName(IReadOnlyProperty)	Obsolete. Returns the base name of the column to which the property would be mapped.
GetColumnName(IReadOnlyProperty)	Returns the name of the column to which the property would be mapped.
GetColumnName(IReadOnlyProperty, StoreObjectIdentifier)	Returns the name of the column to which the property is mapped for a particular table.
GetColumnNameConfigurationSource(IConventionProperty)	Gets the ConfigurationSource for the column name.
GetColumnNameConfigurationSource(IConventionProperty, StoreObjectIdentifier)	Gets the ConfigurationSource for the column name for a particular table-like store object.
GetColumnOrder(IReadOnlyProperty)	Returns the order of the column this property is mapped to.
GetColumnOrder(IReadOnlyProperty, StoreObjectIdentifier)	Returns the order of the column this property is mapped to for a particular table.
GetColumnOrderConfigurationSource(IConventionProperty)	Gets the ConfigurationSource of the column order.
GetColumnType(IProperty)	Returns the database type of the column to which the property is mapped.
GetColumnType(IProperty, StoreObjectIdentifier)	Returns the database type of the column to which the property is mapped.
GetColumnType(IReadOnlyProperty)	Returns the database type of the column to which the property is mapped, or null if the database type could not be found.
GetColumnType(IReadOnlyProperty, StoreObjectIdentifier)	Returns the database type of the column to which the property is mapped, or null if the database type could not be found.
GetColumnTypeConfigurationSource(IConventionProperty)	Gets the ConfigurationSource for the column name.
GetComment(IReadOnlyProperty)	Returns the comment for the column this property is mapped to.
GetComment(IReadOnlyProperty, StoreObjectIdentifier)	Returns the comment for the column this property is mapped to.
GetCommentConfigurationSource(IConventionProperty)	Gets the ConfigurationSource for the column comment.
GetComputedColumnSql(IReadOnlyProperty)	Returns the SQL expression that is used as the computed value for the column this property is mapped to.
GetComputedColumnSql(IReadOnlyProperty, StoreObjectIdentifier)	Returns the SQL expression that is used as the computed value for the column this property is mapped to.
GetComputedColumnSqlConfigurationSource(IConventionProperty)	Gets the ConfigurationSource for the computed value SQL expression.
GetDefaultColumnBaseName(IReadOnlyProperty)	Obsolete. Returns the default base name of the column to which the property would be mapped
GetDefaultColumnMappings(IProperty)	Returns the default columns to which the property would be mapped.
GetDefaultColumnName(IReadOnlyProperty)	Returns the default base name of the column to which the property would be mapped
GetDefaultColumnName(IReadOnlyProperty, StoreObjectIdentifier)	Returns the default column name to which the property would be mapped.
GetDefaultValue(IReadOnlyProperty)	Returns the object that is used as the default value for the column this property is mapped to.
GetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier)	Returns the object that is used as the default value for the column this property is mapped to.
GetDefaultValueConfigurationSource(IConventionProperty)	Gets the ConfigurationSource for the default value.
GetDefaultValueSql(IReadOnlyProperty)	Returns the SQL expression that is used as the default value for the column this property is mapped to.
GetDefaultValueSql(IReadOnlyProperty, StoreObjectIdentifier)	Returns the SQL expression that is used as the default value for the column this property is mapped to.
GetDefaultValueSqlConfigurationSource(IConventionProperty)	Gets the ConfigurationSource for the default value SQL expression.
GetDeleteStoredProcedureParameterMappings(IProperty)	Returns the delete stored procedure parameters to which the property is mapped.
GetFunctionColumnMappings(IProperty)	Returns the function columns to which the property is mapped.
GetInsertStoredProcedureParameterMappings(IProperty)	Returns the insert stored procedure parameters to which the property is mapped.
GetInsertStoredProcedureResultColumnMappings(IProperty)	Returns the insert stored procedure result columns to which the property is mapped.
GetIsFixedLengthConfigurationSource(IConventionProperty)	Gets the ConfigurationSource for IsFixedLength(IReadOnlyProperty).
GetIsStored(IReadOnlyProperty)	Gets whether the value of the computed column this property is mapped to is stored in the database, or calculated when it is read.
GetIsStored(IReadOnlyProperty, StoreObjectIdentifier)	Gets whether the value of the computed column this property is mapped to is stored in the database, or calculated when it is read.
GetIsStoredConfigurationSource(IConventionProperty)	Gets the ConfigurationSource for the computed value SQL expression.
GetJsonPropertyName(IReadOnlyProperty)	Gets the value of JSON property name used for the given property of an entity mapped to a JSON column.
GetJsonPropertyNameConfigurationSource(IConventionProperty)	Gets the ConfigurationSource for the JSON property name for a given entity property.
GetMappedStoreObjects(IReadOnlyProperty, StoreObjectType)	Returns the table-like store objects to which this property is mapped. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetMaxLength(IReadOnlyProperty, StoreObjectIdentifier)	Gets the maximum length of data that is allowed in this property. For example, if the property is a String then this is the maximum number of characters.
GetOrCreateOverrides(IConventionProperty, StoreObjectIdentifier, Boolean)	Returns the property facet overrides for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetOrCreateOverrides(IMutableProperty, StoreObjectIdentifier)	Returns the property facet overrides for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetOverrides(IConventionProperty)	Returns all the property facet overrides. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetOverrides(IMutableProperty)	Returns all the property facet overrides. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetOverrides(IProperty)	Returns all the property facet overrides. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetOverrides(IReadOnlyProperty)	Returns all the property facet overrides. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetPrecision(IReadOnlyProperty, StoreObjectIdentifier)	Gets the precision of data that is allowed in this property. For example, if the property is a Decimal then this is the maximum number of digits.
GetReaderFieldValue(IProperty, RelationalDataReader, Int32, Boolean)	Reads a value for this property from the given relationalReader.
GetRelationalTypeMapping(IReadOnlyProperty)	Returns the RelationalTypeMapping for the given property on a finalized model.
GetScale(IReadOnlyProperty, StoreObjectIdentifier)	Gets the scale of data that is allowed in this property. For example, if the property is a Decimal then this is the maximum number of decimal places.
GetSqlQueryColumnMappings(IProperty)	Returns the SQL query columns to which the property is mapped.
GetTableColumnMappings(IProperty)	Returns the table columns to which the property is mapped.
GetUpdateStoredProcedureParameterMappings(IProperty)	Returns the update stored procedure parameters to which the property is mapped.
GetUpdateStoredProcedureResultColumnMappings(IProperty)	Returns the update stored procedure result columns to which the property is mapped.
GetViewColumnMappings(IProperty)	Returns the view columns to which the property is mapped.
IsColumnNullable(IReadOnlyProperty)	Checks whether the column mapped to the given IProperty will be nullable when created in the database.
IsColumnNullable(IReadOnlyProperty, StoreObjectIdentifier)	Checks whether the column mapped to the given property will be nullable when created in the database.
IsFixedLength(IReadOnlyProperty)	Returns a flag indicating whether the property is capable of storing only fixed-length data, such as strings.
IsFixedLength(IReadOnlyProperty, StoreObjectIdentifier)	Returns a flag indicating whether the property is capable of storing only fixed-length data, such as strings.
IsUnicode(IReadOnlyProperty, StoreObjectIdentifier)	Gets a value indicating whether or not the property can persist Unicode characters.
RemoveOverrides(IConventionProperty, StoreObjectIdentifier)	Removes the property facet overrides for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
RemoveOverrides(IMutableProperty, StoreObjectIdentifier)	Removes the property facet overrides for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
SetCollation(IConventionProperty, String, Boolean)	Configures a collation to be used for the column this property is mapped to.
SetCollation(IMutableProperty, String)	Configures a collation to be used for column this property is mapped to.
SetColumnName(IConventionProperty, String, Boolean)	Sets the column to which the property is mapped.
SetColumnName(IConventionProperty, String, StoreObjectIdentifier, Boolean)	Sets the column to which the property is mapped for a particular table-like store object.
SetColumnName(IMutableProperty, String)	Sets the column to which the property is mapped.
SetColumnName(IMutableProperty, String, StoreObjectIdentifier)	Sets the column to which the property is mapped for a particular table-like store object.
SetColumnOrder(IConventionProperty, Nullable<Int32>, Boolean)	Sets the order of the column the property is mapped to.
SetColumnOrder(IMutableProperty, Nullable<Int32>)	Sets the order of the column the property is mapped to.
SetColumnType(IConventionProperty, String, Boolean)	Sets the database type of the column to which the property is mapped.
SetColumnType(IMutableProperty, String)	Sets the database type of the column to which the property is mapped.
SetComment(IConventionProperty, String, Boolean)	Configures a comment to be applied to the column this property is mapped to.
SetComment(IMutableProperty, String)	Configures a comment to be applied to the column this property is mapped to.
SetComputedColumnSql(IConventionProperty, String, Boolean)	Sets the SQL expression that is used as the computed value for the column this property is mapped to.
SetComputedColumnSql(IMutableProperty, String)	Sets the SQL expression that is used as the computed value for the column this property is mapped to.
SetDefaultValue(IConventionProperty, Object, Boolean)	Sets the object that is used as the default value for the column this property is mapped to.
SetDefaultValue(IMutableProperty, Object)	Sets the object that is used as the default value for the column this property is mapped to.
SetDefaultValueSql(IConventionProperty, String, Boolean)	Sets the SQL expression that is used as the default value for the column this property is mapped to.
SetDefaultValueSql(IMutableProperty, String)	Sets the SQL expression that is used as the default value for the column this property is mapped to.
SetIsFixedLength(IConventionProperty, Nullable<Boolean>, Boolean)	Sets a flag indicating whether the property is capable of storing only fixed-length data, such as strings.
SetIsFixedLength(IMutableProperty, Nullable<Boolean>)	Sets a flag indicating whether the property is capable of storing only fixed-length data, such as strings.
SetIsStored(IConventionProperty, Nullable<Boolean>, Boolean)	Sets whether the value of the computed column this property is mapped to is stored in the database, or calculated when it is read.
SetIsStored(IMutableProperty, Nullable<Boolean>)	Sets whether the value of the computed column this property is mapped to is stored in the database, or calculated when it is read.
SetJsonPropertyName(IConventionProperty, String, Boolean)	Sets the value of JSON property name used for the given property of an entity mapped to a JSON column.
SetJsonPropertyName(IMutableProperty, String)	Sets the value of JSON property name used for the given property of an entity mapped to a JSON column.
TryGetDefaultValue(IReadOnlyProperty, Object)	Returns the object that is used as the default value for the column this property is mapped to.
TryGetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier, Object)	Returns the object that is used as the default value for the column this property is mapped to.