@@ -387,9 +387,7 @@ Options
387
387
388
388
* - ``background``
389
389
- boolean
390
- - For |out| to |s3| only.
391
-
392
- Flag to run aggregation operations in the background. If
390
+ - Flag to run aggregation operations in the background. If
393
391
omitted, defaults to ``false``. When set to ``true``, {+adl+}
394
392
runs the queries in the background.
395
393
@@ -509,7 +507,6 @@ Examples
509
507
same ``sale-date`` value. |out| names each file using the
510
508
documents' ``sale-date`` value converted to a string.
511
509
512
-
513
510
*Multiple Fields from Documents*
514
511
515
512
.. example::
@@ -608,46 +605,17 @@ Examples
608
605
- A string value of part ID from the ``part-id`` field, and
609
606
- A forward slash (``/``).
610
607
611
- **Run Query in the background**
612
-
613
- The following example shows |out| syntax for running an
614
- aggregation pipeline that ends with the |out| stage in the
615
- background.
616
-
617
- .. code-block:: json
618
- :emphasize-lines: 16
619
-
620
- db.foo.aggregate([
621
- {
622
- "$out" : {
623
- "s3" : {
624
- "bucket" : "my-s3-bucket",
625
- "region" : "us-east-1",
626
- "filename" : {
627
- "$toString" : "$sale-date"
628
- },
629
- "format" : {
630
- "name" : "json"
631
- }
632
- }
633
- }
634
- }
635
- ], { background: true })
636
-
637
- |out| writes to |json| files in the root of the bucket in the
638
- background. Each |json| file contains all of the documents
639
- with the same ``sale-date`` value. |out| names each file using
640
- the documents' ``sale-date`` value converted to a string.
641
-
642
608
.. tab:: Atlas Cluster
643
609
:tabid: atlas
644
610
645
- .. example::
611
+ **Write to Collection on Atlas Cluster**
646
612
647
- This |out| syntax sends the aggregated data to a
648
- ``sampleDB.mySampleData`` collection in the |service| cluster
649
- named ``myTestCluster``. The syntax doesn't specify a project
650
- ID; |out| uses the ID of the project that contains your {+dl+}.
613
+ This |out| syntax sends the aggregated data to a
614
+ ``sampleDB.mySampleData`` collection in the |service| cluster
615
+ named ``myTestCluster``. The syntax doesn't specify a project ID;
616
+ |out| uses the ID of the project that contains your {+dl+}.
617
+
618
+ .. example::
651
619
652
620
.. code-block:: json
653
621
:linenos:
@@ -662,6 +630,65 @@ Examples
662
630
}
663
631
}
664
632
633
+ **Run Query in the background**
634
+
635
+ The following example shows |out| syntax for running an aggregation
636
+ pipeline that ends with the |out| stage in the background.
637
+
638
+ .. tabs::
639
+ :hidden:
640
+
641
+ .. tab:: S3
642
+ :tabid: s3
643
+
644
+ .. example::
645
+
646
+ .. code-block:: json
647
+ :emphasize-lines: 16
648
+
649
+ db.foo.aggregate([
650
+ {
651
+ "$out" : {
652
+ "s3" : {
653
+ "bucket" : "my-s3-bucket",
654
+ "region" : "us-east-1",
655
+ "filename" : {
656
+ "$toString" : "$sale-date"
657
+ },
658
+ "format" : {
659
+ "name" : "json"
660
+ }
661
+ }
662
+ }
663
+ }
664
+ ], { background: true })
665
+
666
+ |out| writes to |json| files in the root of the bucket in the
667
+ background. Each |json| file contains all of the documents
668
+ with the same ``sale-date`` value. |out| names each file using
669
+ the documents' ``sale-date`` value converted to a string.
670
+
671
+ .. tab:: Atlas Cluster
672
+ :tabid: atlas
673
+
674
+ .. example::
675
+
676
+ .. code-block:: json
677
+ :emphasize-lines: 9
678
+
679
+ {
680
+ "$out": {
681
+ "atlas": {
682
+ "clusterName": "myTestCluster",
683
+ "db": "sampleDB",
684
+ "coll": "mySampleData"
685
+ }
686
+ }
687
+ }, { background: true })
688
+
689
+ |out| writes to ``sampleDB.mySampleData`` collection in the
690
+ |service| cluster named ``myTestCluster`` in the background.
691
+
665
692
.. _adl-out-stage-limitations:
666
693
667
694
.. tabs::
0 commit comments