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

Create a "Troubleshooting Spatial Queries" page #7901

Open
rmloveland opened this issue Jul 31, 2020 · 0 comments
Open

Create a "Troubleshooting Spatial Queries" page #7901

rmloveland opened this issue Jul 31, 2020 · 0 comments
Assignees
Milestone

Comments

@rmloveland
Copy link
Contributor

rmloveland commented Jul 31, 2020

Richard Loveland (rmloveland) commented:

Sometimes a spatial query will not return quite the results you are looking for. We should have docs on how to debug such queries.

Estimated topics to cover here:

  • Notes on debugging indexes since they work differently than PostGIS
  • Link to reference info on spatial indexes (inverted indexes, etc.)
  • Should probably link to 'Spatial Query Performance' as well
  • Link to general CockroachDB troubleshooting docs
  • Probably many more things that we will discover as we go

Jira Issue: DOC-619

@rmloveland rmloveland self-assigned this Jul 31, 2020
@rmloveland rmloveland added this to the 20.2 milestone Jul 31, 2020
@rmloveland rmloveland added this to To do in Spatial Docs Aug 3, 2020
@rmloveland rmloveland moved this from To do to Backlog in Spatial Docs Oct 7, 2020
rmloveland added a commit that referenced this issue Oct 9, 2020
Fixes #8563.

Addresses #7900, #7901, #7902, #7903, #8172, #8356, #8567.

Summary of changes:

- Add a new page 'Spatial Indexes' that:

  - Describes what they are and how they work at high and lower(ish)
    levels

  - Provides some examples of usage, including how to tune them to
    generate tighter or looser coverings with 'CREATE INDEX', as well as
    exploring potential coverings with 'st_s2covering'.

- Add links to/from 'CREATE INDEX', 'Indexes', and 'Inverted Indexes'
  pages.

- Also, add lots of cross-linking among various spatial pages,
  esp. where indexing is mentioned in the text thereof.
rmloveland added a commit that referenced this issue Oct 9, 2020
Fixes #8563.

Addresses #7835, #7900, #7901, #7902, #7903, #8172, #8356, #8377, #8513, #8567.

Summary of changes:

- Add a new page 'Spatial Indexes' that:

  - Describes what they are and how they work at high and lower(ish)
    levels

  - Provides some examples of usage, including how to tune them to
    generate tighter or looser coverings with 'CREATE INDEX', as well as
    exploring potential coverings with 'st_s2covering'.

- Add links to/from 'CREATE INDEX', 'Indexes', and 'Inverted Indexes'
  pages.

- Also, add lots of cross-linking among various spatial pages,
  esp. where indexing is mentioned in the text thereof.
rmloveland added a commit that referenced this issue Oct 12, 2020
Fixes #8563.

Addresses #7835, #7900, #7901, #7902, #7903, #8172, #8356, #8377, #8513, #8567.

Summary of changes:

- Add a new page 'Spatial Indexes' that:

  - Describes what they are and how they work at high and lower(ish)
    levels

  - Provides some examples of usage, including how to tune them to
    generate tighter or looser coverings with 'CREATE INDEX', as well as
    exploring potential coverings with 'st_s2covering'.

- Add links to/from 'CREATE INDEX', 'Indexes', and 'Inverted Indexes'
  pages.

- Also, add lots of cross-linking among various spatial pages,
  esp. where indexing is mentioned in the text thereof.
rmloveland added a commit that referenced this issue Oct 12, 2020
Fixes #8563.

Addresses #7835, #7900, #7901, #7902, #7903, #8172, #8356, #8377, #8513, #8567.

Summary of changes:

- Add a new page 'Spatial Indexes' that:

  - Describes what they are and how they work at high and lower(ish)
    levels

  - Provides some examples of usage, including how to tune them to
    generate tighter or looser coverings with 'CREATE INDEX', as well as
    exploring potential coverings with 'st_s2covering'.

- Add links to/from 'CREATE INDEX', 'Indexes', and 'Inverted Indexes'
  pages.

- Also, add lots of cross-linking among various spatial pages,
  esp. where indexing is mentioned in the text thereof.
rmloveland added a commit that referenced this issue Oct 13, 2020
Fixes #8563.

Addresses #7835, #7900, #7901, #7902, #7903, #8172, #8356, #8377, #8513, #8567.

Summary of changes:

- Add a new page 'Spatial Indexes' that:

  - Describes what they are and how they work at high and lower(ish)
    levels

  - Provides some examples of usage, including how to tune them to
    generate tighter or looser coverings with 'CREATE INDEX', as well as
    exploring potential coverings with 'st_s2covering'.

- Add links to/from 'CREATE INDEX', 'Indexes', and 'Inverted Indexes'
  pages.

- Also, add lots of cross-linking among various spatial pages,
  esp. where indexing is mentioned in the text thereof.
rmloveland added a commit that referenced this issue Oct 13, 2020
Fixes #8563.

Addresses #7835, #7900, #7901, #7902, #7903, #8172, #8356, #8377, #8513, #8567.

Summary of changes:

- Add a new page 'Spatial Indexes' that:

  - Describes what they are and how they work at high and lower(ish)
    levels

  - Provides some examples of usage, including how to tune them to
    generate tighter or looser coverings with 'CREATE INDEX', as well as
    exploring potential coverings with 'st_s2covering'.

- Add links to/from 'CREATE INDEX', 'Indexes', and 'Inverted Indexes'
  pages.

- Also, add lots of cross-linking among various spatial pages,
  esp. where indexing is mentioned in the text thereof.
rmloveland added a commit that referenced this issue Oct 14, 2020
Fixes #8563.

Addresses #7835, #7900, #7901, #7902, #7903, #8172, #8356, #8377, #8513, #8567.

Summary of changes:

- Add a new page 'Spatial Indexes' that:

  - Describes what they are and how they work at high and lower(ish)
    levels

  - Provides some examples of usage, including how to tune them to
    generate tighter or looser coverings with 'CREATE INDEX', as well as
    exploring potential coverings with 'st_s2covering'.

- Add links to/from 'CREATE INDEX', 'Indexes', and 'Inverted Indexes'
  pages.

- Also, add lots of cross-linking among various spatial pages,
  esp. where indexing is mentioned in the text thereof.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Spatial Docs
  
Backlog
Development

No branches or pull requests

2 participants