Items class

  • Referencia
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)

Ejecutar 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:

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

Ejecutar operaciones masivas en elementos.

Bulk toma una matriz de operaciones que se escriben en función de lo que hace la operación. Las opciones son: Crear, Upsert, Leer, Reemplazar y Eliminar

Ejemplo de uso:

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

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

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

Ejemplo

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 objeto ChangeFeedIterator para iterar en las páginas de cambios
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Crear un objeto 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.
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Devuelve un iterador para iterar en 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.
query(string | SqlQuerySpec, FeedOptions)

Consulta todos los elementos.

Ejemplo

Lee todos los elementos en la matriz.

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)

Consulta todos los elementos.

Ejemplo

Lee todos los elementos en la matriz.

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)

Lee todos los elementos.

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

Ejemplo

Lee todos los elementos en la matriz.

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

Lee 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.

Ejemplo

Lee todos los elementos en la matriz.

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

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

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

Ejemplo

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 objeto ChangeFeedIterator para iterar en las páginas de cambios
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

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

Upsert an item.

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

Upsert an item.

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.

Detalles de las propiedades

container 

container: Container

Valor de propiedad

Container

Detalles del método

batch(OperationInput[], PartitionKey, RequestOptions)

Ejecutar 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:

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

Parámetros

operations

OperationInput[]

Lista de operaciones. Límite 100

partitionKey
PartitionKey
options
RequestOptions

Se usa para modificar la solicitud.

Devoluciones

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Ejecutar operaciones masivas en elementos.

Bulk toma una matriz de operaciones que se escriben en función de lo que hace la operación. Las opciones son: Crear, Upsert, Leer, Reemplazar y Eliminar

Ejemplo de uso:

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

Parámetros

operations

OperationInput[]

Lista de operaciones. Límite 100

bulkOptions
BulkOptions

Objeto de opciones opcionales para modificar el comportamiento masivo. Pass { continueOnError: true } para continuar ejecutando operaciones cuando se produce un error. (El valor predeterminado es false) ** NOTA: ESTE VALOR PREDETERMINADO SERÁ TRUE EN LA VERSIÓN 4.0.

options
RequestOptions

Se usa para modificar la solicitud.

Devoluciones

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Crear un objeto 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)

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

Ejemplo

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)

Crear un objeto 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)

Crear un objeto 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.

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, especificando la clave de partición).

Devoluciones

Promise<ItemResponse<T>>

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Devuelve un iterador para iterar en 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.

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

Parámetros

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Devoluciones

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

Consulta todos los elementos.

Ejemplo

Lee todos los elementos en la matriz.

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>

Parámetros

query

string | SqlQuerySpec

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

options
FeedOptions

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

Devoluciones

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Consulta todos los elementos.

Ejemplo

Lee todos los elementos en la matriz.

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>

Parámetros

query

string | SqlQuerySpec

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

options
FeedOptions

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

Devoluciones

QueryIterator<T>

readAll(FeedOptions)

Lee todos los elementos.

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

Ejemplo

Lee todos los elementos en la matriz.

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

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

Parámetros

options
FeedOptions

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

Devoluciones

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Lee 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.

Ejemplo

Lee todos los elementos en la matriz.

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

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

Parámetros

options
FeedOptions

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

Devoluciones

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Advertencia

Esta API ya está en desuso.

Use changeFeed instead.

Crear un objeto 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 changeFeed instead.

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

Ejemplo

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 changeFeed instead.

Crear un objeto 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 changeFeed instead.

Crear un objeto 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 an item.

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, especificando la clave de partición).

Devoluciones

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsert an item.

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.

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, especificando la clave de partición).

Devoluciones

Promise<ItemResponse<T>>