@azure/cosmos package
Sınıflar
AbortError |
Zaman uyumsuz bir işlem durdurulduğunda bu hata oluşur.
Hatanın ad özelliğinin Örnek
|
ChangeFeedIterator |
Değişiklik akışı için yineleyici sağlar. Yineleyicinin bir örneğini almak için kullanın |
ChangeFeedIteratorResponse |
Azure Cosmos DB Değişiklik Akışı'ndan tek bir yanıt sayfası |
ChangeFeedResponse |
Azure Cosmos DB Değişiklik Akışı'ndan tek bir yanıt sayfası |
ChangeFeedStartFrom |
ChangeFeedIterator'ın başlatıldığı temel sınıf. |
ClientSideMetrics | |
Conflict |
Belirli bir Kimliğe göre çakışmayı okumak veya silmek için kullanın. Bkz . Tüm çakışmaları sorgulamak veya okumak için çakışmalar. |
ConflictResponse | |
Conflicts |
Tüm çakışmaları sorgulamak veya okumak için kullanın. Bkz . Belirli bir Kimliğe göre çakışmayı okumak veya silmek için çakışma. |
Container |
Var olan belirli bir kapsayıcıyı kimliğe göre okuma, değiştirme veya silme işlemleri. Bkz . Yeni kapsayıcılar oluşturmak ve tüm kapsayıcıları okumak/sorgulamak için kapsayıcılar; kullanın Not: Tüm bu işlemler sabit bir bütçeye göre çağrı yapar.
Sisteminizi, bu çağrıların uygulamanızla birlikte alt satır olarak ölçeklendirilmesi için tasarlamanız gerekir.
Örneğin, kapsayıcının var olduğundan emin olmak için her |
ContainerResponse |
Kapsayıcı işlemleri için yanıt nesnesi |
Containers |
Yeni kapsayıcılar oluşturma ve tüm kapsayıcıları okuma/sorgulama işlemleri Mevcut kapsayıcıyı okumak, değiştirmek veya silmek için bkz. Kapsayıcı; kullanın Not: Tüm bu işlemler sabit bir bütçeye göre çağrı yapar.
Sisteminizi, bu çağrıların uygulamanızla birlikte alt satır olarak ölçeklendirilmesi için tasarlamanız gerekir.
Örneğin, kapsayıcının var olduğundan emin olmak için her |
CosmosClient |
Azure Cosmos DB veritabanı hesabının istemci tarafı mantıksal gösterimini sağlar. Bu istemci, Azure Cosmos DB veritabanı hizmetinde istekleri yapılandırmak ve yürütmek için kullanılır. Örnek İstemci örneği oluşturma ve yeni veritabanı oluşturma
Örnek Özel Bağlantı İlkesi ile istemci örneği oluşturma
|
CosmosDiagnostics |
|
Database |
Mevcut veritabanını okuma veya silme işlemleri. Bkz . Yeni veritabanları oluşturmak ve tüm veritabanlarını okumak/sorgulamak için veritabanları; kullanın Not: Tüm bu işlemler sabit bir bütçeye göre çağrı yapar.
Sisteminizi, bu çağrıların uygulamanızla birlikte alt satır olarak ölçeklendirilmesi için tasarlamanız gerekir.
Örneğin, veritabanının var olduğundan emin olmak için her |
DatabaseAccount |
Azure Cosmos DB veritabanı hizmetindeki bir DatabaseAccount değerini temsil eder. |
DatabaseResponse |
Veritabanı işlemleri için yanıt nesnesi |
Databases |
Yeni veritabanları oluşturma ve tüm veritabanlarını okuma/sorgulama işlemleri Mevcut veritabanını okumak veya silmek için bkz . Veritabanı ; kullanın Not: Tüm bu işlemler sabit bir bütçeye göre çağrı yapar.
Sisteminizi, bu çağrıların uygulamanızla birlikte alt satır olarak ölçeklendirilmesi için tasarlamanız gerekir.
Örneğin, veritabanının var olduğundan emin olmak için her |
ErrorResponse | |
FeedRange |
Değişiklik akışı için bir akış aralığı belirtir. |
FeedResponse | |
Item |
Belirli bir öğe üzerinde işlem gerçekleştirmek için kullanılır. Bkz . Tüm öğelerdeki işlemler için öğeler; bkz |
ItemResponse | |
Items |
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 |
Offer |
Var olan bir Teklif'i kimliğe göre okumak veya değiştirmek için kullanın. Bkz . Tüm teklifleri sorgulama veya okuma teklifleri. |
OfferResponse | |
Offers |
Tüm Teklifleri sorgulamak veya okumak için kullanın. Bkz. Mevcut kimliğe göre Teklif'i okumak veya değiştirmek için teklif . |
PartitionKeyBuilder |
PartitionKey oluşturmak için oluşturucu sınıfı. |
Permission |
Belirli bir kimliğe göre İzin'i okumak, değiştirmek veya silmek için kullanın. Bkz. Tüm İzinleri oluşturma, yükseltme, sorgulama veya okuma izinleri. |
PermissionResponse | |
Permissions |
Tüm İzinleri oluşturmak, değiştirmek, sorgulamak ve okumak için kullanın. Bkz. Kimliğe göre belirli bir izni okuma, değiştirme veya silme izni. |
QueryIterator |
Azure Cosmos DB veritabanı hizmetinde yanıt üzerinde dolaşmayı ve yinelemeyi sağlayan bir akış veya sorgu yanıtı uygulaması olan QueryIterator Nesnesini temsil eder. |
QueryMetrics | |
QueryPreparationTimes | |
ResourceResponse | |
RestError |
Başarısız işlem hattı istekleri için özel bir hata türü. |
RuntimeExecutionTimes | |
SasTokenProperties | |
Scripts | |
StoredProcedure |
Kimliğe göre belirli bir saklı yordamı okuma, değiştirme, silme veya yürütme işlemleri. Saklı Yordam oluşturma, tümünü okuma veya sorgulama işlemleri için, |
StoredProcedureResponse | |
StoredProcedures |
Tüm Saklı Yordamları oluşturma, yükseltme veya okuma/sorgulama işlemleri. Kimlikle belirli bir saklı yordamı okuma, değiştirme, silme veya yürütme işlemleri için bkz |
TimeoutError | |
Trigger |
Tetikleyiciyi okuma, değiştirme veya silme işlemleri. Tümünü oluşturmak, eklemek, sorgulamak veya okumak için kullanın |
TriggerResponse | |
Triggers |
Tüm tetikleyicileri oluşturma, yükseltme, sorgulama ve okuma işlemleri. Tetikleyiciyi okumak, değiştirmek veya silmek için kullanın |
User |
Kullanıcıları okumak, değiştirmek ve silmek için kullanılır. Ayrıca, ve Bkz. Oluşturma, yükseltme, sorgulama veya tümünü okuma için kullanıcılar. |
UserDefinedFunction |
Belirtilen User Definied İşlevini kimliğe göre okumak, değiştirmek veya silmek için kullanılır. Tüm Kullanıcı Tanımlı İşlevleri oluşturmak, yukarı eklemek, sorgulamak, okumak için bkz. UserDefinedFunction . |
UserDefinedFunctionResponse | |
UserDefinedFunctions |
Tüm Kullanıcı Tanımlı İşlevleri oluşturmak, eklemek, sorgulamak veya okumak için kullanılır. Belirli bir Kullanıcı Tanımlı İşlevi kimliğe göre okumak, değiştirmek veya silmek için bkz. UserDefinedFunction . |
UserResponse | |
Users |
Tüm kullanıcıları oluşturmak, eklemek, sorgulamak ve okumak için kullanılır. Belirli bir Kullanıcıyı kimliğe göre okumak, değiştirmek veya silmek için bkz. Kullanıcı. |
Arabirimler
@azure/cosmos.IndexAgent | |
BulkOptions |
Toplu yürütmeyi değiştirmek için kullanılan Seçenekler nesnesi. continueOnError (Varsayılan değer: false) - Bir işlem başarısız olduğunda toplu yürütmeye devam eder ** NOT BU, 4.0 YAYıNıNDA VARSAYıLAN OLARAK TRUE OLUR |
ChangeFeedIteratorOptions |
Değişiklik akışı seçeneklerini belirtir Bu seçeneklerden hiçbiri ayarlı değilse, bundan sonra kapsayıcının tamamı için değişiklikleri okumaya başlayacaktır. |
ChangeFeedOptions |
Değişiklik akışı seçeneklerini belirtir Bu seçeneklerden bazıları, değişiklik akışından okumaya nereden ve ne zaman başlayacağını denetler. Öncelik sırası:
Bu seçeneklerden hiçbiri ayarlı değilse, ilk |
ChangeFeedPullModelIterator |
Bölüm anahtarı, akış aralığı veya kapsayıcının tamamı için tüm değişiklikleri yineleyebilecek bir yineleyici döndürmek için kullanın |
ConflictDefinition | |
ConflictResolutionPolicy |
Farklı bölgelerden yazmaların Azure Cosmos DB hizmetindeki koleksiyondaki belgelerde çakışmalara neden olması durumunda çakışmaların nasıl çözüleceğini belirtmek için çakışma çözümleme ilkesi yapılandırmasını temsil eder. |
ConnectionPolicy |
Azure Cosmos DB veritabanı hizmetindeki bir CosmosClient ile ilişkili Bağlantı ilkesini temsil eder. |
ContainerDefinition | |
ContainerRequest | |
CosmosClientOptions | |
CosmosHeaders | |
CreateOperationInput | |
DatabaseDefinition | |
DatabaseRequest | |
DeleteOperationInput | |
DiagnosticNode |
Tanılama bilgilerini yakalamak için yapı gibi bir ağacı temsil eder. |
ErrorBody | |
FailedRequestAttemptDiagnostic |
Bu tür, sunucu API'sine yapılan başarısız istekle ilgili tanılama bilgilerini yakalar. |
FeedOptions |
Akış seçenekleri ve sorgu yöntemleri. |
GroupByAliasToAggregateType | |
IndexedPath | |
IndexingPolicy | |
ItemDefinition |
Cosmos DB'deki öğeler yalnızca JSON nesneleridir. Öğe işlemlerinin çoğu, çok basit ItemDefinition'ı genişleten kendi türünüzü sağlamanıza olanak sağlar. Ayrılmış anahtar kullanamazsınız. Ayrılmış anahtar listesini <xref:ItemBody> |
JSONArray | |
JSONObject | |
Location |
Kullanılabilir konumları belirtmek için kullanılır, okuma dizin 1 ve yazma dizin 0'dır. |
MetadataLookUpDiagnostic |
Bu tür, sunucuya yapılan tek bir meta veri isteğiyle ilgili tanılama bilgilerini içerir. |
OfferDefinition | |
OperationBase | |
OperationResponse | |
PartitionKeyDefinition | |
PartitionKeyRangePropertiesNames | |
PatchOperationInput | |
PermissionBody | |
PermissionDefinition | |
ReadOperationInput | |
ReplaceOperationInput | |
RequestOptions |
Azure Cosmos DB sunucularına verilen istenen bir için belirtilebilen seçenekler.= |
Resource | |
RetryOptions |
Azure Cosmos DB veritabanı hizmetinde kısıtlanmış isteklerle ayrılmış yeniden deneme ilkesini temsil eder. |
SharedOptions |
Azure Cosmos DB sunucularına verilen istenen bir için belirtilebilen seçenekler.= |
SpatialIndex | |
SqlParameter |
SqlQuerySpec'te belirtilen Parametreli SQL sorgusundaki bir parametreyi temsil eder |
SqlQuerySpec |
Azure Cosmos DB hizmetinde bir SQL sorgusunu temsil eder. SQL eklemeye karşı koruma sağlamak için girişlere sahip sorgular parametrelendirilmelidir. Örnek Parametreli SQL Sorgusu
|
StoredProcedureDefinition | |
TriggerDefinition | |
UniqueKey |
UniqueKeyPolicy'nin bir parçası olarak geçirilen tek bir benzersiz anahtar için arabirim |
UniqueKeyPolicy |
Kapsayıcı oluşturmada benzersiz anahtarlar ayarlama arabirimi |
UpsertOperationInput | |
UserDefinedFunctionDefinition | |
UserDefinition |
Tür Diğer Adları
AggregateType | |
BulkOperationResponse | |
BulkPatchOperation | |
ClientConfigDiagnostic |
Bu tür, başlatma işlemiyle ilgili bilgileri barındırır |
ClientSideRequestStatistics |
Bu, tüm istemci tarafı tanılama bilgileri için bir koleksiyon türüdür. |
CreateOperation | |
DeleteOperation | |
ExistingKeyOperation | |
GatewayStatistics | |
GroupByExpressions | |
JSONValue | |
MetadataLookUpDiagnostics |
Bu tür, CosmosDB istemci işlemi sırasında sunucuya yapılan tüm meta veri isteğiyle ilgili tanılama bilgilerini içerir. |
NonePartitionKeyType |
Döndürülen nesne, bölüm anahtarı için değer olmadan öğelerin oluşturulmasına ve bunlara erişmesine olanak tanıyan bir bölüm anahtarı değerini temsil eder |
NullPartitionKeyType |
Döndürülen nesne, bölüm anahtarı için null değer içeren öğelerin oluşturulmasına ve bunlara erişmesine olanak tanıyan bir bölüm anahtarı değerini temsil eder. |
Operation | |
OperationInput | |
OperationWithItem | |
PartitionKey |
Kapsayıcının PartitionKey değeri. |
PatchOperation | |
PatchRequestBody | |
PrimitivePartitionKeyValue |
İlkel Bölüm Anahtarı değeri. |
ReadOperation | |
RemoveOperation | |
ReplaceOperation | |
RetryDiagnostics |
Bu tür, CosmosDB istemci işlemi sırasında yeniden deneme girişimiyle ilgili tanılama bilgilerini yakalar. |
TokenProvider | |
UpsertOperation |
Numaralandırmalar
ConflictResolutionMode | |
ConnectionMode |
CosmosClient'ın bağlantı davranışını belirler. Şu anda yalnızca Ağ Geçidi Modu'nu desteklediğimizi unutmayın. |
ConsistencyLevel |
Azure Cosmos DB istemci işlemleri için desteklenen tutarlılık düzeylerini temsil eder. Güçlülüğe göre tutarlılık düzeyleri Güçlü, SınırlanmışStaleness, Oturum, Tutarlı Ön Ek ve Nihai'dir. Tutarlılık Düzeyleri hakkında daha ayrıntılı belgeler için bkz https://aka.ms/cosmos-consistency . |
CosmosDbDiagnosticLevel |
Cosmos DB Tanılama Düzeyi |
DataType |
Azure Cosmos DB hizmetinde dizin yolu belirtiminin hedef veri türünü tanımlar. |
GeospatialType | |
IndexKind |
Desteklenen Dizin türlerini belirtir. |
IndexingMode |
Desteklenen dizin oluşturma modlarını belirtir. |
MetadataLookUpType |
Bu, Olası Meta Veri aramalarının türü için sabit listesidir. |
PartitionKeyDefinitionVersion |
PartitionKey Tanım Sürümü |
PartitionKeyKind |
PartitionKey türü; örn. Karma, MultiHash |
PermissionMode |
İzin modu değerleri için sabit listesi. |
PriorityLevel |
Her Azure Cosmos DB istemci isteğiyle ilişkili Öncelik Düzeyini temsil eder. Varsayılan olarak tüm istekler Yüksek öncelikli istekler olarak kabul edilir. Öncelik tabanlı azaltma hakkında daha ayrıntılı belgeler için bkz https://aka.ms/CosmosDB/PriorityBasedExecution . |
SpatialType | |
TriggerOperation |
Tetikleyici işlemi değerleri için sabit listesi. tetikleyicinin yürütülmesi gereken işlemleri belirtir. |
TriggerType |
Tetikleyici türü değerleri için sabit listesi. Tetikleyicinin türünü belirtir. |
UserDefinedFunctionType |
udf türü değerleri için sabit listesi. Kullanıcı tanımlı işlevlerin türlerini belirtir. |
İşlevler
create |
Deneysel iç yalnızca sas belirtecinin izin yapılandırmasını temsil eden yükü oluşturur. |
İşlev Ayrıntıları
createAuthorizationSasToken(string, SasTokenProperties)
Deneysel iç yalnızca sas belirtecinin izin yapılandırmasını temsil eden yükü oluşturur.
function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>
Parametreler
- masterKey
-
string
- sasTokenProperties
- SasTokenProperties
Döndürülenler
Promise<string>