Skip to content

Commit d995e2b

Browse files
rustagirrustagir
committed
Merge branch 'master' into v2.0
2 parents 996a131 + eed52fd commit d995e2b

9 files changed

+99
-31
lines changed

Diff for: ‎.github/pull_request_template.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
[PR Reviewing Guidelines](https://github.com/mongodb/docs-php-library/blob/master/REVIEWING.md)
44

55
JIRA - <https://jira.mongodb.org/browse/DOCSP-NNNNN>
6-
Staging - <https://docs-mongodbcom-staging.corp.mongodb.com/drivers/docsworker-xlarge/NNNNN/>
6+
7+
### Staging Links
8+
9+
<!-- start insert-links --><!-- end insert-links -->
710

811
## Self-Review Checklist
912

@@ -12,3 +15,4 @@ Staging - <https://docs-mongodbcom-staging.corp.mongodb.com/drivers/docsworker-x
1215
- [ ] Did you run a grammar-check?
1316
- [ ] Are all the links working?
1417
- [ ] Are the [facets and meta keywords](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) accurate?
18+
- [ ] Are the page titles greater than 20 characters long and [SEO relevant](https://docs.google.com/spreadsheets/d/1Wkt0-5z04KmcMNscN5bjUKnzwWAtMq9VESp-Lz6r2o8/edit?usp=sharing)?

Diff for: ‎.github/workflows/add-netlify-links.yml

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Add Netlify Links To Changed Pages
2+
on:
3+
workflow_call:
4+
pull_request_target:
5+
jobs:
6+
get-pr-changes:
7+
name: Get Changed Files & Update PR Description
8+
runs-on: ubuntu-latest
9+
permissions:
10+
issues: write
11+
contents: write
12+
pull-requests: write
13+
repository-projects: write
14+
steps:
15+
- uses: actions/checkout@v4
16+
- name: Get Changed Files
17+
id: changed-files
18+
# pin to a specific commit to ensure stability
19+
uses: tj-actions/changed-files@c65cd883420fd2eb864698a825fc4162dd94482c
20+
with:
21+
separator: ","
22+
files: source/**
23+
- name: Build Netlify Links for Changed Pages
24+
id: build_page_links
25+
env:
26+
CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
27+
run: |
28+
new_links=""
29+
base_link='https://deploy-preview-${{ github.event.number }}--docs-php-library.netlify.app'
30+
files=$(echo "$CHANGED_FILES" | tr "," "\n")
31+
for file in $files; do
32+
echo "processing ${file}"
33+
if (! grep -s "includes/" <<< "$file") &&
34+
(! grep -s "images/" <<< "$file") &&
35+
(! grep -s "examples/" <<< "$file"); then
36+
file="${file#source}"
37+
file="${file%.txt}"
38+
filenoslash="${file:1}"
39+
echo "${base_link}${file}"
40+
new_links+="<li><a href=${base_link}${file}>${filenoslash}</a></li>"
41+
else
42+
echo "(file skipped)"
43+
fi
44+
done
45+
if [ "$new_links" == "" ]; then
46+
new_links="No pages to preview"
47+
fi
48+
echo "Final new_links string: "
49+
echo "${new_links}"
50+
echo "staging_links=${new_links}" >> "$GITHUB_OUTPUT"
51+
- name: Update the PR Description
52+
uses: MongoCaleb/pr-description-action@master
53+
with:
54+
regex: "<!-- start insert-links -->.*<!-- end insert-links -->"
55+
appendContentOnMatchOnly: true
56+
regexFlags: is
57+
content: "<!-- start insert-links -->\n${{ steps.build_page_links.outputs.staging_links }}\n<!-- end insert-links -->"
58+
token: ${{ secrets.GITHUB_TOKEN }}

Diff for: ‎snooty.toml

-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ toc_landing_pages = [
2020
"/reference/class/MongoDBModelCollectionInfo",
2121
"/reference/class/MongoDBModelDatabaseInfo",
2222
"/reference/class/MongoDBModelIndexInfo",
23-
"/get-started",
2423
"/connect",
2524
"/read",
2625
"/databases-collections",

Diff for: ‎source/includes/extracts-watch-option.yaml

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
ref: watch-option-batchSize
22
content: |
3-
Specifies the batch size for the cursor, which will apply to both the initial
4-
``aggregate`` command and any subsequent ``getMore`` commands. This determines
5-
the maximum number of change events to return in each response from the
6-
server.
3+
The maximum number of documents within each batch returned in a change stream, which applies
4+
to the ``aggregate`` command. By default, the ``aggregate`` command has an initial batch size of
5+
``101`` documents and a maximum size of 16 mebibytes (MiB) for each subsequent batch. This
6+
option can enforce a smaller limit than 16 MiB, but not a larger one. If you set ``batchSize``
7+
to a limit that results in batches larger than 16 MiB, this option has no effect.
78
89
Irrespective of the ``batchSize`` option, the initial ``aggregate`` command
910
response for a change stream generally does not include any documents

Diff for: ‎source/includes/get-started/troubleshoot.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. note::
22

3-
If you run into issues on this step, ask for help in the
3+
If you run into issues in this tutorial, ask for help in the
44
:community-forum:`MongoDB Community Forums <tag/php/>`
55
or submit feedback by using the :guilabel:`Rate this page`
66
tab on the right or bottom right side of this page.

Diff for: ‎source/read/retrieve.txt

+6-1
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,12 @@ you can set in the array:
180180
- Description
181181

182182
* - ``batchSize``
183-
- | The number of documents to return per batch. The default value is ``101``.
183+
- | The maximum number of documents within each batch returned in a query result. By default,
184+
the ``find`` command has an initial batch size of ``101`` documents
185+
and a maximum size of 16 mebibytes (MiB) for each subsequent batch. This
186+
option can enforce a smaller limit than 16 MiB, but not a larger
187+
one. If you set ``batchSize`` to a limit that results in batches larger than
188+
16 MiB, this option has no effect.
184189
| **Type**: ``integer``
185190

186191
* - ``collation``

Diff for: ‎source/reference/method/MongoDBCollection-find.txt

+8-3
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,14 @@ Parameters
5252

5353
* - batchSize
5454
- integer
55-
- The number of documents to return in the first batch. Defaults to
56-
``101``. A batchSize of ``0`` means that the cursor will be
57-
established, but no documents will be returned in the first batch.
55+
- The maximum number of documents within each batch returned in a query result. By default, the ``find``
56+
command has an initial batch size of ``101`` documents and a maximum size of 16 mebibytes (MiB)
57+
for each subsequent batch. This option can enforce a smaller limit than 16 MiB, but not a larger
58+
one. If you set ``batchSize`` to a limit that results in batches larger than
59+
16 MiB, this option has no effect.
60+
61+
A batchSize of ``0`` means that the cursor will be established, but no documents
62+
will be returned in the first batch.
5863

5964
Unlike the previous wire protocol version, a batchSize of ``1`` for the
6065
:dbcommand:`find` command does not close the cursor.

Diff for: ‎source/reference/method/MongoDBCollection-listSearchIndexes.txt

+6-10
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,12 @@ Parameters
4040

4141
* - batchSize
4242
- integer
43-
- Specifies the batch size for the cursor, which will apply to both the
44-
initial ``aggregate`` command and any subsequent ``getMore`` commands.
45-
This determines the maximum number of documents to return in each
46-
response from the server.
47-
48-
A batchSize of ``0`` is special in that and will only apply to the
49-
initial ``aggregate`` command; subsequent ``getMore`` commands will use
50-
the server's default batch size. This may be useful for quickly
51-
returning a cursor or failure from ``aggregate`` without doing
52-
significant server-side work.
43+
- The maximum number of documents within each batch returned in the indexes list, which applies
44+
to the ``aggregate`` command. By default, the ``aggregate`` command has an initial batch size of
45+
``101`` documents and a maximum size of 16 mebibytes (MiB) for each subsequent batch. This
46+
option can enforce a smaller limit than 16 MiB, but not a larger
47+
one. If you set ``batchSize`` to a limit that results in batches larger than
48+
16 MiB, this option has no effect.
5349

5450
* - codec
5551
- MongoDB\\Codec\\DocumentCodec

Diff for: ‎source/reference/method/MongoDBDatabase-aggregate.txt

+10-10
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,16 @@ Parameters
5555

5656
* - batchSize
5757
- integer
58-
- Specifies the batch size for the cursor, which will apply to both the
59-
initial ``aggregate`` command and any subsequent ``getMore`` commands.
60-
This determines the maximum number of documents to return in each
61-
response from the server.
62-
63-
A batchSize of ``0`` is special in that and will only apply to the
64-
initial ``aggregate`` command; subsequent ``getMore`` commands will use
65-
the server's default batch size. This may be useful for quickly
66-
returning a cursor or failure from ``aggregate`` without doing
67-
significant server-side work.
58+
- The maximum number of documents within each batch returned in a query result.
59+
By default, the ``aggregate`` command has an initial batch size of
60+
``101`` documents and a maximum size of 16 mebibytes (MiB) for each subsequent batch. This
61+
option can enforce a smaller limit than 16 MiB, but not a larger
62+
one. If you set ``batchSize`` to a limit that results in batches larger than
63+
16 MiB, this option has no effect.
64+
65+
A batchSize of ``0`` means that the cursor will be established, but no documents
66+
will be returned in the first batch. This may be useful for quickly returning a cursor
67+
or failure from ``aggregate`` without doing significant server-side work.
6868

6969
* - bypassDocumentValidation
7070
- boolean

0 commit comments

Comments
 (0)