Class HerobackDump

Hierarchy

HerobackDump

Index

Constructors

constructor

Properties

Accessors

fileName

Methods

Constructors

constructor

new HerobackDump(options: HerobackDumpOptions): HerobackDump

- Defined in dump.ts:46
Parameters
- options: HerobackDumpOptions
Returns HerobackDump

Properties

Protected exporter

exporter: HerobackExporter

Protected logger

logger: LoggerInstance

options

options: HerobackDumpOptions

Protected provider

provider: HerobackProvider

Protected timestamp

timestamp: Date

Accessors

fileName

get fileName(): string

- Defined in dump.ts:88
Gets a generated filename for this dump instance.

Returns string

Methods

export

export(options?: ExportOptions): Promise<Utils.InputStream>

- Defined in dump.ts:116
Dumps and exports the results.

Parameters
- Default value options: ExportOptions = {}
Returns Promise<Utils.InputStream>

raw

raw(): Promise<string>

- Defined in dump.ts:108
Dumps as a raw string. This is meant for development purposes, may be bad for overall perfomance.

Returns Promise<string>

run

run(): Promise<ChildProcess>

- Defined in dump.ts:100
Spawns a child process and dumps requested database. This methods returns the child process instance itself without any heroback logics wrapped yet, and is mostly used internally.
For a higher level interface, check dump.export() and dump.raw().

Returns Promise<ChildProcess>

Static Private initializeExporter

initializeExporter(options: HerobackDumpOptions): HerobackExporter

- Defined in dump.ts:73
Initializes an exporter instance based on constructor options.

Parameters
- options: HerobackDumpOptions
Returns HerobackExporter

Static Private initializeProvider

initializeProvider(options: HerobackDumpOptions): HerobackProvider

- Defined in dump.ts:58
Initializes a provider instance based on constructor options.

Parameters
- options: HerobackDumpOptions
Returns HerobackProvider

Generated using TypeDoc