Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/storage-internal-avro

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AccessTier

AccessTier: "P4" | "P6" | "P10" | "P15" | "P20" | "P30" | "P40" | "P50" | "P60" | "P70" | "P80" | "Hot" | "Cool" | "Archive"

The AccessTier.

BlobChangeFeedEventType

BlobChangeFeedEventType: "UnspecifiedEventType" | "BlobCreated" | "BlobDeleted" | "BlobPropertiesUpdated" | "BlobSnapshotCreated" | "Control" | "BlobTierChanged" | "BlobAsyncOperationInitiated" | "BlobMetadataUpdated" | "RestorePointMarkerCreated"

Change feed event record types.

BlobType

BlobType: "BlockBlob" | "AppendBlob" | "PageBlob"

The type of blob.

UpdatedBlobProperties

UpdatedBlobProperties: Record<string, BlobPropertyChange>

Blob properties that were updated during an event.

Variables

Const ABORT_ERROR

ABORT_ERROR: any = new AbortError("Reading from the avro stream was aborted.")

Const AVRO_CODEC_KEY

AVRO_CODEC_KEY: string = "avro.codec"

Const AVRO_INIT_BYTES

AVRO_INIT_BYTES: Uint8Array = new Uint8Array([79, 98, 106, 1])

Const AVRO_SCHEMA_KEY

AVRO_SCHEMA_KEY: string = "avro.schema"

Const AVRO_SYNC_MARKER_SIZE

AVRO_SYNC_MARKER_SIZE: number = 16

Const CHANGE_FEED_CHUNK_BLOCK_DOWNLOAD_SIZE

CHANGE_FEED_CHUNK_BLOCK_DOWNLOAD_SIZE: number = 16 * 1024 * 1024

Const CHANGE_FEED_CONTAINER_NAME

CHANGE_FEED_CONTAINER_NAME: string = "$blobchangefeed"

Const CHANGE_FEED_INITIALIZATION_SEGMENT

CHANGE_FEED_INITIALIZATION_SEGMENT: string = "1601"

Const CHANGE_FEED_MAX_PAGE_SIZE

CHANGE_FEED_MAX_PAGE_SIZE: number = 5000

Const CHANGE_FEED_META_SEGMENT_PATH

CHANGE_FEED_META_SEGMENT_PATH: string = "meta/segments.json"

Const CHANGE_FEED_SEGMENT_PREFIX

CHANGE_FEED_SEGMENT_PREFIX: string = "idx/segments/"

Const CHANGE_FEED_STATUS_FINALIZED

CHANGE_FEED_STATUS_FINALIZED: string = "Finalized"

Const SDK_VERSION

SDK_VERSION: string = "12.0.0-preview.3"

Const logger

logger: any = createClientLogger("storage-blob-changefeed")

The @azure/logger configuration for this package.

Const millisecondsInAnHour

millisecondsInAnHour: number = 60 * 60 * 1000

Functions

appendUserAgentPrefix

  • appendUserAgentPrefix(options?: StoragePipelineOptions): StoragePipelineOptions

arraysEqual

  • arraysEqual(a: Uint8Array, b: Uint8Array): boolean

blobToString

  • blobToString(blob: Blob): Promise<string>

bodyToAvroReadable

  • bodyToAvroReadable(): void

bodyToString

  • bodyToString(response: { blobBody?: Promise<Blob>; readableStreamBody?: NodeJS.ReadableStream }, length?: undefined | number): Promise<string>

  • Read body from downloading operation methods to string. Works in both Node.js and browsers.

    Parameters

    • response: { blobBody?: Promise<Blob>; readableStreamBody?: NodeJS.ReadableStream }

      Convenience layer methods response with downloaded body

      • Optional blobBody?: Promise<Blob>
      • Optional readableStreamBody?: NodeJS.ReadableStream
    • Optional length: undefined | number

      Length of Readable stream, needed for Node.js environment

    Returns Promise<string>

ceilToNearestHour

  • ceilToNearestHour(date: Date | undefined): Date | undefined

floorToNearestHour

  • floorToNearestHour(date: Date | undefined): Date | undefined

getHost

  • getHost(url: string): string | undefined

getSegmentsInYear

  • getSegmentsInYear(containerClient: ContainerClient, year: number, startTime?: Date, endTime?: Date, options?: GetSegmentsInYearOptions): Promise<string[]>

getURI

  • getURI(url: string): string

getYearsPaths

  • getYearsPaths(containerClient: ContainerClient, options?: GetYearsPathsOptions): Promise<number[]>

hashString

  • hashString(str: string): number

minDate

  • minDate(dateA: Date, dateB?: Date): Date

newPipeline

  • newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

  • Creates a new Pipeline object with Credential provided.

    Parameters

    • Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

      Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.

    • Default value pipelineOptions: StoragePipelineOptions = {}

      Optional. Options.

    Returns Pipeline

    A new Pipeline object.

parseDateFromSegmentPath

  • parseDateFromSegmentPath(segmentPath: string): Date

rawEventToBlobChangeFeedEvent

streamToAvroReadable

  • streamToAvroReadable(readableStream: NodeJS.ReadableStream): AvroReadable

Generated using TypeDoc