Delen via

Items class

Pakket:
@azure/cosmos

Bewerkingen voor het maken van nieuwe items en het lezen/opvragen van alle items

Zie Item voor het lezen, vervangen of verwijderen van een bestaande container; Gebruik .item(id).

Eigenschappen

container

Methoden

batch(OperationInput[], PartitionKey, RequestOptions)

Voer transactionele batchbewerkingen uit op items.

Batch gebruikt een matrix met bewerkingen die worden getypt op basis van wat de bewerking doet. Batch is transactioneel en zet alle bewerkingen terug als er een mislukt. De opties zijn: Maken, Upsert, Lezen, Vervangen en Verwijderen

Gebruikvoorbeeld:

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)

Voer bulkbewerkingen uit op items.
changeFeed(ChangeFeedOptions)

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
changeFeed(PartitionKey, ChangeFeedOptions)

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen

Example

Lees vanaf het begin van de wijzigingenfeed.

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

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
create<T>(T, RequestOptions)

Maak een item.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

Example

Maak een item.

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)

Voer bulkbewerkingen uit op items.

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)

Hiermee wordt een iterator geretourneerd om pagina's met wijzigingen te herhalen. De geretourneerde iterator kan worden gebruikt om wijzigingen op te halen voor één partitiesleutel, feedbereik of een hele container.

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)

Query's op alle items in een versleutelde container.

Example

Alle items naar matrix lezen.

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)

Hiermee worden alle items opgevraagd.

Example

Alle items naar matrix lezen.

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)

Hiermee worden alle items opgevraagd.

Example

Alle items naar matrix lezen.

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)

Alle items lezen.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

Example

Alle items naar matrix lezen.

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)

Alle items lezen.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

Example

Alle items naar matrix lezen.

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)

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
readChangeFeed(PartitionKey, ChangeFeedOptions)

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen

Example

Lees vanaf het begin van de wijzigingenfeed.

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

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
upsert(unknown, RequestOptions)

Upsert een item.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.
upsert<T>(T, RequestOptions)

Upsert een item.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

Example

Upsert een item.

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: {},
});

Eigenschapdetails

container 

container: Container

Waarde van eigenschap

Container

Methodedetails

batch(OperationInput[], PartitionKey, RequestOptions)

Voer transactionele batchbewerkingen uit op items.

Batch gebruikt een matrix met bewerkingen die worden getypt op basis van wat de bewerking doet. Batch is transactioneel en zet alle bewerkingen terug als er een mislukt. De opties zijn: Maken, Upsert, Lezen, Vervangen en Verwijderen

Gebruikvoorbeeld:

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

Parameters

operations

OperationInput[]

Lijst met bewerkingen. Limiet 100

partitionKey
PartitionKey
options
RequestOptions

Wordt gebruikt voor het wijzigen van de aanvraag

Retouren

Promise<Response<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Waarschuwing

Deze API is nu afgeschaft.

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

Voer bulkbewerkingen uit op items.

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

Parameters

operations

OperationInput[]

Lijst met bewerkingen. Limiet 100

bulkOptions
BulkOptions

Optionele optiesobject om bulkgedrag te wijzigen. Pass { continueOnError: false } om te stoppen met het uitvoeren van bewerkingen wanneer er een mislukt. (Standaard ingesteld op true)

options
RequestOptions

Wordt gebruikt voor het wijzigen van de aanvraag.

Retouren

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Waarschuwing

Deze API is nu afgeschaft.

Use getChangeFeedIterator instead.

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen

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

Parameters

changeFeedOptions
ChangeFeedOptions

Retouren

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Waarschuwing

Deze API is nu afgeschaft.

Use getChangeFeedIterator instead.

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen

Example

Lees vanaf het begin van de wijzigingenfeed.

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>

Parameters

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Retouren

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Waarschuwing

Deze API is nu afgeschaft.

Use getChangeFeedIterator instead.

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen

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

Parameters

changeFeedOptions
ChangeFeedOptions

Retouren

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Waarschuwing

Deze API is nu afgeschaft.

Use getChangeFeedIterator instead.

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen

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

Parameters

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Retouren

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Maak een item.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

Example

Maak een item.

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

Parameters

body

T

Vertegenwoordigt de hoofdtekst van het item. Kan een willekeurig aantal door de gebruiker gedefinieerde eigenschappen bevatten.

options
RequestOptions

Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).

Retouren

Promise<ItemResponse<T>>

executeBulkOperations(OperationInput[], RequestOptions)

Voer bulkbewerkingen uit op items.

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

Parameters

operations

OperationInput[]

Lijst met bewerkingen

options
RequestOptions

Wordt gebruikt voor het wijzigen van de aanvraag

Retouren

Promise<BulkOperationResult[]>

Lijst van de resultaten van de verrichtingen die betrekking hebben op de verrichtingen

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Hiermee wordt een iterator geretourneerd om pagina's met wijzigingen te herhalen. De geretourneerde iterator kan worden gebruikt om wijzigingen op te halen voor één partitiesleutel, feedbereik of een hele container.

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>

Parameters

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Retouren

ChangeFeedPullModelIterator<T>

getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

Query's op alle items in een versleutelde container.

Example

Alle items naar matrix lezen.

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

Parameters

queryBuilder
EncryptionQueryBuilder

Queryconfiguratie voor de bewerking. Zie SqlQuerySpec voor meer informatie over het bouwen van een query op versleutelde eigenschappen.

options
FeedOptions

Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).

Retouren

Promise<QueryIterator<ItemDefinition>>

query(string | SqlQuerySpec, FeedOptions)

Hiermee worden alle items opgevraagd.

Example

Alle items naar matrix lezen.

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>

Parameters

query

string | SqlQuerySpec

Queryconfiguratie voor de bewerking. Zie SqlQuerySpec voor meer informatie over het configureren van een query.

options
FeedOptions

Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).

Retouren

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Hiermee worden alle items opgevraagd.

Example

Alle items naar matrix lezen.

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>

Parameters

query

string | SqlQuerySpec

Queryconfiguratie voor de bewerking. Zie SqlQuerySpec voor meer informatie over het configureren van een query.

options
FeedOptions

Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).

Retouren

QueryIterator<T>

readAll(FeedOptions)

Alle items lezen.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

Example

Alle items naar matrix lezen.

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>

Parameters

options
FeedOptions

Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).

Retouren

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Alle items lezen.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

Example

Alle items naar matrix lezen.

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>

Parameters

options
FeedOptions

Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).

Retouren

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Waarschuwing

Deze API is nu afgeschaft.

Use getChangeFeedIterator instead.

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen

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

Parameters

changeFeedOptions
ChangeFeedOptions

Retouren

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Waarschuwing

Deze API is nu afgeschaft.

Use getChangeFeedIterator instead.

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen

Example

Lees vanaf het begin van de wijzigingenfeed.

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>

Parameters

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Retouren

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Waarschuwing

Deze API is nu afgeschaft.

Use getChangeFeedIterator instead.

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen

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

Parameters

changeFeedOptions
ChangeFeedOptions

Retouren

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Waarschuwing

Deze API is nu afgeschaft.

Use getChangeFeedIterator instead.

Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen

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

Parameters

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Retouren

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Upsert een item.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

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

Parameters

body

unknown

Vertegenwoordigt de hoofdtekst van het item. Kan een willekeurig aantal door de gebruiker gedefinieerde eigenschappen bevatten.

options
RequestOptions

Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).

Retouren

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsert een item.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

Example

Upsert een item.

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

Parameters

body

T

Vertegenwoordigt de hoofdtekst van het item. Kan een willekeurig aantal door de gebruiker gedefinieerde eigenschappen bevatten.

options
RequestOptions

Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).

Retouren

Promise<ItemResponse<T>>