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

SystemObject
VelocityDbOptimizedPersistable
VelocityDbDatabaseLocation

Namespace: VelocityDb
Assembly: VelocityDb (in VelocityDb.dll) Version: 11.1.0.0 (11.1)

Syntax

C++

Copy

[SerializableAttribute]
public class DatabaseLocation : OptimizedPersistable, 
	IComparable

<SerializableAttribute>
Public Class DatabaseLocation
	Inherits OptimizedPersistable
	Implements IComparable

[SerializableAttribute]
public ref class DatabaseLocation : public OptimizedPersistable, 
	IComparable

[<SerializableAttribute>]
type DatabaseLocation =  
    class
        inherit OptimizedPersistable
        interface IComparable
    end

The DatabaseLocation type exposes the following members.

Constructors

	Name	Description
	DatabaseLocation(String, String, UInt32, UInt32, SessionBase)	Creates a transient Database location. A transient DatabaseLocation is made persistent by NewLocation(DatabaseLocation)
	DatabaseLocation(String, String, UInt32, UInt32, SessionBase, PageInfocompressionKind, PageInfoencryptionKind, Boolean, DatabaseLocation)	Creates a transient Database location. A transient DatabaseLocation is made persistent by NewLocation(DatabaseLocation)

Top

Properties

	Name	Description
	AllowOtherTypesOnSamePage	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.)
	BackupOfOrForLocation	Gets a linked DatabaseLocation that is either backup of location or is the location being backup up which is decided by IsBackupLocation
	Cache	We do want to cache this kind of object since they are likely to be frequently used. (Overrides OptimizedPersistableCache.)
	CompressPages	Gets page compression info
	DesKey	Gets the Des encryption key from a .des file in user Documents folder. (Environment.SpecialFolder.MyDocuments)
	DirectoryPath	Gets the full path to the directory hosting databases
	EndDatabaseNumber	Gets or sets the last database number within the range of databases for this location
	HostName	Gets the host name of this database location
	IsBackupLocation	Tells if this is a location used for backing up databases.
	IsDefaultLocation	Is this the default DatabaseLocation where Database 0, 1, 2, 3, 4 may be stored?
	IsLocal	Gets info about this location being on the local host or not.
	PageEncryption	Gets the encryption kind attribute.
	PlacementDatabaseNumber	Hint about where to persist DatabaseLocation (Overrides OptimizedPersistablePlacementDatabaseNumber.)
	Replicas
	RsaPrivateXmlKey	The rsaPrivateXmlKey data field is not persisted but can be set and read with this property
	RsaPublicXmlKey	The rsaPublicXmlKey data field is not persisted but can be set and read with this property
	RsaSignature	The rsaSignature data field is not persisted but can be set and read with this property
	StartDatabaseNumber	Gets and sets the start of the range of Database numbers for this location.

Top

Methods

	Name	Description
	CompareTo	The default compare of two DatabaseLocation is by host name and directory (Overrides OptimizedPersistableCompareTo(Object).)
	ContainsDatabase	Check if this location contains a particular Database
	ContainsNewDatabase	Check if this location contains a particular new database (not yet committed) Database
	DatabasePath	Get the full path to a Database
	Databases	Enumerates all Databases of this location
	InitializeAfterRead	Sets the desKey field for desEncrypted locations by reading .des file in Environment.SpecialFolder.MyDocuments (Overrides OptimizedPersistableInitializeAfterRead(SessionBase).)
	InitializeAfterRecreate	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).)
	Persist	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).)
	ReadMe	(Overrides OptimizedPersistableReadMe(TypeVersion, Byte, Int32, SessionBase, Page, Boolean, Schema, Boolean, ListIOptimizedPersistable, Int32, Int32, Boolean).)

Top

Extension Methods

	Name	Description
	ToStringDetails(SessionBase, Boolean)	Overloaded. Object details as a string (Defined by Utilities.)
	ToStringDetails(Schema, TypeVersion, Boolean)	Overloaded. Currently only used by Database Manager (Defined by Utilities.)

Top

Reference

VelocityDb Namespace