Items class

  • Référence
Paquet:
@azure/cosmos

Opérations de création d’éléments et de lecture/interrogation de tous les éléments

Consultez Élément pour lire, remplacer ou supprimer un conteneur existant . utilisez .item(id).

Propriétés

container

Méthodes

batch(OperationInput[], PartitionKey, RequestOptions)

Exécutez des opérations de traitement par lots transactionnelles sur les éléments.

Batch prend un tableau d’opérations qui sont typées en fonction de ce que fait l’opération. Batch est transactionnel et restaure toutes les opérations en cas d’échec. Les choix sont les suivants : Créer, Upsert, Lire, Remplacer et Supprimer

Exemple d’utilisation :

// partitionKey is required as a second argument to batch, but defaults to the default partition key
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.batch(operations)
bulk(OperationInput[], BulkOptions, RequestOptions)

Exécutez des opérations en bloc sur des éléments.

En bloc prend un tableau d’opérations qui sont typées en fonction de ce que l’opération fait. Les choix sont les suivants : Créer, Upsert, Lire, Remplacer et Supprimer

Exemple d’utilisation :

// 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)

Créer un ChangeFeedIterator pour itérer sur des pages de modifications
changeFeed(PartitionKey, ChangeFeedOptions)

Créer un ChangeFeedIterator pour itérer sur des pages de modifications

Exemple

Lisez à partir du début du flux de modification.

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

Créer un ChangeFeedIterator pour itérer sur des pages de modifications
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Créer un ChangeFeedIterator pour itérer sur des pages de modifications
create<T>(T, RequestOptions)

Créez un élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Retourne un itérateur pour itérer sur des pages de modifications. L’itérateur retourné peut être utilisé pour extraire les modifications d’une clé de partition unique, d’une plage de flux ou d’un conteneur entier.
query(string | SqlQuerySpec, FeedOptions)

Interroge tous les éléments.

Exemple

Lisez tous les éléments dans le tableau.

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)

Interroge tous les éléments.

Exemple

Lisez tous les éléments dans le tableau.

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)

Lisez tous les éléments.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

Exemple

Lisez tous les éléments dans le tableau.

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

Lisez tous les éléments.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

Exemple

Lisez tous les éléments dans le tableau.

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

Créer un ChangeFeedIterator pour itérer sur des pages de modifications
readChangeFeed(PartitionKey, ChangeFeedOptions)

Créer un ChangeFeedIterator pour itérer sur des pages de modifications

Exemple

Lisez à partir du début du flux de modification.

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

Créer un ChangeFeedIterator pour itérer sur des pages de modifications
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Créer un ChangeFeedIterator pour itérer sur des pages de modifications
upsert(unknown, RequestOptions)

Upsert un élément.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.
upsert<T>(T, RequestOptions)

Upsert un élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

Détails de la propriété

container 

container: Container

Valeur de propriété

Container

Détails de la méthode

batch(OperationInput[], PartitionKey, RequestOptions)

Exécutez des opérations de traitement par lots transactionnelles sur les éléments.

Batch prend un tableau d’opérations qui sont typées en fonction de ce que fait l’opération. Batch est transactionnel et restaure toutes les opérations en cas d’échec. Les choix sont les suivants : Créer, Upsert, Lire, Remplacer et Supprimer

Exemple d’utilisation :

// partitionKey is required as a second argument to batch, but defaults to the default partition key
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.batch(operations)

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

Paramètres

operations

OperationInput[]

Liste des opérations. Limite 100

partitionKey
PartitionKey
options
RequestOptions

Utilisé pour modifier la demande

Retours

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Exécutez des opérations en bloc sur des éléments.

En bloc prend un tableau d’opérations qui sont typées en fonction de ce que l’opération fait. Les choix sont les suivants : Créer, Upsert, Lire, Remplacer et Supprimer

Exemple d’utilisation :

// 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>

Paramètres

operations

OperationInput[]

Liste des opérations. Limite 100

bulkOptions
BulkOptions

Objet d’options facultatives pour modifier le comportement en bloc. Passez { continueOnError: true } pour continuer à exécuter les opérations en cas d’échec. (Valeur par défaut false) ** REMARQUE : CETTE VALEUR EST TRUE PAR DÉFAUT DANS LA VERSION 4.0

options
RequestOptions

Utilisé pour modifier la demande.

Retours

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Créer un ChangeFeedIterator pour itérer sur des pages de modifications

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

Paramètres

changeFeedOptions
ChangeFeedOptions

Retours

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Créer un ChangeFeedIterator pour itérer sur des pages de modifications

Exemple

Lisez à partir du début du flux de modification.

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>

Paramètres

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Retours

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Créer un ChangeFeedIterator pour itérer sur des pages de modifications

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

Paramètres

changeFeedOptions
ChangeFeedOptions

Retours

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Créer un ChangeFeedIterator pour itérer sur des pages de modifications

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

Paramètres

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Retours

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Créez un élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

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

Paramètres

body

T

Représente le corps de l’élément. Peut contenir n’importe quel nombre de propriétés définies par l’utilisateur.

options
RequestOptions

Utilisé pour modifier la requête (pour instance, en spécifiant la clé de partition).

Retours

Promise<ItemResponse<T>>

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Retourne un itérateur pour itérer sur des pages de modifications. L’itérateur retourné peut être utilisé pour extraire les modifications d’une clé de partition unique, d’une plage de flux ou d’un conteneur entier.

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

Paramètres

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Retours

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

Interroge tous les éléments.

Exemple

Lisez tous les éléments dans le tableau.

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>

Paramètres

query

string | SqlQuerySpec

Configuration de requête pour l’opération. Pour plus d’informations sur la configuration d’une requête, consultez SqlQuerySpec .

options
FeedOptions

Utilisé pour modifier la requête (pour instance, en spécifiant la clé de partition).

Retours

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Interroge tous les éléments.

Exemple

Lisez tous les éléments dans le tableau.

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>

Paramètres

query

string | SqlQuerySpec

Configuration de requête pour l’opération. Pour plus d’informations sur la configuration d’une requête, consultez SqlQuerySpec .

options
FeedOptions

Utilisé pour modifier la requête (pour instance, en spécifiant la clé de partition).

Retours

QueryIterator<T>

readAll(FeedOptions)

Lisez tous les éléments.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

Exemple

Lisez tous les éléments dans le tableau.

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

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

Paramètres

options
FeedOptions

Utilisé pour modifier la requête (pour instance, en spécifiant la clé de partition).

Retours

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Lisez tous les éléments.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

Exemple

Lisez tous les éléments dans le tableau.

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

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

Paramètres

options
FeedOptions

Utilisé pour modifier la requête (pour instance, en spécifiant la clé de partition).

Retours

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Avertissement

Cette API est à présent déconseillée.

Use changeFeed instead.

Créer un ChangeFeedIterator pour itérer sur des pages de modifications

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

Paramètres

changeFeedOptions
ChangeFeedOptions

Retours

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Avertissement

Cette API est à présent déconseillée.

Use changeFeed instead.

Créer un ChangeFeedIterator pour itérer sur des pages de modifications

Exemple

Lisez à partir du début du flux de modification.

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>

Paramètres

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Retours

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Avertissement

Cette API est à présent déconseillée.

Use changeFeed instead.

Créer un ChangeFeedIterator pour itérer sur des pages de modifications

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

Paramètres

changeFeedOptions
ChangeFeedOptions

Retours

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Avertissement

Cette API est à présent déconseillée.

Use changeFeed instead.

Créer un ChangeFeedIterator pour itérer sur des pages de modifications

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

Paramètres

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Retours

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Upsert un élément.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

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

Paramètres

body

unknown

Représente le corps de l’élément. Peut contenir n’importe quel nombre de propriétés définies par l’utilisateur.

options
RequestOptions

Utilisé pour modifier la requête (pour instance, en spécifiant la clé de partition).

Retours

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsert un élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

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

Paramètres

body

T

Représente le corps de l’élément. Peut contenir n’importe quel nombre de propriétés définies par l’utilisateur.

options
RequestOptions

Utilisé pour modifier la requête (pour instance, en spécifiant la clé de partition).

Retours

Promise<ItemResponse<T>>