Database Class |
Represents a Database which corresponds to file system file.
Inheritance HierarchyNamespace: VelocityDb
Assembly: VelocityDb (in VelocityDb.dll) Version: 11.1.0.0 (11.1)
SyntaxThe Database type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AllowOtherTypesOnSamePage |
We want to be sure that the object representing a Database can share its page with other objects so override AllowOtherTypesOnSamePage and return true.
(Overrides OptimizedPersistableAllowOtherTypesOnSamePage.) |
| CachedVerified |
Setting this property to false will trigger a comparison of the cached version of the Database with the on disk version.
Each new transaction also sets this property to false for all cached databases.
You may alternatively use the session API ForceDatabaseCacheValidation() to trigger validation of all cached databases.
Setting it to false when the Database has been updated in the current transaction is ignored.
|
| FileInfo | FileInfo for this Database, not set for ServerClientSession
|
| FileStream | Stream used for reading and writing this Database |
| HighestPageNumber |
Indicates the highest tryPageNumber number currently in use for this database.
|
| IsDeleted |
Gets info about this Database about to be deleted or not.
|
| IsLocal |
Gets info about this Database being on the local host or not.
|
| IsNew |
Indicates if database was created in the current transactionNumber
|
| IsUpdated |
Gets the updated state of the object
(Overrides OptimizedPersistableIsUpdated.) |
| Location |
The DatabaseLocation of this Database
|
| Name |
Optional name associated with a Database
|
| NumberOfPages |
Indicates how many pages this database contains.
|
| ObjectCachingDefaultPolicy |
Default strategy for this Database, defaults to ObjectCachingDefaultPolicy.
(strategy is not persisted)
|
| PageCacheEnabled |
Turns on or off Page caching for this Database |
| PageOffset |
Methods| Name | Description | |
|---|---|---|
 | AllObjectsT |
Gets an object used for enumerating all objects in this Database
|
| Bytes |
Avoid using this one for now, internal use.
|
| CachedPage |
Try to retrieve a cached Page |
| CloneAs |
Any Database that only uses OidShort references can be cloned without changing any of the internals of the Database. This function simply copies the Database file.
It is the user's responsibility to know that only OidShort references are used within the Database or else such references will still keep the original Database number.
|
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| Equals(Database) |
Compares by version and page 0 offset
|
| Equals(Database, Database) | Determines whether the specified objects are equal. |
| GetEnumerator |
Gets an enumerable sequence of all the pages in this database.
|
| GetHashCode | Returns a hash code for the specified object. |
| OfType |
Gets an object used for enumerating all objects in this Database."/>
|
| Pages |
Gets an enumerable sequence of all the pages in this database.
|
| ReadMe | (Overrides OptimizedPersistableReadMe(TypeVersion, Byte, Int32, SessionBase, Page, Boolean, Schema, Boolean, ListIOptimizedPersistable, Int32, Int32, Boolean).) |
| ToString |
Displays class name plus object id
(Overrides OptimizedPersistableToString.) |
| WritePageBytes |
Fields| Name | Description | |
|---|---|---|
  | InitialReservedDatabaseNumbers | |
| m_guid |
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.) |
See Also