Skip to content
This repository has been archived by the owner on May 6, 2024. It is now read-only.

Commit

Permalink
Tpye feature related sections edited.
Browse files Browse the repository at this point in the history
Signed-off-by: Zsolt Gyulai (zgyulai) <[email protected]>
  • Loading branch information
zsoltgyulai94 committed Nov 23, 2023
1 parent c1c7b12 commit 5241d2e
Show file tree
Hide file tree
Showing 7 changed files with 894 additions and 788 deletions.
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
<?xml version="1.0" encoding="utf-8"?>
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd">
<head>
<meta name="description" content="" />
</head>
<body name="configuring-destinations-mongodb">
<h1 name="configuring-destinations-mongodb">mongodb(): Storing messages in a MongoDB database</h1>
<h1 name="configuring-destinations-mongodb">mongodb: Storing messages in a MongoDB database</h1>
<MadCap:keyword term="destination drivers:[&lt;span class=&quot;Code&quot; oldrole=&quot;parameter&quot;&gt;mongodb()&lt;/span&gt;, ' driver']">
</MadCap:keyword>
<p>The <span class="Code">mongodb()</span> driver sends messages to a <a href="https://www.mongodb.com/">MongoDB</a> database. MongoDB is a schema-free, document-oriented database. For the list of available optional parameters, see <MadCap:xref href="reference-destination-mongodb.htm"><span style="color: #04aada;" class="mcFormatColor">mongodb() destination options</span></MadCap:xref>.</p>
<p>The <span class="Code">mongodb()</span> driver sends messages to a <a href="https://www.mongodb.com/">MongoDB</a> database. MongoDB is a schema-free, document-oriented database. For the list of available optional parameters, see <MadCap:xref href="reference-destination-mongodb.htm#reference-destination-mongodb"><span style="color: #04aada;" class="mcFormatColor">mongodb() destination options</span></MadCap:xref>.</p>
<MadCap:snippetBlock src="../shared/wnt/note-server-mode-only.flsnp">
</MadCap:snippetBlock>
<div>
<h6>Declaration</h6><pre>mongodb(parameters);</pre>
</div>
<p>The <span class="Code">mongodb()</span> driver does not support creating indexes, as that can be a very complex operation in MongoDB. If needed, the administrator of the MongoDB database must ensure that indexes are created on the collections.</p>
<p>The <span class="Code">mongodb()</span> driver does not add the <span class="Code">_id</span> field to the message: the MongoDB server will do that automatically, if none is present. If you want to override this field from <MadCap:variable name="General.abbrev"></MadCap:variable>, use the <b class="Code">key()</b> parameter of the <span class="Code">value-pairs()</span> option.</p>
<p>The <span class="Code">mongodb()</span> driver does not add the <span class="Code">_id</span> field to the message: the MongoDB server will do that automatically, if none is present. If you want to override this field from <MadCap:variable name="General.abbrev"></MadCap:variable>, use the <span class="Code">key()</span> parameter of the <span class="Code">value-pairs()</span> option.</p>
<p>The <MadCap:variable name="General.abbrev"></MadCap:variable> <span class="Code">mongodb()</span> driver is compatible with MongoDB server version 1.4 and newer.</p>
<MadCap:snippetBlock src="../shared/wnt/note-typehinting.htm">
<MadCap:snippetBlock src="../shared/wnt/note-typehinting.flsnp">
</MadCap:snippetBlock>
<div class="Example">
<h6 name="example-destination-mongodb"><a name="example-destination-mongodb"></a>Example: Using the mongodb() driver</h6>
Expand All @@ -30,7 +31,7 @@ <h6 name="example-destination-mongodb"><a name="example-destination-mongodb"></a
)
);
};</pre>
<p>The following example shows the same setup using the deprecated libmongo-client syntax (as used in <MadCap:variable name="General.abbrev"></MadCap:variable> version <MadCap:conditionaltext MadCap:conditions="General.OSE">3.7</MadCap:conditionaltext>), and is equivalent with the previous example.</p><pre>destination d_mongodb {
<p>The following example shows the same setup using the deprecated libmongo-client syntax, and is equivalent with the previous example.</p><pre>destination d_mongodb {
mongodb(
servers("localhost:27017")
database("syslog")
Expand Down
Loading

0 comments on commit 5241d2e

Please sign in to comment.