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 index name limitations #30826

Merged
merged 2 commits into from
May 25, 2018

Conversation

polyfractal
Copy link
Contributor

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.

Also tidy up the docs a bit, there's no yaml example anymore, etc
@polyfractal polyfractal added >docs General docs changes review :Data Management/Indices APIs APIs to create and manage indices and templates labels May 23, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra

Copy link
Member

@dakrone dakrone left a 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
Copy link
Member

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah good catch. Fixing

@polyfractal polyfractal merged commit 6909a05 into elastic:master May 25, 2018
polyfractal added a commit that referenced this pull request May 25, 2018
Also tidy up the docs a bit, there's no yaml example anymore, etc
jasontedor added a commit to jasontedor/elasticsearch that referenced this pull request May 25, 2018
* 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
jasontedor added a commit to jasontedor/elasticsearch that referenced this pull request May 25, 2018
…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
dnhatn added a commit that referenced this pull request May 28, 2018
* 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)
dnhatn added a commit that referenced this pull request May 28, 2018
* 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Indices APIs APIs to create and manage indices and templates >docs General docs changes v6.4.0 v7.0.0-beta1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants