DeveelDB  20151217
complete SQL database system, primarly developed for .NET/Mono frameworks
Public Member Functions | Properties | List of all members
Deveel.Data.Store.IObjectStore Interface Reference

Defines the contract for stores that handle lrge objects within a database system. More...

Inheritance diagram for Deveel.Data.Store.IObjectStore:
Deveel.Data.Store.ObjectStore

Public Member Functions

ILargeObject CreateNewObject (long maxSize, bool compressed)
 Creates a new large object returning a reference to it. More...
 
ILargeObject GetObject (ObjectId id)
 Gets an object that was previously created for the given unique identifier. More...
 
long Create ()
 
void Open (long startOffset)
 

Properties

int Id [get]
 Gets the unique identifier of the store within a database system. More...
 

Detailed Description

Defines the contract for stores that handle lrge objects within a database system.

Object stores manage a variety of ObjectType and must allow the creation and establishments of different type of objects (strings or binaries).

Every object store has a unique identifier that is used to resolve the final address of a large object.

Definition at line 35 of file IObjectStore.cs.

Member Function Documentation

long Deveel.Data.Store.IObjectStore.Create ( )
ILargeObject Deveel.Data.Store.IObjectStore.CreateNewObject ( long  maxSize,
bool  compressed 
)

Creates a new large object returning a reference to it.

Parameters
maxSizeThe maximum byte size that the object will use. This is a value to provide ahead of time and that will not change.
compressedIndicates whether the created object contents will be compressed. Compression reduces the amount of size occupied by the object, but it will also affect performances when writing and reading.
Returns
Returns an instance of ILargeObject that is used to access the object stored.
Exceptions
DataStorageExceptionIf an error occurred when creating the object.

Implemented in Deveel.Data.Store.ObjectStore.

ILargeObject Deveel.Data.Store.IObjectStore.GetObject ( ObjectId  id)

Gets an object that was previously created for the given unique identifier.

Parameters
idThe unique identifier of the object to return.
Returns
Returns an instance of ILargeObject that references an object that was previously created by CreateNewObject.
Exceptions
InvalidObjectIdExceptionIf the given id is outside the range of the store.
See also
CreateNewObject

Implemented in Deveel.Data.Store.ObjectStore.

void Deveel.Data.Store.IObjectStore.Open ( long  startOffset)

Property Documentation

int Deveel.Data.Store.IObjectStore.Id
get

Gets the unique identifier of the store within a database system.

Definition at line 39 of file IObjectStore.cs.


The documentation for this interface was generated from the following file: