@azure/cosmos package

Sınıflar

AbortError	Zaman uyumsuz bir işlem durdurulduğunda bu hata oluşur. Hatanın name özelliğinin nameile eşleştiğinden "AbortError" test ederek bu hatayı denetleyin. Örnek const controller = new AbortController(); controller.abort(); try { doAsyncWork(controller.signal) } catch (e) { if (e.name === 'AbortError') { // handle abort error here. } }
AzureKeyVaultEncryptionKeyResolver	Müşteri tarafından yönetilen anahtarlar için Azure Key Vault kullanan EncryptionKeyResolver uygulaması.
ChangeFeedIterator	Değişiklik akışı için yineleyici sağlar. Yineleyicinin bir örneğini almak için Items.changeFeed() kullanın.
ChangeFeedIteratorResponse	Azure Cosmos DB Değişiklik Akışı'ndan tek bir yanıt sayfası
ChangeFeedPolicy	Azure Cosmos DB hizmetindeki bir kapsayıcı için değişiklik akışı ilkesi yapılandırmasını temsil eder.
ChangeFeedResponse	Azure Cosmos DB Değişiklik Akışı'ndan tek bir yanıt sayfası
ChangeFeedRetentionTimeSpan
ChangeFeedStartFrom	ChangeFeedIterator'ın nereden başlatıldığına ilişkin temel sınıf.
ClientEncryptionKeyResponse	ClientEncryptionKey işlemleri için yanıt nesnesi
ClientSideMetrics
Conflict	Belirli bir Çakışma kimliğe göre okumak veya silmek için kullanın. Tüm çakışmaları sorgulamak veya okumak için bkz. Çakışmalar.
ConflictResponse
Conflicts	Tüm çakışmaları sorgulamak veya okumak için kullanın. Kimliğine göre belirli bir Çakışma okumak veya silmek için bkz. çakışma .
Container	Kimliğe göre belirli bir kapsayıcıyı okuma, değiştirme veya silme işlemleri. Yeni kapsayıcılar oluşturmak ve tüm kapsayıcıları okumak/sorgulamak için bkz. Kapsayıcılar; .containerskullanı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 mevcut olduğundan emin olmak için her container(id).read() çağrısından önce item.read() çağırmayın; uygulama başlatılırken bunu bir kez yapın.
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 mevcut olduğundan emin olmak için her containers.readAll() çağrısından önce item.read() çağırmayın; uygulama başlatılırken bunu bir kez yapın.
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 import { CosmosClient } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key }); Örnek Özel Bağlantı İlkesi ile istemci örneği oluşturma import { CosmosClient } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key, connectionPolicy: { requestTimeout: 10000, }, }); Örnek AAD kimlik doğrulaması ve özel kapsam ile istemci örneği oluşturma import { DefaultAzureCredential } from "@azure/identity"; import { CosmosClient } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const aadCredentials = new DefaultAzureCredential(); const client = new CosmosClient({ endpoint, aadCredentials, aadScope: "https://cosmos.azure.com/.default", // Optional custom scope });
CosmosDiagnostics	Bu, istemci işlemleri sırasında toplanan tanılama bilgilerini tutan bir Cosmos Tanılama türüdür. ıe. Item.read(), Container.create(). Üç üyesi var - clientSideRequestStatistics üye- dahil olmak üzere toplu tanılama bilgilerini içerir meta veri aramaları. Burada, hedeflenen son kaynak dışında tüm sunucu istekleri meta veri çağrıları olarak kabul edilir. örneğin item.read(id) için istemci uç noktaları bulmak için sunucu çağrısı yaparsa meta veri çağrısı olarak kabul edilir. Yeni -den deneme uç noktalarıyla iletişime geçildi. istek, yanıt yükü istatistikleri. gatewayStatistics - Ana işleme karşılık gelen bilgiler. Örneğin Item.read() sırasında istemci meta veri arama gibi birçok işlem gerçekleştirebilir, ancak gatewayStatistics gerçek okuma işlemi için tanılama bilgilerini temsil eder. diagnosticNode - Ayrıntılı tanılama bilgilerini yakalayan yapı gibi bir ağaçtır. Varsayılan olarak devre dışıdır ve yalnızca üretim dışı ortamlarda hata ayıklama için kullanılması amaçlanmıştır. diagnosticNode'da yakalanan ayrıntıların türü CosmosDbDiagnosticLeveltarafından denetlenmektedir. CosmosDbDiagnosticLevel.info - Varsayılan değerdir. Bu düzeyde yalnızca clientSideRequestStatistics yakalanır. üretim ortamları için tasarlanmıştır. CosmosDbDiagnosticLevel.debug - diagnosticNode ve clientConfig değerlerini yakalar. Hiçbir istek ve yanıt yükü yakalanmaz. Üretim ortamında kullanılması amaçlanmamıştır. CosmosDbDiagnosticLevel.debug-unsafe - CosmosDbDiagnosticLevel.debug içinde yakalanan verilere ek olarak istek ve yanıt yüklerini de yakalar. Üretim ortamında kullanılması amaçlanmamıştır. clientConfig - başlatma sırasında istemcinin nasıl yapılandırıldığıyla ilgili bilgileri yakalar.
Database	Mevcut veritabanını okuma veya silme işlemleri. Yeni veritabanları oluşturmak ve tüm veritabanlarını okumak/sorgulamak için bkz. Veritabanları; client.databaseskullanı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 mevcut olduğundan emin olmak için her database.read() çağrısından önce item.read() çağırmayın; uygulama başlatılırken bunu bir kez yapın.
DatabaseAccount	Azure Cosmos DB veritabanı hizmetinde 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ı; client.database(id)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 mevcut olduğundan emin olmak için her databases.readAll() çağrısından önce item.read() çağırmayın; uygulama başlatılırken bunu bir kez yapın.
EncryptionQueryBuilder	Parametrelendirilmiş sorguda şifrelenmiş parametreler oluşturmak için bir oluşturucu sınıfını temsil eder.
ErrorResponse	İşlemlerde döndürülen bir hata yanıtını temsil eder.
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. Tüm öğelerdeki işlemler için bkz. Öğeleri; bkz. container.items.
ItemResponse
Items	Yeni öğe oluşturma ve tüm öğeleri okuma/sorgulama işlemleri Mevcut kapsayıcıyı okumak, değiştirmek veya silmek için bkz. Öğe; .item(id)kullanın.
Offer	Mevcut Teklif kimliğe göre okumak veya değiştirmek için kullanın. Tüm teklifleri sorgulamak veya okumak için bkz. Teklifler.
OfferResponse
Offers	Tüm Teklifleri sorgulamak veya okumak için kullanın. Mevcut Teklifi kimliğe göre okumak veya değiştirmek için bkz. teklif .
PartitionKeyBuilder	PartitionKey oluşturmak için oluşturucu sınıfı.
Permission	Belirli bir İzin kimliğe göre okumak, değiştirmek veya silmek için kullanın. Tüm İzinleri oluşturmak, eklemek, sorgulamak veya okumak için bkz. İzinler.
PermissionResponse
Permissions	Tüm İzinleri oluşturmak, değiştirmek, sorgulamak ve okumak için kullanın. Belirli bir izni kimliğe göre okumak, değiştirmek veya silmek için bkz. İzin.
QueryIterator	Azure Cosmos DB veritabanı hizmetindeki yanıt üzerinde dolaşmayı ve yinelemeyi sağlayan bir akış veya sorgu yanıtı uygulaması olan QueryIterator Nesnesini temsil eder.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure	Kimliğe göre belirli bir saklı yordamı okuma, değiştirme, silme veya yürütme işlemleri. Saklı Yordamları oluşturma, okuma veya sorgulama işlemleri için,
StoredProcedureResponse
StoredProcedures	Tüm Saklı Yordamları oluşturma, yükseltme veya okuma/sorgulama işlemleri. İşlemlerin kimliğe göre belirli bir saklı yordamı okuması, değiştirmesi, silmesi veya yürütmesi için bkz. container.storedProcedure().
TimeoutError
Trigger	Tetikleyicisini okuma, değiştirme veya silme işlemleri. Tümünü oluşturmak, eklemek, sorgulamak veya okumak için container.triggers kullanın.
TriggerResponse
Triggers	Tüm tetikleyicileri oluşturma, ekleme, sorgulama ve okuma işlemleri. container.triggersokumak, 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, user.permission ve user.permissionsaracılığıyla belirli bir kullanıcının izinlerine erişebilirsiniz. Bkz. Kullanıcılar oluşturma, yükseltme, sorgulama veya tümünü okuma.
UserDefinedFunction	Kimliğine göre belirtilen Bir Kullanıcı Definied İşlevini 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 userDefinedFunction bakın.
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 userDefinedFunction bakın.
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.Index

Agent
BulkOperationResult	executeBulkOperations API ile bir işlemin yanıtını toplu olarak temsil eder
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 SÜRÜMDE 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ı: devam başlangıç zamanı başlangıçtan itibaren Bu seçeneklerden hiçbiri ayarlı değilse, ilk ChangeFeedIterator.fetchNext() çağrısından değişiklikleri okumaya başlar.
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 Items.getChangeFeedIterator() kullanın.
ClientEncryptionIncludedPath	Şifreleme yolunu ve ilişkili ayarlarını temsil eder.
ClientEncryptionKeyProperties	Azure Cosmos DB hizmetiyle kullanılacak bir istemci şifreleme anahtarının ayrıntıları.
ClientEncryptionKeyRequest	Cosmos DB'de istemci şifreleme anahtarı isteğini temsil eden arabirim.
ClientEncryptionOptions	CosmosClient ile ilişkili şifreleme seçeneklerini temsil eder.
ClientEncryptionPolicy	Bir kapsayıcı ile ilişkili istemci şifreleme ilkesini temsil eder.
CompositePath	Dizin oluşturma ilkesindeki bileşik yolu temsil eder.
ComputedProperty
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ı hizmetinde CosmosClient ile ilişkili Bağlantı ilkesini temsil eder.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosEncryptedNumber	Bu arabirim, Cosmos DB SDK'sında şifrelenmiş bir numarayı temsil eder. Örnek import { CosmosEncryptedNumber, CosmosEncryptedNumberType } from "@azure/cosmos"; const encryptedNumber1: CosmosEncryptedNumber = { value: 4, numberType: CosmosEncryptedNumberType.Integer, }; const encryptedNumber2: CosmosEncryptedNumber = { value: 4.1, numberType: CosmosEncryptedNumberType.Float, }; const encryptedNumber3: CosmosEncryptedNumber = { value: 4, numberType: CosmosEncryptedNumberType.Float, // represents 4.0 };
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode	Tanılama bilgilerini yakalamak için yapı gibi bir ağacı temsil eder.
EncryptionKeyResolver	Farklı anahtar sağlayıcılar için anahtar çözümleyici için bir arabirim sağlar. Tüm çözümleyiciler bu arayüzü uygulamalıdır.
EncryptionKeyWrapMetadata	Müşteri tarafından yönetilen bir anahtar kullanarak veri şifreleme anahtarını sarmalamak/açmak için kullanılan meta veriler
ErrorBody
ExtendedOperationResponse	executeBulkOperations API ile toplu olarak başarılı bir işlem için yanıt
FailedRequestAttemptDiagnostic	Bu tür, başarısız sunucu api'sine yönelik istekle ilgili tanılama bilgilerini yakalar.
FeedOptions	Akış seçenekleri ve sorgu yöntemleri.
FullTextIndex	Dizin oluşturma ilkesindeki tam metin dizinini temsil eder.
FullTextPath	Azure Cosmos DB hizmetinde dizine eklenecek tam metin yolunu temsil eder.
FullTextPolicy	Azure Cosmos DB hizmetindeki bir koleksiyon için tam metin ilkesini temsil eder.
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 yönelik 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
RestError	Başarısız işlem hattı istekleri için özel bir hata türü.
RetryOptions	Azure Cosmos DB veritabanı hizmetinde kısıtlanmış isteklerle ayrılan Yeniden Deneme ilkesini temsil eder.
SharedOptions	Azure Cosmos DB sunucularına verilen istenen bir için belirtilebilen seçenekler.=
SpatialIndex
SqlParameter	SqlQuerySpec içinde belirtilen Parametreli SQL sorgusundaki bir parametreyi temsil eder
SqlQuerySpec	Azure Cosmos DB hizmetinde bir SQL sorgusunu temsil eder. SQL eklemeye karşı korunmak için girişleri olan sorgular parametrelendirilmelidir. Örnek Parametreli SQL Sorgusu import { SqlQuerySpec } from "@azure/cosmos"; const query: SqlQuerySpec = { query: `SELECT * FROM Families f where f.lastName = @lastName`, parameters: [{ name: "@lastName", value: "Wakefield" }], };
StoredProcedureDefinition
TriggerDefinition
UniqueKey	UniqueKeyPolicy'nin parçası olarak geçirilen tek bir benzersiz anahtar için arabirim
UniqueKeyPolicy	Kapsayıcı oluşturmada benzersiz anahtarlar ayarlama arabirimi
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition
VectorEmbedding	Vektör eklemeyi temsil eder. Belgelerde vektör alanı tanımlamak için vektör ekleme kullanılır.
VectorEmbeddingPolicy	Azure Cosmos DB hizmetinde vektör eklemeleri için ilke yapılandırmasını temsil eder.
VectorIndex	Azure Cosmos DB hizmetindeki bir vektör dizinini temsil eder. Belgelerdeki vektör alanlarını dizine almak için vektör dizini kullanılır.

Tür Diğer Adları

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic	Bu tür, CosmosClient başlatılmasıyla 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 istekleriyle ilgili tanılama bilgilerini içerir.
NonePartitionKeyType	Döndürülen nesne, bölüm anahtarı için değer içermeyen öğ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ğere sahip öğ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

ChangeFeedMode
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. İstenen ConsistencyLevel veritabanı hesabı için sağlananla eşleşmeli veya daha zayıf olmalıdır. Tutarlılık düzeyleri. Güçlülük sırasına göre tutarlılık düzeyleri Güçlü, BoundedStaleness, 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
CosmosEncryptedNumberType	Bu numaralandırma, Cosmos DB SDK'sındaki sayı türünü temsil eder.
DataType	Azure Cosmos DB hizmetinde dizin yolu belirtiminin hedef veri türünü tanımlar.
EncryptionAlgorithm	Veri şifreleme için desteklenen Şifreleme Algoritmaları
EncryptionKeyResolverName	Uygulamalarının adları Bkz. EncryptionKeyResolver
EncryptionType	Gerçekleştirilecek şifreleme türü.
GeospatialType
IndexKind	Desteklenen Dizin türlerini belirtir.
IndexingMode	Desteklenen dizin oluşturma modlarını belirtir.
KeyEncryptionAlgorithm	Veri şifreleme anahtarını anahtar şifreleme anahtarıyla sarmalamak/açmak için kullanılan algoritmalar.
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ü, örneğin Karma, ÇokluHaş
PermissionMode	İzin modu değerleri için sabit listesi.
PriorityLevel	Her Azure Cosmos DB istemci isteğiyle ilişkili Öncelik Düzeyini temsil eder. Düşük öncelikli istekler, yüksek öncelikli isteklerden önce her zaman kısıtlanmıştır. 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şlev türlerini belirtir.
VectorEmbeddingDataType	Vektörünün veri türünü temsil eder.
VectorEmbeddingDistanceFunction	Vektörler arasındaki mesafe hesaplaması için kullanılacak uzaklık işlevini temsil eder.
VectorIndexType	Vektörünün dizin türünü temsil eder.

İşlevler

createAuthorizationSasToken(string, SasTokenProperties)

Yalnızca deneysel iç, sas belirtecinin izin yapılandırmasını temsil eden yükü oluşturur.

İşlev Ayrıntıları

createAuthorizationSasToken(string, SasTokenProperties)

Yalnızca deneysel iç, 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>