Bagikan melalui

Items class

Paket:
@azure/cosmos

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

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

Properti

container

Metode

batch(OperationInput[], PartitionKey, RequestOptions)

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:

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

// 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 container.items.batch(operations, "A");
bulk(OperationInput[], BulkOptions, RequestOptions)

Jalankan operasi massal pada item.
changeFeed(ChangeFeedOptions)

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

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

Example

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 ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan
changeFeed<T>(PartitionKey, ChangeFeedOptions)

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

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

Example

Membuat item.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resource: createdItem } = await container.items.create({
  id: "<item id>",
  properties: {},
});
executeBulkOperations(OperationInput[], RequestOptions)

Jalankan operasi massal pada item.

Example

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const operations: OperationInput[] = [
  {
    operationType: "Create",
    resourceBody: { id: "doc1", name: "sample", key: "A" },
  },
  {
    operationType: "Upsert",
    partitionKey: "A",
    resourceBody: { id: "doc2", name: "other", key: "A" },
  },
];

await container.items.executeBulkOperations(operations);
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.

Example

import {
  CosmosClient,
  PartitionKeyDefinitionVersion,
  PartitionKeyKind,
  ChangeFeedStartFrom,
} from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const containerDefinition = {
  id: "Test Database",
  partitionKey: {
    paths: ["/name", "/address/zip"],
    version: PartitionKeyDefinitionVersion.V2,
    kind: PartitionKeyKind.MultiHash,
  },
};
const { container } = await database.containers.createIfNotExists(containerDefinition);

const partitionKey = "some-partition-Key-value";
const options = {
  changeFeedStartFrom: ChangeFeedStartFrom.Beginning(partitionKey),
};

const iterator = container.items.getChangeFeedIterator(options);

while (iterator.hasMoreResults) {
  const response = await iterator.readNext();
  // process this response
}
getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

Mengkueri semua item dalam kontainer terenkripsi.

Example

Membaca semua item untuk array.

import { CosmosClient, EncryptionQueryBuilder } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const queryBuilder = new EncryptionQueryBuilder(
  `SELECT firstname FROM Families f WHERE f.lastName = @lastName`,
);
queryBuilder.addParameter("@lastName", "Hendricks", "/lastname");
const queryIterator = await container.items.getEncryptionQueryIterator(queryBuilder);
const { resources: items } = await queryIterator.fetchAll();
query(string | SqlQuerySpec, FeedOptions)

Mengkueri semua item.

Example

Membaca semua item untuk array.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

Mengkueri semua item.

Example

Membaca semua item untuk array.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM Families f WHERE f.lastName = @lastName`,
  parameters: [{ name: "@lastName", value: "Hendricks" }],
};
const { resources: items } = await container.items.query(querySpec).fetchAll();
readAll(FeedOptions)

Membaca semua item.

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

Example

Membaca semua item untuk array.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resources: containerList } = await container.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 memberlakukannya.

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

Example

Membaca semua item untuk array.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

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

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

Example

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 ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

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

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

Example

Upsert item.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resource: createdItem1 } = await container.items.create({
  id: "<item id 1>",
  properties: {},
});

const { resource: upsertItem1 } = await container.items.upsert({
  id: "<item id 1>",
  updated_properties: {},
});

const { resource: upsertItem2 } = await container.items.upsert({
  id: "<item id 2>",
  properties: {},
});

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

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

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

Parameter

operations

OperationInput[]

Daftar operasi. Batas 100

partitionKey
PartitionKey
options
RequestOptions

Digunakan untuk memodifikasi permintaan

Mengembalikan

Promise<Response<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Peringatan

API ini sudah tidak digunakan lagi.

Use executeBulkOperations instead.

Bulk takes an array of Operations which are typed based on what the operation does. The choices are: Create, Upsert, Read, Replace, and Delete

Usage example:

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

Jalankan operasi massal pada item.

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: false } untuk berhenti mengeksekusi operasi saat operasi gagal. (Default ke true)

options
RequestOptions

Digunakan untuk mengubah permintaan.

Mengembalikan

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Peringatan

API ini sudah tidak digunakan lagi.

Use getChangeFeedIterator instead.

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

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

Parameter

changeFeedOptions
ChangeFeedOptions

Mengembalikan

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Peringatan

API ini sudah tidak digunakan lagi.

Use getChangeFeedIterator instead.

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

Example

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)

Peringatan

API ini sudah tidak digunakan lagi.

Use getChangeFeedIterator instead.

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

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

Parameter

changeFeedOptions
ChangeFeedOptions

Mengembalikan

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Peringatan

API ini sudah tidak digunakan lagi.

Use getChangeFeedIterator instead.

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

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

Example

Membuat item.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resource: createdItem } = await container.items.create({
  id: "<item id>",
  properties: {},
});

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

executeBulkOperations(OperationInput[], RequestOptions)

Jalankan operasi massal pada item.

Example

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const operations: OperationInput[] = [
  {
    operationType: "Create",
    resourceBody: { id: "doc1", name: "sample", key: "A" },
  },
  {
    operationType: "Upsert",
    partitionKey: "A",
    resourceBody: { id: "doc2", name: "other", key: "A" },
  },
];

await container.items.executeBulkOperations(operations);

function executeBulkOperations(operations: OperationInput[], options?: RequestOptions): Promise<BulkOperationResult[]>

Parameter

operations

OperationInput[]

Daftar operasi

options
RequestOptions

digunakan untuk memodifikasi permintaan

Mengembalikan

Promise<BulkOperationResult[]>

Daftar hasil operasi yang sesuai dengan operasi

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.

Example

import {
  CosmosClient,
  PartitionKeyDefinitionVersion,
  PartitionKeyKind,
  ChangeFeedStartFrom,
} from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const containerDefinition = {
  id: "Test Database",
  partitionKey: {
    paths: ["/name", "/address/zip"],
    version: PartitionKeyDefinitionVersion.V2,
    kind: PartitionKeyKind.MultiHash,
  },
};
const { container } = await database.containers.createIfNotExists(containerDefinition);

const partitionKey = "some-partition-Key-value";
const options = {
  changeFeedStartFrom: ChangeFeedStartFrom.Beginning(partitionKey),
};

const iterator = container.items.getChangeFeedIterator(options);

while (iterator.hasMoreResults) {
  const response = await iterator.readNext();
  // process this response
}

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

Parameter

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Mengembalikan

ChangeFeedPullModelIterator<T>

getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

Mengkueri semua item dalam kontainer terenkripsi.

Example

Membaca semua item untuk array.

import { CosmosClient, EncryptionQueryBuilder } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const queryBuilder = new EncryptionQueryBuilder(
  `SELECT firstname FROM Families f WHERE f.lastName = @lastName`,
);
queryBuilder.addParameter("@lastName", "Hendricks", "/lastname");
const queryIterator = await container.items.getEncryptionQueryIterator(queryBuilder);
const { resources: items } = await queryIterator.fetchAll();

function getEncryptionQueryIterator(queryBuilder: EncryptionQueryBuilder, options?: FeedOptions): Promise<QueryIterator<ItemDefinition>>

Parameter

queryBuilder
EncryptionQueryBuilder

Konfigurasi kueri untuk operasi. Lihat SqlQuerySpec untuk informasi selengkapnya tentang cara membuat kueri pada properti terenkripsi.

options
FeedOptions

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

Mengembalikan

Promise<QueryIterator<ItemDefinition>>

query(string | SqlQuerySpec, FeedOptions)

Mengkueri semua item.

Example

Membaca semua item untuk array.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

Example

Membaca semua item untuk array.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

Example

Membaca semua item untuk array.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resources: containerList } = await container.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 memberlakukannya.

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

Example

Membaca semua item untuk array.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resources: containerList } = await container.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 getChangeFeedIterator instead.

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

Membuat ChangeFeedIterator untuk melakukan iterasi di atas halaman perubahan

Example

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

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

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

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

Example

Upsert item.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resource: createdItem1 } = await container.items.create({
  id: "<item id 1>",
  properties: {},
});

const { resource: upsertItem1 } = await container.items.upsert({
  id: "<item id 1>",
  updated_properties: {},
});

const { resource: upsertItem2 } = await container.items.upsert({
  id: "<item id 2>",
  properties: {},
});

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