مشاركة عبر


Items class

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

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

الخصائص

container

الأساليب

batch(OperationInput[], PartitionKey, RequestOptions)

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

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

رفع عنصر.

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

upsert<T>(T, RequestOptions)

رفع عنصر.

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

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

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

container

container: Container

قيمة الخاصية

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

batch(OperationInput[], PartitionKey, RequestOptions)

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

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

المعلمات

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: false } لإيقاف تنفيذ العمليات عند فشل واحد. (الإعدادات الافتراضية إلى true)

options
RequestOptions

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

المرتجعات

changeFeed(ChangeFeedOptions)

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

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

المعلمات

changeFeedOptions
ChangeFeedOptions

المرتجعات

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

المرتجعات

changeFeed<T>(ChangeFeedOptions)

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

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

المعلمات

changeFeedOptions
ChangeFeedOptions

المرتجعات

changeFeed<T>(PartitionKey, ChangeFeedOptions)

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

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

المعلمات

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

المرتجعات

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

المرتجعات

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

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

المرتجعات

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

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

المرتجعات

readAll(FeedOptions)

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

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

المثال

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

const {body: containerList} = await items.readAll().fetchAll();
function readAll(options?: FeedOptions): QueryIterator<ItemDefinition>

المعلمات

options
FeedOptions

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

المرتجعات

readAll<T>(FeedOptions)

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

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

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

المثال

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

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

المعلمات

options
FeedOptions

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

المرتجعات

readChangeFeed(ChangeFeedOptions)

تحذير

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

Use changeFeed instead.

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

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

المعلمات

changeFeedOptions
ChangeFeedOptions

المرتجعات

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

المرتجعات

readChangeFeed<T>(ChangeFeedOptions)

تحذير

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

Use changeFeed instead.

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

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

المعلمات

changeFeedOptions
ChangeFeedOptions

المرتجعات

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

تحذير

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

Use changeFeed instead.

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

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

المعلمات

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

المرتجعات

upsert(unknown, RequestOptions)

رفع عنصر.

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

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

المعلمات

body

unknown

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

options
RequestOptions

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

المرتجعات

upsert<T>(T, RequestOptions)

رفع عنصر.

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

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

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

المعلمات

body

T

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

options
RequestOptions

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

المرتجعات

Promise<ItemResponse<T>>