AnnotationCodeGenerator Class

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Design

Assembly:: Microsoft.EntityFrameworkCore.Relational.dll

Package:: Microsoft.EntityFrameworkCore.Relational v2.0.3

Package:: Microsoft.EntityFrameworkCore.Relational v2.1.11

Package:: Microsoft.EntityFrameworkCore.Relational v2.2.6

Package:: Microsoft.EntityFrameworkCore.Relational v3.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v3.1.0

Package:: Microsoft.EntityFrameworkCore.Relational v5.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v6.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v7.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Base class to be used by database providers when implementing an IAnnotationCodeGenerator

public class AnnotationCodeGenerator : Microsoft.EntityFrameworkCore.Design.IAnnotationCodeGenerator

type AnnotationCodeGenerator = class
    interface IAnnotationCodeGenerator

Public Class AnnotationCodeGenerator
Implements IAnnotationCodeGenerator

Inheritance: Object
AnnotationCodeGenerator

Implements: IAnnotationCodeGenerator

Remarks

This implementation returns false for all 'IsHandledByConvention' methods and null for all 'GenerateFluentApi' methods. Providers should override for the annotations that they understand.

See Implementation of database providers and extensions for more information and examples.

Constructors

AnnotationCodeGenerator(AnnotationCodeGeneratorDependencies)

Initializes a new instance of this class.

Properties

Dependencies

Relational provider-specific dependencies for this service.

Methods

FilterIgnoredAnnotations(IEnumerable<IAnnotation>)	Filters out annotations in `annotations` for which code should never be generated.
GenerateDataAnnotation(IEntityType, IAnnotation)	Returns a data annotation attribute code fragment for the given `annotation`, or `null` if no data annotation exists for it.
GenerateDataAnnotation(IProperty, IAnnotation)	Returns a data annotation attribute code fragment for the given `annotation`, or `null` if no data annotation exists for it.
GenerateDataAnnotationAttributes(IAnnotatable, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding data annotation attributes, returns those attribute code fragments and removes the annotations.
GenerateDataAnnotationAttributes(IEntityType, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding data annotation attributes, returns those attribute code fragments and removes the annotations.
GenerateDataAnnotationAttributes(IProperty, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding data annotation attributes, returns those attribute code fragments and removes the annotations.
GenerateFluentApi(ICheckConstraint, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(IComplexProperty, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(IComplexType, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(IEntityType, IAnnotation, String)	Obsolete. Returns `null` unless overridden to do otherwise.
GenerateFluentApi(IEntityType, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(IEntityTypeMappingFragment, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(IForeignKey, IAnnotation, String)	Obsolete. Returns `null` unless overridden to do otherwise.
GenerateFluentApi(IForeignKey, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(IIndex, IAnnotation, String)	Obsolete. Returns `null` unless overridden to do otherwise.
GenerateFluentApi(IIndex, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(IKey, IAnnotation, String)	Obsolete. Returns `null` unless overridden to do otherwise.
GenerateFluentApi(IKey, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(IModel, IAnnotation, String)	Obsolete. Returns `null` unless overridden to do otherwise.
GenerateFluentApi(IModel, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(INavigation, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(IProperty, IAnnotation, String)	Obsolete. Returns `null` unless overridden to do otherwise.
GenerateFluentApi(IProperty, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(IRelationalPropertyOverrides, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(ISequence, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(ISkipNavigation, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApi(ITrigger, IAnnotation)	Returns a fluent API call for the given `annotation`, or `null` if no fluent API call exists for it.
GenerateFluentApiCalls(IAnnotatable, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(ICheckConstraint, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(IComplexProperty, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(IComplexType, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(IEntityType, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(IEntityTypeMappingFragment, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(IForeignKey, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(IIndex, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(IKey, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(IModel, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(INavigation, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(IProperty, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(IRelationalPropertyOverrides, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(ISequence, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(ISkipNavigation, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
GenerateFluentApiCalls(ITrigger, IDictionary<String,IAnnotation>)	For the given annotations which have corresponding fluent API calls, returns those fluent API calls and removes the annotations.
IsHandledByConvention(ICheckConstraint, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `checkConstraint`.
IsHandledByConvention(IComplexProperty, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `complexProperty`.
IsHandledByConvention(IComplexType, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `complexType`.
IsHandledByConvention(IEntityType, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `entityType`.
IsHandledByConvention(IEntityTypeMappingFragment, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `fragment`.
IsHandledByConvention(IForeignKey, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `foreignKey`.
IsHandledByConvention(IIndex, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `index`.
IsHandledByConvention(IKey, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `key`.
IsHandledByConvention(IModel, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `model`.
IsHandledByConvention(INavigation, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `navigation`.
IsHandledByConvention(IProperty, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `property`.
IsHandledByConvention(IRelationalPropertyOverrides, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `overrides`.
IsHandledByConvention(ISequence, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `sequence`.
IsHandledByConvention(ISkipNavigation, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `navigation`.
IsHandledByConvention(ITrigger, IAnnotation)	Checks if the given `annotation` is handled by convention when applied to the given `trigger`.
RemoveAnnotationsHandledByConventions(IAnnotatable, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(ICheckConstraint, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(IComplexProperty, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(IComplexType, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(IEntityType, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(IEntityTypeMappingFragment, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(IForeignKey, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(IIndex, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(IKey, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(IModel, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(INavigation, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(IProperty, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(IRelationalPropertyOverrides, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(ISequence, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(ISkipNavigation, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.
RemoveAnnotationsHandledByConventions(ITrigger, IDictionary<String,IAnnotation>)	Removes annotation whose configuration is already applied by convention, and do not need to be specified explicitly.

Applies to

Share via