Items class

  • ‏‏المرجع
الحزمة:
@azure/cosmos

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

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

الخصائص

container

الأساليب

batch(OperationInput[], PartitionKey, RequestOptions)

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

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

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

// partitionKey is required as a second argument to batch, but defaults to the default partition key
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.batch(operations)
bulk(OperationInput[], BulkOptions, RequestOptions)

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

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

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

// 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 database.container.items.bulk(operations)
changeFeed(ChangeFeedOptions)

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

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

مثال

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

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. قد تحتوي على أي عدد من الخصائص المخصصة.
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

إرجاع مكرر للتكرار عبر صفحات التغييرات. يمكن استخدام المكرر الذي تم إرجاعه لجلب التغييرات لمفتاح قسم واحد أو نطاق موجز أو حاوية بأكملها.
query(string | SqlQuerySpec, FeedOptions)

الاستعلام عن جميع العناصر.

مثال

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

const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query(querySpec).fetchAll();
query<T>(string | SqlQuerySpec, FeedOptions)

الاستعلام عن جميع العناصر.

مثال

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

const querySpec: SqlQuerySpec = {
  query: "SELECT firstname FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query<{firstName: string}>(querySpec).fetchAll();
readAll(FeedOptions)

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

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

مثال

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

const {body: containerList} = await items.readAll().fetchAll();
readAll<T>(FeedOptions)

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

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

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

مثال

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

const {body: containerList} = await items.readAll().fetchAll();
readChangeFeed(ChangeFeedOptions)

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

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

مثال

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

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)

Upsert عنصر.

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

Upsert عنصر.

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

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

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

container 

container: Container

قيمة الخاصية

Container

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

batch(OperationInput[], PartitionKey, RequestOptions)

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

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

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

// partitionKey is required as a second argument to batch, but defaults to the default partition key
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.batch(operations)

function batch(operations: OperationInput[], partitionKey?: PartitionKey, options?: RequestOptions): Promise<Response_2<OperationResponse[]>>

المعلمات

operations

OperationInput[]

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

partitionKey
PartitionKey
options
RequestOptions

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

المرتجعات

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

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

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

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

// 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 database.container.items.bulk(operations)

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

المعلمات

operations

OperationInput[]

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

bulkOptions
BulkOptions

عنصر الخيارات الاختيارية لتعديل السلوك المجمع. قم بتمرير { continueOnError: true } لمتابعة تنفيذ العمليات عند فشل واحد. (الإعدادات الافتراضية للخطأ) ** ملاحظة: سيتم تعيين هذا افتراضيا إلى TRUE في الإصدار 4.0

options
RequestOptions

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

المرتجعات

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

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

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

المعلمات

changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

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

مثال

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

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)

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

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

المعلمات

changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

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

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

المعلمات

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

إنشاء عنصر.

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

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

function create<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

المعلمات

body

T

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

options
RequestOptions

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

المرتجعات

Promise<ItemResponse<T>>

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

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

function getChangeFeedIterator<T>(changeFeedIteratorOptions?: ChangeFeedIteratorOptions): ChangeFeedPullModelIterator<T>

المعلمات

changeFeedIteratorOptions
ChangeFeedIteratorOptions

المرتجعات

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

الاستعلام عن جميع العناصر.

مثال

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

const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await 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)

الاستعلام عن جميع العناصر.

مثال

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

const querySpec: SqlQuerySpec = {
  query: "SELECT firstname FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query<{firstName: string}>(querySpec).fetchAll();

function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

المعلمات

query

string | SqlQuerySpec

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

options
FeedOptions

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

المرتجعات

QueryIterator<T>

readAll(FeedOptions)

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

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

مثال

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

const {body: containerList} = await items.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<ItemDefinition>

المعلمات

options
FeedOptions

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

المرتجعات

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

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

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

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

مثال

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

const {body: containerList} = await items.readAll().fetchAll();

function readAll<T>(options?: FeedOptions): QueryIterator<T>

المعلمات

options
FeedOptions

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

المرتجعات

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

تحذير

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

Use changeFeed instead.

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

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

المعلمات

changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

تحذير

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

Use changeFeed instead.

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

مثال

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

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 changeFeed instead.

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

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

المعلمات

changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

تحذير

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

Use changeFeed instead.

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

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

المعلمات

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

المرتجعات

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Upsert عنصر.

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

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

المعلمات

body

unknown

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

options
RequestOptions

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

المرتجعات

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsert عنصر.

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

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

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

المعلمات

body

T

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

options
RequestOptions

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

المرتجعات

Promise<ItemResponse<T>>