ServerClientSession Class |
Use this session class when Page level locking is required and/or not all Databases are local and not reachable by UNC paths.
Inheritance HierarchySystem.Object
VelocityDb.Session.SessionBase
VelocityDb.Session.ServerClientSession
VelocityDb.Session.ServerClientSessionShared
VelocityDb.Session.SessionBase
VelocityDb.Session.ServerClientSession
VelocityDb.Session.ServerClientSessionShared
Namespace: VelocityDb.Session
Assembly: VelocityDb (in VelocityDb.dll) Version: 11.1.0.0 (11.1)
SyntaxThe ServerClientSession type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ServerClientSession(List<ReplicaInfo>, Int32, Boolean, Boolean, Boolean, CacheEnum, Boolean) | Initializes a new instance of the ServerClientSession class |
| ServerClientSession(String, String, Int32, Boolean, Boolean, Boolean, CacheEnum, Boolean) |
Creates a new session.
|
Properties| Name | Description | |
|---|---|---|
 | AddToIndexInSeperateThread |
Indexing thread not yet available with ServerClientSession.
(Overrides SessionBase.AddToIndexInSeperateThread.) |
| WriteToDiskInSeperateDatabaseThreads |
Write threads not yet available with ServerClientSession.
(Overrides SessionBase.WriteToDiskInSeperateDatabaseThreads.) |
Methods| Name | Description | |
|---|---|---|
| Abort |
Aborts a transaction, it undoes all persistent changes made within the transaction
(Overrides SessionBase.Abort().) |
| BeginRead |
Transaction control, begin a read only transaction
(Overrides SessionBase.BeginRead(Boolean).) |
| BeginReadWithEvents |
Start a read only transaction and gets a list of created/updated objects as subscribed to by this session
|
| BeginUpdate |
Transaction control, begin an update transaction.
(Overrides SessionBase.BeginUpdate(Boolean).) |
| BeginUpdateWithEvents |
Starts a transaction that may be creating new persistent data and/or updating persistent data and gets a list of created/updated objects as subscribed to by this session
|
| ClearServerCache |
Used as an aid when debugging server data, internal use, avoid using for now.
|
| Compact() |
Reduce size of databases, if possible, by first attempting to relocate pages to free areas towards the beginning of each Database file and then by truncating files where unused space begins.
Run Compact() outside the scope of any transaction.
(Overrides SessionBase.Compact().) |
| Compact(Database) |
Reduce size of database, if possible, by truncating file where unused space begins
(Overrides SessionBase.Compact(Database).) |
| CopyAllDatabasesTo |
Copies all databases to a selected directory on the local host.
(Overrides SessionBase.CopyAllDatabasesTo(String, Boolean).) |
| DeleteLocation |
Deletes a DatabaseLocation, location must first mot have any Databases in it
(Overrides SessionBase.DeleteLocation(DatabaseLocation, Boolean).) |
| FlushUpdates |
Send all updated pages to the server(s) managing those pages, freeing up memory in client.
(Overrides SessionBase.FlushUpdates().) |
| FlushUpdatesServers |
Make servers Write all updated data. This may free up some memory on the servers. Only effects sessions using VelocityDbServer(s)
(Overrides SessionBase.FlushUpdatesServers().) |
| InUseNumberOfPages |
Gets the number of pages currently in use by a Database
(Overrides SessionBase.InUseNumberOfPages(Database).) |
| NewDatabase |
Create a new Database with a given database number
(Overrides SessionBase.NewDatabase(UInt32, UInt32, String, Boolean).) |
| NewLocation |
Creates a new DatabaseLocation or updates existing ones
(Overrides SessionBase.NewLocation(DatabaseLocation).) |
| OpenAllDatabases |
Open all databases
(Overrides SessionBase.OpenAllDatabases(Boolean).) |
| OpenDatabase |
Opens a Database
(Overrides SessionBase.OpenDatabase(UInt32, Boolean, Boolean).) |
| OpenLocationDatabases |
Opens all the databases in a given location
(Overrides SessionBase.OpenLocationDatabases(DatabaseLocation, Boolean).) |
| RestoreFrom |
Restores Databases and pages from a backup DatabaseLocation. Existing data will be merged with the restored data unless existing Databases to restore are deleted before the restore.
(Overrides SessionBase.RestoreFrom(DatabaseLocation, DateTime).) |
| SubscribeToChanges |
Subscribe to committed database changes of instances of a type when an optional property evaluates to true.
(Overrides SessionBase.SubscribeToChanges(Type, String).) |
| UnsubscribeToChanges |
Unsubscribe to committed database changes of instances of a type when an optional property evaluates to true.
(Overrides SessionBase.UnsubscribeToChanges(Type, String).) |
| UpdateDatabase |
Request an update lock on a database
(Overrides SessionBase.UpdateDatabase(Database).) |
Extension Methods| Name | Description | |
|---|---|---|
 | ExportToCSV |
Export all persistent objects to .csv files, one file for each Type and version of Type.
This is preview release, format may change. ImportFromCSV can be used to recreate your data.
Note that Microsoft Excel can't handle many of these CSV files due to a field value limitation (at about 33000 chars)
Notepad++ is one application that can read these files.
Some fields like array data are encoded http://msdn.microsoft.com/en-us/library/dhx0d524(v=vs.110).aspx
(Defined by ImportExportCsv.) |
| ExportToJson<T>(UInt64) | Overloaded. (Defined by JsonImportExport.) |
| ExportToJson<T>(Oid) | Overloaded. (Defined by JsonImportExport.) |
| ExportToJson<T>(Boolean, Boolean) | Overloaded. (Defined by JsonImportExport.) |
| ImportFromCSV |
Restores database files, pages and objects from a .csv file data created with ExportToCSV
(Defined by ImportExportCsv.) |
| ImportJson<T> | (Defined by JsonImportExport.) |
| MicrosoftSync | (Defined by Sync.) |
| SyncWith(SessionBase) | Overloaded. (Defined by Sync.) |
| SyncWith(SessionBase, Func<SessionBase, UInt64, Change, Boolean>) | Overloaded. (Defined by Sync.) |
See Also