Interface IOdbBackend

Namespace

Stride.Core.Storage

Assembly

Stride.Core.Serialization.dll

Base class for custom object database backends (ODB).

public interface IOdbBackend : IDisposable

Inherited Members

IDisposable.Dispose()

Extension Methods

ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)

Properties

ContentIndexMap

Gets the asset index map.

IContentIndexMap ContentIndexMap { get; }

Property Value

IContentIndexMap

The asset index map.

Methods

CreateStream()

Creates a stream that will be saved to database when closed and/or disposed.

OdbStreamWriter CreateStream()

Returns

OdbStreamWriter

a stream writer that should be passed to Write(ObjectId, Stream, int, bool) in order to be stored in the database

Delete(ObjectId)

Deletes the specified ObjectId.

void Delete(ObjectId objectId)

Parameters

objectId ObjectId

The object id.

EnumerateObjects()

Enumerates the object stored in this backend.

IEnumerable<ObjectId> EnumerateObjects()

Returns

IEnumerable<ObjectId>

Exists(ObjectId)

Determines if the object with the specified ObjectId exists.

bool Exists(ObjectId objectId)

Parameters

objectId ObjectId

The ObjectId to check existence for.

Returns

bool

true if an object with the specified ObjectId exists; otherwise, false.

GetFilePath(ObjectId)

Returns the file path corresponding to the given id (in the VFS domain), if appliable.

string GetFilePath(ObjectId objectId)

Parameters

objectId ObjectId

The ObjectId.

Returns

string

The file path.

GetSize(ObjectId)

Requests that this backend read an object's length (but not its contents).

int GetSize(ObjectId objectId)

Parameters

objectId ObjectId

The ObjectId.

Returns

int

The object size.

OpenStream(ObjectId, VirtualFileMode, VirtualFileAccess, VirtualFileShare)

Opens a Stream of the object with the specified ObjectId.

Stream OpenStream(ObjectId objectId, VirtualFileMode mode = VirtualFileMode.Open, VirtualFileAccess access = VirtualFileAccess.Read, VirtualFileShare share = VirtualFileShare.Read)

Parameters

objectId ObjectId

The ObjectId.

mode VirtualFileMode

The mode.

access VirtualFileAccess

The access.

share VirtualFileShare

The process share mode.

Returns

Stream

A Stream opened from the specified ObjectId.

Write(ObjectId, Stream, int, bool)

Writes an object to the backing store. The backend may need to compute the object ID and return it to the caller.

ObjectId Write(ObjectId objectId, Stream dataStream, int length, bool forceWrite = false)

Parameters

objectId ObjectId

The ObjectId if already computed, or Empty if not determined yet.

dataStream Stream

The data stream.

length int

The data length.

forceWrite bool

Set to true to force writing the datastream even if a content is already stored with the same id. Default is false.

Returns

ObjectId

The generated ObjectId.