Condividi tramite

Items class

  • Riferimento
Pacchetto:
@azure/cosmos

Operazioni per la creazione di nuovi elementi e la lettura/esecuzione di query su tutti gli elementi

Vedere elemento per la lettura, la sostituzione o l'eliminazione di un contenitore esistente; usare .item(id).

Proprietà

container

Metodi

batch(OperationInput[], PartitionKey, RequestOptions)

Eseguire operazioni batch transazionali sugli elementi.

Batch accetta una matrice di operazioni tipate in base alle operazioni eseguite dall'operazione. Batch è transazionale e eseguirà il rollback di tutte le operazioni in caso di errore. Le scelte sono: Create, Upsert, Read, Replace e Delete

Esempio di utilizzo:

// The partitionKey is a required second argument. If it’s undefined, it defaults to the expected partition key format.
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.batch(operations, "A")
bulk(OperationInput[], BulkOptions, RequestOptions)

Eseguire operazioni bulk sugli elementi.

Bulk accetta una matrice di operazioni tipate in base alle operazioni eseguite dall'operazione. Le scelte sono: Create, Upsert, Read, Replace e Delete

Esempio di utilizzo:

// partitionKey is optional at the top level if present in the resourceBody
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.bulk(operations)
changeFeed(ChangeFeedOptions)

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche
changeFeed(PartitionKey, ChangeFeedOptions)

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche

esempio di

Leggere dall'inizio del feed di modifiche.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
changeFeed<T>(ChangeFeedOptions)

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche
create<T>(T, RequestOptions)

Creare un elemento.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Restituisce un iteratore per scorrere le pagine di modifiche. L'iteratore restituito può essere usato per recuperare le modifiche per una singola chiave di partizione, un intervallo di feed o un intero contenitore.
query(string | SqlQuerySpec, FeedOptions)

Esegue query su tutti gli elementi.

esempio di

Legge tutti gli elementi nella matrice.

const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query(querySpec).fetchAll();
query<T>(string | SqlQuerySpec, FeedOptions)

Esegue query su tutti gli elementi.

esempio di

Legge tutti gli elementi nella matrice.

const querySpec: SqlQuerySpec = {
  query: "SELECT firstname FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query<{firstName: string}>(querySpec).fetchAll();
readAll(FeedOptions)

Legge tutti gli elementi.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

esempio di

Legge tutti gli elementi nella matrice.

const {body: containerList} = await items.readAll().fetchAll();
readAll<T>(FeedOptions)

Legge tutti gli elementi.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

esempio di

Legge tutti gli elementi nella matrice.

const {body: containerList} = await items.readAll().fetchAll();
readChangeFeed(ChangeFeedOptions)

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche
readChangeFeed(PartitionKey, ChangeFeedOptions)

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche

esempio di

Leggere dall'inizio del feed di modifiche.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
readChangeFeed<T>(ChangeFeedOptions)

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche
upsert(unknown, RequestOptions)

Upsert di un elemento.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.
upsert<T>(T, RequestOptions)

Upsert di un elemento.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

Dettagli proprietà

container 

container: Container

Valore della proprietà

Container

Dettagli metodo

batch(OperationInput[], PartitionKey, RequestOptions)

Eseguire operazioni batch transazionali sugli elementi.

Batch accetta una matrice di operazioni tipate in base alle operazioni eseguite dall'operazione. Batch è transazionale e eseguirà il rollback di tutte le operazioni in caso di errore. Le scelte sono: Create, Upsert, Read, Replace e Delete

Esempio di utilizzo:

// The partitionKey is a required second argument. If it’s undefined, it defaults to the expected partition key format.
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.batch(operations, "A")

function batch(operations: OperationInput[], partitionKey?: PartitionKey, options?: RequestOptions): Promise<Response_2<OperationResponse[]>>

Parametri

operations

OperationInput[]

Elenco di operazioni. Limite 100

partitionKey
PartitionKey
options
RequestOptions

Utilizzato per modificare la richiesta

Restituisce

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Eseguire operazioni bulk sugli elementi.

Bulk accetta una matrice di operazioni tipate in base alle operazioni eseguite dall'operazione. Le scelte sono: Create, Upsert, Read, Replace e Delete

Esempio di utilizzo:

// partitionKey is optional at the top level if present in the resourceBody
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.bulk(operations)

function bulk(operations: OperationInput[], bulkOptions?: BulkOptions, options?: RequestOptions): Promise<BulkOperationResponse>

Parametri

operations

OperationInput[]

Elenco di operazioni. Limite 100

bulkOptions
BulkOptions

Oggetto opzioni facoltativo per modificare il comportamento bulk. Passare { continueOnError: false } per interrompere l'esecuzione delle operazioni quando si verifica un errore. (Il valore predefinito è true)

options
RequestOptions

Utilizzato per modificare la richiesta.

Restituisce

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche

function changeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parametri

changeFeedOptions
ChangeFeedOptions

Restituisce

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche

esempio di

Leggere dall'inizio del feed di modifiche.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();

function changeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parametri

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Restituisce

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche

function changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parametri

changeFeedOptions
ChangeFeedOptions

Restituisce

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche

function changeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parametri

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Restituisce

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Creare un elemento.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

function create<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

Parametri

body

T

Rappresenta il corpo dell'elemento. Può contenere un numero qualsiasi di proprietà definite dall'utente.

options
RequestOptions

Usato per modificare la richiesta, ad esempio specificando la chiave di partizione.

Restituisce

Promise<ItemResponse<T>>

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Restituisce un iteratore per scorrere le pagine di modifiche. L'iteratore restituito può essere usato per recuperare le modifiche per una singola chiave di partizione, un intervallo di feed o un intero contenitore.

function getChangeFeedIterator<T>(changeFeedIteratorOptions?: ChangeFeedIteratorOptions): ChangeFeedPullModelIterator<T>

Parametri

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Restituisce

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

Esegue query su tutti gli elementi.

esempio di

Legge tutti gli elementi nella matrice.

const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query(querySpec).fetchAll();

function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Parametri

query

string | SqlQuerySpec

Configurazione della query per l'operazione. Per altre informazioni su come configurare una query, vedere SqlQuerySpec.

options
FeedOptions

Usato per modificare la richiesta, ad esempio specificando la chiave di partizione.

Restituisce

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Esegue query su tutti gli elementi.

esempio di

Legge tutti gli elementi nella matrice.

const querySpec: SqlQuerySpec = {
  query: "SELECT firstname FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query<{firstName: string}>(querySpec).fetchAll();

function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

Parametri

query

string | SqlQuerySpec

Configurazione della query per l'operazione. Per altre informazioni su come configurare una query, vedere SqlQuerySpec.

options
FeedOptions

Usato per modificare la richiesta, ad esempio specificando la chiave di partizione.

Restituisce

QueryIterator<T>

readAll(FeedOptions)

Legge tutti gli elementi.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

esempio di

Legge tutti gli elementi nella matrice.

const {body: containerList} = await items.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<ItemDefinition>

Parametri

options
FeedOptions

Usato per modificare la richiesta, ad esempio specificando la chiave di partizione.

Restituisce

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Legge tutti gli elementi.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

esempio di

Legge tutti gli elementi nella matrice.

const {body: containerList} = await items.readAll().fetchAll();

function readAll<T>(options?: FeedOptions): QueryIterator<T>

Parametri

options
FeedOptions

Usato per modificare la richiesta, ad esempio specificando la chiave di partizione.

Restituisce

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Avviso

Questa API è ora deprecata.

Use changeFeed instead.

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche

function readChangeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parametri

changeFeedOptions
ChangeFeedOptions

Restituisce

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Avviso

Questa API è ora deprecata.

Use changeFeed instead.

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche

esempio di

Leggere dall'inizio del feed di modifiche.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();

function readChangeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parametri

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Restituisce

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Avviso

Questa API è ora deprecata.

Use changeFeed instead.

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche

function readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parametri

changeFeedOptions
ChangeFeedOptions

Restituisce

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Avviso

Questa API è ora deprecata.

Use changeFeed instead.

Creare un ChangeFeedIterator per scorrere le pagine delle modifiche

function readChangeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parametri

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Restituisce

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Upsert di un elemento.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

function upsert(body: unknown, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>

Parametri

body

unknown

Rappresenta il corpo dell'elemento. Può contenere un numero qualsiasi di proprietà definite dall'utente.

options
RequestOptions

Usato per modificare la richiesta, ad esempio specificando la chiave di partizione.

Restituisce

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsert di un elemento.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

function upsert<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

Parametri

body

T

Rappresenta il corpo dell'elemento. Può contenere un numero qualsiasi di proprietà definite dall'utente.

options
RequestOptions

Usato per modificare la richiesta, ad esempio specificando la chiave di partizione.

Restituisce

Promise<ItemResponse<T>>