Bagikan melalui

Items class

  • Referensi
Paket:
@azure/cosmos

Operasi untuk membuat item baru, dan membaca/mengkueri semua item

Lihat Item untuk membaca, mengganti, atau menghapus kontainer yang sudah ada; gunakan .item(id).

Properti

container

Metode

batch(OperationInput[], PartitionKey, RequestOptions)

Jalankan operasi batch transaksional pada item.

Batch mengambil array Operasi yang di ketik 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:

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

Jalankan operasi massal pada item.

Secara massal mengambil array Operasi yang di ketik 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)
changeFeed(ChangeFeedOptions)

Membuat untuk melakukan ChangeFeedIterator iterasi di atas halaman perubahan
changeFeed(PartitionKey, ChangeFeedOptions)

Membuat untuk melakukan ChangeFeedIterator 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();
changeFeed<T>(ChangeFeedOptions)

Membuat untuk melakukan ChangeFeedIterator iterasi di atas halaman perubahan
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Membuat untuk melakukan ChangeFeedIterator iterasi di atas halaman perubahan
create<T>(T, RequestOptions)

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

Tidak ada skema yang ditetapkan untuk item JSON. Mereka mungkin berisi sejumlah properti kustom.
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

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.
query(string | SqlQuerySpec, FeedOptions)

Mengkueri semua item.

Contoh

Baca 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();
query<T>(string | SqlQuerySpec, FeedOptions)

Mengkueri semua item.

Contoh

Baca 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();
readAll(FeedOptions)

Membaca semua item.

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

Contoh

Baca semua item untuk array.

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

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

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

Contoh

Baca semua item untuk array.

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

Membuat untuk melakukan ChangeFeedIterator iterasi di atas halaman perubahan
readChangeFeed(PartitionKey, ChangeFeedOptions)

Membuat untuk melakukan ChangeFeedIterator 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();
readChangeFeed<T>(ChangeFeedOptions)

Membuat untuk melakukan ChangeFeedIterator iterasi di atas halaman perubahan
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Membuat untuk melakukan ChangeFeedIterator iterasi di atas halaman perubahan
upsert(unknown, RequestOptions)

Upsert item.

Tidak ada skema yang ditetapkan untuk item JSON. Mereka mungkin berisi sejumlah properti kustom.
upsert<T>(T, RequestOptions)

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

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

Detail Properti

container 

container: Container

Nilai Properti

Container

Detail Metode

batch(OperationInput[], PartitionKey, RequestOptions)

Jalankan operasi batch transaksional pada item.

Batch mengambil array Operasi yang di ketik 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:

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

Parameter

operations

OperationInput[]

Daftar operasi. Batas 100

partitionKey
PartitionKey
options
RequestOptions

Digunakan untuk memodifikasi permintaan

Mengembalikan

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Jalankan operasi massal pada item.

Secara massal mengambil array Operasi yang di ketik 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

operations

OperationInput[]

Daftar operasi. Batas 100

bulkOptions
BulkOptions

Objek opsi opsional untuk mengubah perilaku massal. Teruskan { continueOnError: true } untuk melanjutkan operasi eksekusi saat operasi gagal. (Default ke false) ** CATATAN: INI AKAN DEFAULT KE TRUE DALAM RILIS 4.0

options
RequestOptions

Digunakan untuk mengubah permintaan.

Mengembalikan

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Membuat untuk melakukan ChangeFeedIterator iterasi di atas halaman perubahan

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

Parameter

changeFeedOptions
ChangeFeedOptions

Mengembalikan

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Membuat untuk melakukan ChangeFeedIterator 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

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Mengembalikan

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Membuat untuk melakukan ChangeFeedIterator iterasi di atas halaman perubahan

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

Parameter

changeFeedOptions
ChangeFeedOptions

Mengembalikan

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Membuat untuk melakukan ChangeFeedIterator iterasi di atas halaman perubahan

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

Parameter

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Mengembalikan

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

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

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

body

T

Mewakili isi item. Dapat berisi sejumlah properti yang ditentukan pengguna.

options
RequestOptions

Digunakan untuk memodifikasi permintaan (misalnya, menentukan kunci partisi).

Mengembalikan

Promise<ItemResponse<T>>

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

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

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Mengembalikan

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

Mengkueri semua item.

Contoh

Baca 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

query

string | SqlQuerySpec

Konfigurasi kueri untuk operasi. Lihat SqlQuerySpec untuk informasi selengkapnya tentang cara mengonfigurasi kueri.

options
FeedOptions

Digunakan untuk memodifikasi permintaan (misalnya, menentukan kunci partisi).

Mengembalikan

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Mengkueri semua item.

Contoh

Baca 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

query

string | SqlQuerySpec

Konfigurasi kueri untuk operasi. Lihat SqlQuerySpec untuk informasi selengkapnya tentang cara mengonfigurasi kueri.

options
FeedOptions

Digunakan untuk memodifikasi permintaan (misalnya, menentukan kunci partisi).

Mengembalikan

QueryIterator<T>

readAll(FeedOptions)

Membaca semua item.

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

Contoh

Baca semua item untuk array.

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

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

Parameter

options
FeedOptions

Digunakan untuk memodifikasi permintaan (misalnya, menentukan kunci partisi).

Mengembalikan

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

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

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

Contoh

Baca semua item untuk array.

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

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

Parameter

options
FeedOptions

Digunakan untuk memodifikasi permintaan (misalnya, menentukan kunci partisi).

Mengembalikan

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Peringatan

API ini sudah tidak digunakan lagi.

Use changeFeed instead.

Membuat untuk melakukan ChangeFeedIterator iterasi di atas halaman perubahan

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

Parameter

changeFeedOptions
ChangeFeedOptions

Mengembalikan

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Peringatan

API ini sudah tidak digunakan lagi.

Use changeFeed instead.

Membuat untuk melakukan ChangeFeedIterator 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

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Mengembalikan

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Peringatan

API ini sudah tidak digunakan lagi.

Use changeFeed instead.

Membuat untuk melakukan ChangeFeedIterator iterasi di atas halaman perubahan

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

Parameter

changeFeedOptions
ChangeFeedOptions

Mengembalikan

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Peringatan

API ini sudah tidak digunakan lagi.

Use changeFeed instead.

Membuat untuk melakukan ChangeFeedIterator iterasi di atas halaman perubahan

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

Parameter

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Mengembalikan

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

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

body

unknown

Mewakili isi item. Dapat berisi sejumlah properti yang ditentukan pengguna.

options
RequestOptions

Digunakan untuk memodifikasi permintaan (misalnya, menentukan kunci partisi).

Mengembalikan

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

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

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

body

T

Mewakili isi item. Dapat berisi sejumlah properti yang ditentukan pengguna.

options
RequestOptions

Digunakan untuk memodifikasi permintaan (misalnya, menentukan kunci partisi).

Mengembalikan

Promise<ItemResponse<T>>