Interface IDocumentStoreOld

Metadata store interface.

Namespace: Microsoft.GNS.Roster.DataAccess

Assembly: Microsoft.GNS.Roster.DataAccess.dll

Syntax

public interface IDocumentStoreOld

Methods

CreateQuery<TOut>(Scope, Nullable<String>)

Creates a query for the document store.

Declaration

IQueryable<TOut> CreateQuery<TOut>(Scope scope = null, string? containerName = null)
    where TOut : class, IRosterDocumentOld

Parameters

Type	Name	Description
Scope	scope	The scope of the objects in query. If not specified or set to Empty then the entire database is searched.
System.Nullable<System.String>	containerName	The container of the object in the query. If not specified all containers are searched.

Returns

Type	Description
IQueryable<TOut>	An object.

Type Parameters

Name	Description
TOut	The type returned by the query.

DeleteDocumentAsync(IRosterDocumentOld)

Deletes a document.

Declaration

Task DeleteDocumentAsync(IRosterDocumentOld document)

Parameters

Type	Name	Description
IRosterDocumentOld	document	The IRosterDocument to delete.

Returns

Type	Description
Task	A task representing the work to delete the document.

GetDocumentByIdAsync<TOut>(Guid)

Gets a document by its Id.

Declaration

Task<TOut> GetDocumentByIdAsync<TOut>(Guid id)
    where TOut : class, IRosterDocumentOld

Parameters

Type	Name	Description
Guid	id	The ID of the document.

Returns

Type	Description
Task<TOut>	The document as the reference type requested or null if not found.

Type Parameters

Name	Description
TOut	The deserialized type.

GetDocumentByNameAsync<TOut>(String, String, Scope)

Gets a document by name.

Declaration

Task<TOut> GetDocumentByNameAsync<TOut>(string name, string container, Scope scope)
    where TOut : class, IRosterDocumentOld

Parameters

Type	Name	Description
System.String	name	The name of the document.
System.String	container	The name of the document container.
Scope	scope	The scope of the document container.

Returns

Type	Description
Task<TOut>	An the document as an IRosterDocument.

Type Parameters

Name	Description
TOut	The deserialized type.

GetDocumentsByOwnerAsync<TOut>(String, String, Scope)

Gets all documents for a given owner.

Declaration

IAsyncEnumerable<TOut> GetDocumentsByOwnerAsync<TOut>(string owner, string container, Scope scope)
    where TOut : class, IRosterDocumentOld

Parameters

Type	Name	Description
System.String	owner	The owner of the document.
System.String	container	The name of the document container.
Scope	scope	The scope of the document container.

Returns

Type	Description
IAsyncEnumerable<TOut>	An async enumerable list of objects that implement IRosterDocument.

Type Parameters

Name	Description
TOut	The deserialized type.

GetDocumentsFromContainerAsync<TOut>(String, Scope)

Gets all documents for the given containers.

Declaration

IAsyncEnumerable<TOut> GetDocumentsFromContainerAsync<TOut>(string container, Scope scope)
    where TOut : class, IRosterDocumentOld

Parameters

Type	Name	Description
System.String	container	The name of the document container.
Scope	scope	The scope of the document container.

Returns

Type	Description
IAsyncEnumerable<TOut>	An async enumerable list of objects that implement IRosterDocument.

Type Parameters

Name	Description
TOut	The deserialized type.

SetDocumentAsync<T>(T)

Performs an upsert of the provided document.

Declaration

Task<T> SetDocumentAsync<T>(T document)
    where T : class, IRosterDocumentOld

Parameters

Type	Name	Description
T	document	The document to set.

Returns

Type	Description
Task<T>	The updated document an IRosterDocument.

Type Parameters

Name	Description
T	The deserialized type.