Items class

container: Container

Valor de propiedad

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:

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

Parámetros

Devoluciones

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

Devoluciones

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

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

Parámetros

Devoluciones

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

Devoluciones

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

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

Parámetros

Devoluciones

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

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

Parámetros

Devoluciones

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

Devoluciones

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

Devoluciones

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

Devoluciones

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

Devoluciones

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

Devoluciones

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

Devoluciones

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

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

Parámetros

Devoluciones

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

Devoluciones

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

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

Parámetros

Devoluciones

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

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

Parámetros

Devoluciones

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

Devoluciones

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

Devoluciones