Interface AdminValidateDocumentsRequest

Export

AdminValidateDocumentsRequest

Hierarchy

  • AdminValidateDocumentsRequest

Properties

collection_name database_name from_schema limit? query? sort?

Properties

collection_name

collection_name: any

The name of the collection to validate.

Memberof

AdminValidateDocumentsRequest

database_name

database_name: any

The name of the database that contains the collection to validate.

Memberof

AdminValidateDocumentsRequest

from_schema

from_schema: any

The EJSON schema to validate sampled documents against.

Memberof

AdminValidateDocumentsRequest

Optional limit

limit?: any

The maximum number of documents to sample.

Memberof

AdminValidateDocumentsRequest

Optional query

query?: any

A MongoDB query that matches documents in the collection. The result of running this query is the sample population. Use this to narrow the sample to a subset of documents in the collection.

Memberof

AdminValidateDocumentsRequest

Optional sort

sort?: any

A MongoDB sort for the collection. Use this to determine which end of a range query to start sampling from.

Memberof

AdminValidateDocumentsRequest

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc