< Back

Get-MdbcCollection

Sat Jan 18, 2020 11:32 am

NAME Get-MdbcCollection



SYNOPSIS

Gets collections.





SYNTAX

Get-MdbcCollection [[-Name] <String>] [-Database <IMongoDatabase>] [-Settings <MongoCollectionSettings>]

[-NewCollection] [<CommonParameters>]





DESCRIPTION

This cmdlet gets the collection instance specified by its name, existing or not. This instance may be used as the

parameter Collection of relevant cmdlets. Missing collections are created automatically as soon as needed.





PARAMETERS

-Name

Specifies the collection name. If it is omitted then all collections are returned.



Required? false

Position? 0

Default value

Accept pipeline input?

Accept wildcard characters?



-Database

Database instance. If it is omitted then the variable $Database is used. It is obtained by Connect-Mdbc,

Get-MdbcDatabase, or using the driver API.



Required? false

Position? named

Default value

Accept pipeline input?

Accept wildcard characters?



-NewCollection

Tells to remove the existing collection.



Required? false

Position? named

Default value

Accept pipeline input?

Accept wildcard characters?



-Settings

Extra settings, see MongoDB.Driver.MongoCollectionSettings



Required? false

Position? named

Default value

Accept pipeline input?

Accept wildcard characters?



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

[MongoDB.Driver.IMongoCollection[BsonDocument]]

Collection instance.







RELATED LINKS

Connect-Mdbc