Compartir a través de

Items class

Paquete:
@azure/cosmos

Operaciones para crear nuevos elementos y leer o consultar todos los elementos

Consulte Elemento para leer, reemplazar o eliminar un contenedor existente; use .item(id).

Propiedades

container

Métodos

batch(OperationInput[], PartitionKey, RequestOptions)

Ejecute operaciones por lotes transaccionales en elementos.

Batch toma una matriz de operaciones que se escriben en función de lo que hace la operación. Batch es transaccional y revertirá todas las operaciones si se produce un error. Las opciones son: Crear, Upsert, Leer, Reemplazar y Eliminar

Ejemplo de uso:

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

// 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 container.items.batch(operations, "A");
bulk(OperationInput[], BulkOptions, RequestOptions)

Ejecute operaciones masivas en elementos.
changeFeed(ChangeFeedOptions)

Crear un ChangeFeedIterator para iterar en las páginas de cambios
changeFeed(PartitionKey, ChangeFeedOptions)

Crear un ChangeFeedIterator para iterar en las páginas de cambios

Example

Lea desde el principio de la fuente de cambios.

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

Crear un ChangeFeedIterator para iterar en las páginas de cambios
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Crear un ChangeFeedIterator para iterar en las páginas de cambios
create<T>(T, RequestOptions)

Cree un elemento.

El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla.

No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.

Example

Cree un elemento.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resource: createdItem } = await container.items.create({
  id: "<item id>",
  properties: {},
});
executeBulkOperations(OperationInput[], RequestOptions)

Ejecute operaciones masivas en elementos.

Example

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const operations: OperationInput[] = [
  {
    operationType: "Create",
    resourceBody: { id: "doc1", name: "sample", key: "A" },
  },
  {
    operationType: "Upsert",
    partitionKey: "A",
    resourceBody: { id: "doc2", name: "other", key: "A" },
  },
];

await container.items.executeBulkOperations(operations);
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Devuelve un iterador para iterar en las páginas de cambios. El iterador devuelto se puede usar para capturar los cambios de una sola clave de partición, un intervalo de fuente o un contenedor completo.

Example

import {
  CosmosClient,
  PartitionKeyDefinitionVersion,
  PartitionKeyKind,
  ChangeFeedStartFrom,
} from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const containerDefinition = {
  id: "Test Database",
  partitionKey: {
    paths: ["/name", "/address/zip"],
    version: PartitionKeyDefinitionVersion.V2,
    kind: PartitionKeyKind.MultiHash,
  },
};
const { container } = await database.containers.createIfNotExists(containerDefinition);

const partitionKey = "some-partition-Key-value";
const options = {
  changeFeedStartFrom: ChangeFeedStartFrom.Beginning(partitionKey),
};

const iterator = container.items.getChangeFeedIterator(options);

while (iterator.hasMoreResults) {
  const response = await iterator.readNext();
  // process this response
}
getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

Consulta todos los elementos de un contenedor cifrado.

Example

Lee todos los elementos en la matriz.

import { CosmosClient, EncryptionQueryBuilder } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const queryBuilder = new EncryptionQueryBuilder(
  `SELECT firstname FROM Families f WHERE f.lastName = @lastName`,
);
queryBuilder.addParameter("@lastName", "Hendricks", "/lastname");
const queryIterator = await container.items.getEncryptionQueryIterator(queryBuilder);
const { resources: items } = await queryIterator.fetchAll();
query(string | SqlQuerySpec, FeedOptions)

Consulta todos los elementos.

Example

Lee todos los elementos en la matriz.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

Consulta todos los elementos.

Example

Lee todos los elementos en la matriz.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

Leer todos los elementos.

No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.

Example

Lee todos los elementos en la matriz.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

Leer todos los elementos.

El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla.

No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.

Example

Lee todos los elementos en la matriz.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

Crear un ChangeFeedIterator para iterar en las páginas de cambios
readChangeFeed(PartitionKey, ChangeFeedOptions)

Crear un ChangeFeedIterator para iterar en las páginas de cambios

Example

Lea desde el principio de la fuente de cambios.

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

Crear un ChangeFeedIterator para iterar en las páginas de cambios
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Crear un ChangeFeedIterator para iterar en las páginas de cambios
upsert(unknown, RequestOptions)

Upsert un elemento.

No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.
upsert<T>(T, RequestOptions)

Upsert un elemento.

El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla.

No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.

Example

Upsert un elemento.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resource: createdItem1 } = await container.items.create({
  id: "<item id 1>",
  properties: {},
});

const { resource: upsertItem1 } = await container.items.upsert({
  id: "<item id 1>",
  updated_properties: {},
});

const { resource: upsertItem2 } = await container.items.upsert({
  id: "<item id 2>",
  properties: {},
});

Detalles de las propiedades

container 

container: Container

Valor de propiedad

Container

Detalles del método

batch(OperationInput[], PartitionKey, RequestOptions)

Ejecute operaciones por lotes transaccionales en elementos.

Batch toma una matriz de operaciones que se escriben en función de lo que hace la operación. Batch es transaccional y revertirá todas las operaciones si se produce un error. Las opciones son: Crear, Upsert, Leer, Reemplazar y Eliminar

Ejemplo de uso:

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

// 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 container.items.batch(operations, "A");

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

Parámetros

operations

OperationInput[]

Lista de operaciones. Límite 100

partitionKey
PartitionKey
options
RequestOptions

Se usa para modificar la solicitud

Devoluciones

Promise<Response<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Advertencia

Esta API ya está en desuso.

Use executeBulkOperations instead.

Bulk takes an array of Operations which are typed based on what the operation does. The choices are: Create, Upsert, Read, Replace, and Delete

Usage example:

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

// 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 container.items.bulk(operations);

Ejecute operaciones masivas en elementos.

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

Parámetros

operations

OperationInput[]

Lista de operaciones. Límite 100

bulkOptions
BulkOptions

Objeto de opciones opcionales para modificar el comportamiento masivo. Pass { continueOnError: false } para dejar de ejecutar operaciones cuando se produce un error. (El valor predeterminado es true)

options
RequestOptions

Se usa para modificar la solicitud.

Devoluciones

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Advertencia

Esta API ya está en desuso.

Use getChangeFeedIterator instead.

Crear un ChangeFeedIterator para iterar en las páginas de cambios

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

Parámetros

changeFeedOptions
ChangeFeedOptions

Devoluciones

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Advertencia

Esta API ya está en desuso.

Use getChangeFeedIterator instead.

Crear un ChangeFeedIterator para iterar en las páginas de cambios

Example

Lea desde el principio de la fuente de cambios.

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>

Parámetros

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Devoluciones

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Advertencia

Esta API ya está en desuso.

Use getChangeFeedIterator instead.

Crear un ChangeFeedIterator para iterar en las páginas de cambios

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

Parámetros

changeFeedOptions
ChangeFeedOptions

Devoluciones

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Advertencia

Esta API ya está en desuso.

Use getChangeFeedIterator instead.

Crear un ChangeFeedIterator para iterar en las páginas de cambios

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

Parámetros

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Devoluciones

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Cree un elemento.

El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla.

No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.

Example

Cree un elemento.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resource: createdItem } = await container.items.create({
  id: "<item id>",
  properties: {},
});

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

Parámetros

body

T

Representa el cuerpo del elemento. Puede contener cualquier número de propiedades definidas por el usuario.

options
RequestOptions

Se usa para modificar la solicitud (por ejemplo, especificar la clave de partición).

Devoluciones

Promise<ItemResponse<T>>

executeBulkOperations(OperationInput[], RequestOptions)

Ejecute operaciones masivas en elementos.

Example

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const operations: OperationInput[] = [
  {
    operationType: "Create",
    resourceBody: { id: "doc1", name: "sample", key: "A" },
  },
  {
    operationType: "Upsert",
    partitionKey: "A",
    resourceBody: { id: "doc2", name: "other", key: "A" },
  },
];

await container.items.executeBulkOperations(operations);

function executeBulkOperations(operations: OperationInput[], options?: RequestOptions): Promise<BulkOperationResult[]>

Parámetros

operations

OperationInput[]

Lista de operaciones

options
RequestOptions

Se utiliza para modificar la solicitud

Devoluciones

Promise<BulkOperationResult[]>

Lista de resultados de operaciones correspondientes a las operaciones

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Devuelve un iterador para iterar en las páginas de cambios. El iterador devuelto se puede usar para capturar los cambios de una sola clave de partición, un intervalo de fuente o un contenedor completo.

Example

import {
  CosmosClient,
  PartitionKeyDefinitionVersion,
  PartitionKeyKind,
  ChangeFeedStartFrom,
} from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const containerDefinition = {
  id: "Test Database",
  partitionKey: {
    paths: ["/name", "/address/zip"],
    version: PartitionKeyDefinitionVersion.V2,
    kind: PartitionKeyKind.MultiHash,
  },
};
const { container } = await database.containers.createIfNotExists(containerDefinition);

const partitionKey = "some-partition-Key-value";
const options = {
  changeFeedStartFrom: ChangeFeedStartFrom.Beginning(partitionKey),
};

const iterator = container.items.getChangeFeedIterator(options);

while (iterator.hasMoreResults) {
  const response = await iterator.readNext();
  // process this response
}

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

Parámetros

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Devoluciones

ChangeFeedPullModelIterator<T>

getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

Consulta todos los elementos de un contenedor cifrado.

Example

Lee todos los elementos en la matriz.

import { CosmosClient, EncryptionQueryBuilder } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const queryBuilder = new EncryptionQueryBuilder(
  `SELECT firstname FROM Families f WHERE f.lastName = @lastName`,
);
queryBuilder.addParameter("@lastName", "Hendricks", "/lastname");
const queryIterator = await container.items.getEncryptionQueryIterator(queryBuilder);
const { resources: items } = await queryIterator.fetchAll();

function getEncryptionQueryIterator(queryBuilder: EncryptionQueryBuilder, options?: FeedOptions): Promise<QueryIterator<ItemDefinition>>

Parámetros

queryBuilder
EncryptionQueryBuilder

Consulta de la configuración de la operación. Consulta SqlQuerySpec para obtener más información sobre cómo crear una consulta en propiedades cifradas.

options
FeedOptions

Se usa para modificar la solicitud (por ejemplo, especificar la clave de partición).

Devoluciones

Promise<QueryIterator<ItemDefinition>>

query(string | SqlQuerySpec, FeedOptions)

Consulta todos los elementos.

Example

Lee todos los elementos en la matriz.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

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

Parámetros

query

string | SqlQuerySpec

Consulta de la configuración de la operación. Consulta SqlQuerySpec para obtener más información sobre cómo configurar una consulta.

options
FeedOptions

Se usa para modificar la solicitud (por ejemplo, especificar la clave de partición).

Devoluciones

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Consulta todos los elementos.

Example

Lee todos los elementos en la matriz.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

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

Parámetros

query

string | SqlQuerySpec

Consulta de la configuración de la operación. Consulta SqlQuerySpec para obtener más información sobre cómo configurar una consulta.

options
FeedOptions

Se usa para modificar la solicitud (por ejemplo, especificar la clave de partición).

Devoluciones

QueryIterator<T>

readAll(FeedOptions)

Leer todos los elementos.

No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.

Example

Lee todos los elementos en la matriz.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

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

Parámetros

options
FeedOptions

Se usa para modificar la solicitud (por ejemplo, especificar la clave de partición).

Devoluciones

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Leer todos los elementos.

El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla.

No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.

Example

Lee todos los elementos en la matriz.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

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

Parámetros

options
FeedOptions

Se usa para modificar la solicitud (por ejemplo, especificar la clave de partición).

Devoluciones

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Advertencia

Esta API ya está en desuso.

Use getChangeFeedIterator instead.

Crear un ChangeFeedIterator para iterar en las páginas de cambios

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

Parámetros

changeFeedOptions
ChangeFeedOptions

Devoluciones

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Advertencia

Esta API ya está en desuso.

Use getChangeFeedIterator instead.

Crear un ChangeFeedIterator para iterar en las páginas de cambios

Example

Lea desde el principio de la fuente de cambios.

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>

Parámetros

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Devoluciones

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Advertencia

Esta API ya está en desuso.

Use getChangeFeedIterator instead.

Crear un ChangeFeedIterator para iterar en las páginas de cambios

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

Parámetros

changeFeedOptions
ChangeFeedOptions

Devoluciones

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Advertencia

Esta API ya está en desuso.

Use getChangeFeedIterator instead.

Crear un ChangeFeedIterator para iterar en las páginas de cambios

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

Parámetros

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Devoluciones

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Upsert un elemento.

No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.

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

Parámetros

body

unknown

Representa el cuerpo del elemento. Puede contener cualquier número de propiedades definidas por el usuario.

options
RequestOptions

Se usa para modificar la solicitud (por ejemplo, especificar la clave de partición).

Devoluciones

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsert un elemento.

El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla.

No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.

Example

Upsert un elemento.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resource: createdItem1 } = await container.items.create({
  id: "<item id 1>",
  properties: {},
});

const { resource: upsertItem1 } = await container.items.upsert({
  id: "<item id 1>",
  updated_properties: {},
});

const { resource: upsertItem2 } = await container.items.upsert({
  id: "<item id 2>",
  properties: {},
});

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

Parámetros

body

T

Representa el cuerpo del elemento. Puede contener cualquier número de propiedades definidas por el usuario.

options
RequestOptions

Se usa para modificar la solicitud (por ejemplo, especificar la clave de partición).

Devoluciones

Promise<ItemResponse<T>>