Items class

container: Container

قيمة الخاصية

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

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

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

// 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 database.container.items.batch(operations, "A")

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

المعلمات

المرتجعات

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

يأخذ المجمع صفيف العمليات التي تتم كتابتها بناء على ما تقوم به العملية. الخيارات هي: 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>

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

إنشاء 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>

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

إنشاء عنصر.

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

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

المثال

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

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>

المعلمات

المرتجعات

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

المثال

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

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>

المعلمات

المرتجعات

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

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

المثال

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

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

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

المعلمات

المرتجعات

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

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

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

المثال

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

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

إنشاء 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>

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

رفع عنصر.

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

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

المعلمات

المرتجعات

رفع عنصر.

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

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

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

المعلمات

المرتجعات