Show / Hide Table of Contents

Interface IMetadataStore

Store containing metadata for IPackage originating from any partition of the package graph.

Inherited Members
System.Collections.Generic.IEnumerable<Microsoft.PackageGraph.ObjectModel.IPackage>.GetEnumerator()
IMetadataSource.GetMetadata(IPackageIdentity)
IMetadataSource.ContainsMetadata(IPackageIdentity)
IMetadataSource.GetFiles<T>(IPackageIdentity)
IMetadataSource.CopyTo(IMetadataSink, CancellationToken)
IMetadataSource.CopyTo(IMetadataSink, IMetadataFilter, CancellationToken)
IMetadataSource.MetadataCopyProgress
IMetadataSource.OpenProgress
IMetadataSink.AddPackages(IEnumerable<IPackage>)
IMetadataSink.AddPackage(IPackage)
IMetadataSink.PackagesAddProgress
System.IDisposable.Dispose()
Namespace: Microsoft.PackageGraph.Storage
Assembly: package-graph-microsoft-update.dll
Syntax
public interface IMetadataStore : IEnumerable<IPackage>, IEnumerable, IMetadataSource, IMetadataSink, IDisposable

Properties

| Improve this Doc View Source

IsMetadataIndexingSupported

True if the metadata in this store is indexed for fast queries; false otherwise

Declaration
bool IsMetadataIndexingSupported { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsReindexingRequired

True if re-indexing is required in a metadata store, false otherwise

Declaration
bool IsReindexingRequired { get; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

ContainsPackage(IPackageIdentity)

Checks if the store contains a package by identity

Declaration
bool ContainsPackage(IPackageIdentity packageIdentity)
Parameters
Type Name Description
IPackageIdentity packageIdentity

Package identity

Returns
Type Description
System.Boolean

True if the store contains the package, false otherwise

| Improve this Doc View Source

Flush()

Flush the store to its underlying storage

Declaration
void Flush()
| Improve this Doc View Source

GetPackage(IPackageIdentity)

Retrieves a package by package identity

Declaration
IPackage GetPackage(IPackageIdentity packageIdentity)
Parameters
Type Name Description
IPackageIdentity packageIdentity

Package identity

Returns
Type Description
IPackage
| Improve this Doc View Source

GetPackage(Int32)

Retrieves a package by package index. The package index must originate from this store instance.

Declaration
IPackage GetPackage(int packageIndex)
Parameters
Type Name Description
System.Int32 packageIndex
Returns
Type Description
IPackage
| Improve this Doc View Source

GetPackageIdentities()

Retrieves a list of all package identities in the store

Declaration
List<IPackageIdentity> GetPackageIdentities()
Returns
Type Description
System.Collections.Generic.List<IPackageIdentity>

List of package identities

| Improve this Doc View Source

GetPackageIndex(IPackageIdentity)

Gets a integer index for a package. This index is unique only in the context of the metadata source that retrieved it.

Declaration
int GetPackageIndex(IPackageIdentity packageIdentity)
Parameters
Type Name Description
IPackageIdentity packageIdentity
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetPendingPackages()

Gets a list of packages pending indexing

Declaration
IReadOnlyList<IPackage> GetPendingPackages()
Returns
Type Description
System.Collections.Generic.IReadOnlyList<IPackage>
| Improve this Doc View Source

ReIndex()

Re-indexes the metadata store, if supported.

Declaration
void ReIndex()

Events

| Improve this Doc View Source

PackageIndexingProgress

Progress reporting for a long-running reindexing operation.

Declaration
event EventHandler<PackageStoreEventArgs> PackageIndexingProgress
Event Type
Type Description
System.EventHandler<PackageStoreEventArgs>
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX