PoshMongo.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-MongoDBDocument</command:name> <command:verb>Add</command:verb> <command:noun>MongoDBDocument</command:noun> <maml:description> <maml:para>This cmdlet adds a document (JSON) to a MongoDB Collection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet adds a document to the selected MongoDB Collection. You must first select the collection (Get-MongoDBCollection) before a document can be added.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-MongoDBDocument</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>This is a JSON string object. It can be a complex object that is converted to JSON via ConvertTo-Json.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>This is a JSON string object. It can be a complex object that is converted to JSON via ConvertTo-Json.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Text.Json</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Add-MongoDBDocument -Document '{"_id":"4e27b0f5-aaa0-4d4d-bdc8-43f811242d93","Name":"FirstName"}'</dev:code> <dev:remarks> <maml:para>An example showing how to add a simple json document to the collection</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Add-MongoDBDocument -Document $ComplexDocument |ConvertTo-Json -Compress</dev:code> <dev:remarks> <maml:para>An example showing how to add a more complex document to the collection</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-MongoDBCollection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Connect-MongoDBInstance</command:name> <command:verb>Connect</command:verb> <command:noun>MongoDBInstance</command:noun> <maml:description> <maml:para>Connect to a MongoDB Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Connect to a MongoDB Instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-MongoDBInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>A proper MongoDB connection string</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ForceTls12</maml:name> <maml:description> <maml:para>This switch forces the TLS 1.2 Protocol, this is required for Azure CosmosDB with a MongoDB API backend.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>A proper MongoDB connection string</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ForceTls12</maml:name> <maml:description> <maml:para>This switch forces the TLS 1.2 Protocol, this is required for Azure CosmosDB with a MongoDB API backend.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>MongoDB.Driver.MongoClient</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Connect-MongoDBInstance -ConnectionString $settings</dev:code> <dev:remarks> <maml:para>A simple example showing a connectionstring stored in a variable</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>MongoDB Connection String</maml:linkText> <maml:uri>https://www.mongodb.com/docs/manual/reference/connection-string/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-MongoDBCollection</command:name> <command:verb>Get</command:verb> <command:noun>MongoDBCollection</command:noun> <maml:description> <maml:para>Get a MongoDB Collection</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns a specific MongoDB Collection from the selected MongoDB Database, or all available collections.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MongoDBCollection</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CollectionName</maml:name> <maml:description> <maml:para>The name of the collection to retrieve from the Database</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CollectionName</maml:name> <maml:description> <maml:para>The name of the collection to retrieve from the Database</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>MongoDB.Driver.IMongoCollection</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-MongoDBCollection -CollectionName MyCollection CollectionNamespace : MyDB.MyCollection Database : MongoDB.Driver.MongoDatabaseImpl DocumentSerializer : MongoDB.Bson.Serialization.Serializers.BsonDocumentSerializer Indexes : MongoDB.Driver.MongoCollectionImpl`1+MongoIndexManager[MongoDB.Bson.BsonDocument] Settings : AssignIdOnInsert=True;GuidRepresentation=CSharpLegacy;ReadConcern={ };ReadEncoding=null;ReadPreference={ Mode : Primary };WriteConcern={ };WriteEncoding=null</dev:code> <dev:remarks> <maml:para>How to get a collection by name</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-MongoDBCollection CollectionNamespace : MyDB.MyCollection Database : MongoDB.Driver.MongoDatabaseImpl DocumentSerializer : MongoDB.Bson.Serialization.Serializers.BsonDocumentSerializer Indexes : MongoDB.Driver.MongoCollectionImpl`1+MongoIndexManager[MongoDB.Bson.BsonDocument] Settings : AssignIdOnInsert=True;GuidRepresentation=CSharpLegacy;ReadConcern={ };ReadEncoding=null;ReadPreference={ Mode : Primary };WriteConcern={ };WriteEncoding=null CollectionNamespace : MyDB.MyCollection2 Database : MongoDB.Driver.MongoDatabaseImpl DocumentSerializer : MongoDB.Bson.Serialization.Serializers.BsonDocumentSerializer Indexes : MongoDB.Driver.MongoCollectionImpl`1+MongoIndexManager[MongoDB.Bson.BsonDocument] Settings : AssignIdOnInsert=True;GuidRepresentation=CSharpLegacy;ReadConcern={ };ReadEncoding=null;ReadPreference={ Mode : Primary };WriteConcern={ };WriteEncoding=null</dev:code> <dev:remarks> <maml:para>Get a list of collections</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-MongoDBDatabase</command:name> <command:verb>Get</command:verb> <command:noun>MongoDBDatabase</command:noun> <maml:description> <maml:para>Get a MongoDB Database</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a MongoDB Database</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MongoDBDatabase</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the Database to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the Database to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>MongoDB.Driver.MongoDatabaseBase</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-MongoDBDatabase -DatabaseName MyDB Client : MongoDB.Driver.MongoClient DatabaseNamespace : MyDB Settings : GuidRepresentation=CSharpLegacy;ReadConcern={ };ReadEncoding=null;ReadPreference={ Mode : Primary };WriteConcern={ };WriteEncoding=null</dev:code> <dev:remarks> <maml:para>Get a specific database from MongoDB</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-MongoDBDatabase Client : MongoDB.Driver.MongoClient DatabaseNamespace : MyDB Settings : GuidRepresentation=CSharpLegacy;ReadConcern={ };ReadEncoding=null;ReadPreference={ Mode : Primary };WriteConcern={ };WriteEncoding=null Client : MongoDB.Driver.MongoClient DatabaseNamespace : MyDB2 Settings : GuidRepresentation=CSharpLegacy;ReadConcern={ };ReadEncoding=null;ReadPreference={ Mode : Primary };WriteConcern={ };WriteEncoding=null</dev:code> <dev:remarks> <maml:para>Get a list of databases from MongoDB</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-MongoDBDocument</command:name> <command:verb>Get</command:verb> <command:noun>MongoDBDocument</command:noun> <maml:description> <maml:para>Get a MongoDB Document</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a MongoDB Document from the selected Database and Collection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MongoDBDocument</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DocumentId</maml:name> <maml:description> <maml:para>This is the _id of the document</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>This is a hashtable of values that are converted into a simple equality type filter. For example:</maml:para> <maml:para></maml:para> <maml:para>@{'Name'='FirstName'}</maml:para> <maml:para></maml:para> <maml:para>Is translated into a FilterDefinition object</maml:para> <maml:para></maml:para> <maml:para>Filter.Eq(key, value));</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DocumentId</maml:name> <maml:description> <maml:para>This is the _id of the document</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>This is a hashtable of values that are converted into a simple equality type filter. For example:</maml:para> <maml:para></maml:para> <maml:para>@{'Name'='FirstName'}</maml:para> <maml:para></maml:para> <maml:para>Is translated into a FilterDefinition object</maml:para> <maml:para></maml:para> <maml:para>Filter.Eq(key, value));</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Text.Json</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-MongoDBDocument -DocumentId '4e27b0f5-aaa0-4d4d-bdc8-43f811242d93' _id : 4e27b0f5-aaa0-4d4d-bdc8-43f811242d93 Name : FirstName</dev:code> <dev:remarks> <maml:para>Get a specific document by the id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-MongoDBDocument -Filter @{'Name'='FirstName'} _id : 4e27b0f5-aaa0-4d4d-bdc8-43f811242d93 Name : FirstName</dev:code> <dev:remarks> <maml:para>Get a document using a filter</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-MongoDBDocument _id : 4e27b0f5-aaa0-4d4d-bdc8-43f811242d93 Name : FirstName _id : 1777c473-15fa-44f6-9509-97c3d7847cc1 Name : SecondName _id : e6a4b5cc-9a1e-46df-b240-0136afdf1e24 Name : ThirdName</dev:code> <dev:remarks> <maml:para>Get a list of available documents from the collection</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FilterDefinitionBuilder</maml:linkText> <maml:uri>https://mongodb.github.io/mongo-csharp-driver/2.18/apidocs/html/T_MongoDB_Driver_FilterDefinitionBuilder_1.htm</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-MongoDBCollection</command:name> <command:verb>New</command:verb> <command:noun>MongoDBCollection</command:noun> <maml:description> <maml:para>Create a MongoDB Collection</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a MongoDB Collection in the selected Database, the collection is only written back to the database when a document is added to it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-MongoDBCollection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CollectionName</maml:name> <maml:description> <maml:para>The name of the collection to create</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CollectionName</maml:name> <maml:description> <maml:para>The name of the collection to create</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>MongoDB.Driver.IMongoCollection</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-MongoDBCollection -CollectionName MyCollection3 CollectionNamespace : MyDB.MyCollection3 Database : MongoDB.Driver.MongoDatabaseImpl DocumentSerializer : MongoDB.Bson.Serialization.Serializers.BsonDocumentSerializer Indexes : MongoDB.Driver.MongoCollectionImpl`1+MongoIndexManager[MongoDB.Bson.BsonDocument] Settings : AssignIdOnInsert=True;GuidRepresentation=CSharpLegacy;ReadConcern={ };ReadEncoding=null;ReadPreference={ Mode : Primary };WriteConcern={ };WriteEncoding=null</dev:code> <dev:remarks> <maml:para>Create a new collection</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-MongoDBDatabase</command:name> <command:verb>New</command:verb> <command:noun>MongoDBDatabase</command:noun> <maml:description> <maml:para>Create a MongoDB Database</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a MongoDB Database, the database is only written to Mongo when a collection is stored in it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-MongoDBDatabase</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the database to create</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the database to create</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>MongoDB.Driver.MongoDatabaseBase</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-MongoDBDatabase -DatabaseName MyDB3 Client : MongoDB.Driver.MongoClient DatabaseNamespace : MyDB3 Settings : GuidRepresentation=CSharpLegacy;ReadConcern={ };ReadEncoding=null;ReadPreference={ Mode : Primary };WriteConcern={ };WriteEncoding=null</dev:code> <dev:remarks> <maml:para>Create a new database</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-MongoDBCollection</command:name> <command:verb>Remove</command:verb> <command:noun>MongoDBCollection</command:noun> <maml:description> <maml:para>Remove a MongoDB Collection</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a MongoDB Collection from the selected database</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-MongoDBCollection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CollectionName</maml:name> <maml:description> <maml:para>The name of the collection to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CollectionName</maml:name> <maml:description> <maml:para>The name of the collection to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>MongoDB.Driver.IMongoCollection</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-MongoDBCollection -CollectionName MyCollection</dev:code> <dev:remarks> <maml:para>Remove a collection from the database</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-MongoDBDatabase</command:name> <command:verb>Remove</command:verb> <command:noun>MongoDBDatabase</command:noun> <maml:description> <maml:para>Remove a MongoDB Database</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a MongoDB Database</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-MongoDBDatabase</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the database to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the database to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>MongoDB.Driver.MongoDatabaseBase</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-MongoDBDatabase -DatabaseName MyDB3</dev:code> <dev:remarks> <maml:para>Remove a database from Mongo</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-MongoDBDocument</command:name> <command:verb>Remove</command:verb> <command:noun>MongoDBDocument</command:noun> <maml:description> <maml:para>Remove a MongoDB Document</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a MongoDB Document from the selected collection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-MongoDBDocument</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DocumentId</maml:name> <maml:description> <maml:para>The document to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>This is a hashtable of values that are converted into a simple equality type filter. For example:</maml:para> <maml:para></maml:para> <maml:para>@{'Name'='FirstName'}</maml:para> <maml:para></maml:para> <maml:para>Is translated into a FilterDefinition object</maml:para> <maml:para></maml:para> <maml:para>Filter.Eq(key, value));</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DocumentId</maml:name> <maml:description> <maml:para>The document to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>This is a hashtable of values that are converted into a simple equality type filter. For example:</maml:para> <maml:para></maml:para> <maml:para>@{'Name'='FirstName'}</maml:para> <maml:para></maml:para> <maml:para>Is translated into a FilterDefinition object</maml:para> <maml:para></maml:para> <maml:para>Filter.Eq(key, value));</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Text.Json</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-MongoDBDocument -DocumentId '4e27b0f5-aaa0-4d4d-bdc8-43f811242d93'</dev:code> <dev:remarks> <maml:para>Remove a document from the collection</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Remove-MongoDBDocument -Filter @{'Name'='FirstName'}</dev:code> <dev:remarks> <maml:para>Remove a document from the collection using a filter</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |