diff --git a/.github/workflows/backport.yml b/.github/workflows/backport.yml new file mode 100644 index 000000000..971e8a650 --- /dev/null +++ b/.github/workflows/backport.yml @@ -0,0 +1,26 @@ +name: Backport +on: + pull_request_target: + types: + - closed + - labeled + +jobs: + backport: + name: Backport + runs-on: ubuntu-latest + # Only react to merged PRs for security reasons. + # See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target. + if: > + github.event.pull_request.merged + && ( + github.event.action == 'closed' + || ( + github.event.action == 'labeled' + && contains(github.event.label.name, 'backport') + ) + ) + steps: + - uses: tibdex/backport@v2 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/source/fundamentals.txt b/source/fundamentals.txt index 05d6e9b17..019c88bd7 100644 --- a/source/fundamentals.txt +++ b/source/fundamentals.txt @@ -9,23 +9,23 @@ Fundamentals :titlesonly: :maxdepth: 1 - /fundamentals/connection - /fundamentals/auth - /fundamentals/enterprise-auth - /fundamentals/stable-api - /fundamentals/databases-collections - /fundamentals/data-formats - /fundamentals/crud - /fundamentals/builders - /fundamentals/aggregation - /fundamentals/aggregation-expression-operations - /fundamentals/indexes - /fundamentals/transactions - /fundamentals/collations - /fundamentals/logging - /fundamentals/monitoring - /fundamentals/gridfs - /fundamentals/encrypt-fields - /fundamentals/time-series + Connection Guide + Authentication + Enterprise Authentication + Stable API + Databases & Collections + Data Formats + CRUD Operations + Builders + Aggregation + Aggregation Expressions + Indexes + Transactions + Collations + Logging + Monitoring + GridFS + In-Use Encryption + Time Series Collections .. include:: /includes/fundamentals-sections.rst diff --git a/source/fundamentals/builders.txt b/source/fundamentals/builders.txt index 631622fa8..ee1e92425 100644 --- a/source/fundamentals/builders.txt +++ b/source/fundamentals/builders.txt @@ -8,12 +8,12 @@ Builders .. toctree:: - /fundamentals/builders/aggregates - /fundamentals/builders/filters - /fundamentals/builders/indexes - /fundamentals/builders/projections - /fundamentals/builders/sort - /fundamentals/builders/updates + Aggregation + Filters + Indexes + Projection + Sort + Update .. contents:: On this page :local: diff --git a/source/fundamentals/connection.txt b/source/fundamentals/connection.txt index 6f398ba7d..63969b0f1 100644 --- a/source/fundamentals/connection.txt +++ b/source/fundamentals/connection.txt @@ -6,14 +6,14 @@ Connection Guide .. toctree:: - /fundamentals/connection/connect - /fundamentals/connection/connection-options - /fundamentals/connection/mongoclientsettings - /fundamentals/connection/network-compression - /fundamentals/connection/tls - /fundamentals/connection/socks - /fundamentals/connection/jndi - Connect to MongoDB Atlas from AWS Lambda + Connect to MongoDB + Connection Options + MongoClient Settings + Network Compression + TLS/SSL + SOCKS5 Proxy + JNDI Datasource + AWS Lambda .. contents:: On this page :local: diff --git a/source/fundamentals/crud.txt b/source/fundamentals/crud.txt index 262ab9d41..3417cd5e0 100644 --- a/source/fundamentals/crud.txt +++ b/source/fundamentals/crud.txt @@ -9,10 +9,10 @@ CRUD Operations .. toctree:: :caption: CRUD Operations - /fundamentals/crud/read-operations - /fundamentals/crud/write-operations - /fundamentals/crud/query-document - /fundamentals/crud/compound-operations + Read + Write + Query + Compound Operations CRUD (Create, Read, Update, Delete) operations enable you to work with data stored in MongoDB. diff --git a/source/fundamentals/crud/read-operations.txt b/source/fundamentals/crud/read-operations.txt index f0c264f90..0eb147951 100644 --- a/source/fundamentals/crud/read-operations.txt +++ b/source/fundamentals/crud/read-operations.txt @@ -5,6 +5,19 @@ Read Operations .. meta:: :description: Learn about the commands for running read operations on MongoDB by using the {+driver-long+}. +.. toctree:: + :caption: Read Operations + + Retrieve Data + Data from a Cursor + Open Change Streams + Sort Results + Skip Returned Results + Limit Returned Results + Specify Fields to Return + Geospatial Data + Search Text + - :doc:`/fundamentals/crud/read-operations/retrieve` - :doc:`/fundamentals/crud/read-operations/cursor` - :doc:`/fundamentals/crud/read-operations/change-streams` @@ -14,16 +27,3 @@ Read Operations - :doc:`/fundamentals/crud/read-operations/project` - :doc:`/fundamentals/crud/read-operations/geo` - :doc:`/fundamentals/crud/read-operations/text` - -.. toctree:: - :caption: Read Operations - - /fundamentals/crud/read-operations/retrieve - /fundamentals/crud/read-operations/cursor - /fundamentals/crud/read-operations/change-streams - /fundamentals/crud/read-operations/sort - /fundamentals/crud/read-operations/skip - /fundamentals/crud/read-operations/limit - /fundamentals/crud/read-operations/project - /fundamentals/crud/read-operations/geo - /fundamentals/crud/read-operations/text diff --git a/source/fundamentals/crud/write-operations.txt b/source/fundamentals/crud/write-operations.txt index f9ca6ec47..fd4e57d6a 100644 --- a/source/fundamentals/crud/write-operations.txt +++ b/source/fundamentals/crud/write-operations.txt @@ -5,19 +5,19 @@ Write Operations .. meta:: :description: Learn about the commands for running MongoDB write operations by using the {+driver-long+}. +.. toctree:: + :caption: Write Operations + + Insert + Delete + Modify + Update Array Elements + Upsert + Bulk Operations + - :doc:`/fundamentals/crud/write-operations/insert` - :doc:`/fundamentals/crud/write-operations/delete` - :doc:`/fundamentals/crud/write-operations/modify` - :doc:`/fundamentals/crud/write-operations/embedded-arrays` - :doc:`/fundamentals/crud/write-operations/upsert` - :doc:`/fundamentals/crud/write-operations/bulk` - -.. toctree:: - :caption: Write Operations - - /fundamentals/crud/write-operations/insert - /fundamentals/crud/write-operations/delete - /fundamentals/crud/write-operations/modify - /fundamentals/crud/write-operations/embedded-arrays - /fundamentals/crud/write-operations/upsert - /fundamentals/crud/write-operations/bulk diff --git a/source/fundamentals/data-formats.txt b/source/fundamentals/data-formats.txt index 280b95ab4..a26dfd099 100644 --- a/source/fundamentals/data-formats.txt +++ b/source/fundamentals/data-formats.txt @@ -5,6 +5,17 @@ Data Formats .. meta:: :description: Learn how to convert between MongoDB and Java data formats by using the {+driver-long+}. +.. toctree:: + :caption: Data Formats + + BSON + Extended JSON + Documents + POJOs + Records + POJO Customization + Codecs + - :doc:`/fundamentals/data-formats/document-data-format-bson` - :doc:`/fundamentals/data-formats/document-data-format-extended-json` - :doc:`/fundamentals/data-formats/documents` @@ -12,16 +23,3 @@ Data Formats - :doc:`/fundamentals/data-formats/document-data-format-record` - :doc:`/fundamentals/data-formats/pojo-customization` - :doc:`/fundamentals/data-formats/codecs` - -.. toctree:: - :caption: Data Formats - - /fundamentals/data-formats/document-data-format-bson - /fundamentals/data-formats/document-data-format-extended-json - /fundamentals/data-formats/documents - /fundamentals/data-formats/document-data-format-pojo - /fundamentals/data-formats/document-data-format-record - /fundamentals/data-formats/pojo-customization - /fundamentals/data-formats/codecs - - diff --git a/source/index.txt b/source/index.txt index 831cfcdf8..5399663d5 100644 --- a/source/index.txt +++ b/source/index.txt @@ -19,19 +19,19 @@ MongoDB Java Driver :maxdepth: 1 Quick Start - /quick-reference - /whats-new - /usage-examples - /fundamentals - /api-documentation - /faq - /connection-troubleshooting - /issues-and-help - /integrations - /compatibility - /upgrade - /validate-signatures - /legacy + Quick Reference + What's New + Usage Examples + Fundamentals + API Documentation + FAQ + Connection Troubleshooting + Issues & Help + Driver Integrations + Compatibility + Upgrade + Validate Driver Signatures + Migrate from the Legacy API View the Source Introduction diff --git a/source/usage-examples.txt b/source/usage-examples.txt index 307fdbf53..208b025ec 100644 --- a/source/usage-examples.txt +++ b/source/usage-examples.txt @@ -12,16 +12,15 @@ Usage Examples .. toctree:: - /usage-examples/find-operations - /usage-examples/insert-operations - /usage-examples/update-operations - /usage-examples/delete-operations - /usage-examples/bulkWrite - /usage-examples/watch - /usage-examples/count - /usage-examples/distinct - /usage-examples/command - + Find + Insert + Update & Replace + Delete + Bulk Operations + Watch for Changes + Count Documents + Distinct Field Values + Run a Command Overview -------- diff --git a/source/usage-examples/delete-operations.txt b/source/usage-examples/delete-operations.txt index f458f84e4..811d30db6 100644 --- a/source/usage-examples/delete-operations.txt +++ b/source/usage-examples/delete-operations.txt @@ -5,12 +5,11 @@ Delete Operations .. meta:: :description: Learn by example: how to delete data from MongoDB by using the {+driver-long+}. -- :doc:`Delete a Document ` -- :doc:`Delete Multiple Documents ` - .. toctree:: :caption: Examples - /usage-examples/deleteOne - /usage-examples/deleteMany - + Delete One + Delete Many + +- :doc:`Delete a Document ` +- :doc:`Delete Multiple Documents ` diff --git a/source/usage-examples/find-operations.txt b/source/usage-examples/find-operations.txt index 37c2dc28e..712144c6d 100644 --- a/source/usage-examples/find-operations.txt +++ b/source/usage-examples/find-operations.txt @@ -5,11 +5,11 @@ Find Operations .. meta:: :description: Learn by example: how to create queries and retrieve data from MongoDB by using the {+driver-long+}. -- :doc:`Find a Document ` -- :doc:`Find Multiple Documents ` - .. toctree:: :caption: Examples - /usage-examples/findOne - /usage-examples/find + Find One + Find Many + +- :doc:`Find a Document ` +- :doc:`Find Multiple Documents ` diff --git a/source/usage-examples/insert-operations.txt b/source/usage-examples/insert-operations.txt index 77951e3e2..0c4b9975e 100644 --- a/source/usage-examples/insert-operations.txt +++ b/source/usage-examples/insert-operations.txt @@ -5,11 +5,11 @@ Insert Operations .. meta:: :description: Learn by example: how to insert data into MongoDB by using the {+driver-long+}. -- :doc:`Insert a Document ` -- :doc:`Insert Multiple Documents ` - .. toctree:: :caption: Examples - /usage-examples/insertOne - /usage-examples/insertMany + Insert One + Insert Many + +- :doc:`Insert a Document ` +- :doc:`Insert Multiple Documents ` diff --git a/source/usage-examples/update-operations.txt b/source/usage-examples/update-operations.txt index d09625d7f..0f8e93d37 100644 --- a/source/usage-examples/update-operations.txt +++ b/source/usage-examples/update-operations.txt @@ -5,13 +5,13 @@ Update & Replace Operations .. meta:: :description: Learn by example: how to update and replace data in MongoDB by using the {+driver-long+}. -- :doc:`Update a Document ` -- :doc:`Update Multiple Documents ` -- :doc:`Replace a Document ` - .. toctree:: :caption: Examples - /usage-examples/updateOne - /usage-examples/updateMany - /usage-examples/replaceOne + Update One + Update Many + Replace One + +- :doc:`Update a Document ` +- :doc:`Update Multiple Documents ` +- :doc:`Replace a Document `