IRelationalModel Interface

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Metadata

Assembly:: Microsoft.EntityFrameworkCore.Relational.dll

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.

Represents a relational database.

public interface IRelationalModel : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable

type IRelationalModel = interface
    interface IAnnotatable

type IRelationalModel = interface
    interface IAnnotatable
    interface IReadOnlyAnnotatable

Public Interface IRelationalModel
Implements IAnnotatable

Implements: IAnnotatable IReadOnlyAnnotatable

Remarks

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

Properties

Collation	Returns the database collation.
Functions	Returns all user-defined functions contained in the model.
Item[String]	Gets the value of the annotation with the given name, returning `null` if it does not exist. (Inherited from IReadOnlyAnnotatable)
Model	Gets the full model.
Queries	Returns all the SQL queries mapped in the model.
Sequences	Returns all sequences contained in the model.
StoredProcedures	Returns all stored procedures contained in the model.
Tables	Returns all the tables mapped in the model.
Views	Returns all the views mapped in the model.

Methods

AddRuntimeAnnotation(String, Object)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from IAnnotatable)
AnnotationsToDebugString(Int32)	Gets the debug string for all annotations declared on the object. (Inherited from IReadOnlyAnnotatable)
FindAnnotation(String)	Gets the annotation with the given name, returning `null` if it does not exist. (Inherited from IReadOnlyAnnotatable)
FindFunction(String, String, IReadOnlyList<String>)	Finds a IStoreFunction with the given signature.
FindQuery(String)	Gets the SQL query with the given name. Returns `null` if no SQL query with the given name is defined.
FindRuntimeAnnotation(String)	Gets the runtime annotation with the given name, returning `null` if it does not exist. (Inherited from IAnnotatable)
FindRuntimeAnnotationValue(String)	Gets the value of the runtime annotation with the given name, returning `null` if it does not exist. (Inherited from IAnnotatable)
FindSequence(String, String)	Finds an ISequence with the given name.
FindStoredProcedure(String, String)	Finds a IStoreStoredProcedure with the name.
FindTable(String, String)	Gets the table with the given name. Returns `null` if no table with the given name is defined.
FindView(String, String)	Gets the view with the given name. Returns `null` if no view with the given name is defined.
GetAnnotation(String)	Gets the annotation with the given name, throwing if it does not exist. (Inherited from IReadOnlyAnnotatable)
GetAnnotations()	Gets all annotations on the current object. (Inherited from IReadOnlyAnnotatable)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	Gets the value of the runtime annotation with the given name, adding it if one does not exist. (Inherited from IAnnotatable)
GetRuntimeAnnotations()	Gets all the runtime annotations on the current object. (Inherited from IAnnotatable)
RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object. (Inherited from IAnnotatable)
SetRuntimeAnnotation(String, Object)	Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Creates a human-readable representation of the given metadata. Warning: Do not rely on the format of the returned string. It is designed for debugging only and may change arbitrarily between releases.