Items class

container: Container

Nilai Properti

Jalankan operasi batch transaksional pada item.

Batch mengambil array Operasi yang dititik berdasarkan apa yang dilakukan operasi. Batch bersifat transaksi dan akan memutar kembali semua operasi jika gagal. Pilihannya adalah: Buat, Upsert, Baca, Ganti, dan Hapus

Contoh penggunaan:

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

Parameter

Mengembalikan

Jalankan operasi massal pada item.

Secara massal mengambil array Operasi yang dititik berdasarkan apa yang dilakukan operasi. Pilihannya adalah: Buat, Upsert, Baca, Ganti, dan Hapus

Contoh penggunaan:

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

Parameter

Mengembalikan

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

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

Parameter

Mengembalikan

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

Contoh

Baca dari awal umpan perubahan.

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>

Parameter

Mengembalikan

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

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

Parameter

Mengembalikan

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

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

Parameter

Mengembalikan

Membuat item.

Jenis apa pun yang disediakan, T, belum tentu diberlakukan oleh SDK. Anda mungkin mendapatkan lebih banyak atau kurang properti dan terserah logika Anda untuk memberlakukannya.

Tidak ada skema yang ditetapkan untuk item JSON. Mereka mungkin berisi sejumlah properti kustom.

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

Parameter

Mengembalikan

Mengembalikan iterator untuk melakukan iterasi di atas halaman perubahan. Iterator yang dikembalikan dapat digunakan untuk mengambil perubahan untuk satu kunci partisi, rentang umpan, atau seluruh kontainer.

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

Parameter

Mengembalikan

Mengkueri semua item.

Contoh

Membaca semua item untuk array.

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>

Parameter

Mengembalikan

Mengkueri semua item.

Contoh

Membaca semua item untuk array.

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>

Parameter

Mengembalikan

Membaca semua item.

Tidak ada skema yang ditetapkan untuk item JSON. Mereka mungkin berisi sejumlah properti kustom.

Contoh

Membaca semua item untuk array.

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

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

Parameter

Mengembalikan

Membaca semua item.

Jenis apa pun yang disediakan, T, belum tentu diberlakukan oleh SDK. Anda mungkin mendapatkan lebih banyak atau kurang properti dan terserah logika Anda untuk memberlakukannya.

Tidak ada skema yang ditetapkan untuk item JSON. Mereka mungkin berisi sejumlah properti kustom.

Contoh

Membaca semua item untuk array.

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

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

Parameter

Mengembalikan

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

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

Parameter

Mengembalikan

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

Contoh

Baca dari awal umpan perubahan.

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>

Parameter

Mengembalikan

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

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

Parameter

Mengembalikan

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

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

Parameter

Mengembalikan

Upsert item.

Tidak ada skema yang ditetapkan untuk item JSON. Mereka mungkin berisi sejumlah properti kustom.

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

Parameter

Mengembalikan

Upsert item.

Jenis apa pun yang disediakan, T, belum tentu diberlakukan oleh SDK. Anda mungkin mendapatkan lebih banyak atau kurang properti dan terserah logika Anda untuk memberlakukannya.

Tidak ada skema yang ditetapkan untuk item JSON. Mereka mungkin berisi sejumlah properti kustom.

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

Parameter

Mengembalikan