[DOCS-14522] [Server] Explicitly document the cursor option of the listIndexes command Created: 01/Jun/21  Updated: 30/Oct/23  Resolved: 29/Mar/22

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Improvement Priority: Major - P3
Reporter: Spencer Brown Assignee: Sarah Olson
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 1 year, 45 weeks, 1 day ago
Epic Link: DOCSP-11701

 Description   

Description

The listIndexes command documentation is missing the documentation for cursor option, which allows the user to specify a batch size for the results.

Please explicitly add "cursor" as an option for this command, with the description that it takes a document

{batchSize: N}

where N is the desired batch size.

Please also amend the output description for "listIndexes.cursor", mentioning to use the getMore command to retrieve additional results if the cursor is non-zero.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 29/Mar/22 ]

Author:

{'name': 'Sarah Olson', 'email': '98367156+sarah-olson-mongodb@users.noreply.github.com', 'username': 'sarah-olson-mongodb'}

Message: Docs 14522 v4.0 (#879)

  • DOCS-14522: Updates to the listIndexes page (#771)
  • DOCS-14522: Update listIndexes based on jira request.
  • DOCS-14522: Incorporate edits, add examples section.
  • Review edits
    :
  • DOCS:14522: Troubleshooting some issue

Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local>
Co-authored-by: Sarah Olson <sarah.olson@M-Q05KQ99304.local>

  • DOCS-14522: Removed unnecessary files from 4.0 branch

Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local>
Co-authored-by: Sarah Olson <sarah.olson@M-Q05KQ99304.local>
Branch: v4.0
https://github.com/10gen/docs-mongodb-internal/commit/d7a5e19eb7f3d5763fcfa3bec8d50b917dbdd62b

Comment by Githook User [ 29/Mar/22 ]

Author:

{'name': 'Sarah Olson', 'email': '98367156+sarah-olson-mongodb@users.noreply.github.com', 'username': 'sarah-olson-mongodb'}

Message: Docs 14522 v4.2 (#877)

  • DOCS-14522: Updates to the listIndexes page (#771)
  • DOCS-14522: Update listIndexes based on jira request.
  • DOCS-14522: Incorporate edits, add examples section.
  • Review edits
    :
  • DOCS:14522: Troubleshooting some issue

Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local>
Co-authored-by: Sarah Olson <sarah.olson@M-Q05KQ99304.local>

  • DOCS-14522: Minor additional edits for code-block
  • Empty commit
  • DOCS-14522: Remove unnecessary file from the 4.2 branch

Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local>
Co-authored-by: Sarah Olson <sarah.olson@M-Q05KQ99304.local>
Branch: v4.2
https://github.com/10gen/docs-mongodb-internal/commit/45f5d95cdb78970e5a2a58cf1bb2d82f65b8c7db

Comment by Githook User [ 29/Mar/22 ]

Author:

{'name': 'Sarah Olson', 'email': '98367156+sarah-olson-mongodb@users.noreply.github.com', 'username': 'sarah-olson-mongodb'}

Message: DOCS-14522: Updates to the listIndexes page (#771) (#875)

  • DOCS-14522: Update listIndexes based on jira request.
  • DOCS-14522: Incorporate edits, add examples section.
  • Review edits
    :
  • DOCS:14522: Troubleshooting some issue

Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local>
Co-authored-by: Sarah Olson <sarah.olson@M-Q05KQ99304.local>

"DOCS-14522:Fix merge conflicts for v4.4"
Branch: v4.4
https://github.com/10gen/docs-mongodb-internal/commit/f4cccad6c8d61650ebd9ad1d8f6ad3b909192760

Comment by Githook User [ 29/Mar/22 ]

Author:

{'name': 'Sarah Olson', 'email': '98367156+sarah-olson-mongodb@users.noreply.github.com', 'username': 'sarah-olson-mongodb'}

Message: DOCS-14522: Updates to the listIndexes page (#771) (#874)

  • DOCS-14522: Update listIndexes based on jira request.
  • DOCS-14522: Incorporate edits, add examples section.
  • Review edits
    :
  • DOCS:14522: Troubleshooting some issue

Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local>
Co-authored-by: Sarah Olson <sarah.olson@M-Q05KQ99304.local>

Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local>
Co-authored-by: Sarah Olson <sarah.olson@M-Q05KQ99304.local>
Branch: v5.0
https://github.com/10gen/docs-mongodb-internal/commit/50b50cd2008fa07e968107a499960a7bef8a6186

Comment by Githook User [ 29/Mar/22 ]

Author:

{'name': 'Sarah Olson', 'email': '98367156+sarah-olson-mongodb@users.noreply.github.com', 'username': 'sarah-olson-mongodb'}

Message: DOCS-14522: Updates to the listIndexes page (#771) (#873)

  • DOCS-14522: Update listIndexes based on jira request.
  • DOCS-14522: Incorporate edits, add examples section.
  • Review edits
    :
  • DOCS:14522: Troubleshooting some issue

Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local>
Co-authored-by: Sarah Olson <sarah.olson@M-Q05KQ99304.local>

Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local>
Co-authored-by: Sarah Olson <sarah.olson@M-Q05KQ99304.local>
Branch: v5.2
https://github.com/10gen/docs-mongodb-internal/commit/c77f3a72329009b9f8e5199ffc7d034582fded5f

Comment by Githook User [ 25/Mar/22 ]

Author:

{'name': 'Sarah Olson', 'email': '98367156+sarah-olson-mongodb@users.noreply.github.com', 'username': 'sarah-olson-mongodb'}

Message: DOCS-14522: Updates to the listIndexes page (#771)

  • DOCS-14522: Update listIndexes based on jira request.
  • DOCS-14522: Incorporate edits, add examples section.
  • Review edits
    :
  • DOCS:14522: Troubleshooting some issue

Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local>
Co-authored-by: Sarah Olson <sarah.olson@M-Q05KQ99304.local>
Branch: master
https://github.com/10gen/docs-mongodb-internal/commit/499fe7db3d4c8f17a6498260402b440f7b3fb439

Comment by Sarah Olson [ 10/Mar/22 ]

Hi spencer.brown! I'm pretty new to the Server documentation team and as part of my onboarding and learning process the team assigned me this relatively old Jira that you filed. 

Would you mind having a quick look and let me know if I addressed your concerns?

PR: https://github.com/10gen/docs-mongodb-internal/pull/771

Updates staging link: https://docs-mongodbcom-staging.corp.mongodb.com/docs/docsworker-xlarge/DOCS-14522/reference/command/listIndexes/

 

Generated at Thu Feb 08 08:10:34 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.