Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document createIndexes, listIndexes, and dropIndexes commands #2488

Merged
merged 7 commits into from May 5, 2023

Conversation

Fashander
Copy link
Member

Description

Closes #2271.

Readiness checklist

  • I added/updated unit tests.
  • I added/updated integration/compatibility tests.
  • I added/updated comments and checked rendering.
  • I made spot refactorings.
  • I updated user documentation.
  • I ran task all, and it passed.
  • I ensured that PR title is good enough for the changelog.
  • (for maintainers only) I set Reviewers (@FerretDB/core), Labels, Project and project's Sprint fields.
  • I marked all done items in this checklist.

@Fashander Fashander added the documentation Something user-visible is badly or not documented label Apr 20, 2023
@Fashander Fashander added this to the v1.1.0 milestone Apr 20, 2023
@Fashander Fashander requested a review from a team April 20, 2023 08:49
@Fashander Fashander self-assigned this Apr 20, 2023
@AlekSi AlekSi added the trust PRs that can access Actions secrets label Apr 20, 2023
@codecov
Copy link

codecov bot commented Apr 20, 2023

Codecov Report

Merging #2488 (5953472) into main (27fc560) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2488   +/-   ##
=======================================
  Coverage   65.15%   65.15%           
=======================================
  Files         410      410           
  Lines       20071    20071           
=======================================
  Hits        13077    13077           
  Misses       6055     6055           
  Partials      939      939           

see 1 file with indirect coverage changes

Flag Coverage Δ
integration 57.89% <ø> (ø)
mongodb 5.04% <ø> (ø)
pg 57.82% <ø> (ø)
unit 25.69% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@AlekSi AlekSi enabled auto-merge (squash) April 20, 2023 08:56
@AlekSi AlekSi changed the title Document Indexes section about createIndexes, listIndexes, and dropIndexes Document createIndexes, listIndexes, and dropIndexes commands Apr 20, 2023
@AlekSi AlekSi requested a review from rumyantseva April 20, 2023 08:56
website/docs/indexes.md Outdated Show resolved Hide resolved
website/docs/indexes.md Outdated Show resolved Hide resolved
website/docs/indexes.md Outdated Show resolved Hide resolved
website/docs/indexes.md Outdated Show resolved Hide resolved
website/docs/indexes.md Outdated Show resolved Hide resolved
website/docs/indexes.md Outdated Show resolved Hide resolved
website/docs/indexes.md Outdated Show resolved Hide resolved
Co-authored-by: Chi Fujii <chi.fujii@ferretdb.io>
Copy link
Member

@rumyantseva rumyantseva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested a few things and asked a few questions.

There is one thing to clarify: commands and methods/wrappers/handers are not the same.
Commands are on the server (FerretDB) side, and methods/wrappers/handers are on the client/driver side.
There could be a few methods to call the same command. For example, both dropIndex() and dropIndexes() methods call dropIndexes() command.

I find this mixture of methods and commands a bit inconsistent, but probably this is how we use in the other parts of our docs too...

website/docs/indexes.md Outdated Show resolved Hide resolved
website/docs/indexes.md Outdated Show resolved Hide resolved
website/docs/indexes.md Outdated Show resolved Hide resolved
website/docs/indexes.md Outdated Show resolved Hide resolved
website/docs/indexes.md Outdated Show resolved Hide resolved
website/docs/indexes.md Outdated Show resolved Hide resolved
website/docs/indexes.md Outdated Show resolved Hide resolved
website/docs/indexes.md Outdated Show resolved Hide resolved
Copy link
Member

@rumyantseva rumyantseva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Fashander
Copy link
Member Author

@AlekSi PTAL

@AlekSi AlekSi merged commit 4bf7563 into FerretDB:main May 5, 2023
23 of 24 checks passed
@Fashander Fashander deleted the document-indexes branch December 4, 2023 08:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something user-visible is badly or not documented trust PRs that can access Actions secrets
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Document createIndexes command
4 participants