Condividi tramite

Ottenere intervalli di chiavi di partizione

  • Articolo

L'esecuzione di un oggetto GET nella risorsa figlio di pkranges una raccolta specifica recupera l'elenco di intervalli di chiavi di partizione per la raccolta.

Nota

Questi articoli di riferimento sulle API illustrano come creare risorse usando l'API del piano dati di Azure Cosmos DB. Con l'API del piano dati è possibile configurare opzioni di base, ad esempio criteri di indicizzazione, chiavi di partizione molto simili a quelle che è possibile usare gli SDK di Cosmos DB. Se è necessario il supporto completo delle funzionalità per tutte le risorse di Azure Cosmos DB, è consigliabile usare il provider di risorse Cosmos DB.

Richiesta

Metodo URI richiesta Descrizione
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges Si noti che il {databaseaccount} nome dell'account Azure Cosmos DB creato nella sottoscrizione. L'ID {db-id} del database e il valore {coll-id} è l'ID della raccolta.

Intestazioni

Vedere Intestazioni di richiesta REST di Azure Cosmos DB comuni per le intestazioni usate da tutte le richieste di Cosmos DB.

Corpo

Nessuno.

Risposta

Restituisce l'elenco degli intervalli di chiavi di partizione per la raccolta.

Intestazioni

Vedere Intestazioni di risposta REST di Azure Cosmos DB comuni per le intestazioni restituite da tutte le risposte di Cosmos DB.

Codici di stato

La seguente tabella elenca i codici di stato comuni restituiti da questa operazione. Per un elenco completo dei codici di stato, vedere Codici di stato HTTP.

Codice di stato HTTP Descrizione
200 Ok L'operazione è stata completata.
404 - Non trovato La raccolta non viene trovata.

Corpo

Proprietà Descrizione
id Si tratta del nome univoco che identifica la raccolta.
_rid Proprietà generata dal sistema. L'ID risorsa (_rid) è un identificatore univoco che è anche gerarchico per ogni stack di risorse nel modello di risorsa. Viene usato internamente per il posizionamento e l'esplorazione della risorsa di autorizzazione.
_ts Proprietà generata dal sistema. Indica il timestamp dell'ultimo aggiornamento della risorsa. Il valore è un timestamp.
_self Proprietà generata dal sistema. URI indirizzabile univoco per la risorsa.
_etag Si tratta di una proprietà generata dal sistema che rappresenta la risorsa etag necessaria per il controllo di concorrenza ottimistica.
PartitionKeyRanges Questo è l'elenco degli intervalli di chiavi di partizione per la raccolta. Questa operazione può essere usata per la lettura incrementale con l'intestazione x-ms-documentdb-partitionkeyrangeid .

Proprietà di PartitionKeyRanges

Proprietà Descrizione
id

L'ID per l'intervallo di chiavi di partizione. Si tratta di un ID stabile e univoco in ciascuna raccolta.

Può essere usato per leggere documenti in base all'intervallo di chiavi di partizione.
maxExclusive Il valore hash di chiave di partizione massimo per l'intervallo di chiavi di partizione. Per uso interno.
minInclusive Il valore hash di chiave di partizione minimo per l'intervallo di chiavi di partizione. Per uso interno.

Esempio

È possibile recuperare gli intervalli di chiavi di partizione richiedendo la risorsa pkranges all'interno di una raccolta. Ad esempio, la richiesta seguente recupera l'elenco di intervalli di chiavi di partizione per la raccolta serverlogs:

    GET https://querydemo.documents.azure.com/dbs/bigdb/colls/serverlogs/pkranges HTTP/1.1
    x-ms.date: 04/20/2021
    authorization: type%3dmaster%26ver%3d1.0%26sig%3dEConYmRgDExu6q%2bZ8GjfUGOH0AcOx%2behkancw3LsGQ8%3d
    x-ms-consistency-level: Session
    x-ms-version: 2016-07-11
    Accept: application/json
    Host: querydemo.documents.azure.com

Questa richiesta restituisce la risposta seguente che contiene i metadati sugli intervalli di chiavi di partizione:

    HTTP/1.1 200 Ok
    Content-Type: application/json
    x-ms-item-count: 25
    x-ms-schemaversion: 1.1
    Date: Tue, 15 Nov 2016 07:26:51 GMT

    {
       "_rid":"qYcAAPEvJBQ=",
       "PartitionKeyRanges":[
          {
             "_rid":"qYcAAPEvJBQCAAAAAAAAUA==",
             "id":"0",
             "_etag":"\"00002800-0000-0000-0000-580ac4ea0000\"",
             "minInclusive":"",
             "maxExclusive":"05C1CFFFFFFFF8",
             "_self":"dbs\/qYcAAA==\/colls\/qYcAAPEvJBQ=\/pkranges\/qYcAAPEvJBQCAAAAAAAAUA==\/",
             "_ts":1477100776
          },
          ...
       ],
       "_count": 25
    }

Vedere anche