Module utils.helper

Index

References

Classes

Logger

Functions

References

DEFAULT_OPTIONS

Re-exports DEFAULT_OPTIONS

mergeOptions

Re-exports mergeOptions

Functions

checkMongodumpInstalled

checkMongodumpInstalled(): void

- Defined in source/utils/checkMongodumpInstalled/index.ts:8
Returns void

checkMongoexportInstalled

checkMongoexportInstalled(): void

- Defined in source/utils/checkMongoexportInstalled/index.ts:8
Returns void

exportCollections

exportCollections(schema: DetailedExportSchema, options: Options, logger: Logger): Promise<{ code: ExportResultCode; exportedCollections: DetailedExportSchema }>

- Defined in source/utils/exportCollections/index.ts:85
Parameters
- schema: DetailedExportSchema
- options: Options
- logger: Logger
Returns Promise<{ code: ExportResultCode; exportedCollections: DetailedExportSchema }>

getMongoConnectionFromOptions

getMongoConnectionFromOptions(options: ConnectionOptions): Promise<ConnectionParameters>

- Defined in source/utils/connection/index.ts:52
Parameters
- options: ConnectionOptions
Returns Promise<ConnectionParameters>

getParsedCollections

getParsedCollections(options: Options, dbParams: ConnectionParameters, logger: Logger): Promise<DetailedExportSchema>

- Defined in source/utils/getParsedCollections/index.ts:31
Parameters
- options: Options
- dbParams: ConnectionParameters
- logger: Logger
Returns Promise<DetailedExportSchema>

purgeExportingOptions

purgeExportingOptions(obj: any): ExportingOptions

- Defined in source/utils/getParsedCollections/purgeExportingOptions.ts:24
Parameters
- obj: any
Returns ExportingOptions

removeSchemaDetails

removeSchemaDetails(detailedExportSchema: DetailedExportSchema): ExportSchema

- Defined in source/utils/getParsedCollections/index.ts:69
Parameters
- detailedExportSchema: DetailedExportSchema
Returns ExportSchema

Generated using TypeDoc