Skip to content
DocsTry Aspire
DocsTry

SqlProjectResource

Handle
📦 CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects v13.4.0
interface SqlProjectResource
extends IResource,
IResourceWithDacpac,
IResourceWithWaitSupport {
readonly dacDeployOptionsPath: string;
readonly dacpacPath: string;
readonly skipWhenDeployed: boolean;
withConnectionReference(target: IResourceWithConnectionString): SqlProjectResource;
withDacDeployOptions(optionsPath: string): SqlProjectResource;
withDacpac(dacpacPath: string): SqlProjectResource;
withReference(target: SqlServerDatabaseResource): SqlProjectResource;
withSkipWhenDeployed(): SqlProjectResource;
}

Properties

propertydacDeployOptionsPathstringget
Gets the configured path to the deployment options publish profile.
propertydacpacPathstringget
Gets the configured path to the .dacpac file.
propertyskipWhenDeployedbooleanget
Gets a value indicating whether deployment should be skipped when the dacpac has already been deployed.

Methods

Publishes the SQL Server database project to a connection string resource.
withConnectionReference(target: IResourceWithConnectionString): SqlProjectResource
targetIResourceWithConnectionString
SqlProjectResource
Sets the publish profile path used for DAC deployment options.
withDacDeployOptions(optionsPath: string): SqlProjectResource
optionsPathstring
SqlProjectResource
methodwithDacpacbuilder
Specifies the path to the .dacpac file.
withDacpac(dacpacPath: string): SqlProjectResource
dacpacPathstring
SqlProjectResource
methodwithReferencebuilder
Publishes the SQL Server database project to a SQL Server database resource.
withReference(target: SqlServerDatabaseResource): SqlProjectResource
targetSqlServerDatabaseResource
SqlProjectResource
Specifies that .dacpac deployment should be skipped if metadata in the target database indicates that the .dacpac has already been deployed in its current state.
withSkipWhenDeployed(): SqlProjectResource
SqlProjectResource