Items class

container: Container

Özellik Değeri

Öğelerde işlem toplu işlemleri yürütür.

Batch, işlemin ne yaptığına göre yazılan bir dizi İşlem alır. Batch işlemseldir ve başarısız olursa tüm işlemleri geri alır. Seçenekler şunlardır: Oluşturma, Yükseltme, Okuma, Değiştirme ve Silme

Kullanım örneği:

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

Parametreler

Döndürülenler

Öğelerde toplu işlemleri yürütme.

Toplu olarak, işlemin ne yaptığına göre yazılan bir dizi İşlem alır. Seçenekler şunlardır: Oluşturma, Yükseltme, Okuma, Değiştirme ve Silme

Kullanım örneği:

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

Parametreler

Döndürülenler

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

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

Parametreler

Döndürülenler

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

Örnek

Değişiklik akışının başından itibaren okuyun.

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>

Parametreler

Döndürülenler

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

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

Parametreler

Döndürülenler

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

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

Parametreler

Döndürülenler

Öğe oluşturun.

Sağlanan T türü SDK tarafından zorunlu tutulmayabilir. Daha fazla veya daha az özellik alabilirsiniz ve bunu zorlamak sizin mantığınıza göredir.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

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

Parametreler

Döndürülenler

Değişiklik sayfalarını yinelemek için bir yineleyici döndürür. Döndürülen yineleyici, tek bir bölüm anahtarı, akış aralığı veya kapsayıcının tamamı için değişiklikleri getirmek için kullanılabilir.

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

Parametreler

Döndürülenler

Tüm öğeleri sorgular.

Örnek

Dizideki tüm öğeleri okuyun.

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>

Parametreler

Döndürülenler

Tüm öğeleri sorgular.

Örnek

Dizideki tüm öğeleri okuyun.

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>

Parametreler

Döndürülenler

Tüm öğeleri okuma.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

Örnek

Dizideki tüm öğeleri okuyun.

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

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

Parametreler

Döndürülenler

Tüm öğeleri okuma.

Sağlanan T türü SDK tarafından zorunlu tutulmayabilir. Daha fazla veya daha az özellik alabilirsiniz ve bunu zorlamak sizin mantığınıza göredir.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

Örnek

Dizideki tüm öğeleri okuyun.

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

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

Parametreler

Döndürülenler

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

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

Parametreler

Döndürülenler

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

Örnek

Değişiklik akışının başından itibaren okuyun.

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>

Parametreler

Döndürülenler

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

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

Parametreler

Döndürülenler

Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator oluşturma

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

Parametreler

Döndürülenler

Bir öğeyi yukarı ekle.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

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

Parametreler

Döndürülenler

Bir öğeyi yukarı ekle.

Sağlanan T türü SDK tarafından zorunlu tutulmayabilir. Daha fazla veya daha az özellik alabilirsiniz ve bunu zorlamak sizin mantığınıza göredir.

JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir.

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

Parametreler

Döndürülenler