Udostępnij za pomocą

Items class

Pakiet:
@azure/cosmos

Operacje tworzenia nowych elementów i odczytywania/wykonywania zapytań dotyczących wszystkich elementów

Zobacz Element do odczytywania, zastępowania lub usuwania istniejącego kontenera; posługiwać się .item(id).

Właściwości

container

Metody

batch(OperationInput[], PartitionKey, RequestOptions)

Wykonywanie transakcyjnych operacji wsadowych na elementach.

Usługa Batch przyjmuje tablicę operacji, które są typizowane na podstawie operacji. Usługa Batch jest transakcyjna i wycofa wszystkie operacje, jeśli zakończy się niepowodzeniem. Dostępne opcje to: Tworzenie, upsert, odczyt, zastępowanie i usuwanie

Przykład użycia:

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)

Wykonywanie operacji zbiorczych na elementach.
changeFeed(ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian
changeFeed(PartitionKey, ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

Example

Odczytaj od początku zestawienia zmian.

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

Tworzenie ChangeFeedIterator w celu iterowania stron zmian
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian
create<T>(T, RequestOptions)

Utwórz element.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Example

Utwórz element.

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)

Wykonywanie operacji zbiorczych na elementach.

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)

Zwraca iterator do iteracji na stronach zmian. Zwrócony iterator może służyć do pobierania zmian dla pojedynczego klucza partycji, zakresu kanału informacyjnego lub całego kontenera.

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)

Wysyła zapytanie do wszystkich elementów w zaszyfrowanym kontenerze.

Example

Odczytaj wszystkie elementy do tablicy.

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)

Wykonuje zapytanie o wszystkie elementy.

Example

Odczytaj wszystkie elementy do tablicy.

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)

Wykonuje zapytanie o wszystkie elementy.

Example

Odczytaj wszystkie elementy do tablicy.

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)

Odczytaj wszystkie elementy.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Example

Odczytaj wszystkie elementy do tablicy.

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)

Odczytaj wszystkie elementy.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Example

Odczytaj wszystkie elementy do tablicy.

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)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian
readChangeFeed(PartitionKey, ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

Example

Odczytaj od początku zestawienia zmian.

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

Tworzenie ChangeFeedIterator w celu iterowania stron zmian
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian
upsert(unknown, RequestOptions)

Upsert elementu.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.
upsert<T>(T, RequestOptions)

Upsert elementu.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Example

Upsert elementu.

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

Szczegóły właściwości

container 

container: Container

Wartość właściwości

Container

Szczegóły metody

batch(OperationInput[], PartitionKey, RequestOptions)

Wykonywanie transakcyjnych operacji wsadowych na elementach.

Usługa Batch przyjmuje tablicę operacji, które są typizowane na podstawie operacji. Usługa Batch jest transakcyjna i wycofa wszystkie operacje, jeśli zakończy się niepowodzeniem. Dostępne opcje to: Tworzenie, upsert, odczyt, zastępowanie i usuwanie

Przykład użycia:

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

Parametry

operations

OperationInput[]

Lista operacji. Limit 100

partitionKey
PartitionKey
options
RequestOptions

Służy do modyfikowania żądania

Zwraca

Promise<Response<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

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

Wykonywanie operacji zbiorczych na elementach.

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

Parametry

operations

OperationInput[]

Lista operacji. Limit 100

bulkOptions
BulkOptions

Opcjonalny obiekt opcji, aby zmodyfikować zachowanie zbiorcze. Przekaż { continueOnError: false } , aby zatrzymać wykonywanie operacji w przypadku niepowodzenia. (Wartości domyślne to true)

options
RequestOptions

Służy do modyfikowania żądania.

Zwraca

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use getChangeFeedIterator instead.

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

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

Parametry

changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use getChangeFeedIterator instead.

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

Example

Odczytaj od początku zestawienia zmian.

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>

Parametry

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use getChangeFeedIterator instead.

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

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

Parametry

changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use getChangeFeedIterator instead.

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

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

Parametry

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Utwórz element.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Example

Utwórz element.

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

Parametry

body

T

Reprezentuje treść elementu. Może zawierać dowolną liczbę właściwości zdefiniowanych przez użytkownika.

options
RequestOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

Promise<ItemResponse<T>>

executeBulkOperations(OperationInput[], RequestOptions)

Wykonywanie operacji zbiorczych na elementach.

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

Parametry

operations

OperationInput[]

Lista operacji

options
RequestOptions

Służy do modyfikowania żądania

Zwraca

Promise<BulkOperationResult[]>

Wykaz wyników operacji odpowiadających operacjom

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Zwraca iterator do iteracji na stronach zmian. Zwrócony iterator może służyć do pobierania zmian dla pojedynczego klucza partycji, zakresu kanału informacyjnego lub całego kontenera.

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>

Parametry

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Zwraca

ChangeFeedPullModelIterator<T>

getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

Wysyła zapytanie do wszystkich elementów w zaszyfrowanym kontenerze.

Example

Odczytaj wszystkie elementy do tablicy.

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

Parametry

queryBuilder
EncryptionQueryBuilder

Wykonywanie zapytań o konfigurację operacji. Zobacz SqlQuerySpec , aby uzyskać więcej informacji na temat tworzenia zapytania dotyczącego zaszyfrowanych właściwości.

options
FeedOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

Promise<QueryIterator<ItemDefinition>>

query(string | SqlQuerySpec, FeedOptions)

Wykonuje zapytanie o wszystkie elementy.

Example

Odczytaj wszystkie elementy do tablicy.

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>

Parametry

query

string | SqlQuerySpec

Wykonywanie zapytań o konfigurację operacji. Zobacz SqlQuerySpec , aby uzyskać więcej informacji na temat konfigurowania zapytania.

options
FeedOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Wykonuje zapytanie o wszystkie elementy.

Example

Odczytaj wszystkie elementy do tablicy.

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>

Parametry

query

string | SqlQuerySpec

Wykonywanie zapytań o konfigurację operacji. Zobacz SqlQuerySpec , aby uzyskać więcej informacji na temat konfigurowania zapytania.

options
FeedOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

QueryIterator<T>

readAll(FeedOptions)

Odczytaj wszystkie elementy.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Example

Odczytaj wszystkie elementy do tablicy.

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>

Parametry

options
FeedOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Odczytaj wszystkie elementy.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Example

Odczytaj wszystkie elementy do tablicy.

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>

Parametry

options
FeedOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use getChangeFeedIterator instead.

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

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

Parametry

changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use getChangeFeedIterator instead.

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

Example

Odczytaj od początku zestawienia zmian.

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>

Parametry

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use getChangeFeedIterator instead.

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

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

Parametry

changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use getChangeFeedIterator instead.

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

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

Parametry

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Upsert elementu.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

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

Parametry

body

unknown

Reprezentuje treść elementu. Może zawierać dowolną liczbę właściwości zdefiniowanych przez użytkownika.

options
RequestOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsert elementu.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Example

Upsert elementu.

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

Parametry

body

T

Reprezentuje treść elementu. Może zawierać dowolną liczbę właściwości zdefiniowanych przez użytkownika.

options
RequestOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

Promise<ItemResponse<T>>