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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation for model indexing #2500

Merged
merged 4 commits into from Jan 10, 2019

Conversation

bearjaws
Copy link
Contributor

@bearjaws bearjaws commented Dec 16, 2018

My PR is a:

  • 馃挜 Breaking change
  • 馃悰 Bug fix #issueNumber
  • 馃拝 Enhancement
  • 馃殌 New feature

Main update on the:

  • Admin
  • Documentation
  • Framework
  • Plugin

When working on a larger collection in mongo, I realized strapi did not add an index to a field I was querying against.
Upon tinkering with Strapi I found that adding index: true to a field configuration added the index automatically, but was not documented.

@derrickmehaffy
Copy link
Member

Can you please add in a bit about what the index does and also add a notice header that it currently is only supported on Mongo and not MySQL/Postgres

@lauriejim lauriejim self-requested a review December 17, 2018 15:31
@lauriejim lauriejim self-assigned this Dec 17, 2018
@lauriejim lauriejim added this to In progress in 3.0.0-alpha.17 via automation Dec 17, 2018
@lauriejim lauriejim added this to the 3.0.0-alpha.17 milestone Dec 17, 2018
@lauriejim lauriejim removed their request for review December 18, 2018 13:05
@lauriejim lauriejim removed their assignment Dec 18, 2018
@lauriejim lauriejim removed this from In progress in 3.0.0-alpha.17 Dec 18, 2018
@lauriejim lauriejim removed this from the 3.0.0-alpha.17 milestone Dec 18, 2018
@bearjaws
Copy link
Contributor Author

Can you please add in a bit about what the index does and also add a notice header that it currently is only supported on Mongo and not MySQL/Postgres

I have added a link to Mongodb's documentation on single field indexes, as there are several types of indexes. I did not add a comment about only working with Mongodb as the header of that section includes: The following supported validations are *only supported by MongoDB*

Do you want me to add the comment about only working for mongodb anyway?

@lauriejim lauriejim added this to In progress in 3.0.0-alpha.19 via automation Jan 7, 2019
@lauriejim lauriejim added this to the 3.0.0-alpha.19 milestone Jan 7, 2019
@lauriejim lauriejim self-requested a review January 7, 2019 14:19
@lauriejim lauriejim self-assigned this Jan 7, 2019
3.0.0-alpha.19 automation moved this from In progress to Reviewer approved Jan 10, 2019
Copy link
Contributor

@lauriejim lauriejim left a comment

Choose a reason for hiding this comment

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

LGTM!

@lauriejim lauriejim merged commit 4a1270f into strapi:master Jan 10, 2019
3.0.0-alpha.19 automation moved this from Reviewer approved to Done Jan 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
source: docs Documentation changes
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants