DatabaseCollection Class

The DatabaseCollection class represents a collection of Database objects in the topology of a server farm.

System.Object

Microsoft.SharePoint.Portal.Topology.SqlCollectionBase

   Microsoft.SharePoint.Portal.Topology.TopologyObjectCollectionBase

      **Microsoft.SharePoint.Portal.Topology.DatabaseCollection**

Public Constructors

The following table shows the constructors of the DatabaseCollection class and a brief description of each.

Name Description
DatabaseCollection(Microsoft.SharePoint.Portal.Topology.TopologyManager) Reserved for internal use only.
DatabaseCollection(Microsoft.SharePoint.Portal.Topology.TopologyManager, Microsoft.SharePoint.Portal.Topology.Service) Reserved for internal use only.
DatabaseCollection(Microsoft.SharePoint.Portal.Topology.TopologyManager, Microsoft.SharePoint.Portal.Topology.VirtualServer) Reserved for internal use only.

Public Methods

The following table shows the public methods of the DatabaseCollection class and a brief description of each.

Name Description
Add(Microsoft.SharePoint.Portal.Topology.Database) Adds the specified content database.
Remove(System.Guid) Removes the specified content database.

Protected Methods

The following table shows the protected methods of the DatabaseCollection class and a brief description of each.

Name Description
CreateSqlCollectionItem(System.Data.SqlClient.SqlDataReader) Populates the values of the properties of a Database object from a row in the configuration database and returns the Database object.
InitializeSqlCollection Returns a collection of existing Database objects.

Public Properties

The following table shows the properties of the DatabaseCollection class, the data type of each property, and a brief description of each.

Name Data type Description
Item(System.Guid) Microsoft.SharePoint.Portal.Topology.Database Gets a Database object.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Remarks

Use the DatabaseCollection class to manage content databases in the topology of a server farm. The DatabaseCollection object corresponds to the list of content databases in the Databases table of the configuration database.

Deriving from this class is not supported.

To use the properties and methods of the objects in the Topology namespace you must be a member of the local STS_WPG and SPS_WPG security groups, and a member of the db_owner database role for the configuration database.

In addition, for certain methods, such as those that create a portal site, you must be a member of the local Administrators group, and have membership in the Database Creators and Security Administrators server roles in the SQL Server instance that hosts the configuration database.

Requirements

Namespace: Microsoft.SharePoint.Portal.Topology

Platforms: Microsoft Windows Server 2003

Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)

Security: Code Access Security