-
Notifications
You must be signed in to change notification settings - Fork 24.8k
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 index name limitations #30826
Conversation
Also tidy up the docs a bit, there's no yaml example anymore, etc
Pinging @elastic/es-core-infra |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, left one comment
- Indices prior to 7.0 could contain a colon (`:`), but that's been deprecated and won't be supported in 7.0+ | ||
- Cannot start with `-`, `_`, `+` | ||
- Cannot be `.` or ``..` | ||
- Cannot be longer than 255 characters |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is actually 255 bytes, so multi-byte characters could count towards multiple bytes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah good catch. Fixing
Also tidy up the docs a bit, there's no yaml example anymore, etc
* elastic/master: Do not serialize basic license exp in x-pack info (elastic#30848) Change BWC version for VerifyRepositoryResponse (elastic#30796) [DOCS] Document index name limitations (elastic#30826) Harmonize include_defaults tests (elastic#30700) [TEST] Mute {p0=snapshot.get_repository/10_basic/Verify created repository} YAML test
…ster * elastic/master: Do not serialize basic license exp in x-pack info (elastic#30848) Change BWC version for VerifyRepositoryResponse (elastic#30796) [DOCS] Document index name limitations (elastic#30826) Harmonize include_defaults tests (elastic#30700) [TEST] Mute {p0=snapshot.get_repository/10_basic/Verify created repository} YAML test
* master: silence InstallPluginCommandTests, see #30900 Remove left-over comment Fix double semicolon in import statement [TEST] Fix minor random bug from #30794 Include size of snapshot in snapshot metadata #18543, bwc clean up (#30890) Enabling testing against an external cluster (#30885) Add public key header/footer (#30877) SQL: Remove the last remaining server dependencies from jdbc (#30771) Include size of snapshot in snapshot metadata (#29602) Do not serialize basic license exp in x-pack info (#30848) Change BWC version for VerifyRepositoryResponse (#30796) [DOCS] Document index name limitations (#30826) Harmonize include_defaults tests (#30700)
* 6.x: Fix double semicolon in import statement [TEST] Fix minor random bug from #30794 Enabling testing against an external cluster (#30885) SQL: Remove the last remaining server dependencies from jdbc (#30771) Add public key header/footer (#30877) Include size of snapshot in snapshot metadata (#29602) QA: Test template creation during rolling restart (#30850) REST high-level client: add put ingest pipeline API (#30793) Do not serialize basic license exp in x-pack info (#30848) [docs] explainer for java packaging tests (#30825) Verify signatures on official plugins (#30800) [DOCS] Document index name limitations (#30826) [Docs] Add reindex.remote.whitelist example (#30828)
We have a number of limitations on how indices can be named, but those limitations don't appear to be documented anywhere. This PR adds those limitations as a callout at the top of the CreateIndex API docs.
It also tidies the opening section a bit, removes reference to a yaml example that doesn't exist, etc.