DbMigration.SqlFile(String, Boolean, Object) Method

Definition

Namespace:

System.Data.Entity.Migrations

Assembly:

EntityFramework.dll

Adds an operation to execute a SQL file.

Entity Framework Migrations APIs are not designed to accept input provided by untrusted sources (such as the end user of an application). If input is accepted from such sources it should be validated before being passed to these APIs to protect against SQL injection attacks etc.

[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1719:ParameterNamesShouldNotMatchMemberNames", MessageId="0#")]
protected internal void SqlFile (string sqlFile, bool suppressTransaction = false, object anonymousArguments = null);

member this.SqlFile : string * bool * obj -> unit

Protected Friend Sub SqlFile (sqlFile As String, Optional suppressTransaction As Boolean = false, Optional anonymousArguments As Object = null)

Parameters

sqlFile

String

The SQL file to be executed. Relative paths are assumed to be relative to the current AppDomain's BaseDirectory.

suppressTransaction

Boolean

A value indicating if the SQL should be executed outside of the transaction being used for the migration process. If no value is supplied the SQL will be executed within the transaction.

anonymousArguments

Object

Additional arguments that may be processed by providers. Use anonymous type syntax to specify arguments e.g. 'new { SampleArgument = "MyValue" }'.

Attributes

SuppressMessageAttribute