Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ScanOptions

The options used when MongoScanner looks for data.

Hierarchy

  • ScanOptions

Index

Properties

excludeCollections?: string | RegExp | (string | RegExp)[]

Collections that you want to exclude from the result. You can provide a string, a Regexp or an array of both. A collection will be removed from the result if it is equal to a string or matches a Regexp.

Default: undefined

excludeDatabases?: string | RegExp | (string | RegExp)[]

Databases that you want to exclude from the result. You can provide a string, a Regexp or an array of both. A database will be removed from the result if it is equal to a string or matches a Regexp.

Default: undefined

excludeEmptyDatabases?: boolean

If you want to exclude empty databases from the result of the method "getSchema()"

NB: Database that are not empty but whose collections are excluded by other options such as excludeSystem or excludeCollections will be considered as empty.

Default: false

excludeSystem?: boolean

If you want system collections to be excluded by the result.

Default: false

ignoreLackOfPermissions?: boolean

If you want to ignore and not throw an error occurred when trying to list databases or collections but the connection had not permission to do it.

NB: Actually, this will ignore all the errors that will occur when listing database or collections.

Default: false

onLackOfPermissions?: LackOfPermissionsCallback

The [[LackOfpermissionsCallback]] callback called if an error occurred when trying to list databases or collections but the connection had not permission to do it.

NB: Actually, this will be called for all the errors that will occur when listing database or collections.

Default: () => { }

useCache?: boolean

If you want to use the cache before starting a database connection. When true, all the previous executions of the MongoScanner instance will be checked before establishing a new database connection. The cache is update every time an execution retrieves data form the database connection.

Default: false

Generated using TypeDoc