BlobAggregationStorage Class
Signature
export declare class BlobAggregationStorage extends SnapshotExtractor implements IDocumentStorageService
Extends: SnapshotExtractor
Implements: IDocumentStorageService
Constructors
| Constructor | Description |
|---|---|
| (constructor)(storage, logger, allowPacking, packingLevel, blobCutOffSize) | Constructs a new instance of the BlobAggregationStorage class |
Static Properties
| Property | Type | Description |
|---|---|---|
| fullDataStoreSummaries |
Static Methods
| Method | Return Type | Description |
|---|---|---|
| unpackSnapshot(snapshot) | Promise<void> | |
| wrap(storage, logger, allowPacking, packingLevel) | BlobAggregationStorage |
Properties
| Property | Type | Description |
|---|---|---|
| loadedFromSummary | boolean | |
| policies | IDocumentStorageServicePolicies | undefined | |
| repositoryUrl | string | |
| virtualBlobs | Map<string, ArrayBufferLike> |
Methods
| Method | Return Type | Description |
|---|---|---|
| createBlob(file) | Promise<ICreateBlobResponse> | |
| downloadSummary(handle) | Promise<ISummaryTree> | |
| getBlob(id, tree) | Promise<ArrayBufferLike> | |
| getSnapshotTree(version) | Promise<ISnapshotTree | null> | |
| getVersions(versionId, count) | Promise<IVersion[]> | |
| isRealStorageId(id) | boolean | |
| readBlob(id) | Promise<ArrayBufferLike> | |
| setBlob(id, tree, content) | void | |
| unpackSnapshot(snapshot) | Promise<void> | |
| uploadSummaryWithContext(summary, context) | Promise<string> |
Constructor Details
(constructor)
Constructs a new instance of the BlobAggregationStorage class
Signature
protected constructor(storage: IDocumentStorageService, logger: ITelemetryLogger, allowPacking: boolean, packingLevel: number, blobCutOffSize?: number | undefined);
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| storage | IDocumentStorageService | ||
| logger | ITelemetryLogger | ||
| allowPacking | boolean | ||
| packingLevel | number | ||
| blobCutOffSize | optional | number | undefined |
Property Details
fullDataStoreSummaries
Signature
static readonly fullDataStoreSummaries = true;
loadedFromSummary
Signature
protected loadedFromSummary: boolean;
Type: boolean
policies
Signature
get policies(): IDocumentStorageServicePolicies | undefined;
Type: IDocumentStorageServicePolicies | undefined
repositoryUrl
Signature
get repositoryUrl(): string;
Type: string
virtualBlobs
Signature
protected virtualBlobs: Map<string, ArrayBufferLike>;
Type: Map<string, ArrayBufferLike>
Method Details
createBlob
Signature
createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| file | ArrayBufferLike |
Returns
Return type: Promise<ICreateBlobResponse>
downloadSummary
Signature
downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| handle | ISummaryHandle |
Returns
Return type: Promise<ISummaryTree>
getBlob
Signature
getBlob(id: string, tree: ISnapshotTree): Promise<ArrayBufferLike>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| tree | ISnapshotTree |
Returns
Return type: Promise<ArrayBufferLike>
getSnapshotTree
Signature
getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| version | optional | IVersion |
Returns
Return type: Promise<ISnapshotTree | null>
getVersions
Signature
getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| versionId | string | null | |
| count | number |
Returns
Return type: Promise<IVersion[]>
isRealStorageId
Signature
protected isRealStorageId(id: string): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string |
Returns
Return type: boolean
readBlob
Signature
readBlob(id: string): Promise<ArrayBufferLike>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string |
Returns
Return type: Promise<ArrayBufferLike>
setBlob
Signature
setBlob(id: string, tree: ISnapshotTree, content: string): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| tree | ISnapshotTree | |
| content | string |
unpackSnapshot
Signature
unpackSnapshot(snapshot: ISnapshotTree): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| snapshot | ISnapshotTree |
Returns
Return type: Promise<void>
unpackSnapshot
Signature
static unpackSnapshot(snapshot: ISnapshotTree): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| snapshot | ISnapshotTree |
Returns
Return type: Promise<void>
uploadSummaryWithContext
Signature
uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| summary | ISummaryTree | |
| context | ISummaryContext |
Returns
Return type: Promise<string>
wrap
Signature
static wrap(storage: IDocumentStorageService, logger: ITelemetryLogger, allowPacking?: boolean, packingLevel?: number): BlobAggregationStorage;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| storage | IDocumentStorageService | ||
| logger | ITelemetryLogger | ||
| allowPacking | optional | boolean | |
| packingLevel | optional | number |
Returns
Return type: BlobAggregationStorage