ISqlFunction Interface

Models a function.

Namespace:  Microsoft.Data.Schema.Sql.SchemaModel
Assembly:  Microsoft.Data.Schema.Sql (in Microsoft.Data.Schema.Sql.dll)

Syntax

'Declaration
Public Interface ISqlFunction _
    Inherits IDatabaseFunction, ISqlSubroutine, IModelNamed, ISqlOwnedObject,  _
    ISqlExtendedPropertyHost, ISqlSecurable, ISqlSpecifiesAnsiNulls, ISqlSpecifiesQuotedIdentifier, ISqlSupportsReplication,  _
    ISqlModelElement, IScriptSourcedModelElement, IModelElement, IModelPropertyContainer, IModelEntity,  _
    IModelAnnotationHolder

public interface ISqlFunction : IDatabaseFunction, 
    ISqlSubroutine, IModelNamed, ISqlOwnedObject, ISqlExtendedPropertyHost, ISqlSecurable, 
    ISqlSpecifiesAnsiNulls, ISqlSpecifiesQuotedIdentifier, ISqlSupportsReplication, ISqlModelElement, IScriptSourcedModelElement, 
    IModelElement, IModelPropertyContainer, IModelEntity, IModelAnnotationHolder

public interface class ISqlFunction : IDatabaseFunction, 
    ISqlSubroutine, IModelNamed, ISqlOwnedObject, ISqlExtendedPropertyHost, ISqlSecurable, 
    ISqlSpecifiesAnsiNulls, ISqlSpecifiesQuotedIdentifier, ISqlSupportsReplication, ISqlModelElement, IScriptSourcedModelElement, 
    IModelElement, IModelPropertyContainer, IModelEntity, IModelAnnotationHolder

type ISqlFunction =  
    interface
        interface IDatabaseFunction
        interface ISqlSubroutine
        interface IModelNamed
        interface ISqlOwnedObject
        interface ISqlExtendedPropertyHost
        interface ISqlSecurable
        interface ISqlSpecifiesAnsiNulls
        interface ISqlSpecifiesQuotedIdentifier
        interface ISqlSupportsReplication
        interface ISqlModelElement
        interface IScriptSourcedModelElement
        interface IModelElement
        interface IModelPropertyContainer
        interface IModelEntity
        interface IModelAnnotationHolder
    end

public interface ISqlFunction extends IDatabaseFunction, ISqlSubroutine, IModelNamed, ISqlOwnedObject, ISqlExtendedPropertyHost, ISqlSecurable, ISqlSpecifiesAnsiNulls, ISqlSpecifiesQuotedIdentifier, ISqlSupportsReplication, ISqlModelElement, IScriptSourcedModelElement, IModelElement, IModelPropertyContainer, IModelEntity, IModelAnnotationHolder

The ISqlFunction type exposes the following members.

Properties

	Name	Description
	BodyDependencies	The collection of elements referenced by the body of the function. (Inherited from IDatabaseFunction.)
	DynamicObjects	Gets a list of temporary column sources that are created within the function body.
	ElementClass	Gets the metadata class for an element. (Inherited from IModelElement.)
	ExtendedProperties	Gets the list of extended properties for this object. (Inherited from ISqlExtendedPropertyHost.)
	FunctionBody	Gets or sets the implementation of the function.
	IsAnsiNullsOn	Gets or sets a value that indicates whether the ANSI NULLS setting is ON for this object. (Inherited from ISqlSpecifiesAnsiNulls.)
	IsEncrypted	Gets or sets a value that indicates whether the subroutine is encrypted. (Inherited from ISqlSubroutine.)
	IsQuotedIdentifierOn	Gets or sets a value that indicates whether the QUOTED IDENTIFIER setting is ON for this object. (Inherited from ISqlSpecifiesQuotedIdentifier.)
	IsReplicated	Gets or sets a value that indicates whether the object is subject to replication. (Inherited from ISqlSupportsReplication.)
	IsSchemaBound	Gets or sets a value that models the SCHEMABINDING option for the function.
	Model	Gets the model reference. (Inherited from IModelEntity.)
	Name	Gets or sets the name of the element. (Inherited from IModelElement.)
	Owner	Gets or sets the owner of this object. (Inherited from ISqlOwnedObject.)
	Parameters	Gets the list of parameters to the subroutine. (Inherited from ISqlSubroutine.)
	Permissions	Gets the list of permissions that apply to this object. (Inherited from ISqlSecurable.)
	PrimarySource	Gets information about the primary source for the element. (Inherited from IScriptSourcedModelElement.)
	ResolutionStatus	Gets or sets the value of the model element resolution status. (Inherited from IModelElement.)
	SecondarySources	Gets a list of secondary sources for the element. (Inherited from IScriptSourcedModelElement.)
	SourceCodePositions	Gets the list of sources that define this element. (Inherited from IModelElement.)
	Type	Gets or sets the return type of the function.
	ValidationStatus	Gets or sets the value of the model element validation status. (Inherited from IModelElement.)

Top

Methods

	Name	Description
	AddAnnotation	Adds the given annotation to this element. (Inherited from IModelAnnotationHolder.)
	Delete	Deletes this instance from the model. (Inherited from IModelElement.)
	GetAnnotations()	Returns a list of annotations attached to this element. (Inherited from IModelAnnotationHolder.)
	GetAnnotations(Type)	Returns a list of attached annotations of the given type. (Inherited from IModelAnnotationHolder.)
	GetAnnotations(ModelIdentifier)	Returns a list of attached annotations that have the given identifier. (Inherited from IModelAnnotationHolder.)
	GetAnnotations(ModelIdentifier, Type)	(Inherited from IModelAnnotationHolder.)
	GetAnnotations<TType>()	Returns all attached model annotations that implement the given annotation type and have the specified model identifier. (Inherited from IModelAnnotationHolder.)
	GetAnnotations<TType>(ModelIdentifier)	(Inherited from IModelAnnotationHolder.)
	GetBodyDependenciesRelationship	Returns the IModelMultiRelationship between this IDatabaseFunction and the IModelElement nodes that are referenced by the function body. (Inherited from IDatabaseFunction.)
	GetComposingChildren	Returns a list of composing children for this element. (Inherited from IModelElement.)
	GetDynamicObjectsRelationship	Returns an IModelMultiRelationship between this and the associated ISqlDynamicColumnSource.
	GetExtendedPropertiesRelationship	Returns an IModelReverseMultiRelationship between this and the associated ISqlExtendedProperty. (Inherited from ISqlExtendedPropertyHost.)
	GetFunctionBodyRelationship	Returns an IModelSingleRelationship between this and the associated ISqlFunctionImplementation.
	GetHierarchicalChildren	Returns a list of hierarchical children for this element. (Inherited from IModelElement.)
	GetOwnerInfo	Returns information about the element owner. (Inherited from IModelElement.)
	GetOwnerRelationship	Returns an IModelSingleRelationship between this and the associated ISqlObjectOwner. (Inherited from ISqlOwnedObject.)
	GetParametersRelationship	Returns an IModelMultiRelationship between this and the associated ISqlSubroutineParameter. (Inherited from ISqlSubroutine.)
	GetPermissionsRelationship	Returns an IModelReverseMultiRelationship between this and the associated ISqlPermissionStatement. (Inherited from ISqlSecurable.)
	GetProperty<TProperty>	Gets the specified property. (Inherited from IModelPropertyContainer.)
	GetReferencedDanglingRelationshipEntries	Returns a list of the relationship entries, where this element is on the left side and there is either no element on the right side of the relationship, or the element on the right does not exist in the model. (Inherited from IModelElement.)
	GetReferencedElements	Returns a list of the elements that are in a relationship with this element, where this element is on the left side of the relationship. (Inherited from IModelElement.)
	GetReferencedRelationshipEntries	Returns a list of the relationship entries, where this element is on the left side. (Inherited from IModelElement.)
	GetReferencingElements	Returns a list of the elements that are in a relationship with this element, where this element is on the right side. (Inherited from IModelElement.)
	GetReferencingRelationshipEntries	Returns a list of the relationship entries, where this element is on the right side. (Inherited from IModelElement.)
	GetRelationship(ModelRelationshipClass)	Returns the requested relationship by using the provided metadata. (Inherited from IModelElement.)
	GetRelationship<TFrom, TTo>(ModelRelationshipClass)	Returns a relationship where the two related elements are of the specified types. (Inherited from IModelElement.)
	GetRelationshipEntrySources	Returns a collection of source information about the given relationship. (Inherited from IScriptSourcedModelElement.)
	GetRelationships	Returns a list of the relationships in this element. (Inherited from IModelElement.)
	GetTypeRelationship	Returns an IModelSingleRelationship between this and the associated ISqlTypeSpecifier.
	IsDeleted	Specifies whether the object is deleted. (Inherited from IModelElement.)
	IsExternal	Returns a value that indicates whether the object was loaded from an external source and is not a part of the schema model. (Inherited from IModelElement.)
	RemoveAnnotation	Removes the specified annotation from this model element. (Inherited from IModelAnnotationHolder.)
	SetProperty<TProperty>	Sets the specified property. (Inherited from IModelPropertyContainer.)

Top

See Also

Reference

Microsoft.Data.Schema.Sql.SchemaModel Namespace