API Reference
EmailStoreTableQuery
Bounded Store table query with a typed filter AST, deterministic ordering, projection, and keyset continuation.
Inheritance
- Object
- EmailStoreTableQuery
Usage
Explore 8 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 5
- Property EmailStorePstSplitOptions.Query
- Method EmailStoreTableQuery.ContinueFrom
- Method EmailStoreTableQuery.OrderBy
- Method EmailStoreTableQuery.Select
- Method EmailStoreTableQuery.Where
Accepted by parameters 3
Constructors
public EmailStoreTableQuery(EmailStoreFolderId? folderId = null, Boolean includeDescendants = false, Boolean includeAssociatedItems = false, Boolean includeOrphanedItems = false, EmailStoreFilter? filter = null, IEnumerable<EmailStoreSort>? sorts = null, EmailStoreProjection? projection = null, EmailStoreContinuationToken? continuationToken = null, Int32 maxItemsScanned = 1000000, Int32 pageSize = 100) #Creates an immutable table query.
Parameters
- folderId OfficeIMO.Email.Store.EmailStoreFolderId? = null
- includeDescendants System.Boolean = false
- includeAssociatedItems System.Boolean = false
- includeOrphanedItems System.Boolean = false
- filter OfficeIMO.Email.Store.EmailStoreFilter? = null
- sorts System.Collections.Generic.IEnumerable<OfficeIMO.Email.Store.EmailStoreSort>? = null
- projection OfficeIMO.Email.Store.EmailStoreProjection? = null
- continuationToken OfficeIMO.Email.Store.EmailStoreContinuationToken? = null
- maxItemsScanned System.Int32 = 1000000
- pageSize System.Int32 = 100
Methods
public EmailStoreTableQuery ContinueFrom(EmailStoreContinuationToken? token) #EmailStoreTableQueryReturns a copy that resumes from the supplied continuation.
Parameters
- token OfficeIMO.Email.Store.EmailStoreContinuationToken?
public EmailStoreQueryPlan Explain() #EmailStoreQueryPlanReturns the deterministic execution plan without reading item payloads.
public EmailStoreTableQuery OrderBy(params EmailStoreSort[] sorts) #EmailStoreTableQueryReturns a copy with a different ordered column list.
Parameters
- sorts OfficeIMO.Email.Store.EmailStoreSort[]
public EmailStoreTableQuery Select(params EmailStoreField[] fields) #EmailStoreTableQueryReturns a copy with a different table projection.
Parameters
- fields OfficeIMO.Email.Store.EmailStoreField[]
public EmailStoreTableQuery Where(EmailStoreFilter filter) #EmailStoreTableQueryReturns a copy with a different typed filter.
Parameters
- filter OfficeIMO.Email.Store.EmailStoreFilter
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public EmailStoreFolderId? FolderId { get; } #Optional typed folder scope.
public Boolean IncludeDescendants { get; } #Whether descendants of EmailStoreTableQuery.FolderId are included.
public Boolean IncludeAssociatedItems { get; } #Whether folder-associated information is included.
public Boolean IncludeOrphanedItems { get; } #Whether source-index orphans are included.
public EmailStoreFilter Filter { get; } #Typed expression tree evaluated over lightweight references and summaries.
public IReadOnlyList<EmailStoreSort> Sorts { get; } #Caller-requested ordering. Stable folder/item tie-breakers are appended internally.
public EmailStoreContinuationToken? ContinuationToken { get; } #Optional keyset continuation from a compatible earlier page.
public Int32 MaxItemsScanned { get; } #Maximum lightweight references evaluated per execution.