Header menu logo Migrondi

IMiMigrationSource Type

Minimal abstraction for reading/writing raw migration content. Users implement this to provide custom sources (HTTP, S3, Azure Blob, etc.). The library handles all serialization/deserialization internally.

Instance members

Instance member Description

this.ListFiles

Full Usage: this.ListFiles

Parameters:
    locationUri : Uri - Full URI to the directory-like location

Returns: Uri seq A sequence of URIs to migration files
Modifiers: abstract

Lists migration URIs at a location

locationUri : Uri

Full URI to the directory-like location

Returns: Uri seq

A sequence of URIs to migration files

this.ListFilesAsync

Full Usage: this.ListFilesAsync

Parameters:
    locationUri : Uri - Full URI to the directory-like location
    ?cancellationToken : CancellationToken - A cancellation token that can be used to cancel the operation

Returns: Task<Uri seq> A sequence of URIs to migration files
Modifiers: abstract

Lists migration URIs at a location

locationUri : Uri

Full URI to the directory-like location

?cancellationToken : CancellationToken

A cancellation token that can be used to cancel the operation

Returns: Task<Uri seq>

A sequence of URIs to migration files

this.ReadContent

Full Usage: this.ReadContent

Parameters:
    uri : Uri - Full URI to the resource (file://, http://, s3://, etc.)

Returns: string The raw content as a string
Modifiers: abstract

Reads raw string content from a URI

uri : Uri

Full URI to the resource (file://, http://, s3://, etc.)

Returns: string

The raw content as a string

SourceNotFound Thrown when the resource is not found

this.ReadContentAsync

Full Usage: this.ReadContentAsync

Parameters:
    uri : Uri - Full URI to the resource (file://, http://, s3://, etc.)
    ?cancellationToken : CancellationToken - A cancellation token that can be used to cancel the operation

Returns: Task<string> The raw content as a string
Modifiers: abstract

Reads raw string content from a URI

uri : Uri

Full URI to the resource (file://, http://, s3://, etc.)

?cancellationToken : CancellationToken

A cancellation token that can be used to cancel the operation

Returns: Task<string>

The raw content as a string

SourceNotFound Thrown when the resource is not found

this.WriteContent

Full Usage: this.WriteContent

Parameters:
    uri : Uri - Full URI to the resource
    content : string - The raw content to write

Modifiers: abstract

Writes raw string content to a URI

uri : Uri

Full URI to the resource

content : string

The raw content to write

this.WriteContentAsync

Full Usage: this.WriteContentAsync

Parameters:
    uri : Uri - Full URI to the resource
    content : string - The raw content to write
    ?cancellationToken : CancellationToken - A cancellation token that can be used to cancel the operation

Returns: Task
Modifiers: abstract

Writes raw string content to a URI

uri : Uri

Full URI to the resource

content : string

The raw content to write

?cancellationToken : CancellationToken

A cancellation token that can be used to cancel the operation

Returns: Task

Type something to start searching.