Algolia Indexing Contract
Overview
This skill designs the write path from an authoritative dataset to Algolia. It separates record transformation, validation, transport, task completion, and publication so a failed run cannot silently leave ambiguous search state.
Prerequisites
- A named repository, environment, and Algolia application or index in scope
- The local lockfile and installed client types as implementation authority
- A safe read-only query or explicitly disposable test target
- Current first-party documentation for any provider behavior that affects the change
Tool Discipline
Use Read, Glob, and Grep to inspect local code, configuration names, tests, and dependency versions. Use WebFetch only for current official Algolia documentation. Use Write or Edit only after identifying the target files, constraints, and verification plan.
Current Contract
- Generate stable
objectIDvalues from source identities and reject duplicates before upload. - Choose
saveObjectsfor bounded upserts andreplaceAllObjectsonly for an intentional full-state replacement. - Wait for returned task IDs before verification or traffic cutover.
- Version settings, synonyms, and rules as reviewable inputs; do not infer them from production state during deployment.
Authentication
Run indexing only from a trusted backend with a custom key restricted to the target indices and required write ACLs. Keep search-only keys out of indexing jobs.
Instructions
- Identify the source of truth, deletion semantics, index aliases or replicas, and acceptable publication window.
- Transform and validate records locally, including size, required fields, stable IDs, and prohibited data.
- Select incremental or full replacement based on source deletion guarantees and rollback needs.
- Submit bounded batches, retain task IDs, and wait for completion with an overall timeout.
- Verify counts, sentinel records, settings hashes, and representative queries.
- Record the source snapshot, target index, completed tasks, and rollback or prior-index path.
Approval Boundaries
Do not run a full replacement, delete records, change settings, or swap a production target until the source snapshot and rollback plan are approved.
Output
Return the data contract, operation choice, validation report, task receipts, post-write checks, deletion behavior, and rollback instructions.
Error Handling
| Condition | Response |
|---|---|
| Duplicate objectID | Fail before upload and report source records. |
| Partial batch failure | Stop publication and preserve successful task IDs. |
| Task timeout | Do not assume failure or success; query task state. |
| Verification mismatch | Keep the prior production target and investigate. |
Examples
Use this compact input and expected handoff to calibrate scope and evidence quality.
Input:
source=snapshot-2026-09-10; mode=full-replacement; target=products_next
Expected handoff:
records=48012; tasks=49-complete; sentinel-query=pass; cutover=pending-approval