Interface IFunctionBuilder

Interface for a function builder

Namespace: MESL.SqlRace.Domain.Functions

Assembly: MESL.SqlRace.Domain.dll

Syntax

public interface IFunctionBuilder

Properties

SuppressSaving

Gets a value indicating whether saving should be suppressed for functions created by this builder.

Declaration

bool SuppressSaving { get; }

Property Value

Type	Description
System.Boolean	true if [suppress saving]; otherwise, false.

Methods

Build(IFunctionDefinition, FunctionBuildResults, Boolean)

Builds the specified function definition.

Declaration

IFunctionBuilderOutput Build(IFunctionDefinition functionDefinition, FunctionBuildResults functionBuildResults, bool dryRun)

Parameters

Type	Name	Description
IFunctionDefinition	functionDefinition	The function definition.
FunctionBuildResults	functionBuildResults	The function build results.
System.Boolean	dryRun	Specifies that the build is a dry-run to check for build errors.

Returns

Type	Description
IFunctionBuilderOutput	Build output in the form of a specialized implementation of IFunctionBuilderOutput

Remarks

For implementers: If dryRun is set to true, the function build should proceed as normal, adding any errors or warnings to the FunctionBuildResults, but it is not necessary to return an IFunctionBuilderOutput object that can be used, and no applicable internal state should be permanently modified.

CreateFunctionImplementationDefinition()

Creates the function implementation definition.

Declaration

IFunctionImplementationDefinition CreateFunctionImplementationDefinition()

Returns

Type	Description
IFunctionImplementationDefinition	A specialised implementation of IFunctionImplementationDefinition

Initialize()

Initializes this instance.

Declaration

bool Initialize()

Returns

Type	Description
System.Boolean	Whether initializing this instance was successful or not.