Skip to content

Commit e9cc7fd

Browse files
terakilobyteChris Cho
terakilobyte
and
Chris Cho
authored
Docsp 9582 (#54)
* DOCSP-9582: builders overview * add more information and link to pages * code formatting * fix ref * Update source/fundamentals/builders.txt Co-authored-by: Chris Cho <[email protected]> * Update source/fundamentals/builders.txt Co-authored-by: Chris Cho <[email protected]> * Update source/fundamentals/builders.txt Co-authored-by: Chris Cho <[email protected]> * nits Co-authored-by: Chris Cho <[email protected]>
1 parent d8c0a62 commit e9cc7fd

File tree

8 files changed

+153
-1
lines changed

8 files changed

+153
-1
lines changed

‎snooty.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
name = "java"
22
title = "Java"
3-
toc_landing_pages = ["/fundamentals/connection", "/fundamentals/crud"]
3+
toc_landing_pages = [
4+
"/fundamentals/connection",
5+
"/fundamentals/crud",
6+
"/fundamentals/builders"
7+
]
48

59
[constants]
610
version = 4.0

‎source/fundamentals/builders.txt

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
========
2+
Builders
3+
========
4+
5+
.. default-domain:: mongodb
6+
7+
.. toctree::
8+
9+
/fundamentals/builders/aggregates
10+
/fundamentals/builders/filters
11+
/fundamentals/builders/indexes
12+
/fundamentals/builders/projections
13+
/fundamentals/builders/sort
14+
/fundamentals/builders/updates
15+
16+
.. contents:: On this page
17+
:local:
18+
:backlinks: none
19+
:depth: 2
20+
:class: singlecol
21+
22+
This section includes guides on how to use each of the available builders, and demonstrates the utility the Java driver
23+
builder classes provide.
24+
25+
Overview
26+
--------
27+
28+
The Java driver provides classes to make it easier to use CRUD operations and the Aggregation API. The static utility methods
29+
allow you to build a query more succinctly.
30+
31+
32+
Imagine we want to send a marketing email to all users in our users collection that identify as "female" gender and are older than "29".
33+
We only need their email address, so we'll ensure our query doesn't return data we pay bandwidth
34+
costs for but don't need.
35+
36+
Using JSON and the MongoDB shell, the query would look something like:
37+
38+
.. code-block:: js
39+
40+
collection.find({ "gender": "female", "age" : { "$gt": 29 }}, { "_id": 0, "email": 1 })
41+
42+
Without builders, we construct the query in Java as:
43+
44+
.. code-block:: java
45+
46+
Bson filter = new Document().append("gender", "female").append("age", new Document().append("$gt", 28));
47+
Bson projection = new Document().append("_id", 0).append("email", 1);
48+
collection.find(filter).projection(projection);
49+
50+
With builders, the query becomes:
51+
52+
.. code-block:: java
53+
54+
import static com.mongodb.client.model.Filters.*;
55+
import static com.mongodb.client.model.Projections.*;
56+
...
57+
58+
Bson filter = and(eq("gender", "female"), gt("age", 29));
59+
Bson projection = fields(excludeId(), include("email"));
60+
collection.find(filter).projection(projection);
61+
62+
Available Builders
63+
------------------
64+
65+
- :ref:`Filters <filters-builders>` for building query filters.
66+
- :ref:`Projections <projections-builders>` for building projections.
67+
- :ref:`Sorts <sorts-builders>` for building sort criteria.
68+
- :ref:`Updates <updates-builders>` for building updates.
69+
- :ref:`Aggregates <aggregates-builders>` for building aggregation pipelines.
70+
- :ref:`Indexes <indexes-builders>` for creating index keys.

‎source/fundamentals/builders/aggregates.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
===================
2+
Aggregates Builders
3+
===================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
.. _aggregates-builders:

‎source/fundamentals/builders/filters.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
================
2+
Filters Builders
3+
================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
.. _filters-builders:

‎source/fundamentals/builders/indexes.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
================
2+
Indexes Builders
3+
================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
.. _indexes-builders:

‎source/fundamentals/builders/projections.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
====================
2+
Projections Builders
3+
====================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
.. _projections-builders:

‎source/fundamentals/builders/sort.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
==============
2+
Sorts Builders
3+
==============
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
.. _sorts-builders:

‎source/fundamentals/builders/updates.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
================
2+
Updates Builders
3+
================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
.. _updates-builders:

0 commit comments

Comments
 (0)