Inspect geospatial indexes

GET /v1/tenants/{tenant}/geo/{schema}

Check whether locations are indexed consistentlyThis reports index health, not nearby locations.

Choose the table schemaRequest its geospatial configuration.
Compare point and index countsInspect points, indexed and consistency.
Check for pending repairAccount for repair state before relying on searches.

Before you start

Use your database bearer token.

Use a registered schema with a declared geospatial field. The example targets demo.locations.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`schema`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

Compare points with indexed, and check consistent and index_repair_pending. This inspects geospatial indexing; it does not return nearby locations.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
404	Check the resource ID and API route.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/geo/demo.locations" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "schema": "demo.locations",
  "fields": [
    {
      "field": "location",
      "source": "location",
      "index": "r_tree",
      "points": 1,
      "indexed": 1,
      "consistent": true,
      "index_repair_pending": false
    }
  ]
}

Assumes demo.locations declares an R-tree index on the location source column and contains the one geo fixture point.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses