SPDatabase members
Encapsulates access to Microsoft SQL Server databases.
The SPDatabase type exposes the following members.
Constructors
Name | Description | |
---|---|---|
SPDatabase() | Initializes a new instance of the SPDatabase class. | |
SPDatabase(SPDatabaseParameters) | Initializes a new instance of the SPDatabase class based on the specified SPDatabaseParameters object. | |
SPDatabase(String, SPDatabaseServiceInstance) | Initializes a new instance of the SPDatabase class based on the specified name and instance. |
Top
Properties
Name | Description | |
---|---|---|
AvailabilityGroup | ||
BackupLocation | ||
BackupTimeoutOverride | ||
BuildVersion | Gets the cached build version of the database. | |
CanRenameOnRestore | Gets a Boolean value that indicates whether the database can be renamed when it is restored. | |
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. | |
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. | |
CanUpgrade | Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.) | |
DatabaseConnectionString | Gets the connection string that is used to connect to the database. | |
DBAccessPassword | ||
DBAccessUsername | ||
DeploymentLocked | (Inherited from SPPersistedObject.) | |
DiskSizeRequired | Gets the amount of disk space that is required for a backup. | |
DisplayName | Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.) | |
Exists | Gets a Boolean value that indicates whether the database exists. | |
FailoverServer | Gets the SPServer object that represents the server that is hosting the mirror of the database. | |
FailoverServiceInstance | Gets or sets the SPDatabaseServiceInstance object that represents the instance of the database service that is hosting the mirror of the database. | |
Farm | Gets the server farm where the object resides. (Inherited from SPPersistedObject.) | |
Id | Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.) | |
IncludeInVssBackup | Gets a Boolean value that indicates whether the database is included in the Microsoft Visual SourceSafe component list. | |
IsBackwardsCompatible | Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.) | |
IsReadOnly | Gets a value that indicates whether the database is read-only. | |
IsSqlAzure | ||
LegacyDatabaseConnectionString | Gets a string that contains the OLEDB connection string. | |
MultiSubnetFailover | ||
Name | Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.) | |
NeedsUpgrade | (Overrides SPPersistedUpgradableObject.NeedsUpgrade.) | |
NeedsUpgradeIncludeChildren | Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.) | |
NormalizedDataSource | Gets the normalized data source of the database. | |
Parent | Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.) | |
Password | Gets or sets the password that is used for SQL authentication. | |
Properties | Gets metadata for the persisted object. (Inherited from SPPersistedObject.) | |
SchemaVersionXml | Gets information about the schema versions associated with this [c] derived class. | |
Server | Gets the server that contains the database. | |
ServiceInstance | Gets an instance of the SQL service that owns the database. | |
ShouldDeferUpgradeActions | (Inherited from SPPersistedUpgradableObject.) | |
ShouldSkipUpgradeForHigherSchemaVersion | ||
Snapshots | Gets the snapshots of the database. | |
Status | Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.) | |
TypeName | Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.) | |
UpgradeContext | Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.) | |
UpgradedPersistedProperties | Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.) | |
Username | Gets or sets the user name that is used for SQL authentication login. | |
Version | Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.) | |
WasCreated | Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.) |
Top
Methods
Name | Description | |
---|---|---|
AddBackupObjects | Adds the database and its children to the backup/restore job. | |
AddFailoverServiceInstance(String) | Identifies to SharePoint Foundation a server and a database service instance that hosts the mirror of the database. | |
AddFailoverServiceInstance(String, Boolean, Boolean) | ||
AddLogon(String, SecureString, String) | ||
AddLogon(String, SecureString, String, Boolean) | ||
AddLogon(String, SecureString, String, Boolean, Boolean) | ||
ChangeDatabaseInstance(String) | Modifies the database service instance with the specified name for each connection string that is used to access the database. | |
ChangeDatabaseInstance(SPDatabaseServiceInstance) | Modifies the specified database service instance for each connection string that is used to access the database. | |
CleanupAfterMount | ||
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.) | |
CreateFromFilePath | ||
Delete | Deletes the object. (Inherited from SPPersistedObject.) | |
DropRoleMember | ||
Equals | Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.) | |
Finalize | (Inherited from Object.) | |
GenerateConnectionStringForProvisioning | Obsolete. Creates a connection string that is used in provisioning based on a specified connection string. | |
GenerateRandomName | Generates a random database name using the specified connection string as a starting point. | |
GetChild<T>() | Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.) | |
GetChild<T>(String) | Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.) | |
GetHashCode | Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.) | |
GetObjectData | Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.) | |
GetType | (Inherited from Object.) | |
GetVersionForId | Returns the schema version associated with the upgrade sequence specified by ID. | |
GrantAccess(SecurityIdentifier) | Grants the specified user access to the database. | |
GrantAccess(SecurityIdentifier, String) | Grants the specified user access to the database and adds the user to the specified role. | |
GrantOwnerAccessToDatabaseAccount | Grants the database owner permissions to the database access account. | |
HasAdditionalUpdateAccess | Override this method to allow more users to update the object. (Inherited from SPPersistedObject.) | |
Invalidate | Invalidates the cached version stamp and other flags that are related to upgrade. (Overrides SPPersistedUpgradableObject.Invalidate().) | |
IsEmpty | Determines if the database is empty. | |
IsRoleMember | ||
LegacyUpdate | (Inherited from SPPersistedObject.) | |
MemberwiseClone | (Inherited from Object.) | |
Migrate | ||
OnAbort | Raises the Abort (backup) event. | |
OnBackup | Raises the Backup event. | |
OnBackupComplete | Raises the BackupComplete event. | |
OnDeserialization | (Overrides SPPersistedObject.OnDeserialization().) | |
OnPostCreate | (Inherited from SPPersistedObject.) | |
OnPostRestore | Raises the PostRestore event. | |
OnPreCreate | (Inherited from SPPersistedObject.) | |
OnPrepareBackup | Raises the PrepareBackup event. | |
OnPreRestore | Raises the PreRestore event. | |
OnRestore | Raises the Restore event. | |
PreventConnectionDuringUpgrade | ||
Provision() | Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.) | |
Provision(SqlConnectionStringBuilder, TextReader, Dictionary<SPDatabase.DatabaseOptions, Boolean>) | ||
Provision(SqlConnectionStringBuilder, TextReader, Dictionary<String, Boolean>) | Obsolete. Creates a Microsoft SQL Server database with a user schema, creating the schema if it is necessary | |
Provision(SqlConnectionStringBuilder, String, Dictionary<SPDatabase.DatabaseOptions, Boolean>) | ||
Provision(SqlConnectionStringBuilder, String, Dictionary<String, Boolean>) | Obsolete. Prepares a Microsoft SQL Server database for use with Microsoft SharePoint Foundation. If the database does not exist it will be created. If the database exists prior to calling the method, it will be provisioned with the SharePoint schema. | |
Provision(String, String, Dictionary<SPDatabase.DatabaseOptions, Boolean>) | ||
Provision(String, String, Dictionary<String, Boolean>) | Obsolete. Creates a Microsoft SQL Server database with a user schema, creating the schema if necessary. | |
RunWithConcurrencyRetries | (Inherited from SPPersistedObject.) | |
ToString | Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.) | |
Uncache | Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.) | |
Unprovision | Makes the necessary changes to the local server to clean up after deleting the database. (Overrides SPPersistedObject.Unprovision().) | |
Update() | Causes the database to save its state and propagate changes to all the computers in the server farm. (Overrides SPPersistedObject.Update().) | |
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.) | |
UpdateParent | Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.) | |
UpdateWithNoObjectCallbackCheck | (Inherited from SPPersistedObject.) | |
Upgrade() | Upgrades the object. (Inherited from SPPersistedUpgradableObject.) | |
Upgrade(Boolean) | (Overrides SPPersistedUpgradableObject.Upgrade(Boolean).) | |
Validate | Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.) | |
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.) | |
WarnAboutRemoteBlobStorageSettings | Returns a Boolean value that specifies whether the administrator is warned that external binary large object (BLOB) storage is installed. |
Top
Fields
Name | Description | |
---|---|---|
SqlDatabaseOption | Specifies SQL database options that are used in Transact-SQL statements. |
Top