QueryHint¶

class aerospike_sdk.aio.operations.query.QueryHint[source]¶

Bases: object

Hint for influencing secondary index selection and query scheduling.

Provide index_name to force a specific named secondary index, or bin_name to redirect the filter to a different bin’s index. These two are mutually exclusive. query_duration overrides the policy’s expected_duration for this query only.

Example:

hint = QueryHint(
    index_name="age_idx",
    query_duration=QueryDuration.SHORT,
)
stream = await (
    session.query(dataset)
        .filter(Filter.equal("age", 30))
        .with_hint(hint)
        .execute()
)

Parameters:

index_name (Optional[str]) – Force the query to use the named secondary index.
bin_name (Optional[str]) – Redirect the filter to use a different bin’s index.
query_duration (Optional[QueryDuration]) – Override expected_duration on the query policy.

Raises:

ValueError – If both index_name and bin_name are provided.