Aracılığıyla paylaş

Items class

Paket:
@azure/cosmos

Yeni öğe oluşturma ve tüm öğeleri okuma/sorgulama işlemleri

Mevcut bir kabı okumak, değiştirmek veya silmek için Öğe'ye bakın; kullanın .item(id).

Özellikler

container

Yöntemler

batch(OperationInput[], PartitionKey, RequestOptions)

Öğelerde işlem toplu işlemleri yürütür.

Batch, işlemin ne yaptığına göre yazılan bir İşlem dizisi alır. Batch işlemseldir ve başarısız olursa tüm işlemleri geri alır. Seçenekler şunlardır: Oluşturma, Yukarı Ekle, Oku, Değiştir ve Sil

Kullanım örneği:

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)

Öğelerde toplu işlemleri yürütür.
changeFeed(ChangeFeedOptions)

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma
changeFeed(PartitionKey, ChangeFeedOptions)

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

Example

Değişiklik akışının başından itibaren okuyun.

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

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma
create<T>(T, RequestOptions)

Öğe oluşturun.

Sağlanan herhangi bir tür olan T, SDK tarafından zorunlu tutulmayabilir. Daha fazla veya daha az özellik alabilirsiniz ve bunu zorlamak sizin mantığınıza bağlı.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

Example

Öğe oluşturun.

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)

Öğelerde toplu işlemleri yürütür.

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)

Değişiklik sayfalarını yinelemek için bir yineleyici döndürür. Döndürülen yineleyici, tek bir bölüm anahtarı, akış aralığı veya kapsayıcının tamamı için değişiklikleri getirmek için kullanılabilir.

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)

Şifrelenmiş bir kapsayıcıdaki tüm öğeleri sorgular.

Example

Dizideki tüm öğeleri okuyun.

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)

Tüm öğeleri sorgular.

Example

Dizideki tüm öğeleri okuyun.

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)

Tüm öğeleri sorgular.

Example

Dizideki tüm öğeleri okuyun.

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)

Tüm öğeleri okuyun.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

Example

Dizideki tüm öğeleri okuyun.

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)

Tüm öğeleri okuyun.

Sağlanan herhangi bir tür olan T, SDK tarafından zorunlu tutulmayabilir. Daha fazla veya daha az özellik alabilirsiniz ve bunu zorlamak sizin mantığınıza bağlı.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

Example

Dizideki tüm öğeleri okuyun.

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)

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma
readChangeFeed(PartitionKey, ChangeFeedOptions)

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

Example

Değişiklik akışının başından itibaren okuyun.

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

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma
upsert(unknown, RequestOptions)

Öğeyi yukarı ekle.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.
upsert<T>(T, RequestOptions)

Öğeyi yukarı ekle.

Sağlanan herhangi bir tür olan T, SDK tarafından zorunlu tutulmayabilir. Daha fazla veya daha az özellik alabilirsiniz ve bunu zorlamak sizin mantığınıza bağlı.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

Example

Öğeyi yukarı ekle.

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

Özellik Ayrıntıları

container 

container: Container

Özellik Değeri

Container

Yöntem Ayrıntıları

batch(OperationInput[], PartitionKey, RequestOptions)

Öğelerde işlem toplu işlemleri yürütür.

Batch, işlemin ne yaptığına göre yazılan bir İşlem dizisi alır. Batch işlemseldir ve başarısız olursa tüm işlemleri geri alır. Seçenekler şunlardır: Oluşturma, Yukarı Ekle, Oku, Değiştir ve Sil

Kullanım örneği:

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

Parametreler

operations

OperationInput[]

İşlemlerin listesi. Sınır 100

partitionKey
PartitionKey
options
RequestOptions

İsteği değiştirmek için kullanılır

Döndürülenler

Promise<Response<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Uyarı

Bu API artık kullanım dışıdır.

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

Öğelerde toplu işlemleri yürütür.

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

Parametreler

operations

OperationInput[]

İşlemlerin listesi. Sınır 100

bulkOptions
BulkOptions

Toplu davranışı değiştirmek için isteğe bağlı seçenekler nesnesi. İşlem başarısız olduğunda yürütmeyi durdurmak için { continueOnError: false } geçirin. (Varsayılan değer true'dır)

options
RequestOptions

İsteği değiştirmek için kullanılır.

Döndürülenler

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Uyarı

Bu API artık kullanım dışıdır.

Use getChangeFeedIterator instead.

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

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

Parametreler

changeFeedOptions
ChangeFeedOptions

Döndürülenler

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Uyarı

Bu API artık kullanım dışıdır.

Use getChangeFeedIterator instead.

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

Example

Değişiklik akışının başından itibaren okuyun.

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>

Parametreler

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Döndürülenler

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Uyarı

Bu API artık kullanım dışıdır.

Use getChangeFeedIterator instead.

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

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

Parametreler

changeFeedOptions
ChangeFeedOptions

Döndürülenler

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Uyarı

Bu API artık kullanım dışıdır.

Use getChangeFeedIterator instead.

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

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

Parametreler

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Döndürülenler

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Öğe oluşturun.

Sağlanan herhangi bir tür olan T, SDK tarafından zorunlu tutulmayabilir. Daha fazla veya daha az özellik alabilirsiniz ve bunu zorlamak sizin mantığınıza bağlı.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

Example

Öğe oluşturun.

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

Parametreler

body

T

Öğenin gövdesini temsil eder. Herhangi bir sayıda kullanıcı tanımlı özellik içerebilir.

options
RequestOptions

İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).

Döndürülenler

Promise<ItemResponse<T>>

executeBulkOperations(OperationInput[], RequestOptions)

Öğelerde toplu işlemleri yürütür.

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

Parametreler

operations

OperationInput[]

İşlem listesi

options
RequestOptions

İsteği değiştirmek için kullanılır

Döndürülenler

Promise<BulkOperationResult[]>

İşlemlere karşılık gelen işlem sonuçlarının listesi

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Değişiklik sayfalarını yinelemek için bir yineleyici döndürür. Döndürülen yineleyici, tek bir bölüm anahtarı, akış aralığı veya kapsayıcının tamamı için değişiklikleri getirmek için kullanılabilir.

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>

Parametreler

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Döndürülenler

ChangeFeedPullModelIterator<T>

getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

Şifrelenmiş bir kapsayıcıdaki tüm öğeleri sorgular.

Example

Dizideki tüm öğeleri okuyun.

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

Parametreler

queryBuilder
EncryptionQueryBuilder

İşlem için sorgu yapılandırması. Şifrelenmiş özelliklerde sorgu oluşturma hakkında daha fazla bilgi için bkz.

options
FeedOptions

İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).

Döndürülenler

Promise<QueryIterator<ItemDefinition>>

query(string | SqlQuerySpec, FeedOptions)

Tüm öğeleri sorgular.

Example

Dizideki tüm öğeleri okuyun.

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>

Parametreler

query

string | SqlQuerySpec

İşlem için sorgu yapılandırması. Sorgu yapılandırma hakkında daha fazla bilgi için bkz.

options
FeedOptions

İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).

Döndürülenler

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Tüm öğeleri sorgular.

Example

Dizideki tüm öğeleri okuyun.

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>

Parametreler

query

string | SqlQuerySpec

İşlem için sorgu yapılandırması. Sorgu yapılandırma hakkında daha fazla bilgi için bkz.

options
FeedOptions

İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).

Döndürülenler

QueryIterator<T>

readAll(FeedOptions)

Tüm öğeleri okuyun.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

Example

Dizideki tüm öğeleri okuyun.

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>

Parametreler

options
FeedOptions

İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).

Döndürülenler

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Tüm öğeleri okuyun.

Sağlanan herhangi bir tür olan T, SDK tarafından zorunlu tutulmayabilir. Daha fazla veya daha az özellik alabilirsiniz ve bunu zorlamak sizin mantığınıza bağlı.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

Example

Dizideki tüm öğeleri okuyun.

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>

Parametreler

options
FeedOptions

İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).

Döndürülenler

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Uyarı

Bu API artık kullanım dışıdır.

Use getChangeFeedIterator instead.

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

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

Parametreler

changeFeedOptions
ChangeFeedOptions

Döndürülenler

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Uyarı

Bu API artık kullanım dışıdır.

Use getChangeFeedIterator instead.

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

Example

Değişiklik akışının başından itibaren okuyun.

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>

Parametreler

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Döndürülenler

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Uyarı

Bu API artık kullanım dışıdır.

Use getChangeFeedIterator instead.

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

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

Parametreler

changeFeedOptions
ChangeFeedOptions

Döndürülenler

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Uyarı

Bu API artık kullanım dışıdır.

Use getChangeFeedIterator instead.

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

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

Parametreler

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Döndürülenler

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Öğeyi yukarı ekle.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

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

Parametreler

body

unknown

Öğenin gövdesini temsil eder. Herhangi bir sayıda kullanıcı tanımlı özellik içerebilir.

options
RequestOptions

İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).

Döndürülenler

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Öğeyi yukarı ekle.

Sağlanan herhangi bir tür olan T, SDK tarafından zorunlu tutulmayabilir. Daha fazla veya daha az özellik alabilirsiniz ve bunu zorlamak sizin mantığınıza bağlı.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

Example

Öğeyi yukarı ekle.

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

Parametreler

body

T

Öğenin gövdesini temsil eder. Herhangi bir sayıda kullanıcı tanımlı özellik içerebilir.

options
RequestOptions

İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).

Döndürülenler

Promise<ItemResponse<T>>