مشاركة عبر

Items class

الحزمة:
@azure/cosmos

عمليات إنشاء عناصر جديدة وقراءة/الاستعلام عن كافة العناصر

انظر العنصر لقراءة حاوية موجودة أو استبدالها أو حذفها. يستخدم .item(id).

الخصائص

container

الأساليب

batch(OperationInput[], PartitionKey, RequestOptions)

تنفيذ عمليات دفعة المعاملات على العناصر.

تأخذ الدفعة صفيفا من العمليات التي تتم كتابتها بناء على ما تقوم به العملية. الدفعة عبارة عن معاملات وستتراجع جميع العمليات إذا فشلت واحدة. الخيارات هي: Create و Upsert و Read و Replace و Delete

مثال على الاستخدام:

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)

تنفيذ عمليات مجمعة على العناصر.
changeFeed(ChangeFeedOptions)

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات
changeFeed(PartitionKey, ChangeFeedOptions)

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات

Example

القراءة من بداية موجز التغيير.

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

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات
changeFeed<T>(PartitionKey, ChangeFeedOptions)

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات
create<T>(T, RequestOptions)

إنشاء عنصر.

لا يتم بالضرورة فرض أي نوع متوفر، T، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

Example

إنشاء عنصر.

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)

تنفيذ عمليات مجمعة على العناصر.

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)

إرجاع مكرر للتكرار عبر صفحات التغييرات. يمكن استخدام المكرر الذي تم إرجاعه لجلب التغييرات لمفتاح قسم واحد أو نطاق موجز أو حاوية بأكملها.

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)

الاستعلام عن جميع العناصر الموجودة في حاوية مشفرة.

Example

قراءة كافة العناصر إلى صفيف.

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)

الاستعلام عن كافة العناصر.

Example

قراءة كافة العناصر إلى صفيف.

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)

الاستعلام عن كافة العناصر.

Example

قراءة كافة العناصر إلى صفيف.

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)

قراءة كافة العناصر.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

Example

قراءة كافة العناصر إلى صفيف.

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، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

Example

قراءة كافة العناصر إلى صفيف.

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 للتكرار عبر صفحات التغييرات
readChangeFeed(PartitionKey, ChangeFeedOptions)

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات

Example

القراءة من بداية موجز التغيير.

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

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات
upsert(unknown, RequestOptions)

رفع عنصر.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.
upsert<T>(T, RequestOptions)

رفع عنصر.

لا يتم بالضرورة فرض أي نوع متوفر، T، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

Example

رفع عنصر.

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

تفاصيل الخاصية

container 

container: Container

قيمة الخاصية

Container

تفاصيل الأسلوب

batch(OperationInput[], PartitionKey, RequestOptions)

تنفيذ عمليات دفعة المعاملات على العناصر.

تأخذ الدفعة صفيفا من العمليات التي تتم كتابتها بناء على ما تقوم به العملية. الدفعة عبارة عن معاملات وستتراجع جميع العمليات إذا فشلت واحدة. الخيارات هي: Create و Upsert و Read و Replace و Delete

مثال على الاستخدام:

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

المعلمات

operations

OperationInput[]

قائمة العمليات. الحد الأقصى 100

partitionKey
PartitionKey
options
RequestOptions

يستخدم لتعديل الطلب

المرتجعات

Promise<Response<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

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

تنفيذ عمليات مجمعة على العناصر.

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

المعلمات

operations

OperationInput[]

قائمة العمليات. الحد الأقصى 100

bulkOptions
BulkOptions

عنصر الخيارات الاختيارية لتعديل السلوك المجمع. مرر { continueOnError: false } لإيقاف تنفيذ العمليات عند فشل واحد. (الإعدادات الافتراضية إلى true)

options
RequestOptions

يستخدم لتعديل الطلب.

المرتجعات

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use getChangeFeedIterator instead.

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات

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

المعلمات

changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use getChangeFeedIterator instead.

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات

Example

القراءة من بداية موجز التغيير.

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>

المعلمات

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use getChangeFeedIterator instead.

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات

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

المعلمات

changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use getChangeFeedIterator instead.

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات

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

المعلمات

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

إنشاء عنصر.

لا يتم بالضرورة فرض أي نوع متوفر، T، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

Example

إنشاء عنصر.

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

المعلمات

body

T

يمثل نص العنصر. يمكن أن يحتوي على أي عدد من الخصائص المعرفة من قبل المستخدم.

options
RequestOptions

يستخدم لتعديل الطلب (على سبيل المثال، تحديد مفتاح القسم).

المرتجعات

Promise<ItemResponse<T>>

executeBulkOperations(OperationInput[], RequestOptions)

تنفيذ عمليات مجمعة على العناصر.

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

المعلمات

operations

OperationInput[]

قائمة العمليات

options
RequestOptions

يستخدم لتعديل الطلب

المرتجعات

Promise<BulkOperationResult[]>

قائمة بنتائج العمليات المقابلة للعمليات

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

إرجاع مكرر للتكرار عبر صفحات التغييرات. يمكن استخدام المكرر الذي تم إرجاعه لجلب التغييرات لمفتاح قسم واحد أو نطاق موجز أو حاوية بأكملها.

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>

المعلمات

changeFeedIteratorOptions
ChangeFeedIteratorOptions

المرتجعات

ChangeFeedPullModelIterator<T>

getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

الاستعلام عن جميع العناصر الموجودة في حاوية مشفرة.

Example

قراءة كافة العناصر إلى صفيف.

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

المعلمات

queryBuilder
EncryptionQueryBuilder

تكوين الاستعلام للعملية. راجع SqlQuerySpec للحصول على مزيد من المعلومات حول كيفية إنشاء استعلام على الخصائص المشفرة.

options
FeedOptions

يستخدم لتعديل الطلب (على سبيل المثال، تحديد مفتاح القسم).

المرتجعات

Promise<QueryIterator<ItemDefinition>>

query(string | SqlQuerySpec, FeedOptions)

الاستعلام عن كافة العناصر.

Example

قراءة كافة العناصر إلى صفيف.

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>

المعلمات

query

string | SqlQuerySpec

تكوين الاستعلام للعملية. راجع SqlQuerySpec للحصول على مزيد من المعلومات حول كيفية تكوين استعلام.

options
FeedOptions

يستخدم لتعديل الطلب (على سبيل المثال، تحديد مفتاح القسم).

المرتجعات

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

الاستعلام عن كافة العناصر.

Example

قراءة كافة العناصر إلى صفيف.

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>

المعلمات

query

string | SqlQuerySpec

تكوين الاستعلام للعملية. راجع SqlQuerySpec للحصول على مزيد من المعلومات حول كيفية تكوين استعلام.

options
FeedOptions

يستخدم لتعديل الطلب (على سبيل المثال، تحديد مفتاح القسم).

المرتجعات

QueryIterator<T>

readAll(FeedOptions)

قراءة كافة العناصر.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

Example

قراءة كافة العناصر إلى صفيف.

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>

المعلمات

options
FeedOptions

يستخدم لتعديل الطلب (على سبيل المثال، تحديد مفتاح القسم).

المرتجعات

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

قراءة كافة العناصر.

لا يتم بالضرورة فرض أي نوع متوفر، T، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

Example

قراءة كافة العناصر إلى صفيف.

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>

المعلمات

options
FeedOptions

يستخدم لتعديل الطلب (على سبيل المثال، تحديد مفتاح القسم).

المرتجعات

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use getChangeFeedIterator instead.

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات

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

المعلمات

changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use getChangeFeedIterator instead.

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات

Example

القراءة من بداية موجز التغيير.

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>

المعلمات

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use getChangeFeedIterator instead.

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات

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

المعلمات

changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use getChangeFeedIterator instead.

إنشاء ChangeFeedIterator للتكرار عبر صفحات التغييرات

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

المعلمات

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

رفع عنصر.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

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

المعلمات

body

unknown

يمثل نص العنصر. يمكن أن يحتوي على أي عدد من الخصائص المعرفة من قبل المستخدم.

options
RequestOptions

يستخدم لتعديل الطلب (على سبيل المثال، تحديد مفتاح القسم).

المرتجعات

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

رفع عنصر.

لا يتم بالضرورة فرض أي نوع متوفر، T، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

Example

رفع عنصر.

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

المعلمات

body

T

يمثل نص العنصر. يمكن أن يحتوي على أي عدد من الخصائص المعرفة من قبل المستخدم.

options
RequestOptions

يستخدم لتعديل الطلب (على سبيل المثال، تحديد مفتاح القسم).

المرتجعات

Promise<ItemResponse<T>>