From 8deeac60d2caef744207aad064cb3674dfa459a0 Mon Sep 17 00:00:00 2001 From: Angela Date: Fri, 14 Mar 2025 11:32:01 -0400 Subject: [PATCH 01/14] change batchsize descriptions --- docs.sln | 196 ++++++++++++++++++ source/reference/command/find.txt | 11 +- source/reference/command/getMore.txt | 9 +- source/reference/method/cursor.batchSize.txt | 21 +- .../reference/method/db.collection.watch.txt | 8 +- .../operator/aggregation/queryStats.txt | 8 +- 6 files changed, 231 insertions(+), 22 deletions(-) create mode 100644 docs.sln diff --git a/docs.sln b/docs.sln new file mode 100644 index 0000000000..e086525fa3 --- /dev/null +++ b/docs.sln @@ -0,0 +1,196 @@ +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.5.2.0 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "source", "source", "{B8EFCA5F-814F-285C-A8CB-F00F14650265}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "includes", "includes", "{875621A1-E1B2-F608-9BB7-FC3A3F183D31}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "qe-tutorials", "qe-tutorials", "{F8E9B2B9-90F0-B3A6-2265-5C72CAABF613}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryptionExample", "source\includes\qe-tutorials\csharp\QueryableEncryptionExample.csproj", "{8D49187A-80CC-62FF-290B-EDB9B533685C}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "generated", "generated", "{4510497D-6DCC-F594-327A-CF3D728AB3C1}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "in-use-encryption", "in-use-encryption", "{7C0A80DE-4380-7B1C-6F4B-8DFF90382FD1}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "csfle", "csfle", "{5E0F3E54-956B-23D1-43E4-8073E08941E7}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "dotnet", "dotnet", "{87BAD27A-77DA-32C7-8D6A-86119F53C551}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "kmip", "kmip", "{8E3D6239-D920-65D6-8628-8F1AD685C460}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{4D59E27A-09C3-E835-E1D4-375F558C4490}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSFLE", "source\includes\generated\in-use-encryption\csfle\dotnet\kmip\reader\CSFLE\CSFLE.csproj", "{C46C27B8-F64C-C8A9-E774-4D235A6AD6BC}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "azure", "azure", "{CFBAAE68-351B-58CB-6FE1-04881A2B51BC}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{99841D8C-3AF8-17D8-4E92-4CC3CDE9E74D}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSFLE", "source\includes\generated\in-use-encryption\csfle\dotnet\azure\reader\CSFLE\CSFLE.csproj", "{9F6A1868-BA70-8B70-6B86-18E449D3786E}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "gcp", "gcp", "{CEC115D1-6CD0-281F-B7D5-328F38CB9243}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{FEDD9067-990D-0DD1-8725-A53EA91A221A}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSFLE", "source\includes\generated\in-use-encryption\csfle\dotnet\gcp\reader\CSFLE\CSFLE.csproj", "{D6BF0B62-00B9-D9C0-B5B7-B847D59A9B72}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "local", "local", "{191B186A-85E8-3435-CDC4-3AF7D440BA7E}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{8D5FF2D0-51B8-D35D-ACC5-6F09A742485D}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSFLE", "source\includes\generated\in-use-encryption\csfle\dotnet\local\reader\CSFLE\CSFLE.csproj", "{825BECF2-A21A-59AB-F47F-63D9D2FC3A8C}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "aws", "aws", "{BF93B00C-CEDE-4A31-96CF-C5D42B41F707}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{C46F4138-F84E-06B1-F178-A7B6DE09936B}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSFLE", "source\includes\generated\in-use-encryption\csfle\dotnet\aws\reader\CSFLE\CSFLE.csproj", "{60EF86D5-B23F-A057-3080-4102B045F0A7}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "queryable-encryption", "queryable-encryption", "{EFCDE7FE-BDEF-AC04-7D90-AFB0DBB98874}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "dotnet", "dotnet", "{1EA68CBF-D341-6F72-89CE-9E23392F634B}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "kmip", "kmip", "{72A5EE2A-1492-49C3-A301-89C72C4FEDBD}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{BB27418F-7478-6336-89A9-1A3E42367B12}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryption", "source\includes\generated\in-use-encryption\queryable-encryption\dotnet\kmip\reader\QueryableEncryption\QueryableEncryption.csproj", "{011A8BEC-1358-17DB-2FB2-EE6BF7FD1E30}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "azure", "azure", "{C1CAE349-CB16-0D02-0F73-DF1864859629}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{DA661325-A367-7586-BB4F-214E16465565}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryption", "source\includes\generated\in-use-encryption\queryable-encryption\dotnet\azure\reader\QueryableEncryption\QueryableEncryption.csproj", "{D772DDD4-2916-1BAF-A614-6884E32B1EC8}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "gcp", "gcp", "{DF467CA1-F242-91D4-3CB9-58B1DC3B89AA}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{F5A5F529-9214-52A1-6E8E-F3D780971656}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryption", "source\includes\generated\in-use-encryption\queryable-encryption\dotnet\gcp\reader\QueryableEncryption\QueryableEncryption.csproj", "{8FF55202-38A4-04ED-BFC3-D7D7AA7AD4E8}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "local", "local", "{09252992-DB5E-1A4F-F722-D4A7C5F0EE91}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{7A15F4AD-B866-B371-CFD1-751590C4D511}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryption", "source\includes\generated\in-use-encryption\queryable-encryption\dotnet\local\reader\QueryableEncryption\QueryableEncryption.csproj", "{E9AD90FE-E2D3-9F12-399A-2E2EDE013959}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "aws", "aws", "{1EA2F366-CA4B-EB6E-4198-6447063CF3B6}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{D3D2B190-8B98-3F0C-7F54-8AB8D1CE067A}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryption", "source\includes\generated\in-use-encryption\queryable-encryption\dotnet\aws\reader\QueryableEncryption\QueryableEncryption.csproj", "{48088910-FE0F-058D-6B98-AD4049FC9CDA}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "exp", "exp", "{AB722F0C-4FAA-AFEE-F1E9-ADE50DD08092}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{2F8F79BA-3026-42B0-117C-1FCB7FFF6CB3}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryption", "source\includes\generated\in-use-encryption\queryable-encryption\dotnet\exp\reader\QueryableEncryption\QueryableEncryption.csproj", "{2BCE13CF-2182-A8A1-C5D1-655E7A2D21B1}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {8D49187A-80CC-62FF-290B-EDB9B533685C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {8D49187A-80CC-62FF-290B-EDB9B533685C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {8D49187A-80CC-62FF-290B-EDB9B533685C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {8D49187A-80CC-62FF-290B-EDB9B533685C}.Release|Any CPU.Build.0 = Release|Any CPU + {C46C27B8-F64C-C8A9-E774-4D235A6AD6BC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {C46C27B8-F64C-C8A9-E774-4D235A6AD6BC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {C46C27B8-F64C-C8A9-E774-4D235A6AD6BC}.Release|Any CPU.ActiveCfg = Release|Any CPU + {C46C27B8-F64C-C8A9-E774-4D235A6AD6BC}.Release|Any CPU.Build.0 = Release|Any CPU + {9F6A1868-BA70-8B70-6B86-18E449D3786E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9F6A1868-BA70-8B70-6B86-18E449D3786E}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9F6A1868-BA70-8B70-6B86-18E449D3786E}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9F6A1868-BA70-8B70-6B86-18E449D3786E}.Release|Any CPU.Build.0 = Release|Any CPU + {D6BF0B62-00B9-D9C0-B5B7-B847D59A9B72}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {D6BF0B62-00B9-D9C0-B5B7-B847D59A9B72}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D6BF0B62-00B9-D9C0-B5B7-B847D59A9B72}.Release|Any CPU.ActiveCfg = Release|Any CPU + {D6BF0B62-00B9-D9C0-B5B7-B847D59A9B72}.Release|Any CPU.Build.0 = Release|Any CPU + {825BECF2-A21A-59AB-F47F-63D9D2FC3A8C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {825BECF2-A21A-59AB-F47F-63D9D2FC3A8C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {825BECF2-A21A-59AB-F47F-63D9D2FC3A8C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {825BECF2-A21A-59AB-F47F-63D9D2FC3A8C}.Release|Any CPU.Build.0 = Release|Any CPU + {60EF86D5-B23F-A057-3080-4102B045F0A7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {60EF86D5-B23F-A057-3080-4102B045F0A7}.Debug|Any CPU.Build.0 = Debug|Any CPU + {60EF86D5-B23F-A057-3080-4102B045F0A7}.Release|Any CPU.ActiveCfg = Release|Any CPU + {60EF86D5-B23F-A057-3080-4102B045F0A7}.Release|Any CPU.Build.0 = Release|Any CPU + {011A8BEC-1358-17DB-2FB2-EE6BF7FD1E30}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {011A8BEC-1358-17DB-2FB2-EE6BF7FD1E30}.Debug|Any CPU.Build.0 = Debug|Any CPU + {011A8BEC-1358-17DB-2FB2-EE6BF7FD1E30}.Release|Any CPU.ActiveCfg = Release|Any CPU + {011A8BEC-1358-17DB-2FB2-EE6BF7FD1E30}.Release|Any CPU.Build.0 = Release|Any CPU + {D772DDD4-2916-1BAF-A614-6884E32B1EC8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {D772DDD4-2916-1BAF-A614-6884E32B1EC8}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D772DDD4-2916-1BAF-A614-6884E32B1EC8}.Release|Any CPU.ActiveCfg = Release|Any CPU + {D772DDD4-2916-1BAF-A614-6884E32B1EC8}.Release|Any CPU.Build.0 = Release|Any CPU + {8FF55202-38A4-04ED-BFC3-D7D7AA7AD4E8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {8FF55202-38A4-04ED-BFC3-D7D7AA7AD4E8}.Debug|Any CPU.Build.0 = Debug|Any CPU + {8FF55202-38A4-04ED-BFC3-D7D7AA7AD4E8}.Release|Any CPU.ActiveCfg = Release|Any CPU + {8FF55202-38A4-04ED-BFC3-D7D7AA7AD4E8}.Release|Any CPU.Build.0 = Release|Any CPU + {E9AD90FE-E2D3-9F12-399A-2E2EDE013959}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E9AD90FE-E2D3-9F12-399A-2E2EDE013959}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E9AD90FE-E2D3-9F12-399A-2E2EDE013959}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E9AD90FE-E2D3-9F12-399A-2E2EDE013959}.Release|Any CPU.Build.0 = Release|Any CPU + {48088910-FE0F-058D-6B98-AD4049FC9CDA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {48088910-FE0F-058D-6B98-AD4049FC9CDA}.Debug|Any CPU.Build.0 = Debug|Any CPU + {48088910-FE0F-058D-6B98-AD4049FC9CDA}.Release|Any CPU.ActiveCfg = Release|Any CPU + {48088910-FE0F-058D-6B98-AD4049FC9CDA}.Release|Any CPU.Build.0 = Release|Any CPU + {2BCE13CF-2182-A8A1-C5D1-655E7A2D21B1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2BCE13CF-2182-A8A1-C5D1-655E7A2D21B1}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2BCE13CF-2182-A8A1-C5D1-655E7A2D21B1}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2BCE13CF-2182-A8A1-C5D1-655E7A2D21B1}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {875621A1-E1B2-F608-9BB7-FC3A3F183D31} = {B8EFCA5F-814F-285C-A8CB-F00F14650265} + {F8E9B2B9-90F0-B3A6-2265-5C72CAABF613} = {875621A1-E1B2-F608-9BB7-FC3A3F183D31} + {8D49187A-80CC-62FF-290B-EDB9B533685C} = {F8E9B2B9-90F0-B3A6-2265-5C72CAABF613} + {4510497D-6DCC-F594-327A-CF3D728AB3C1} = {875621A1-E1B2-F608-9BB7-FC3A3F183D31} + {7C0A80DE-4380-7B1C-6F4B-8DFF90382FD1} = {4510497D-6DCC-F594-327A-CF3D728AB3C1} + {5E0F3E54-956B-23D1-43E4-8073E08941E7} = {7C0A80DE-4380-7B1C-6F4B-8DFF90382FD1} + {87BAD27A-77DA-32C7-8D6A-86119F53C551} = {5E0F3E54-956B-23D1-43E4-8073E08941E7} + {8E3D6239-D920-65D6-8628-8F1AD685C460} = {87BAD27A-77DA-32C7-8D6A-86119F53C551} + {4D59E27A-09C3-E835-E1D4-375F558C4490} = {8E3D6239-D920-65D6-8628-8F1AD685C460} + {C46C27B8-F64C-C8A9-E774-4D235A6AD6BC} = {4D59E27A-09C3-E835-E1D4-375F558C4490} + {CFBAAE68-351B-58CB-6FE1-04881A2B51BC} = {87BAD27A-77DA-32C7-8D6A-86119F53C551} + {99841D8C-3AF8-17D8-4E92-4CC3CDE9E74D} = {CFBAAE68-351B-58CB-6FE1-04881A2B51BC} + {9F6A1868-BA70-8B70-6B86-18E449D3786E} = {99841D8C-3AF8-17D8-4E92-4CC3CDE9E74D} + {CEC115D1-6CD0-281F-B7D5-328F38CB9243} = {87BAD27A-77DA-32C7-8D6A-86119F53C551} + {FEDD9067-990D-0DD1-8725-A53EA91A221A} = {CEC115D1-6CD0-281F-B7D5-328F38CB9243} + {D6BF0B62-00B9-D9C0-B5B7-B847D59A9B72} = {FEDD9067-990D-0DD1-8725-A53EA91A221A} + {191B186A-85E8-3435-CDC4-3AF7D440BA7E} = {87BAD27A-77DA-32C7-8D6A-86119F53C551} + {8D5FF2D0-51B8-D35D-ACC5-6F09A742485D} = {191B186A-85E8-3435-CDC4-3AF7D440BA7E} + {825BECF2-A21A-59AB-F47F-63D9D2FC3A8C} = {8D5FF2D0-51B8-D35D-ACC5-6F09A742485D} + {BF93B00C-CEDE-4A31-96CF-C5D42B41F707} = {87BAD27A-77DA-32C7-8D6A-86119F53C551} + {C46F4138-F84E-06B1-F178-A7B6DE09936B} = {BF93B00C-CEDE-4A31-96CF-C5D42B41F707} + {60EF86D5-B23F-A057-3080-4102B045F0A7} = {C46F4138-F84E-06B1-F178-A7B6DE09936B} + {EFCDE7FE-BDEF-AC04-7D90-AFB0DBB98874} = {7C0A80DE-4380-7B1C-6F4B-8DFF90382FD1} + {1EA68CBF-D341-6F72-89CE-9E23392F634B} = {EFCDE7FE-BDEF-AC04-7D90-AFB0DBB98874} + {72A5EE2A-1492-49C3-A301-89C72C4FEDBD} = {1EA68CBF-D341-6F72-89CE-9E23392F634B} + {BB27418F-7478-6336-89A9-1A3E42367B12} = {72A5EE2A-1492-49C3-A301-89C72C4FEDBD} + {011A8BEC-1358-17DB-2FB2-EE6BF7FD1E30} = {BB27418F-7478-6336-89A9-1A3E42367B12} + {C1CAE349-CB16-0D02-0F73-DF1864859629} = {1EA68CBF-D341-6F72-89CE-9E23392F634B} + {DA661325-A367-7586-BB4F-214E16465565} = {C1CAE349-CB16-0D02-0F73-DF1864859629} + {D772DDD4-2916-1BAF-A614-6884E32B1EC8} = {DA661325-A367-7586-BB4F-214E16465565} + {DF467CA1-F242-91D4-3CB9-58B1DC3B89AA} = {1EA68CBF-D341-6F72-89CE-9E23392F634B} + {F5A5F529-9214-52A1-6E8E-F3D780971656} = {DF467CA1-F242-91D4-3CB9-58B1DC3B89AA} + {8FF55202-38A4-04ED-BFC3-D7D7AA7AD4E8} = {F5A5F529-9214-52A1-6E8E-F3D780971656} + {09252992-DB5E-1A4F-F722-D4A7C5F0EE91} = {1EA68CBF-D341-6F72-89CE-9E23392F634B} + {7A15F4AD-B866-B371-CFD1-751590C4D511} = {09252992-DB5E-1A4F-F722-D4A7C5F0EE91} + {E9AD90FE-E2D3-9F12-399A-2E2EDE013959} = {7A15F4AD-B866-B371-CFD1-751590C4D511} + {1EA2F366-CA4B-EB6E-4198-6447063CF3B6} = {1EA68CBF-D341-6F72-89CE-9E23392F634B} + {D3D2B190-8B98-3F0C-7F54-8AB8D1CE067A} = {1EA2F366-CA4B-EB6E-4198-6447063CF3B6} + {48088910-FE0F-058D-6B98-AD4049FC9CDA} = {D3D2B190-8B98-3F0C-7F54-8AB8D1CE067A} + {AB722F0C-4FAA-AFEE-F1E9-ADE50DD08092} = {1EA68CBF-D341-6F72-89CE-9E23392F634B} + {2F8F79BA-3026-42B0-117C-1FCB7FFF6CB3} = {AB722F0C-4FAA-AFEE-F1E9-ADE50DD08092} + {2BCE13CF-2182-A8A1-C5D1-655E7A2D21B1} = {2F8F79BA-3026-42B0-117C-1FCB7FFF6CB3} + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {4860BE77-4C55-47A8-AE72-9408E714F174} + EndGlobalSection +EndGlobal diff --git a/source/reference/command/find.txt b/source/reference/command/find.txt index ad45b25c44..7cde5a082d 100644 --- a/source/reference/command/find.txt +++ b/source/reference/command/find.txt @@ -132,9 +132,14 @@ The command accepts the following fields: * - ``batchSize`` - non-negative integer - - Optional. The number of documents to return in the first batch. - Defaults to 101. A batchSize of 0 means that the cursor will be - established, but no documents will be returned in the first batch. + - Optional. The maximum number of documents within each batch returned in a query result. + By default, the ``find`` command has an initial batch size of ``101`` documents and a maximum + size of 16 mebibytes (MiB) for each subsequent batch. This option can enforce a smaller + limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results + in batches larger than 16 MiB, this option has no effect. +` + A batchSize of 0 means that the cursor will be established, but no documents + will be returned in the first batch. Unlike the previous wire protocol version, a batchSize of 1 for the :dbcommand:`find` command does not close the cursor. diff --git a/source/reference/command/getMore.txt b/source/reference/command/getMore.txt index c5fa0fbfbd..1a9015ce73 100644 --- a/source/reference/command/getMore.txt +++ b/source/reference/command/getMore.txt @@ -72,11 +72,12 @@ The command accepts the following fields: * - ``batchSize`` - positive integer - - Optional. The number of documents to return in the batch. + - Optional. Specifies the maximum number of documents within each batch returned in a query result. - If ``batchSize`` is not set, ``getMore`` returns up to 16 - mebibytes of data. If ``batchSize`` is set, ``getMore`` returns - the smaller of 16 mebibytes of data or ``batchSize`` documents. + If batchSize is not set, getMore returns up to ``101`` documents in the first batch + and up to 16 mebibytes (MiB) of data in all subsequent batches. If ``batchSize`` is set, ``getMore`` returns + the smaller of 16 mebibytes of data or ``batchSize`` documents. If you set ``batchSize`` to a limit that results + in batches larger than 16 MiB, this option has no effect. * - ``maxTimeMS`` - non-negative integer diff --git a/source/reference/method/cursor.batchSize.txt b/source/reference/method/cursor.batchSize.txt index 31555c04ca..aab55014c5 100644 --- a/source/reference/method/cursor.batchSize.txt +++ b/source/reference/method/cursor.batchSize.txt @@ -19,12 +19,14 @@ Definition .. include:: /includes/fact-mongosh-shell-method.rst - Specifies the - number of documents to return in each batch of the response from the - MongoDB instance. In most cases, modifying the batch size will - not affect the user or the application, as :binary:`~bin.mongosh` and - most :driver:`drivers ` return results as if MongoDB returned a - single batch. + Specifies the maximum number of documents within each batch returned in a query result. + By default, the initial batch size is ``101`` documents and subsequent batches have a maximum + size of 16 mebibytes (MiB). This option can enforce a smaller + limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results + in batches larger than 16 MiB, this option has no effect. + + A batchSize of 0 means that the cursor will be established, but no documents + will be returned in the first batch. .. note:: @@ -51,9 +53,10 @@ Definition * - ``size`` - integer - - The initial number of documents to return for a batch. The - default initial batch size is 101 documents. Subsequent - batches are 16 mebibytes. The default applies to drivers and + - The maximum number of documents to return for a batch. The + default initial batch size is ``101`` documents and subsequent + batches have a maximum size of 16 mebibytes (MiB). This option can enforce a smaller limit than + 16 MiB, but not a larger one. The default applies to drivers and Mongo Shell. For details, see :ref:`cursor-batches`. Compatibility diff --git a/source/reference/method/db.collection.watch.txt b/source/reference/method/db.collection.watch.txt index 5274b70f58..dcb980fe35 100644 --- a/source/reference/method/db.collection.watch.txt +++ b/source/reference/method/db.collection.watch.txt @@ -115,13 +115,15 @@ Definition * - ``batchSize`` - int - - Optional. Specifies the maximum number of change events to return in each - batch of the response from the MongoDB cluster. + - Optional. The maximum number of documents within each batch returned in a change stream. + By default, :method:`~db.collection.watch()` has an initial batch size of ``101`` documents and a maximum size + of 16 mebibytes (MiB) for each subsequent batch. This option can enforce a smaller + limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that + results in batches larger than 16 MiB, this option has no effect. Has the same functionality as :method:`cursor.batchSize()`. - * - ``maxAwaitTimeMS`` - int diff --git a/source/reference/operator/aggregation/queryStats.txt b/source/reference/operator/aggregation/queryStats.txt index c63e2023c3..6f285d132f 100644 --- a/source/reference/operator/aggregation/queryStats.txt +++ b/source/reference/operator/aggregation/queryStats.txt @@ -354,9 +354,11 @@ Each document in the output array contains the following fields: * - ``key.batchSize`` - String - Normalized - - The :ref:`batch size ` for the key. Batch size - specifies the number of documents to return in each batch of the - response from the MongoDB instance. + - The :ref:`batch size ` for the key. Batch size specifies + the maximum number of documents returned within each batch from the MongoDB instance. + By default, the initial batch size is ``101`` documents and subsequent batches have a + maximum size of 16 mebibytes (MiB). ``batchSize`` can enforce a smaller limit than + 16 MiB, but not a larger one. * - ``key.comment`` - String From be213a151e2ddf18bb66e2d19d3297d3a3b01f1e Mon Sep 17 00:00:00 2001 From: Angela Date: Fri, 14 Mar 2025 11:57:57 -0400 Subject: [PATCH 02/14] Empty-Commit From 33ca30acf9526231df0cb2c0b82c0ef571b521d7 Mon Sep 17 00:00:00 2001 From: Angela Date: Fri, 14 Mar 2025 12:30:41 -0400 Subject: [PATCH 03/14] remove file --- docs.sln | 196 ------------------------------------------------------- 1 file changed, 196 deletions(-) delete mode 100644 docs.sln diff --git a/docs.sln b/docs.sln deleted file mode 100644 index e086525fa3..0000000000 --- a/docs.sln +++ /dev/null @@ -1,196 +0,0 @@ -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 17 -VisualStudioVersion = 17.5.2.0 -MinimumVisualStudioVersion = 10.0.40219.1 -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "source", "source", "{B8EFCA5F-814F-285C-A8CB-F00F14650265}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "includes", "includes", "{875621A1-E1B2-F608-9BB7-FC3A3F183D31}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "qe-tutorials", "qe-tutorials", "{F8E9B2B9-90F0-B3A6-2265-5C72CAABF613}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryptionExample", "source\includes\qe-tutorials\csharp\QueryableEncryptionExample.csproj", "{8D49187A-80CC-62FF-290B-EDB9B533685C}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "generated", "generated", "{4510497D-6DCC-F594-327A-CF3D728AB3C1}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "in-use-encryption", "in-use-encryption", "{7C0A80DE-4380-7B1C-6F4B-8DFF90382FD1}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "csfle", "csfle", "{5E0F3E54-956B-23D1-43E4-8073E08941E7}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "dotnet", "dotnet", "{87BAD27A-77DA-32C7-8D6A-86119F53C551}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "kmip", "kmip", "{8E3D6239-D920-65D6-8628-8F1AD685C460}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{4D59E27A-09C3-E835-E1D4-375F558C4490}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSFLE", "source\includes\generated\in-use-encryption\csfle\dotnet\kmip\reader\CSFLE\CSFLE.csproj", "{C46C27B8-F64C-C8A9-E774-4D235A6AD6BC}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "azure", "azure", "{CFBAAE68-351B-58CB-6FE1-04881A2B51BC}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{99841D8C-3AF8-17D8-4E92-4CC3CDE9E74D}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSFLE", "source\includes\generated\in-use-encryption\csfle\dotnet\azure\reader\CSFLE\CSFLE.csproj", "{9F6A1868-BA70-8B70-6B86-18E449D3786E}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "gcp", "gcp", "{CEC115D1-6CD0-281F-B7D5-328F38CB9243}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{FEDD9067-990D-0DD1-8725-A53EA91A221A}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSFLE", "source\includes\generated\in-use-encryption\csfle\dotnet\gcp\reader\CSFLE\CSFLE.csproj", "{D6BF0B62-00B9-D9C0-B5B7-B847D59A9B72}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "local", "local", "{191B186A-85E8-3435-CDC4-3AF7D440BA7E}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{8D5FF2D0-51B8-D35D-ACC5-6F09A742485D}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSFLE", "source\includes\generated\in-use-encryption\csfle\dotnet\local\reader\CSFLE\CSFLE.csproj", "{825BECF2-A21A-59AB-F47F-63D9D2FC3A8C}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "aws", "aws", "{BF93B00C-CEDE-4A31-96CF-C5D42B41F707}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{C46F4138-F84E-06B1-F178-A7B6DE09936B}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSFLE", "source\includes\generated\in-use-encryption\csfle\dotnet\aws\reader\CSFLE\CSFLE.csproj", "{60EF86D5-B23F-A057-3080-4102B045F0A7}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "queryable-encryption", "queryable-encryption", "{EFCDE7FE-BDEF-AC04-7D90-AFB0DBB98874}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "dotnet", "dotnet", "{1EA68CBF-D341-6F72-89CE-9E23392F634B}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "kmip", "kmip", "{72A5EE2A-1492-49C3-A301-89C72C4FEDBD}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{BB27418F-7478-6336-89A9-1A3E42367B12}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryption", "source\includes\generated\in-use-encryption\queryable-encryption\dotnet\kmip\reader\QueryableEncryption\QueryableEncryption.csproj", "{011A8BEC-1358-17DB-2FB2-EE6BF7FD1E30}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "azure", "azure", "{C1CAE349-CB16-0D02-0F73-DF1864859629}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{DA661325-A367-7586-BB4F-214E16465565}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryption", "source\includes\generated\in-use-encryption\queryable-encryption\dotnet\azure\reader\QueryableEncryption\QueryableEncryption.csproj", "{D772DDD4-2916-1BAF-A614-6884E32B1EC8}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "gcp", "gcp", "{DF467CA1-F242-91D4-3CB9-58B1DC3B89AA}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{F5A5F529-9214-52A1-6E8E-F3D780971656}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryption", "source\includes\generated\in-use-encryption\queryable-encryption\dotnet\gcp\reader\QueryableEncryption\QueryableEncryption.csproj", "{8FF55202-38A4-04ED-BFC3-D7D7AA7AD4E8}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "local", "local", "{09252992-DB5E-1A4F-F722-D4A7C5F0EE91}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{7A15F4AD-B866-B371-CFD1-751590C4D511}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryption", "source\includes\generated\in-use-encryption\queryable-encryption\dotnet\local\reader\QueryableEncryption\QueryableEncryption.csproj", "{E9AD90FE-E2D3-9F12-399A-2E2EDE013959}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "aws", "aws", "{1EA2F366-CA4B-EB6E-4198-6447063CF3B6}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{D3D2B190-8B98-3F0C-7F54-8AB8D1CE067A}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryption", "source\includes\generated\in-use-encryption\queryable-encryption\dotnet\aws\reader\QueryableEncryption\QueryableEncryption.csproj", "{48088910-FE0F-058D-6B98-AD4049FC9CDA}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "exp", "exp", "{AB722F0C-4FAA-AFEE-F1E9-ADE50DD08092}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reader", "reader", "{2F8F79BA-3026-42B0-117C-1FCB7FFF6CB3}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QueryableEncryption", "source\includes\generated\in-use-encryption\queryable-encryption\dotnet\exp\reader\QueryableEncryption\QueryableEncryption.csproj", "{2BCE13CF-2182-A8A1-C5D1-655E7A2D21B1}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {8D49187A-80CC-62FF-290B-EDB9B533685C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {8D49187A-80CC-62FF-290B-EDB9B533685C}.Debug|Any CPU.Build.0 = Debug|Any CPU - {8D49187A-80CC-62FF-290B-EDB9B533685C}.Release|Any CPU.ActiveCfg = Release|Any CPU - {8D49187A-80CC-62FF-290B-EDB9B533685C}.Release|Any CPU.Build.0 = Release|Any CPU - {C46C27B8-F64C-C8A9-E774-4D235A6AD6BC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {C46C27B8-F64C-C8A9-E774-4D235A6AD6BC}.Debug|Any CPU.Build.0 = Debug|Any CPU - {C46C27B8-F64C-C8A9-E774-4D235A6AD6BC}.Release|Any CPU.ActiveCfg = Release|Any CPU - {C46C27B8-F64C-C8A9-E774-4D235A6AD6BC}.Release|Any CPU.Build.0 = Release|Any CPU - {9F6A1868-BA70-8B70-6B86-18E449D3786E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {9F6A1868-BA70-8B70-6B86-18E449D3786E}.Debug|Any CPU.Build.0 = Debug|Any CPU - {9F6A1868-BA70-8B70-6B86-18E449D3786E}.Release|Any CPU.ActiveCfg = Release|Any CPU - {9F6A1868-BA70-8B70-6B86-18E449D3786E}.Release|Any CPU.Build.0 = Release|Any CPU - {D6BF0B62-00B9-D9C0-B5B7-B847D59A9B72}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {D6BF0B62-00B9-D9C0-B5B7-B847D59A9B72}.Debug|Any CPU.Build.0 = Debug|Any CPU - {D6BF0B62-00B9-D9C0-B5B7-B847D59A9B72}.Release|Any CPU.ActiveCfg = Release|Any CPU - {D6BF0B62-00B9-D9C0-B5B7-B847D59A9B72}.Release|Any CPU.Build.0 = Release|Any CPU - {825BECF2-A21A-59AB-F47F-63D9D2FC3A8C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {825BECF2-A21A-59AB-F47F-63D9D2FC3A8C}.Debug|Any CPU.Build.0 = Debug|Any CPU - {825BECF2-A21A-59AB-F47F-63D9D2FC3A8C}.Release|Any CPU.ActiveCfg = Release|Any CPU - {825BECF2-A21A-59AB-F47F-63D9D2FC3A8C}.Release|Any CPU.Build.0 = Release|Any CPU - {60EF86D5-B23F-A057-3080-4102B045F0A7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {60EF86D5-B23F-A057-3080-4102B045F0A7}.Debug|Any CPU.Build.0 = Debug|Any CPU - {60EF86D5-B23F-A057-3080-4102B045F0A7}.Release|Any CPU.ActiveCfg = Release|Any CPU - {60EF86D5-B23F-A057-3080-4102B045F0A7}.Release|Any CPU.Build.0 = Release|Any CPU - {011A8BEC-1358-17DB-2FB2-EE6BF7FD1E30}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {011A8BEC-1358-17DB-2FB2-EE6BF7FD1E30}.Debug|Any CPU.Build.0 = Debug|Any CPU - {011A8BEC-1358-17DB-2FB2-EE6BF7FD1E30}.Release|Any CPU.ActiveCfg = Release|Any CPU - {011A8BEC-1358-17DB-2FB2-EE6BF7FD1E30}.Release|Any CPU.Build.0 = Release|Any CPU - {D772DDD4-2916-1BAF-A614-6884E32B1EC8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {D772DDD4-2916-1BAF-A614-6884E32B1EC8}.Debug|Any CPU.Build.0 = Debug|Any CPU - {D772DDD4-2916-1BAF-A614-6884E32B1EC8}.Release|Any CPU.ActiveCfg = Release|Any CPU - {D772DDD4-2916-1BAF-A614-6884E32B1EC8}.Release|Any CPU.Build.0 = Release|Any CPU - {8FF55202-38A4-04ED-BFC3-D7D7AA7AD4E8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {8FF55202-38A4-04ED-BFC3-D7D7AA7AD4E8}.Debug|Any CPU.Build.0 = Debug|Any CPU - {8FF55202-38A4-04ED-BFC3-D7D7AA7AD4E8}.Release|Any CPU.ActiveCfg = Release|Any CPU - {8FF55202-38A4-04ED-BFC3-D7D7AA7AD4E8}.Release|Any CPU.Build.0 = Release|Any CPU - {E9AD90FE-E2D3-9F12-399A-2E2EDE013959}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {E9AD90FE-E2D3-9F12-399A-2E2EDE013959}.Debug|Any CPU.Build.0 = Debug|Any CPU - {E9AD90FE-E2D3-9F12-399A-2E2EDE013959}.Release|Any CPU.ActiveCfg = Release|Any CPU - {E9AD90FE-E2D3-9F12-399A-2E2EDE013959}.Release|Any CPU.Build.0 = Release|Any CPU - {48088910-FE0F-058D-6B98-AD4049FC9CDA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {48088910-FE0F-058D-6B98-AD4049FC9CDA}.Debug|Any CPU.Build.0 = Debug|Any CPU - {48088910-FE0F-058D-6B98-AD4049FC9CDA}.Release|Any CPU.ActiveCfg = Release|Any CPU - {48088910-FE0F-058D-6B98-AD4049FC9CDA}.Release|Any CPU.Build.0 = Release|Any CPU - {2BCE13CF-2182-A8A1-C5D1-655E7A2D21B1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {2BCE13CF-2182-A8A1-C5D1-655E7A2D21B1}.Debug|Any CPU.Build.0 = Debug|Any CPU - {2BCE13CF-2182-A8A1-C5D1-655E7A2D21B1}.Release|Any CPU.ActiveCfg = Release|Any CPU - {2BCE13CF-2182-A8A1-C5D1-655E7A2D21B1}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection - GlobalSection(NestedProjects) = preSolution - {875621A1-E1B2-F608-9BB7-FC3A3F183D31} = {B8EFCA5F-814F-285C-A8CB-F00F14650265} - {F8E9B2B9-90F0-B3A6-2265-5C72CAABF613} = {875621A1-E1B2-F608-9BB7-FC3A3F183D31} - {8D49187A-80CC-62FF-290B-EDB9B533685C} = {F8E9B2B9-90F0-B3A6-2265-5C72CAABF613} - {4510497D-6DCC-F594-327A-CF3D728AB3C1} = {875621A1-E1B2-F608-9BB7-FC3A3F183D31} - {7C0A80DE-4380-7B1C-6F4B-8DFF90382FD1} = {4510497D-6DCC-F594-327A-CF3D728AB3C1} - {5E0F3E54-956B-23D1-43E4-8073E08941E7} = {7C0A80DE-4380-7B1C-6F4B-8DFF90382FD1} - {87BAD27A-77DA-32C7-8D6A-86119F53C551} = {5E0F3E54-956B-23D1-43E4-8073E08941E7} - {8E3D6239-D920-65D6-8628-8F1AD685C460} = {87BAD27A-77DA-32C7-8D6A-86119F53C551} - {4D59E27A-09C3-E835-E1D4-375F558C4490} = {8E3D6239-D920-65D6-8628-8F1AD685C460} - {C46C27B8-F64C-C8A9-E774-4D235A6AD6BC} = {4D59E27A-09C3-E835-E1D4-375F558C4490} - {CFBAAE68-351B-58CB-6FE1-04881A2B51BC} = {87BAD27A-77DA-32C7-8D6A-86119F53C551} - {99841D8C-3AF8-17D8-4E92-4CC3CDE9E74D} = {CFBAAE68-351B-58CB-6FE1-04881A2B51BC} - {9F6A1868-BA70-8B70-6B86-18E449D3786E} = {99841D8C-3AF8-17D8-4E92-4CC3CDE9E74D} - {CEC115D1-6CD0-281F-B7D5-328F38CB9243} = {87BAD27A-77DA-32C7-8D6A-86119F53C551} - {FEDD9067-990D-0DD1-8725-A53EA91A221A} = {CEC115D1-6CD0-281F-B7D5-328F38CB9243} - {D6BF0B62-00B9-D9C0-B5B7-B847D59A9B72} = {FEDD9067-990D-0DD1-8725-A53EA91A221A} - {191B186A-85E8-3435-CDC4-3AF7D440BA7E} = {87BAD27A-77DA-32C7-8D6A-86119F53C551} - {8D5FF2D0-51B8-D35D-ACC5-6F09A742485D} = {191B186A-85E8-3435-CDC4-3AF7D440BA7E} - {825BECF2-A21A-59AB-F47F-63D9D2FC3A8C} = {8D5FF2D0-51B8-D35D-ACC5-6F09A742485D} - {BF93B00C-CEDE-4A31-96CF-C5D42B41F707} = {87BAD27A-77DA-32C7-8D6A-86119F53C551} - {C46F4138-F84E-06B1-F178-A7B6DE09936B} = {BF93B00C-CEDE-4A31-96CF-C5D42B41F707} - {60EF86D5-B23F-A057-3080-4102B045F0A7} = {C46F4138-F84E-06B1-F178-A7B6DE09936B} - {EFCDE7FE-BDEF-AC04-7D90-AFB0DBB98874} = {7C0A80DE-4380-7B1C-6F4B-8DFF90382FD1} - {1EA68CBF-D341-6F72-89CE-9E23392F634B} = {EFCDE7FE-BDEF-AC04-7D90-AFB0DBB98874} - {72A5EE2A-1492-49C3-A301-89C72C4FEDBD} = {1EA68CBF-D341-6F72-89CE-9E23392F634B} - {BB27418F-7478-6336-89A9-1A3E42367B12} = {72A5EE2A-1492-49C3-A301-89C72C4FEDBD} - {011A8BEC-1358-17DB-2FB2-EE6BF7FD1E30} = {BB27418F-7478-6336-89A9-1A3E42367B12} - {C1CAE349-CB16-0D02-0F73-DF1864859629} = {1EA68CBF-D341-6F72-89CE-9E23392F634B} - {DA661325-A367-7586-BB4F-214E16465565} = {C1CAE349-CB16-0D02-0F73-DF1864859629} - {D772DDD4-2916-1BAF-A614-6884E32B1EC8} = {DA661325-A367-7586-BB4F-214E16465565} - {DF467CA1-F242-91D4-3CB9-58B1DC3B89AA} = {1EA68CBF-D341-6F72-89CE-9E23392F634B} - {F5A5F529-9214-52A1-6E8E-F3D780971656} = {DF467CA1-F242-91D4-3CB9-58B1DC3B89AA} - {8FF55202-38A4-04ED-BFC3-D7D7AA7AD4E8} = {F5A5F529-9214-52A1-6E8E-F3D780971656} - {09252992-DB5E-1A4F-F722-D4A7C5F0EE91} = {1EA68CBF-D341-6F72-89CE-9E23392F634B} - {7A15F4AD-B866-B371-CFD1-751590C4D511} = {09252992-DB5E-1A4F-F722-D4A7C5F0EE91} - {E9AD90FE-E2D3-9F12-399A-2E2EDE013959} = {7A15F4AD-B866-B371-CFD1-751590C4D511} - {1EA2F366-CA4B-EB6E-4198-6447063CF3B6} = {1EA68CBF-D341-6F72-89CE-9E23392F634B} - {D3D2B190-8B98-3F0C-7F54-8AB8D1CE067A} = {1EA2F366-CA4B-EB6E-4198-6447063CF3B6} - {48088910-FE0F-058D-6B98-AD4049FC9CDA} = {D3D2B190-8B98-3F0C-7F54-8AB8D1CE067A} - {AB722F0C-4FAA-AFEE-F1E9-ADE50DD08092} = {1EA68CBF-D341-6F72-89CE-9E23392F634B} - {2F8F79BA-3026-42B0-117C-1FCB7FFF6CB3} = {AB722F0C-4FAA-AFEE-F1E9-ADE50DD08092} - {2BCE13CF-2182-A8A1-C5D1-655E7A2D21B1} = {2F8F79BA-3026-42B0-117C-1FCB7FFF6CB3} - EndGlobalSection - GlobalSection(ExtensibilityGlobals) = postSolution - SolutionGuid = {4860BE77-4C55-47A8-AE72-9408E714F174} - EndGlobalSection -EndGlobal From d5b3d928479618393d2965869fb8218e1ec8be69 Mon Sep 17 00:00:00 2001 From: Angela Date: Fri, 14 Mar 2025 15:20:48 -0400 Subject: [PATCH 04/14] address feedback --- source/reference/command/find.txt | 11 ++++------- source/reference/command/getMore.txt | 9 ++++----- source/reference/method/cursor.batchSize.txt | 13 +++++-------- source/reference/method/db.collection.watch.txt | 8 +++----- .../reference/operator/aggregation/queryStats.txt | 5 +---- 5 files changed, 17 insertions(+), 29 deletions(-) diff --git a/source/reference/command/find.txt b/source/reference/command/find.txt index 7cde5a082d..193f2963d4 100644 --- a/source/reference/command/find.txt +++ b/source/reference/command/find.txt @@ -132,14 +132,11 @@ The command accepts the following fields: * - ``batchSize`` - non-negative integer - - Optional. The maximum number of documents within each batch returned in a query result. - By default, the ``find`` command has an initial batch size of ``101`` documents and a maximum - size of 16 mebibytes (MiB) for each subsequent batch. This option can enforce a smaller - limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results - in batches larger than 16 MiB, this option has no effect. + - Optional. The maximum number of documents within each batch returned in a + query result. By default, the ``find`` command has an initial batch size of ``101`` documents and a maximum size of 16 mebibytes (MiB) for each subsequent batch. This option can enforce a smaller limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and the ``find`` command uses the default batch size. ` - A batchSize of 0 means that the cursor will be established, but no documents - will be returned in the first batch. + A ``batchSize`` of ``0`` means that the cursor is established, but no documents + are returned in the first batch. Unlike the previous wire protocol version, a batchSize of 1 for the :dbcommand:`find` command does not close the cursor. diff --git a/source/reference/command/getMore.txt b/source/reference/command/getMore.txt index 1a9015ce73..2ffa2855ee 100644 --- a/source/reference/command/getMore.txt +++ b/source/reference/command/getMore.txt @@ -72,12 +72,11 @@ The command accepts the following fields: * - ``batchSize`` - positive integer - - Optional. Specifies the maximum number of documents within each batch returned in a query result. + - Optional. Specifies the maximum number of documents within each + batch returned in a query result. - If batchSize is not set, getMore returns up to ``101`` documents in the first batch - and up to 16 mebibytes (MiB) of data in all subsequent batches. If ``batchSize`` is set, ``getMore`` returns - the smaller of 16 mebibytes of data or ``batchSize`` documents. If you set ``batchSize`` to a limit that results - in batches larger than 16 MiB, this option has no effect. + If ``batchSize`` is not set, ``getMore`` returns up to ``101`` documents in the first batch and up to 16 mebibytes (MiB) of data in all subsequent batches. If ``batchSize`` is set, ``getMore`` returns the smaller of 16 mebibytes of data or ``batchSize`` documents. If you set ``batchSize`` to a limit that results + in batches larger than 16 MiB, this option has no effect and ``getMore`` uses the default batch size. * - ``maxTimeMS`` - non-negative integer diff --git a/source/reference/method/cursor.batchSize.txt b/source/reference/method/cursor.batchSize.txt index aab55014c5..52e40a3997 100644 --- a/source/reference/method/cursor.batchSize.txt +++ b/source/reference/method/cursor.batchSize.txt @@ -19,14 +19,11 @@ Definition .. include:: /includes/fact-mongosh-shell-method.rst - Specifies the maximum number of documents within each batch returned in a query result. - By default, the initial batch size is ``101`` documents and subsequent batches have a maximum - size of 16 mebibytes (MiB). This option can enforce a smaller - limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results - in batches larger than 16 MiB, this option has no effect. - - A batchSize of 0 means that the cursor will be established, but no documents - will be returned in the first batch. + Specifies the maximum number of documents within each batch returned in a query result. By default, the initial batch size is ``101`` documents and subsequent batches have a maximum size of 16 mebibytes (MiB). This option can enforce a smaller + limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and the ``find`` command uses the default batch size. + + A ``batchSize`` of ``0`` means that the cursor is established, but no documents + are returned in the first batch. .. note:: diff --git a/source/reference/method/db.collection.watch.txt b/source/reference/method/db.collection.watch.txt index dcb980fe35..33a75e1cf6 100644 --- a/source/reference/method/db.collection.watch.txt +++ b/source/reference/method/db.collection.watch.txt @@ -115,11 +115,9 @@ Definition * - ``batchSize`` - int - - Optional. The maximum number of documents within each batch returned in a change stream. - By default, :method:`~db.collection.watch()` has an initial batch size of ``101`` documents and a maximum size - of 16 mebibytes (MiB) for each subsequent batch. This option can enforce a smaller - limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that - results in batches larger than 16 MiB, this option has no effect. + - Optional. The maximum number of documents within each batch returned + in a change stream. By default, :method:`~db.collection.watch()` has an initial batch size of ``101`` documents and a maximum size + of 16 mebibytes (MiB) for each subsequent batch. This option can enforce a smaller limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and :method:`~db.collection.watch()` uses the default batch size. Has the same functionality as :method:`cursor.batchSize()`. diff --git a/source/reference/operator/aggregation/queryStats.txt b/source/reference/operator/aggregation/queryStats.txt index 6f285d132f..4e53b3ee21 100644 --- a/source/reference/operator/aggregation/queryStats.txt +++ b/source/reference/operator/aggregation/queryStats.txt @@ -355,10 +355,7 @@ Each document in the output array contains the following fields: - String - Normalized - The :ref:`batch size ` for the key. Batch size specifies - the maximum number of documents returned within each batch from the MongoDB instance. - By default, the initial batch size is ``101`` documents and subsequent batches have a - maximum size of 16 mebibytes (MiB). ``batchSize`` can enforce a smaller limit than - 16 MiB, but not a larger one. + the maximum number of documents returned within each batch from the MongoDB instance. By default, the initial batch size is ``101`` documents and subsequent batches have a maximum size of 16 mebibytes (MiB). ``batchSize`` can enforce a smaller limit than 16 MiB, but not a larger one. * - ``key.comment`` - String From cf8c2a45b42dc44141c9015227d3b01de29bb1bd Mon Sep 17 00:00:00 2001 From: Angela Date: Fri, 14 Mar 2025 15:28:50 -0400 Subject: [PATCH 05/14] fix wording error --- source/reference/method/cursor.batchSize.txt | 2 +- source/reference/operator/aggregation/queryStats.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/method/cursor.batchSize.txt b/source/reference/method/cursor.batchSize.txt index 52e40a3997..d9199f6cea 100644 --- a/source/reference/method/cursor.batchSize.txt +++ b/source/reference/method/cursor.batchSize.txt @@ -20,7 +20,7 @@ Definition .. include:: /includes/fact-mongosh-shell-method.rst Specifies the maximum number of documents within each batch returned in a query result. By default, the initial batch size is ``101`` documents and subsequent batches have a maximum size of 16 mebibytes (MiB). This option can enforce a smaller - limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and the ``find`` command uses the default batch size. + limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and :method:`~cursor.batchSize()`` uses the default batch size. A ``batchSize`` of ``0`` means that the cursor is established, but no documents are returned in the first batch. diff --git a/source/reference/operator/aggregation/queryStats.txt b/source/reference/operator/aggregation/queryStats.txt index 4e53b3ee21..4545a53409 100644 --- a/source/reference/operator/aggregation/queryStats.txt +++ b/source/reference/operator/aggregation/queryStats.txt @@ -355,7 +355,7 @@ Each document in the output array contains the following fields: - String - Normalized - The :ref:`batch size ` for the key. Batch size specifies - the maximum number of documents returned within each batch from the MongoDB instance. By default, the initial batch size is ``101`` documents and subsequent batches have a maximum size of 16 mebibytes (MiB). ``batchSize`` can enforce a smaller limit than 16 MiB, but not a larger one. + the maximum number of documents returned within each batch from the MongoDB instance. By default, the initial batch size is ``101`` documents and subsequent batches have a maximum size of 16 mebibytes (MiB). ``batchSize`` can enforce a smaller limit than 16 MiB, but not a larger one. * - ``key.comment`` - String From bc536e24d672277c98e1e4a69840445d4d9f8acf Mon Sep 17 00:00:00 2001 From: Angela Date: Fri, 14 Mar 2025 15:30:14 -0400 Subject: [PATCH 06/14] style change --- source/reference/command/getMore.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/command/getMore.txt b/source/reference/command/getMore.txt index 2ffa2855ee..5ccbbf303f 100644 --- a/source/reference/command/getMore.txt +++ b/source/reference/command/getMore.txt @@ -75,7 +75,7 @@ The command accepts the following fields: - Optional. Specifies the maximum number of documents within each batch returned in a query result. - If ``batchSize`` is not set, ``getMore`` returns up to ``101`` documents in the first batch and up to 16 mebibytes (MiB) of data in all subsequent batches. If ``batchSize`` is set, ``getMore`` returns the smaller of 16 mebibytes of data or ``batchSize`` documents. If you set ``batchSize`` to a limit that results + If ``batchSize`` is not set, ``getMore`` returns up to ``101`` documents in the first batch and up to 16 mebibytes (MiB) of data in all subsequent batches. If ``batchSize`` is set, ``getMore`` returns the smaller of 16 MiB of data or ``batchSize`` documents. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and ``getMore`` uses the default batch size. * - ``maxTimeMS`` From 035d6918c1679292d78d4187c0f2f43c35802e66 Mon Sep 17 00:00:00 2001 From: Angela Date: Fri, 14 Mar 2025 15:43:50 -0400 Subject: [PATCH 07/14] extra quotation --- source/reference/method/cursor.batchSize.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/method/cursor.batchSize.txt b/source/reference/method/cursor.batchSize.txt index d9199f6cea..4fc0fe097b 100644 --- a/source/reference/method/cursor.batchSize.txt +++ b/source/reference/method/cursor.batchSize.txt @@ -20,7 +20,7 @@ Definition .. include:: /includes/fact-mongosh-shell-method.rst Specifies the maximum number of documents within each batch returned in a query result. By default, the initial batch size is ``101`` documents and subsequent batches have a maximum size of 16 mebibytes (MiB). This option can enforce a smaller - limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and :method:`~cursor.batchSize()`` uses the default batch size. + limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and :method:`~cursor.batchSize()` uses the default batch size. A ``batchSize`` of ``0`` means that the cursor is established, but no documents are returned in the first batch. From faf17d1ffe07dbbbc098a776f7000d21c23728b2 Mon Sep 17 00:00:00 2001 From: Angela Date: Fri, 14 Mar 2025 16:54:50 -0400 Subject: [PATCH 08/14] wrap --- source/reference/command/find.txt | 13 +++++++++---- source/reference/command/getMore.txt | 8 ++++++-- source/reference/method/cursor.batchSize.txt | 9 +++++++-- source/reference/method/db.collection.watch.txt | 8 ++++++-- .../reference/operator/aggregation/queryStats.txt | 8 ++++++-- 5 files changed, 34 insertions(+), 12 deletions(-) diff --git a/source/reference/command/find.txt b/source/reference/command/find.txt index 193f2963d4..d2c002d5c6 100644 --- a/source/reference/command/find.txt +++ b/source/reference/command/find.txt @@ -132,11 +132,16 @@ The command accepts the following fields: * - ``batchSize`` - non-negative integer - - Optional. The maximum number of documents within each batch returned in a - query result. By default, the ``find`` command has an initial batch size of ``101`` documents and a maximum size of 16 mebibytes (MiB) for each subsequent batch. This option can enforce a smaller limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and the ``find`` command uses the default batch size. + - Optional. The maximum number of documents within each batch returned + in a query result. By default, the ``find`` command has an initial + batch size of ``101`` documents and a maximum size of 16 mebibytes (MiB) + for each subsequent batch. This option can enforce a smaller limit than + 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that + results in batches larger than 16 MiB, this option has no effect and + the ``find`` command uses the default batch size. ` - A ``batchSize`` of ``0`` means that the cursor is established, but no documents - are returned in the first batch. + A ``batchSize`` of ``0`` means that the cursor is established, + but no documents are returned in the first batch. Unlike the previous wire protocol version, a batchSize of 1 for the :dbcommand:`find` command does not close the cursor. diff --git a/source/reference/command/getMore.txt b/source/reference/command/getMore.txt index 5ccbbf303f..17b8c185ae 100644 --- a/source/reference/command/getMore.txt +++ b/source/reference/command/getMore.txt @@ -75,8 +75,12 @@ The command accepts the following fields: - Optional. Specifies the maximum number of documents within each batch returned in a query result. - If ``batchSize`` is not set, ``getMore`` returns up to ``101`` documents in the first batch and up to 16 mebibytes (MiB) of data in all subsequent batches. If ``batchSize`` is set, ``getMore`` returns the smaller of 16 MiB of data or ``batchSize`` documents. If you set ``batchSize`` to a limit that results - in batches larger than 16 MiB, this option has no effect and ``getMore`` uses the default batch size. + If ``batchSize`` is not set, ``getMore`` returns up to ``101`` documents + in the first batch and up to 16 mebibytes (MiB) of data in all + subsequent batches. If ``batchSize`` is set, ``getMore`` returns + the smaller of 16 MiB of data or ``batchSize`` documents. If you set + ``batchSize`` to a limit that results in batches larger than 16 MiB, this + option has no effect and ``getMore`` uses the default batch size. * - ``maxTimeMS`` - non-negative integer diff --git a/source/reference/method/cursor.batchSize.txt b/source/reference/method/cursor.batchSize.txt index 4fc0fe097b..a3c72ae5a0 100644 --- a/source/reference/method/cursor.batchSize.txt +++ b/source/reference/method/cursor.batchSize.txt @@ -19,8 +19,13 @@ Definition .. include:: /includes/fact-mongosh-shell-method.rst - Specifies the maximum number of documents within each batch returned in a query result. By default, the initial batch size is ``101`` documents and subsequent batches have a maximum size of 16 mebibytes (MiB). This option can enforce a smaller - limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and :method:`~cursor.batchSize()` uses the default batch size. + Specifies the maximum number of documents within each batch returned in + a query result. By default, the initial batch size is ``101`` documents + and subsequent batches have a maximum size of 16 mebibytes (MiB). This + option can enforce a smaller limit than 16 MiB, but not a larger one. If + you set ``batchSize`` to a limit that results in batches larger than 16 + MiB, this option has no effect and :method:`~cursor.batchSize()` uses + the default batch size. A ``batchSize`` of ``0`` means that the cursor is established, but no documents are returned in the first batch. diff --git a/source/reference/method/db.collection.watch.txt b/source/reference/method/db.collection.watch.txt index 33a75e1cf6..6a72f90941 100644 --- a/source/reference/method/db.collection.watch.txt +++ b/source/reference/method/db.collection.watch.txt @@ -116,8 +116,12 @@ Definition - int - Optional. The maximum number of documents within each batch returned - in a change stream. By default, :method:`~db.collection.watch()` has an initial batch size of ``101`` documents and a maximum size - of 16 mebibytes (MiB) for each subsequent batch. This option can enforce a smaller limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and :method:`~db.collection.watch()` uses the default batch size. + in a change stream. By default, :method:`~db.collection.watch()` has + an initial batch size of ``101`` documents and a maximum size + of 16 mebibytes (MiB) for each subsequent batch. This option can + enforce a smaller limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, + this option has no effect and :method:`~db.collection.watch()` uses + the default batch size. Has the same functionality as :method:`cursor.batchSize()`. diff --git a/source/reference/operator/aggregation/queryStats.txt b/source/reference/operator/aggregation/queryStats.txt index 4545a53409..01831bb39c 100644 --- a/source/reference/operator/aggregation/queryStats.txt +++ b/source/reference/operator/aggregation/queryStats.txt @@ -354,8 +354,12 @@ Each document in the output array contains the following fields: * - ``key.batchSize`` - String - Normalized - - The :ref:`batch size ` for the key. Batch size specifies - the maximum number of documents returned within each batch from the MongoDB instance. By default, the initial batch size is ``101`` documents and subsequent batches have a maximum size of 16 mebibytes (MiB). ``batchSize`` can enforce a smaller limit than 16 MiB, but not a larger one. + - The :ref:`batch size ` for the key. Batch size + specifies the maximum number of documents returned within each batch + from the MongoDB instance. By default, the initial batch size is + ``101`` documents and subsequent batches have a maximum size of 16 + mebibytes (MiB). ``batchSize`` can enforce a smaller limit than 16 MiB, + but not a larger one. * - ``key.comment`` - String From 63c684fe519aa2ec36d51384e75f08d027a9b329 Mon Sep 17 00:00:00 2001 From: Angela Date: Thu, 3 Apr 2025 17:37:11 -0400 Subject: [PATCH 09/14] ch feedback --- source/reference/command/find.txt | 14 +++++++------- source/reference/command/getMore.txt | 5 ++--- source/reference/method/cursor.batchSize.txt | 13 ++++++------- source/reference/method/db.collection.watch.txt | 12 ++++++------ .../reference/operator/aggregation/queryStats.txt | 9 ++++----- 5 files changed, 25 insertions(+), 28 deletions(-) diff --git a/source/reference/command/find.txt b/source/reference/command/find.txt index d2c002d5c6..a4f4e6ecc2 100644 --- a/source/reference/command/find.txt +++ b/source/reference/command/find.txt @@ -133,13 +133,13 @@ The command accepts the following fields: * - ``batchSize`` - non-negative integer - Optional. The maximum number of documents within each batch returned - in a query result. By default, the ``find`` command has an initial - batch size of ``101`` documents and a maximum size of 16 mebibytes (MiB) - for each subsequent batch. This option can enforce a smaller limit than - 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that - results in batches larger than 16 MiB, this option has no effect and - the ``find`` command uses the default batch size. -` + in a query result. By default, the ``find`` command has an initial ``batchSize``of + the lesser of ``101`` documents or 16MiB worth of documents. Subsequent batches + have a maximum size of 16 mebibytes (MiB). This option can enforce a smaller limit + than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results + in batches larger than 16 MiB, this option has no effect and the ``find`` command + uses the default batch size. + A ``batchSize`` of ``0`` means that the cursor is established, but no documents are returned in the first batch. diff --git a/source/reference/command/getMore.txt b/source/reference/command/getMore.txt index 17b8c185ae..b2fd0ca957 100644 --- a/source/reference/command/getMore.txt +++ b/source/reference/command/getMore.txt @@ -72,11 +72,10 @@ The command accepts the following fields: * - ``batchSize`` - positive integer - - Optional. Specifies the maximum number of documents within each + - Optional. The maximum number of documents within each batch returned in a query result. - If ``batchSize`` is not set, ``getMore`` returns up to ``101`` documents - in the first batch and up to 16 mebibytes (MiB) of data in all + If ``batchSize`` is not set, ``getMore`` returns up to 16 mebibytes (MiB) of data in all subsequent batches. If ``batchSize`` is set, ``getMore`` returns the smaller of 16 MiB of data or ``batchSize`` documents. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this diff --git a/source/reference/method/cursor.batchSize.txt b/source/reference/method/cursor.batchSize.txt index a3c72ae5a0..789a9380c9 100644 --- a/source/reference/method/cursor.batchSize.txt +++ b/source/reference/method/cursor.batchSize.txt @@ -19,13 +19,12 @@ Definition .. include:: /includes/fact-mongosh-shell-method.rst - Specifies the maximum number of documents within each batch returned in - a query result. By default, the initial batch size is ``101`` documents - and subsequent batches have a maximum size of 16 mebibytes (MiB). This - option can enforce a smaller limit than 16 MiB, but not a larger one. If - you set ``batchSize`` to a limit that results in batches larger than 16 - MiB, this option has no effect and :method:`~cursor.batchSize()` uses - the default batch size. + The maximum number of documents within each batch returned in a query result. + By default, the initial batch size is the lesser of ``101`` documents or 16MiB worth of + documents. Subsequent batches have a maximum size of 16 mebibytes (MiB). This option + can enforce a smaller limit than 16 MiB, but not a larger one. If you set ``batchSize`` + to a limit that results in batches larger than 16 MiB, this option has no effect and + :method:`~cursor.batchSize()` uses the default batch size. A ``batchSize`` of ``0`` means that the cursor is established, but no documents are returned in the first batch. diff --git a/source/reference/method/db.collection.watch.txt b/source/reference/method/db.collection.watch.txt index 6a72f90941..ece7e034ec 100644 --- a/source/reference/method/db.collection.watch.txt +++ b/source/reference/method/db.collection.watch.txt @@ -116,12 +116,12 @@ Definition - int - Optional. The maximum number of documents within each batch returned - in a change stream. By default, :method:`~db.collection.watch()` has - an initial batch size of ``101`` documents and a maximum size - of 16 mebibytes (MiB) for each subsequent batch. This option can - enforce a smaller limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, - this option has no effect and :method:`~db.collection.watch()` uses - the default batch size. + in a change stream. By default, :method:`~db.collection.watch()` has an initial + batch size of the lesser of ``101`` documents or 16MiB + worth of documents. Subsequent batches have a maximum size of 16 mebibytes + (MiB).This option can enforce a smaller limit than 16 MiB, but not a larger one. If you set + ``batchSize`` to a limit that results in batches larger than 16 MiB, this option + has no effect and :method:`~db.collection.watch()` uses the default batch size. Has the same functionality as :method:`cursor.batchSize()`. diff --git a/source/reference/operator/aggregation/queryStats.txt b/source/reference/operator/aggregation/queryStats.txt index 01831bb39c..db037f959b 100644 --- a/source/reference/operator/aggregation/queryStats.txt +++ b/source/reference/operator/aggregation/queryStats.txt @@ -355,11 +355,10 @@ Each document in the output array contains the following fields: - String - Normalized - The :ref:`batch size ` for the key. Batch size - specifies the maximum number of documents returned within each batch - from the MongoDB instance. By default, the initial batch size is - ``101`` documents and subsequent batches have a maximum size of 16 - mebibytes (MiB). ``batchSize`` can enforce a smaller limit than 16 MiB, - but not a larger one. + specifies the maximum number of documents within each batch returned in a query + result. By default, the initial batch size is the lesser of ``101`` documents or 16MiB + worth of documents. Subsequent batches have a maximum size of 16 mebibytes (MiB). ``batchSize`` can enforce a + smaller limit than 16 MiB, but not a larger one. * - ``key.comment`` - String From e660f33495c5b1fd8414a627b84102bb48c1ed78 Mon Sep 17 00:00:00 2001 From: Angela Date: Thu, 3 Apr 2025 17:51:45 -0400 Subject: [PATCH 10/14] style --- source/reference/command/find.txt | 4 ++-- source/reference/method/cursor.batchSize.txt | 4 ++-- source/reference/method/db.collection.watch.txt | 6 +++--- source/reference/operator/aggregation/queryStats.txt | 4 ++-- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/source/reference/command/find.txt b/source/reference/command/find.txt index a4f4e6ecc2..9453cd7a88 100644 --- a/source/reference/command/find.txt +++ b/source/reference/command/find.txt @@ -134,8 +134,8 @@ The command accepts the following fields: - non-negative integer - Optional. The maximum number of documents within each batch returned in a query result. By default, the ``find`` command has an initial ``batchSize``of - the lesser of ``101`` documents or 16MiB worth of documents. Subsequent batches - have a maximum size of 16 mebibytes (MiB). This option can enforce a smaller limit + the lesser of ``101`` documents or 16 mebibytes (MiB) worth of documents. Subsequent batches + have a maximum size of 16 MiB. This option can enforce a smaller limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and the ``find`` command uses the default batch size. diff --git a/source/reference/method/cursor.batchSize.txt b/source/reference/method/cursor.batchSize.txt index 789a9380c9..105c4064ab 100644 --- a/source/reference/method/cursor.batchSize.txt +++ b/source/reference/method/cursor.batchSize.txt @@ -20,8 +20,8 @@ Definition .. include:: /includes/fact-mongosh-shell-method.rst The maximum number of documents within each batch returned in a query result. - By default, the initial batch size is the lesser of ``101`` documents or 16MiB worth of - documents. Subsequent batches have a maximum size of 16 mebibytes (MiB). This option + By default, the initial batch size is the lesser of ``101`` documents or 16 mebibytes (MiB) worth of + documents. Subsequent batches have a maximum size of 16 MiB. This option can enforce a smaller limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and :method:`~cursor.batchSize()` uses the default batch size. diff --git a/source/reference/method/db.collection.watch.txt b/source/reference/method/db.collection.watch.txt index ece7e034ec..12616eae48 100644 --- a/source/reference/method/db.collection.watch.txt +++ b/source/reference/method/db.collection.watch.txt @@ -117,9 +117,9 @@ Definition - int - Optional. The maximum number of documents within each batch returned in a change stream. By default, :method:`~db.collection.watch()` has an initial - batch size of the lesser of ``101`` documents or 16MiB - worth of documents. Subsequent batches have a maximum size of 16 mebibytes - (MiB).This option can enforce a smaller limit than 16 MiB, but not a larger one. If you set + batch size of the lesser of ``101`` documents or 16 mebibytes (MiB) worth of + documents. Subsequent batches have a maximum size of 16 mebibytes.This option + can enforce a smaller limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results in batches larger than 16 MiB, this option has no effect and :method:`~db.collection.watch()` uses the default batch size. diff --git a/source/reference/operator/aggregation/queryStats.txt b/source/reference/operator/aggregation/queryStats.txt index db037f959b..6e88fc5ec9 100644 --- a/source/reference/operator/aggregation/queryStats.txt +++ b/source/reference/operator/aggregation/queryStats.txt @@ -356,8 +356,8 @@ Each document in the output array contains the following fields: - Normalized - The :ref:`batch size ` for the key. Batch size specifies the maximum number of documents within each batch returned in a query - result. By default, the initial batch size is the lesser of ``101`` documents or 16MiB - worth of documents. Subsequent batches have a maximum size of 16 mebibytes (MiB). ``batchSize`` can enforce a + result. By default, the initial batch size is the lesser of ``101`` documents or 16 + mebibytes (MiB) worth of documents. Subsequent batches have a maximum size of 16 MiB. ``batchSize`` can enforce a smaller limit than 16 MiB, but not a larger one. * - ``key.comment`` From caa5e225e4862233aada8b839bf422d56840ebd8 Mon Sep 17 00:00:00 2001 From: Angela Date: Thu, 3 Apr 2025 17:58:47 -0400 Subject: [PATCH 11/14] fix spacing --- source/reference/command/find.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/command/find.txt b/source/reference/command/find.txt index 9453cd7a88..be5ba19d64 100644 --- a/source/reference/command/find.txt +++ b/source/reference/command/find.txt @@ -133,7 +133,7 @@ The command accepts the following fields: * - ``batchSize`` - non-negative integer - Optional. The maximum number of documents within each batch returned - in a query result. By default, the ``find`` command has an initial ``batchSize``of + in a query result. By default, the ``find`` command has an initial ``batchSize`` of the lesser of ``101`` documents or 16 mebibytes (MiB) worth of documents. Subsequent batches have a maximum size of 16 MiB. This option can enforce a smaller limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results From 0617073d6ebf6f958ae0aa5f47f25f3dc85d12a9 Mon Sep 17 00:00:00 2001 From: Angela Date: Thu, 3 Apr 2025 18:06:36 -0400 Subject: [PATCH 12/14] change size desc --- source/reference/method/cursor.batchSize.txt | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/source/reference/method/cursor.batchSize.txt b/source/reference/method/cursor.batchSize.txt index 105c4064ab..06af9e1913 100644 --- a/source/reference/method/cursor.batchSize.txt +++ b/source/reference/method/cursor.batchSize.txt @@ -55,10 +55,11 @@ Definition * - ``size`` - integer - The maximum number of documents to return for a batch. The - default initial batch size is ``101`` documents and subsequent - batches have a maximum size of 16 mebibytes (MiB). This option can enforce a smaller limit than - 16 MiB, but not a larger one. The default applies to drivers and - Mongo Shell. For details, see :ref:`cursor-batches`. + default initial batch size is the lesser or ``101`` documents or 16 mebibytes + (MiB) worth of documents. Subsequent batches have a maximum size of 16 MiB. This + option can enforce a smaller limit than 16 MiB, but not a larger one. The + default applies to drivers and Mongo Shell. For details, see + :ref:`cursor-batches`. Compatibility ------------- From e78b353d472ad576a9ddbd0ae906f76dd8d4acb1 Mon Sep 17 00:00:00 2001 From: Angela Date: Tue, 8 Apr 2025 12:09:02 -0400 Subject: [PATCH 13/14] ch feedback --- source/reference/command/find.txt | 15 +++++++-------- source/reference/command/getMore.txt | 7 ++----- source/reference/method/cursor.batchSize.txt | 9 ++++----- source/reference/method/db.collection.watch.txt | 10 +++++----- .../reference/operator/aggregation/queryStats.txt | 6 ++++-- 5 files changed, 22 insertions(+), 25 deletions(-) diff --git a/source/reference/command/find.txt b/source/reference/command/find.txt index be5ba19d64..c37b90e06d 100644 --- a/source/reference/command/find.txt +++ b/source/reference/command/find.txt @@ -132,14 +132,13 @@ The command accepts the following fields: * - ``batchSize`` - non-negative integer - - Optional. The maximum number of documents within each batch returned - in a query result. By default, the ``find`` command has an initial ``batchSize`` of - the lesser of ``101`` documents or 16 mebibytes (MiB) worth of documents. Subsequent batches - have a maximum size of 16 MiB. This option can enforce a smaller limit - than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results - in batches larger than 16 MiB, this option has no effect and the ``find`` command - uses the default batch size. - + - Optional. The maximum number of documents that can be returned in each batch of a + query result. By default, the ``find`` command has an initial ``batchSize`` of + the lesser of ``101`` documents or 16 mebibytes (MiB) worth of documents. + Subsequent batches have a maximum size of 16 MiB. This option can enforce a smaller + limit than 16 MiB, but not a larger one. When set, the ``batchSize`` is the lesser + of ``batchSize`` documents or 16 MiB worth of documents. + A ``batchSize`` of ``0`` means that the cursor is established, but no documents are returned in the first batch. diff --git a/source/reference/command/getMore.txt b/source/reference/command/getMore.txt index b2fd0ca957..7d7cd07546 100644 --- a/source/reference/command/getMore.txt +++ b/source/reference/command/getMore.txt @@ -72,14 +72,11 @@ The command accepts the following fields: * - ``batchSize`` - positive integer - - Optional. The maximum number of documents within each - batch returned in a query result. + - Optional. The maximum number of documents that can be returned in each batch of a query result. If ``batchSize`` is not set, ``getMore`` returns up to 16 mebibytes (MiB) of data in all subsequent batches. If ``batchSize`` is set, ``getMore`` returns - the smaller of 16 MiB of data or ``batchSize`` documents. If you set - ``batchSize`` to a limit that results in batches larger than 16 MiB, this - option has no effect and ``getMore`` uses the default batch size. + the lesser of ``batchSize`` documents or 16 MiB worth of documents. * - ``maxTimeMS`` - non-negative integer diff --git a/source/reference/method/cursor.batchSize.txt b/source/reference/method/cursor.batchSize.txt index 06af9e1913..d10609a396 100644 --- a/source/reference/method/cursor.batchSize.txt +++ b/source/reference/method/cursor.batchSize.txt @@ -19,12 +19,11 @@ Definition .. include:: /includes/fact-mongosh-shell-method.rst - The maximum number of documents within each batch returned in a query result. + The maximum number of documents that can be returned in each batch of a query result. By default, the initial batch size is the lesser of ``101`` documents or 16 mebibytes (MiB) worth of documents. Subsequent batches have a maximum size of 16 MiB. This option - can enforce a smaller limit than 16 MiB, but not a larger one. If you set ``batchSize`` - to a limit that results in batches larger than 16 MiB, this option has no effect and - :method:`~cursor.batchSize()` uses the default batch size. + can enforce a smaller limit than 16 MiB, but not a larger one. When set, the ``batchSize`` is the lesser + of ``batchSize`` documents or 16 MiB worth of documents. A ``batchSize`` of ``0`` means that the cursor is established, but no documents are returned in the first batch. @@ -54,7 +53,7 @@ Definition * - ``size`` - integer - - The maximum number of documents to return for a batch. The + - The maximum number of documents that can be returned in each batch of a query result. The default initial batch size is the lesser or ``101`` documents or 16 mebibytes (MiB) worth of documents. Subsequent batches have a maximum size of 16 MiB. This option can enforce a smaller limit than 16 MiB, but not a larger one. The diff --git a/source/reference/method/db.collection.watch.txt b/source/reference/method/db.collection.watch.txt index 12616eae48..684f594791 100644 --- a/source/reference/method/db.collection.watch.txt +++ b/source/reference/method/db.collection.watch.txt @@ -115,13 +115,13 @@ Definition * - ``batchSize`` - int - - Optional. The maximum number of documents within each batch returned - in a change stream. By default, :method:`~db.collection.watch()` has an initial + - Optional. The maximum number of documents that can be returned in each batch of + a change stream. By default, :method:`~db.collection.watch()` has an initial batch size of the lesser of ``101`` documents or 16 mebibytes (MiB) worth of documents. Subsequent batches have a maximum size of 16 mebibytes.This option - can enforce a smaller limit than 16 MiB, but not a larger one. If you set - ``batchSize`` to a limit that results in batches larger than 16 MiB, this option - has no effect and :method:`~db.collection.watch()` uses the default batch size. + can enforce a smaller limit than 16 MiB, but not a larger one. When set, the + ``batchSize`` is the lesser of ``batchSize`` documents or 16 MiB worth of + documents. Has the same functionality as :method:`cursor.batchSize()`. diff --git a/source/reference/operator/aggregation/queryStats.txt b/source/reference/operator/aggregation/queryStats.txt index 6e88fc5ec9..2d08cd3632 100644 --- a/source/reference/operator/aggregation/queryStats.txt +++ b/source/reference/operator/aggregation/queryStats.txt @@ -355,10 +355,12 @@ Each document in the output array contains the following fields: - String - Normalized - The :ref:`batch size ` for the key. Batch size - specifies the maximum number of documents within each batch returned in a query + specifies the maximum number of documents that can be returned in each batch of a query result. By default, the initial batch size is the lesser of ``101`` documents or 16 mebibytes (MiB) worth of documents. Subsequent batches have a maximum size of 16 MiB. ``batchSize`` can enforce a - smaller limit than 16 MiB, but not a larger one. + smaller limit than 16 MiB, but not a larger one. When set, the + ``batchSize`` is the lesser of ``batchSize`` documents or 16 MiB worth of + documents. * - ``key.comment`` - String From 26fd63101380a6fbeb17562ec088bd23398aaa7f Mon Sep 17 00:00:00 2001 From: Angela Date: Tue, 8 Apr 2025 12:17:47 -0400 Subject: [PATCH 14/14] fix spacing --- source/reference/operator/aggregation/queryStats.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/operator/aggregation/queryStats.txt b/source/reference/operator/aggregation/queryStats.txt index 2d08cd3632..7d097b0243 100644 --- a/source/reference/operator/aggregation/queryStats.txt +++ b/source/reference/operator/aggregation/queryStats.txt @@ -360,7 +360,7 @@ Each document in the output array contains the following fields: mebibytes (MiB) worth of documents. Subsequent batches have a maximum size of 16 MiB. ``batchSize`` can enforce a smaller limit than 16 MiB, but not a larger one. When set, the ``batchSize`` is the lesser of ``batchSize`` documents or 16 MiB worth of - documents. + documents. * - ``key.comment`` - String