Click or drag to resize

DatabaseLocation Class

Represents a host and a directory in which a range of databases are stored. The range is a database number range.
Inheritance Hierarchy

Namespace:  VelocityDb
Assembly:  VelocityDb (in VelocityDb.dll) Version: 10.2.0.0 (10.2)
Syntax
[SerializableAttribute]
public class DatabaseLocation : OptimizedPersistable, 
	IComparable

The DatabaseLocation type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAllowOtherTypesOnSamePage
Objects can be stored more efficiently if all object types on the page share the same type. By default mixed types are allowed. Override this to return false for types that should not share pages with other types.
(Overrides OptimizedPersistableAllowOtherTypesOnSamePage.)
Public propertyBackupOfOrForLocation
Gets a linked DatabaseLocation that is either backup of location or is the location being backup up which is decided by IsBackupLocation
Public propertyCache
We do want to cache this kind of object since they are likely to be frequently used.
(Overrides OptimizedPersistableCache.)
Public propertyCompressPages
Gets page compression info
Public propertyDesKey
Gets the Des encryption key from a .des file in user Documents folder. (Environment.SpecialFolder.MyDocuments)
Public propertyDirectoryPath
Gets the full path to the directory hosting databases
Public propertyEndDatabaseNumber
Gets or sets the last database number within the range of databases for this location
Public propertyHostName
Gets the host name of this database location
Public propertyIsBackupLocation
Tells if this is a location used for backing up databases.
Public propertyIsDefaultLocation
Is this the default DatabaseLocation where Database 0, 1, 2, 3, 4 may be stored?
Public propertyIsLocal
Gets info about this location being on the local host or not.
Public propertyPageEncryption
Gets the encryption kind attribute.
Public propertyPlacementDatabaseNumber
Hint about where to persist DatabaseLocation
(Overrides OptimizedPersistablePlacementDatabaseNumber.)
Public propertyReplicas
Public propertyRsaPrivateXmlKey
The rsaPrivateXmlKey data field is not persisted but can be set and read with this property
Public propertyRsaPublicXmlKey
The rsaPublicXmlKey data field is not persisted but can be set and read with this property
Public propertyRsaSignature
The rsaSignature data field is not persisted but can be set and read with this property
Public propertyStartDatabaseNumber
Gets and sets the start of the range of Database numbers for this location.
Top
Methods
  NameDescription
Public methodCompareTo
The default compare of two DatabaseLocation is by host name and directory
(Overrides OptimizedPersistableCompareTo(Object).)
Public methodContainsDatabase
Check if this location contains a particular Database
Public methodContainsNewDatabase
Check if this location contains a particular new database (not yet committed) Database
Public methodDatabasePath
Get the full path to a Database
Public methodDatabases
Enumerates all Databases of this location
Public methodInitializeAfterRead
Sets the desKey field for desEncrypted locations by reading .des file in Environment.SpecialFolder.MyDocuments
(Overrides OptimizedPersistableInitializeAfterRead(SessionBase).)
Public methodInitializeAfterRecreate
This function is called when an object has been read from disk before all data members (fields) have been fully loaded. Override this to provide your own initializations of transient data.
(Overrides OptimizedPersistableInitializeAfterRecreate(SessionBase).)
Public methodPersist
Persists this object. Override in your subclasses when you want fields of your class to be persisted in some special way.
(Overrides OptimizedPersistablePersist(Placement, SessionBase, Boolean, Boolean, QueueIOptimizedPersistable).)
Public methodReadMe (Overrides OptimizedPersistableReadMe(TypeVersion, Byte, Int32, SessionBase, Page, Boolean, Schema, Boolean, ListIOptimizedPersistable, Int32, Int32, Boolean).)
Top
Extension Methods
  NameDescription
Public Extension MethodToStringDetails(SessionBase, Boolean)Overloaded.
Object details as a string
(Defined by Utilities.)
Public Extension MethodToStringDetails(Schema, TypeVersion, Boolean)Overloaded.
Currently only used by Database Manager
(Defined by Utilities.)
Top
See Also