This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.EntityFrameworkCore.

Summary

Base class for all efcore tools.

Assembly

Cake.EntityFrameworkCore.dll

Namespace

Cake.EntityFrameworkCore

Base Types

DotNetTool<TSettings>

Derived Types

EfCoreDatabaseUpdater

graph BT Type-->Base0["DotNetTool<TSettings>"] Type["EfCoreTool<TSettings>"] class Type type-node Derived0["EfCoreDatabaseUpdater"]-->Type click Derived0 "/api/Cake.EntityFrameworkCore.Database/EfCoreDatabaseUpdater"

Syntax

public abstract class EfCoreTool<TSettings> : DotNetTool<TSettings> 
    where TSettings : EfCoreToolSettings

Type Parameters

Name	Description
TSettings	The settings type.

Constructors

Name	Summary
EfCoreTool(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator, ICakeLog)	Initializes a new instance of the `EfCoreTool` class.

Fields

Name	Constant Value	Summary
_environment
_log

Methods

Name	Value	Summary
AppendToolArguments(ProcessArgumentBuilder, TSettings)	ProcessArgumentBuilder	Adds specific tool commandline arguments.
GetArguments(TSettings)	ProcessArgumentBuilder	Gets all the Arguments needed to run a ef command from a mgiration dll.

Extension Methods

Name	Value	Summary
Dump<EfCoreTool<TSettings>>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<EfCoreTool<TSettings>>(EfCoreTool<TSettings>[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<EfCoreTool<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<EfCoreTool<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<EfCoreTool<TSettings>>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<EfCoreTool<TSettings>>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin