Items class
Yeni öğe oluşturma ve tüm öğeleri okuma/sorgulama işlemleri
Var olan bir kapsayıcıyı okumak, değiştirmek veya silmek için bkz. Öğe ; kullanın .item(id)
.
Özellikler
container |
Yöntemler
batch(Operation |
Öğ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:
|
bulk(Operation |
Öğ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:
|
change |
Değişiklik sayfalarını yinelemek için bir |
change |
Değişiklik sayfalarını yinelemek için bir Örnek Değişiklik akışının başından itibaren okuyun.
|
change |
Değişiklik sayfalarını yinelemek için bir |
change |
Değişiklik sayfalarını yinelemek için bir |
create<T>(T, Request |
Öğ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. |
get |
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. |
query(string | Sql |
Tüm öğeleri sorgular. Örnek Dizideki tüm öğeleri okuyun.
|
query<T>(string | Sql |
Tüm öğeleri sorgular. Örnek Dizideki tüm öğeleri okuyun.
|
read |
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.
|
read |
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.
|
read |
Değişiklik sayfalarını yinelemek için bir |
read |
Değişiklik sayfalarını yinelemek için bir Örnek Değişiklik akışının başından itibaren okuyun.
|
read |
Değişiklik sayfalarını yinelemek için bir |
read |
Değişiklik sayfalarını yinelemek için bir |
upsert(unknown, Request |
Bir öğeyi yukarı ekle. JSON öğeleri için ayarlanmış şema yok. Bunlar herhangi bir sayıda özel özellik içerebilir. |
upsert<T>(T, Request |
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. |
Özellik Ayrıntıları
container
Yöntem Ayrıntıları
batch(OperationInput[], PartitionKey, RequestOptions)
Öğ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
- operations
İşlemlerin listesi. Sınır 100
- partitionKey
- PartitionKey
- options
- RequestOptions
İsteği değiştirmek için kullanılır
Döndürülenler
Promise<Response_2<OperationResponse[]>>
bulk(OperationInput[], BulkOptions, RequestOptions)
Öğ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
- operations
İşlemlerin listesi. Sınır 100
- bulkOptions
- BulkOptions
Toplu davranışı değiştirmek için isteğe bağlı seçenekler nesnesi. İşlem başarısız olduğunda yürütmeye devam etmek için { continueOnError: true } geçirin. (Varsayılan değer false'tur) ** NOT: BU, 4.0 SÜRÜMÜNDE VARSAYıLAN OLARAK TRUE OLUR
- options
- RequestOptions
İsteği değiştirmek için kullanılır.
Döndürülenler
Promise<BulkOperationResponse>
changeFeed(ChangeFeedOptions)
Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator
oluşturma
function changeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>
Parametreler
- changeFeedOptions
- ChangeFeedOptions
Döndürülenler
ChangeFeedIterator<any>
changeFeed(PartitionKey, ChangeFeedOptions)
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
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
Döndürülenler
ChangeFeedIterator<any>
changeFeed<T>(ChangeFeedOptions)
Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator
oluşturma
function changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>
Parametreler
- changeFeedOptions
- ChangeFeedOptions
Döndürülenler
changeFeed<T>(PartitionKey, ChangeFeedOptions)
Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator
oluşturma
function changeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>
Parametreler
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
Döndürülenler
create<T>(T, RequestOptions)
Öğ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
- body
-
T
Öğenin gövdesini temsil eder. Herhangi bir sayıda kullanıcı tanımlı özellik içerebilir.
- options
- RequestOptions
İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).
Döndürülenler
Promise<ItemResponse<T>>
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)
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
- changeFeedIteratorOptions
- ChangeFeedIteratorOptions
Döndürülenler
query(string | SqlQuerySpec, FeedOptions)
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
- query
-
string | SqlQuerySpec
İşlem için sorgu yapılandırması. Sorgu yapılandırma hakkında daha fazla bilgi için bkz . SqlQuerySpec .
- options
- FeedOptions
İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).
Döndürülenler
QueryIterator<any>
query<T>(string | SqlQuerySpec, FeedOptions)
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
- query
-
string | SqlQuerySpec
İşlem için sorgu yapılandırması. Sorgu yapılandırma hakkında daha fazla bilgi için bkz . SqlQuerySpec .
- options
- FeedOptions
İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).
Döndürülenler
readAll(FeedOptions)
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
- options
- FeedOptions
İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).
Döndürülenler
readAll<T>(FeedOptions)
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
- options
- FeedOptions
İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).
Döndürülenler
readChangeFeed(ChangeFeedOptions)
Uyarı
Bu API artık kullanım dışıdır.
Use changeFeed
instead.
Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator
oluşturma
function readChangeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>
Parametreler
- changeFeedOptions
- ChangeFeedOptions
Döndürülenler
ChangeFeedIterator<any>
readChangeFeed(PartitionKey, ChangeFeedOptions)
Uyarı
Bu API artık kullanım dışıdır.
Use changeFeed
instead.
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
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
Döndürülenler
ChangeFeedIterator<any>
readChangeFeed<T>(ChangeFeedOptions)
Uyarı
Bu API artık kullanım dışıdır.
Use changeFeed
instead.
Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator
oluşturma
function readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>
Parametreler
- changeFeedOptions
- ChangeFeedOptions
Döndürülenler
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)
Uyarı
Bu API artık kullanım dışıdır.
Use changeFeed
instead.
Değişiklik sayfalarını yinelemek için bir ChangeFeedIterator
oluşturma
function readChangeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>
Parametreler
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
Döndürülenler
upsert(unknown, RequestOptions)
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
- body
-
unknown
Öğenin gövdesini temsil eder. Herhangi bir sayıda kullanıcı tanımlı özellik içerebilir.
- options
- RequestOptions
İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).
Döndürülenler
Promise<ItemResponse<ItemDefinition>>
upsert<T>(T, RequestOptions)
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
- body
-
T
Öğenin gövdesini temsil eder. Herhangi bir sayıda kullanıcı tanımlı özellik içerebilir.
- options
- RequestOptions
İsteği değiştirmek için kullanılır (örneğin, bölüm anahtarını belirtme).
Döndürülenler
Promise<ItemResponse<T>>