Megosztás a következőn keresztül:

Items class

Csomag:
@azure/cosmos

Új elemek létrehozására és az összes elem olvasására/lekérdezésére szolgáló műveletek

Lásd: Elem meglévő tároló olvasásához, cseréjéhez vagy törléséhez; használja a .item(id)lehetőséget.

Tulajdonságok

container

Metódusok

batch(OperationInput[], PartitionKey, RequestOptions)

Tranzakciós kötegműveletek végrehajtása elemeken.

A Batch egy művelettömböt vesz fel, amely a művelet működése alapján van begépelve. A Batch tranzakciós, és minden műveletet visszaállít, ha az egyik sikertelen. A lehetőségek a következők: Létrehozás, Felolvasás, Olvasás, Csere és Törlés

Használati példa:

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)

Tömeges műveletek végrehajtása elemeken.
changeFeed(ChangeFeedOptions)

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához
changeFeed(PartitionKey, ChangeFeedOptions)

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

Example

Olvasás a változáscsatorna elejétől.

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

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához
changeFeed<T>(PartitionKey, ChangeFeedOptions)

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához
create<T>(T, RequestOptions)

Hozzon létre egy elemet.

A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

Example

Hozzon létre egy elemet.

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)

Tömeges műveletek végrehajtása elemeken.

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)

Egy iterátort ad vissza a módosítások oldalainak iterálásához. A visszaadott iterátor egy partíciókulcs, adatcsatornatartomány vagy egy teljes tároló módosításainak beolvasására használható.

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)

Lekérdezi az összes elemet egy titkosított tárolóban.

Example

Olvassa el az összes elemet a tömbben.

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)

Az összes elemet lekérdezi.

Example

Olvassa el az összes elemet a tömbben.

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)

Az összes elemet lekérdezi.

Example

Olvassa el az összes elemet a tömbben.

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)

Olvassa el az összes elemet.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

Example

Olvassa el az összes elemet a tömbben.

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)

Olvassa el az összes elemet.

A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

Example

Olvassa el az összes elemet a tömbben.

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)

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához
readChangeFeed(PartitionKey, ChangeFeedOptions)

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

Example

Olvasás a változáscsatorna elejétől.

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

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához
upsert(unknown, RequestOptions)

Elem beszúrása.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.
upsert<T>(T, RequestOptions)

Elem beszúrása.

A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

Example

Elem beszúrása.

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

Tulajdonság adatai

container 

container: Container

Tulajdonság értéke

Container

Metódus adatai

batch(OperationInput[], PartitionKey, RequestOptions)

Tranzakciós kötegműveletek végrehajtása elemeken.

A Batch egy művelettömböt vesz fel, amely a művelet működése alapján van begépelve. A Batch tranzakciós, és minden műveletet visszaállít, ha az egyik sikertelen. A lehetőségek a következők: Létrehozás, Felolvasás, Olvasás, Csere és Törlés

Használati példa:

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

Paraméterek

operations

OperationInput[]

Műveletek listája. 100-as korlát

partitionKey
PartitionKey
options
RequestOptions

A kérelem módosítására szolgál

Válaszok

Promise<Response<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Figyelmeztetés

Ez az API már elavult.

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

Tömeges műveletek végrehajtása elemeken.

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

Paraméterek

operations

OperationInput[]

Műveletek listája. 100-as korlát

bulkOptions
BulkOptions

A választható beállítások objektuma a tömeges viselkedés módosításához. {continueOnError: false} passzával leállítja a műveletek végrehajtását, ha az egyik sikertelen. (Alapértelmezett érték: igaz)

options
RequestOptions

A kérés módosítására szolgál.

Válaszok

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Figyelmeztetés

Ez az API már elavult.

Use getChangeFeedIterator instead.

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

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

Paraméterek

changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Figyelmeztetés

Ez az API már elavult.

Use getChangeFeedIterator instead.

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

Example

Olvasás a változáscsatorna elejétől.

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>

Paraméterek

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Figyelmeztetés

Ez az API már elavult.

Use getChangeFeedIterator instead.

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

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

Paraméterek

changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Figyelmeztetés

Ez az API már elavult.

Use getChangeFeedIterator instead.

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

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

Paraméterek

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Hozzon létre egy elemet.

A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

Example

Hozzon létre egy elemet.

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

Paraméterek

body

T

Az elem törzsét jelöli. Tetszőleges számú felhasználó által definiált tulajdonságot tartalmazhat.

options
RequestOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

Promise<ItemResponse<T>>

executeBulkOperations(OperationInput[], RequestOptions)

Tömeges műveletek végrehajtása elemeken.

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

Paraméterek

operations

OperationInput[]

Műveletek listája

options
RequestOptions

a kérelem módosításához használt

Válaszok

Promise<BulkOperationResult[]>

a műveleteknek megfelelő műveleti eredmények listája

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Egy iterátort ad vissza a módosítások oldalainak iterálásához. A visszaadott iterátor egy partíciókulcs, adatcsatornatartomány vagy egy teljes tároló módosításainak beolvasására használható.

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>

Paraméterek

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Válaszok

ChangeFeedPullModelIterator<T>

getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

Lekérdezi az összes elemet egy titkosított tárolóban.

Example

Olvassa el az összes elemet a tömbben.

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

Paraméterek

queryBuilder
EncryptionQueryBuilder

Lekérdezéskonfiguráció a művelethez. A titkosított tulajdonságokon végzett lekérdezések létrehozásával kapcsolatos további információkért lásd: SqlQuerySpec .

options
FeedOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

Promise<QueryIterator<ItemDefinition>>

query(string | SqlQuerySpec, FeedOptions)

Az összes elemet lekérdezi.

Example

Olvassa el az összes elemet a tömbben.

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>

Paraméterek

query

string | SqlQuerySpec

Lekérdezéskonfiguráció a művelethez. A lekérdezések konfigurálásával kapcsolatos további információkért lásd: SqlQuerySpec .

options
FeedOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Az összes elemet lekérdezi.

Example

Olvassa el az összes elemet a tömbben.

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>

Paraméterek

query

string | SqlQuerySpec

Lekérdezéskonfiguráció a művelethez. A lekérdezések konfigurálásával kapcsolatos további információkért lásd: SqlQuerySpec .

options
FeedOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

QueryIterator<T>

readAll(FeedOptions)

Olvassa el az összes elemet.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

Example

Olvassa el az összes elemet a tömbben.

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>

Paraméterek

options
FeedOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Olvassa el az összes elemet.

A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

Example

Olvassa el az összes elemet a tömbben.

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>

Paraméterek

options
FeedOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Figyelmeztetés

Ez az API már elavult.

Use getChangeFeedIterator instead.

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

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

Paraméterek

changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Figyelmeztetés

Ez az API már elavult.

Use getChangeFeedIterator instead.

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

Example

Olvasás a változáscsatorna elejétől.

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>

Paraméterek

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Figyelmeztetés

Ez az API már elavult.

Use getChangeFeedIterator instead.

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

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

Paraméterek

changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Figyelmeztetés

Ez az API már elavult.

Use getChangeFeedIterator instead.

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

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

Paraméterek

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Elem beszúrása.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

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

Paraméterek

body

unknown

Az elem törzsét jelöli. Tetszőleges számú felhasználó által definiált tulajdonságot tartalmazhat.

options
RequestOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Elem beszúrása.

A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

Example

Elem beszúrása.

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

Paraméterek

body

T

Az elem törzsét jelöli. Tetszőleges számú felhasználó által definiált tulajdonságot tartalmazhat.

options
RequestOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

Promise<ItemResponse<T>>