Placement Class

This class is used when deciding where to place a new object persistently. That is we have a choice of database number, page number and page number. There is other ways to control the placement including ObjectsPerPage, PagesPerDatabase, and it is also possible to override Persist(Placement, SessionBase, Boolean, Boolean, QueueIOptimizedPersistable).

Inheritance Hierarchy

SystemObject
  VelocityDbOptimizedPersistable
    VelocityDbPlacement
      VelocityDbAutoPlacement

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

Syntax

C++

Copy

[SerializableAttribute]
public class Placement : OptimizedPersistable

<SerializableAttribute>
Public Class Placement
	Inherits OptimizedPersistable

[SerializableAttribute]
public ref class Placement : public OptimizedPersistable

[<SerializableAttribute>]
type Placement =  
    class
        inherit OptimizedPersistable
    end

The Placement type exposes the following members.

Constructors

	Name	Description
	Placement(SessionBase, IOptimizedPersistable, IOptimizedPersistable, Boolean, UInt32, Boolean)	Creates a Placement used for choosing a place to persist objects
	Placement(UInt32, UInt16, UInt16, UInt16, UInt16, Boolean, Boolean, UInt32, Boolean, Boolean)	Creates a Placement used for choosing a place to persist objects

Top

Properties

	Name	Description
	AllowOtherTypesOnSamePage	Gets/sets permission to create multiple types on the same page.
	EndDatabaseNumber	The last Database number acceptable for placement
	MaxObjectsPerPage	Gets/Sets the limit on how many objects to create on a single page.
	MaxPagesPerDatabase	Gets/sets the limit on the number of pages per database.
	StartDatabaseNumber	The first/original Database number used by this Placement
	StartPageNumber	The first/original Page number used by this Placement
	TryDatabaseNumber	Gets the current Database number to try with first for object placement.
	TryPageNumber	Gets/sets the page number to try with first when persisting a new object.
	TrySlotNumber	Gets/sets the page number to try next when persisting an object.

Top

Methods

	Name	Description
	IncrementTryDatabaseNumber	Incremnts the Database number used when placing (persisting) objects
	IncrementTryPageNumber	Increments the tryPageNumber by 1
	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).)
	ReadMe	(Overrides OptimizedPersistableReadMe(TypeVersion, Byte, Int32, SessionBase, Page, Boolean, Schema, Boolean, ListIOptimizedPersistable, Int32, Int32, Boolean).)

Top

Fields

	Name	Description
	DefaultPlacementDatabaseNumber	If no other Database number is selected when persisting an object then this number is choosen.
	DefaultPlacementPage	If no other Page number is selected when persisting an object then this number is choosen.

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