<?xml version="1.0"?>

<page xmlns="http://projectmallard.org/1.0/"
      type="topic"
      style="function"
      xmlns:api="http://projectmallard.org/experimental/api/"
      xmlns:ui="http://projectmallard.org/experimental/ui/"
      id="mongoc_database_command">


  <info>
    <link type="guide" xref="mongoc_database_t" group="function"/>
  </info>
  <title>mongoc_database_command()</title>

  <section id="synopsis">
    <title>Synopsis</title>
    <synopsis><code mime="text/x-csrc"><![CDATA[mongoc_cursor_t *
mongoc_database_command (mongoc_database_t         *database,
                         mongoc_query_flags_t       flags,
                         uint32_t                   skip,
                         uint32_t                   limit,
                         uint32_t                   batch_size,
                         const bson_t              *command,
                         const bson_t              *fields,
                         const mongoc_read_prefs_t *read_prefs);
]]></code></synopsis>
  </section>


  <section id="parameters">
    <title>Parameters</title>
    <table>
      <tr><td><p>database</p></td><td><p>A <code xref="mongoc_database_t">mongoc_database_t</code>.</p></td></tr>
      <tr><td><p>flags</p></td><td><p>A <code xref="mongoc_query_flags_t">mongoc_query_flags_t</code>.</p></td></tr>
      <tr><td><p>skip</p></td><td><p>The number of documents to skip on the server.</p></td></tr>
      <tr><td><p>limit</p></td><td><p>The maximum number of documents to return from the cursor.</p></td></tr>
      <tr><td><p>batch_size</p></td><td><p>Attempt to batch results from the server in groups of <code>batch_size</code> documents.</p></td></tr>
      <tr><td><p>command</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the command.</p></td></tr>
      <tr><td><p>fields</p></td><td><p>An optional <code xref="bson:bson_t">bson_t</code> containing the fields to return. <code>NULL</code> for all fields.</p></td></tr>
      <tr><td><p>read_prefs</p></td><td><p>An optional <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code>.</p></td></tr>
    </table>
  </section>

  <section id="description">
    <p>The <code>mongoc_database_command()</code> function shall execute a command on a database. This is performed lazily after calling <code xref="mongoc_cursor_next">mongoc_cursor_next()</code> on the resulting cursor structure.</p>
  </section>

  <section id="return">
    <title>Returns</title>
    <p>This command returns a <code xref="mongoc_cursor_t">mongoc_cursor_t</code> that should be freed with <code xref="mongoc_cursor_destroy">mongoc_cursor_destroy()</code> when no longer in use.</p>
  </section>

  <section id="seealso">
    <title>See Also</title>
    <p><code xref="mongoc_cursor_next">mongoc_cursor_next()</code></p>
  </section>
</page>
