Export (0) Print
Expand All

UserDefinedAggregate Class

The UserDefinedAggregate object represents a SQL Server user-defined aggregate.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type UserDefinedAggregate =  
    class 
        inherit ScriptSchemaObjectBase 
        interface ISfcSupportsDesignMode 
        interface IObjectPermission 
        interface ICreatable 
        interface IDroppable 
        interface IExtendedProperties 
        interface IScriptable 
        interface IAlterable 
    end

The UserDefinedAggregate type exposes the following members.

  NameDescription
Public methodUserDefinedAggregate()Initializes a new instance of the UserDefinedAggregate class.
Public methodUserDefinedAggregate(Database, String)Initializes a new instance of the UserDefinedAggregate class on the specified database and with the specified name.
Public methodUserDefinedAggregate(Database, String, String)Initializes a new instance of the UserDefinedAggregate class on the specified database and with the specified name and schema.
Top

  NameDescription
Public propertyAssemblyNameGets or sets the name of the assembly for the user-defined aggregate.
Public propertyClassNameGets or sets the name of the class for the user-defined aggregate.
Public propertyCreateDateGets the date and time when the user-defined aggregate was created.
Public propertyDataTypeGets or sets the data type returned by the user-defined aggregate.
Public propertyDateLastModifiedGets the date and time when the user-defined aggregate was last modified.
Public propertyExtendedPropertiesRepresents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property defined on the user-defined aggregate.
Public propertyIDGets the ID value that uniquely identifies the user-defined aggregate.
Public propertyIsSchemaOwnedGets a Boolean value that indicates whether the UserDefinedAggregate object is owned by a schema.
Public propertyNameGets or sets a String which contains the name of the UserDefinedAggregate. (Overrides ScriptSchemaObjectBase.Name.)
Public propertyOwnerGets the name of the owner of the UserDefinedAggregate object.
Public propertyParametersRepresents a collection of UserDefinedAggregateParameter objects. Each UserDefinedAggregateParameter object represents a parameter defined on the user-defined aggregate.
Public propertyParentGets the Database object that is the parent of the UserDefinedAggregate object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertySchemaGets or sets a String which contains the name of the Scheme which owns the UserDefinedAggregate. (Overrides ScriptSchemaObjectBase.Schema.)
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAlterUpdates any UserDefinedAggregate object property changes on instance of Microsoft SQL Server.
Public methodChangeSchemaChanges the schema for the user-defined aggregate.
Public methodCreateCreates a user-defined aggregate on the instance of Microsoft SQL Server as defined by the UserDefinedAggregate object.
Public methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee on the user-defined aggregate.
Public methodDeny(ObjectPermissionSet, String[])Denies the specified set of permissions for the specified grantees on the user-defined aggregate.
Public methodDeny(ObjectPermissionSet, String, Boolean)Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the user-defined aggregate.
Public methodDeny(ObjectPermissionSet, String[], Boolean)Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the user-defined aggregate.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the user-defined aggregate from the instance of Microsoft SQL Server.
Public methodEnumObjectPermissions()Enumerates a list of object permissions for the user-defined aggregate.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the user-defined aggregate.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the user-defined aggregate.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the user-defined aggregate.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodGrant(ObjectPermissionSet, String)Grants the specified set of permissions to the specified grantee on the user-defined aggregate.
Public methodGrant(ObjectPermissionSet, String[])Grants the specified set of permissions to the specified grantees on the user-defined aggregate.
Public methodGrant(ObjectPermissionSet, String, Boolean)Grants access to the specified permission to the grantee and the ability to grant access to other users on the user-defined aggregate.
Public methodGrant(ObjectPermissionSet, String[], Boolean)Grants access to the specified permission to the grantees and the ability to grant access to other users on the user-defined aggregate.
Public methodGrant(ObjectPermissionSet, String, Boolean, String)Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the user-defined aggregate under an assumed role.
Public methodGrant(ObjectPermissionSet, String[], Boolean, String)Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the user-defined aggregate under an assumed role.
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the UserDefinedAggregate object properties. (Overrides ScriptNameObjectBase.Refresh().)
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the user-defined aggregate.
Public methodRevoke(ObjectPermissionSet, String[])Revokes a previously granted set of permissions from a list of grantees on the user-defined aggregate.
Public methodRevoke(ObjectPermissionSet, String, Boolean, Boolean)Revokes previously granted permissions from a grantee on the user-defined aggregate and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public methodRevoke(ObjectPermissionSet, String[], Boolean, Boolean)Revokes previously granted permissions from grantees on the user-defined aggregate and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public methodRevoke(ObjectPermissionSet, String, Boolean, Boolean, String)Revokes previously granted permissions from a grantee on the user-defined aggregate and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public methodRevoke(ObjectPermissionSet, String[], Boolean, Boolean, String)Revokes previously granted permissions from grantees on the user-defined aggregate and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public methodScript()Generates a Transact-SQL script that can be used to re-create the user-defined aggregate.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the user-defined aggregate as specified by the script options.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate propertyISfcSupportsDesignMode.IsDesignModeGets a value that indicates whether the UserDefinedAggregate object supports design mode.
Top

To get UserDefinedAggregate object properties, users can be a member of the public fixed server role.

To set UserDefinedAggregate object properties, users must have CREATE AGGREGATE permission on the database and also REFERENCES permission on the specified assembly.

To create a user-defined aggregate, users must have DROP AGGREGATE permission on the database or ALTER permission on the user-defined aggregate.

To grant, deny, or revoke permission on the user-defined aggregate to other users, users must have CONTROL permission on the user-defined aggregate.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft