SPContentDatabase members

  • Article

Represents a content database in the SharePoint Foundation deployment.

The SPContentDatabase type exposes the following members.

Constructors

  Name Description
Public method SPContentDatabase Initializes a new instance of the SPContentDatabase class.

Top

Properties

  Name Description
Public property AvailabilityGroup (Inherited from SPDatabase.)
Public property BackupLocation (Inherited from SPDatabase.)
Public property BackupTimeoutOverride (Inherited from SPDatabase.)
Public property BuildVersion Gets the cached build version of the database. (Inherited from SPDatabase.)
Public property CanMigrate Obsolete. Returns a value that indicates whether the content database can be migrated.
Public property CanRenameOnRestore Gets a Boolean value that indicates whether the database can be renamed when it is restored. (Inherited from SPDatabase.)
Public property CanSelectForBackup Gets or sets a Boolean value that specifies whether the database object and its children can be selected for a backup operation in the Central Administration user interface. (Inherited from SPDatabase.)
Public property CanSelectForRestore Gets or sets a Boolean value that specifies whether this object and its children can be selected for a restore operation in the Central Administration user interface. (Inherited from SPDatabase.)
Public property CanUpgrade Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property ConcurrentSiteUpgradeSessionLimit Gets or sets the limit on how many site upgrade session can happen concurrently on this database.
Public property CorruptionChecker
Public property CurrentChangeToken Gets the change token used to log the next change in the change log for the content database.
Public property CurrentSiteCount Gets the current number of site collections that are represented in the content database.
Public property DatabaseConnectionString Gets the connection string that is used to connect to the database. (Inherited from SPDatabase.)
Public property DatabaseExtensions
Public property DBAccessPassword (Inherited from SPDatabase.)
Public property DBAccessUsername (Inherited from SPDatabase.)
Public property DeploymentLocked (Inherited from SPPersistedObject.)
Public property DiskSizeRequired Gets the amount of disk space that is required for a backup. (Inherited from SPDatabase.)
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property Exists Gets a Boolean value that indicates whether the database exists. (Inherited from SPDatabase.)
Public property ExistsInFarm Gets a value that indicates whether the content database exists in the farm.
Public property FailoverServer Gets the SPServer object that represents the server that is hosting the mirror of the database. (Inherited from SPDatabase.)
Public property FailoverServiceInstance Gets or sets the SPDatabaseServiceInstance object that represents the instance of the database service that is hosting the mirror of the database. (Inherited from SPDatabase.)
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property FollowableLists Gets a collection containing all the follow able lists in the content database sorted by the most recent last item modified date.
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property IncludeInVssBackup Gets a Boolean value that indicates whether the database is included in the Microsoft Visual SourceSafe component list. (Inherited from SPDatabase.)
Public property IsAttachedToFarm Gets a value that indicates whether the content database is attached to the farm.
Public property IsBackwardsCompatible Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
Public property IsPaired Obsolete. Gets or sets a Boolean value that specifies whether the content database is paired to a Windows SharePoint Services 2.0 content database.
Public property IsReadOnly (Overrides SPDatabase.IsReadOnly.)
Public property IsSqlAzure (Inherited from SPDatabase.)
Public property LastLanguageAndRegionSyncTime Gets or sets the last time the language and region synchronization ran.
Public property LastMembershipSyncChangeToken Gets or sets the change token for the last time the membership synchronization was performed on this database.
Public property LastProfileSyncChangeToken Gets or sets the change token for the last time the user profile synchronization was performed on this database.
Public property LastProfileSyncTime Gets or sets the timestamp for the last time the user profile synchronization was performed on this database.
Public property LastSearchCrawlSyncTime Gets or sets the last synchronization time for search.
Public property LastSweepSyncChangeToken Gets or sets the change token for the last time sweep synchronization was performed on this database.
Public property LegacyDatabaseConnectionString Gets a string that contains the OLEDB connection string. (Inherited from SPDatabase.)
Public property MaintenanceWindows Gets the collection of maintenance windows for this database.
Public property MaximumSiteCount Gets or sets the maximum number of sites that can be represented in the content database.
Public property MultiSubnetFailover (Inherited from SPDatabase.)
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public property NeedsUpgrade (Inherited from SPDatabase.)
Public property NeedsUpgradeIncludeChildren Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
Public property NormalizedDataSource Gets the normalized data source of the database. (Inherited from SPDatabase.)
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Password Gets or sets the password that is used for SQL authentication. (Inherited from SPDatabase.)
Public property PreferredTimerServiceInstance Gets or sets the timer service instance that will execute any timer jobs against the content database.
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property RemoteBlobStorageSettings Gets an object that holds settings that determine how the content database uses Microsoft SQL Server Remote Blob Storage.
Public property RestoredTime Gets the time when the content database was added or restored to the farm, in UTC format.
Public property SchemaVersionXml Gets information about the schema versions associated with this [c] derived class. (Inherited from SPDatabase.)
Public property SearchServiceInstance Gets or sets an instance of the search service that is associated with the content database.
Public property Server Gets the name of the database server that contains the content database.
Public property ServiceInstance Gets an instance of the SQL service that owns the database. (Inherited from SPDatabase.)
Public property ShouldDeferUpgradeActions (Inherited from SPPersistedUpgradableObject.)
Public property ShouldSkipUpgradeForHigherSchemaVersion (Inherited from SPDatabase.)
Public property Sites Gets the collection of site collections that are represented in the content database.
Public property SiteSubscriptions Gets the site subscriptions in the content database.
Public property SkipOrphanCheck
Public property Snapshots Gets the snapshots of the database. (Inherited from SPDatabase.)
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property TypeName Gets the display name that is used to describe the object type in the administration user interface. (Overrides SPPersistedObject.TypeName.)
Public property UpgradeContext Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property Username Gets or sets the user name that is used for SQL authentication login. (Inherited from SPDatabase.)
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Public property WarningSiteCount Gets or sets the number of sites that can be created before a warning event is generated and the owner of the site collection is notified.
Protected property WasCreated Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)
Public property WebApplication Gets the Web application that uses the content database.

Top

Methods

  Name Description
Public method AddBackupObjects Adds the content database to the backup/restore job. (Overrides SPDatabase.AddBackupObjects(SPBackupRestoreObject).)
Public method AddFailoverServiceInstance(String) Identifies to SharePoint Foundation a server and a database service instance that hosts the mirror of the database. (Inherited from SPDatabase.)
Public method AddFailoverServiceInstance(String, Boolean, Boolean) (Inherited from SPDatabase.)
Public method AddLogon(String, SecureString, String) (Inherited from SPDatabase.)
Public method AddLogon(String, SecureString, String, Boolean) (Inherited from SPDatabase.)
Public method AddLogon(String, SecureString, String, Boolean, Boolean) (Inherited from SPDatabase.)
Public method AddSitesToUserSyncQueue Adds site collections to the queue of site collections where user information needs to be synchronized.
Public methodStatic member AreContentDatabasesCompatibleForCopy
Public method ChangeDatabaseInstance(String) Modifies the database service instance with the specified name for each connection string that is used to access the database. (Inherited from SPDatabase.)
Public method ChangeDatabaseInstance(SPDatabaseServiceInstance) Modifies the specified database service instance for each connection string that is used to access the database. (Inherited from SPDatabase.)
Protected method CleanupAfterMount (Overrides SPDatabase.CleanupAfterMount().)
Public method Clone Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
Public methodStatic member CreateFromPreconfiguredDatabase
Public methodStatic member CreateUnattachedContentDatabase(SqlConnectionStringBuilder) Creates a content database object, from the database with the specified connection string, without registering it in the configuration database of the farm.
Public methodStatic member CreateUnattachedContentDatabase(String, String, String, String) Creates a content database object, by using the specified connection information, without registering it in the configuration database of the farm.
Public method Delete Deletes the content database. (Overrides SPPersistedObject.Delete().)
Public method DoesSiteMasterExist
Protected method DropRoleMember (Inherited from SPDatabase.)
Public method EnsureSiteMasterExists
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method ForceDeleteSite(Guid, Boolean, Boolean) Removes a site collection object from the content database when standard deletion methods are unusable.
Public method ForceDeleteSite(Guid, Boolean, Boolean, Boolean)
Public method ForceDeleteSite(Guid, Boolean, Boolean, Boolean, Boolean)
Public method ForceGradualDeleteSites([])
Public method ForceGradualDeleteSites([], Int32)
Public method GetActiveWorkItems Gets the collection of work items that are associated with the content database based on the specified work item type.
Public method GetChanges() Returns the default number of changes listed in the current change log for the content database.
Public method GetChanges(SPChangeQuery) Returns a collection of changes from the change log that have been filtered by the specified query.
Public method GetChanges(SPChangeToken) Returns the collection of content database changes, starting from a specified date.
Public method GetChanges(SPChangeToken, SPChangeToken) Returns a collection of changes that have been logged over a specified period of time.
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetDeletedSite Gets the deleted site with a specified site ID.
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetMaintenanceWindow Returns the first maintenance window where the ShouldNotify operation returns true.
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetSitesFromSids Returns the site collections that correspond to specific security identifiers (SIDs).
Public method GetSitesInUserSyncQueue Returns the site collections that need their user information lists synchronized.
Public method GetType (Inherited from Object.)
Protected method GetVersionForId Returns the schema version associated with the upgrade sequence specified by ID. (Inherited from SPDatabase.)
Public method GetWorkItems Returns the individual work items, number of columns, and number of rows in the specified work item collection as output parameters.
Protected method GrantAccess(SecurityIdentifier) Grants the specified user access to the database. (Inherited from SPDatabase.)
Protected method GrantAccess(SecurityIdentifier, String) Grants the specified user access to the database and adds the user to the specified role. (Inherited from SPDatabase.)
Public method GrantOwnerAccessToDatabaseAccount Grants the database owner permissions to the database access account. (Inherited from SPDatabase.)
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Public method Invalidate Invalidates the cached version stamp and other flags that are related to upgrade. (Inherited from SPDatabase.)
Public method IsEmpty Determines if the database is empty. (Inherited from SPDatabase.)
Protected method IsRoleMember (Inherited from SPDatabase.)
Public method IsSiteScheduledForDeletion
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Migrate() Obsolete. Migrates settings between paired content databases.
Public method Migrate(Boolean) Obsolete. Migrates settings from a paired content database with the option of including all children.
Public method Migrate(SPContentDatabase, ServiceExtensionType, Guid, SPDatabaseMigrationOptions) (Inherited from SPDatabase.)
Public method Move(SPContentDatabase, List<SPSite>, Dictionary<SPSite, String>) Moves the specified sites from this content database to the specified content database.
Public method Move(SPContentDatabase, List<SPSite>, Dictionary<String, String>, Dictionary<SPSite, String>) Moves the specified sites from this content database to the specified content database and optionally specifies the source and destination storage providers.
Public method OnAbort Raises the Abort (backup) event. (Inherited from SPDatabase.)
Public method OnBackup Raises the Backup event. (Inherited from SPDatabase.)
Public method OnBackupComplete Raises the BackupComplete event. (Inherited from SPDatabase.)
Protected method OnDeserialization (Inherited from SPDatabase.)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Public method OnPostRestore(SPDatabaseSnapshotRestoreEvent) Provides post restoration processing after the content database is restored from one of its snapshots.
Public method OnPostRestore(Object, SPRestoreInformation) Raises the PostRestore event. (Overrides SPDatabase.OnPostRestore(Object, SPRestoreInformation).)
Protected method OnPreCreate (Inherited from SPPersistedObject.)
Public method OnPrepareBackup Raises the PrepareBackup event. (Overrides SPDatabase.OnPrepareBackup(Object, SPBackupInformation).)
Public method OnPreRestore(SPDatabaseSnapshotRestoreEvent) Provides preparation processing for the restoration of a content database from one of its snapshots.
Public method OnPreRestore(Object, SPRestoreInformation) Raises the PreRestore event. (Inherited from SPDatabase.)
Public method OnRestore Raises the Restore event. (Overrides SPDatabase.OnRestore(Object, SPRestoreInformation).)
Protected method PreventConnectionDuringUpgrade (Overrides SPDatabase.PreventConnectionDuringUpgrade().)
Public method Provision Creates the content database. (Overrides SPPersistedObject.Provision().)
Public method QueryFeatures(Guid) Gets all site- or Web-scoped features in this content database that have a specific feature ID.
Public method QueryFeatures(SPFeatureScope, Boolean) Gets all site- or Web-scoped features that need to be upgraded, or all that do not, as specified.
Public method QueryFeatures(Guid, Boolean) Gets all site- or Web-scoped features in this content database that have a specific feature ID and that need to be upgraded, or all that do not, as specified.
Public method QueryFeatures(Guid, Int64)
Public method QueryFeatures(Guid, Version) Gets all site- or Web-scoped features in the content database that have a specific feature ID and version.
Public method RefreshSitesInConfigurationDatabase Synchronizes the content database with the configuration database of the farm with respect to what site collections actually exist in the content database.
Public method RemoveSiteFromUserSyncQueue Removes a site collection from the queue of sites that need their user information synchronized.
Public method RemoveSubscriptionMaps
Public method Repair Repairs the content database.
Public method RepairSiteOrphans
Public method RestoreSiteMap
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
Public method ShrinkDB
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the necessary changes to the local server to clean up after deleting the database. (Inherited from SPDatabase.)
Public method Update() Saves the state of the content database and propagates changes in it to all the computers in the server farm, after first verifying that the content database is attached to the farm. (Overrides SPDatabase.Update().)
Public method Update(Boolean) Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Public method Upgrade() Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
Public method Upgrade(Boolean) Upgrades the content database from a previous release to the current release, with the option of upgrading all its children in the upgrade hierarchy. (Overrides SPDatabase.Upgrade(Boolean).)
Protected method Validate Validates the state of the content database before persisting it. (Overrides SPPersistedObject.Validate().)
Public method ValidateBackwardsCompatibility Validates the backward compatibility of the content database schema for the DLLs on the Web front end. This method is called each time a connection is made to the content database to verify that the database schema is compatible. (Inherited from SPPersistedUpgradableObject.)
Protected method WarnAboutRemoteBlobStorageSettings Returns a Boolean value that specifies whether the administrator is warned that external binary large object (BLOB) storage is installed. (Inherited from SPDatabase.)
Public method WriteFailedSiteInUserSyncQueue Records a failure to synchronize user information for a site collection.

Top

See also

Reference

SPContentDatabase class

Microsoft.SharePoint.Administration namespace