Index

The hanzo index commands.

Fast full-text search over your own data, typos forgiven.

hanzo index indexes list

Every command takes --json for the raw response and --help for its own flags. Sign in once with hanzo auth login; the commands below use that session, and the org they act in is the one it carries.

Command	What it does
`hanzo index health`	Reports whether the search plane can serve.
`hanzo index stats`	Counts the documents in each of your indexes.
`hanzo index version`	Identifies the search implementation answering.

Indexes

Command	What it does
`hanzo index indexes create`	Creates an index.
`hanzo index indexes documents create <uid>`	Add or replace documents in an index
`hanzo index indexes documents delete-batch <uid>`	Delete many documents by primary key in one call
`hanzo index indexes documents get <uid> <id>`	Reads one document by its primary key.
`hanzo index indexes documents list <uid>`	Pages through the documents in an index.
`hanzo index indexes documents replace <uid>`	Add or update documents in an index
`hanzo index indexes documents rm <uid> <id>`	Deletes one document by its primary key.
`hanzo index indexes get <uid>`	Reads one index's definition.
`hanzo index indexes list`	Lists the indexes your org holds.
`hanzo index indexes rm <uid>`	Deletes an index and everything in it.
`hanzo index indexes search <uid>`	Searches an index, forgiving typos.
`hanzo index indexes settings get <uid>`	Reads an index's filterable attributes.
`hanzo index indexes settings patch <uid>`	Sets which attributes an index can be filtered on.

Tasks

Command	What it does
`hanzo index tasks get 1`	Checks a write task, which has already finished.

Was this page useful?

PreviousSearch NextKnowledge