Pinecone TypeScript SDK - v9.0.0
    Preparing search index...

    Interface ReadCapacityStatus

    The state of an index's read capacity, including its current replica and shard counts.

    interface ReadCapacityStatus {
        currentReplicas?: number | null;
        currentShards?: number | null;
        errorMessage?: string;
        state: ReadCapacityState;
    }

    Hierarchy

    • Omit<GeneratedReadCapacityStatus, "state">
      • ReadCapacityStatus
    Index
    currentReplicas? currentShards? errorMessage? state
    currentReplicas?: number | null

    The number of replicas. Each replica has dedicated compute resources and data storage. Increasing this number will increase the total throughput of the index. null for OnDemand indexes and for a Dedicated index that has not finished provisioning.

    ReadCapacityStatus

    currentShards?: number | null

    The number of shards. Each shard has dedicated storage. Increasing shards alleviates index fullness. null for OnDemand indexes and for a Dedicated index that has not finished provisioning.

    ReadCapacityStatus

    errorMessage?: string

    An optional error message indicating any issues with your read capacity configuration

    ReadCapacityStatus

    state: ReadCapacityState

    The current state of the read capacity configuration.

    Settings
    Member Visibility

    On This Page
    Properties