@azure/cosmos package
Třídy
AbortError |
Tato chyba je vyvolána při přerušení asynchronní operace.
Zkontrolujte tuto chybu tím, že otestujete Příklad
|
ChangeFeedIterator |
Poskytuje iterátor pro kanál změn. K získání instance iterátoru použijte příkaz |
ChangeFeedIteratorResponse |
Jedna stránka odpovědi z kanálu změn služby Azure Cosmos DB |
ChangeFeedResponse |
Jedna stránka odpovědi z kanálu změn služby Azure Cosmos DB |
ChangeFeedStartFrom |
Základní třída pro místo, kde spustit ChangeFeedIterator. |
ClientSideMetrics | |
Conflict |
Slouží ke čtení nebo odstranění daného konfliktu podle ID. Viz Konflikty při dotazování nebo čtení všech konfliktů. |
ConflictResponse | |
Conflicts |
Slouží k dotazování nebo čtení všech konfliktů. Informace o čtení nebo odstranění daného konfliktu podle ID najdete v tématu Konflikt. |
Container |
Operace pro čtení, nahrazení nebo odstranění konkrétního existujícího kontejneru podle ID Viz Kontejnery pro vytváření nových kontejnerů a čtení/dotazování všech kontejnerů. použijte Poznámka: Všechny tyto operace můžou provádět volání do pevného rozpočtu.
Systém byste měli navrhnout tak, aby volaly dílčí měřítko s vaší aplikací.
Například nevolejte |
ContainerResponse |
Objekt odpovědi pro operace kontejneru |
Containers |
Operace pro vytváření nových kontejnerů a čtení/dotazování všech kontejnerů Viz Kontejner pro čtení, nahrazení nebo odstranění existujícího kontejneru. použijte Poznámka: Všechny tyto operace můžou provádět volání do pevného rozpočtu.
Systém byste měli navrhnout tak, aby volaly dílčí měřítko s vaší aplikací.
Například nevolejte |
CosmosClient |
Poskytuje logickou reprezentaci účtu databáze Azure Cosmos DB na straně klienta. Tento klient se používá ke konfiguraci a spouštění požadavků v databázové službě Azure Cosmos DB. Příklad Vytvoření instance klienta a vytvoření nové databáze
Příklad Vytvoření instance klienta s využitím vlastních zásad připojení
|
CosmosDiagnostics |
|
Database |
Operace čtení nebo odstranění existující databáze Viz Databáze pro vytváření nových databází a čtení/dotazování všech databází. použijte Poznámka: Všechny tyto operace můžou provádět volání do pevného rozpočtu.
Systém byste měli navrhnout tak, aby volaly dílčí měřítko s vaší aplikací.
Například nevolejte |
DatabaseAccount |
Představuje databaseAccount v databázové službě Azure Cosmos DB. |
DatabaseResponse |
Objekt odpovědi pro databázové operace |
Databases |
Operace pro vytváření nových databází a čtení/dotazování všech databází Viz Databáze pro čtení nebo odstranění existující databáze; použijte Poznámka: Všechny tyto operace můžou provádět volání do pevného rozpočtu.
Systém byste měli navrhnout tak, aby volaly dílčí měřítko s vaší aplikací.
Například nevolejte |
ErrorResponse | |
FeedRange |
Určuje rozsah podávání pro kanál změn. |
FeedResponse | |
Item |
Slouží k provádění operací s konkrétní položkou. Viz Položky pro operace se všemi položkami; viz |
ItemResponse | |
Items |
Operace vytváření nových položek a čtení/dotazování všech položek Viz Položka pro čtení, nahrazení nebo odstranění existujícího kontejneru. použijte |
Offer |
Slouží ke čtení nebo nahrazení existující nabídky ID. Viz Nabídky pro dotazování nebo čtení všech nabídek. |
OfferResponse | |
Offers |
Slouží k dotazování nebo čtení všech nabídek. |
PartitionKeyBuilder |
Třída Builderu pro vytváření PartitionKey. |
Permission |
Slouží ke čtení, nahrazení nebo odstranění daného oprávnění podle ID. Viz Oprávnění k vytvoření, upsertování, dotazování nebo čtení všech oprávnění. |
PermissionResponse | |
Permissions |
Slouží k vytváření, nahrazování, dotazování a čtení všech oprávnění. Viz Oprávnění ke čtení, nahrazení nebo odstranění konkrétního oprávnění pomocí ID. |
QueryIterator |
Představuje objekt QueryIterator, implementaci informačního kanálu nebo odpovědi na dotaz, která umožňuje procházení a iteraci odpovědi v databázové službě Azure Cosmos DB. |
QueryMetrics | |
QueryPreparationTimes | |
ResourceResponse | |
RestError |
Vlastní typ chyby pro neúspěšné požadavky kanálu. |
RuntimeExecutionTimes | |
SasTokenProperties | |
Scripts | |
StoredProcedure |
Operace čtení, nahrazení, odstranění nebo spuštění konkrétní uložené procedury podle ID Pro operace vytvoření, čtení všech nebo dotazování uložených procedur: |
StoredProcedureResponse | |
StoredProcedures |
Operace pro vytváření, upsertování nebo čtení/dotazování všech uložených procedur. Operace pro čtení, nahrazení, odstranění nebo spuštění konkrétní existující uložené procedury podle ID najdete v tématu |
TimeoutError | |
Trigger |
Operace čtení, nahrazení nebo odstranění triggeru Umožňuje |
TriggerResponse | |
Triggers |
Operace pro vytvoření, upsert, dotazování a čtení všech triggerů Slouží |
User |
Slouží ke čtení, nahrazení a odstraňování uživatelů. Kromě toho můžete získat přístup k oprávněním pro daného uživatele prostřednictvím Viz Uživatelé pro vytváření, upsertování, dotazování nebo čtení všech. |
UserDefinedFunction |
Slouží ke čtení, nahrazení nebo odstranění zadané funkce uživatele definied podle ID. Viz UserDefinedFunction pro vytvoření, upsert, dotaz a čtení všech uživatelem definovaných funkcí. |
UserDefinedFunctionResponse | |
UserDefinedFunctions |
Používá se k vytváření, upsertování, dotazování nebo čtení všech uživatelem definovaných funkcí. Informace o čtení, nahrazení nebo odstranění dané funkce definované uživatelem pomocí ID najdete v tématu UserDefinedFunction . |
UserResponse | |
Users |
Používá se k vytváření, upsertování, dotazování a čtení všech uživatelů. Viz Uživatel ke čtení, nahrazení nebo odstranění konkrétního uživatele podle ID. |
Rozhraní
@azure/cosmos.IndexAgent | |
BulkOptions |
Objekt Options použitý k úpravě hromadného spuštění. continueOnError (výchozí hodnota: false) – pokračuje v hromadném provádění, když se operace nezdaří .* POZNÁMKA: VE VERZI 4.0 SE VE VÝCHOZÍM NASTAVENÍ POUŽIJE HODNOTA TRUE. |
ChangeFeedIteratorOptions |
Určuje možnosti pro kanál změn. Pokud není žádná z těchto možností nastavená, začne se od této chvíle číst změny pro celý kontejner. |
ChangeFeedOptions |
Určuje možnosti pro kanál změn. Některé z těchto možností určují, kde a kdy začít číst z kanálu změn. Pořadí priorit je:
Pokud není žádná z těchto možností nastavená, začne číst změny od prvního |
ChangeFeedPullModelIterator |
Slouží |
ConflictDefinition | |
ConflictResolutionPolicy |
Představuje konfiguraci zásad řešení konfliktů pro určení způsobu řešení konfliktů v případě, že zápisy z různých oblastí vedou ke konfliktům dokumentů v kolekci ve službě Azure Cosmos DB. |
ConnectionPolicy |
Představuje zásadu připojení přidruženou ke službě CosmosClient v databázové službě Azure Cosmos DB. |
ContainerDefinition | |
ContainerRequest | |
CosmosClientOptions | |
CosmosHeaders | |
CreateOperationInput | |
DatabaseDefinition | |
DatabaseRequest | |
DeleteOperationInput | |
DiagnosticNode |
Představuje stromovou strukturu pro zachytávání diagnostických informací. |
ErrorBody | |
FailedRequestAttemptDiagnostic |
Tento typ zachycuje diagnostické informace týkající se neúspěšného požadavku na rozhraní API serveru. |
FeedOptions |
Možnosti informačního kanálu a metody dotazu. |
GroupByAliasToAggregateType | |
IndexedPath | |
IndexingPolicy | |
ItemDefinition |
Položky ve službě Cosmos DB jsou jednoduše objekty JSON. Většina operací item umožňuje zadat vlastní typ, který rozšiřuje velmi jednoduchou ItemDefinition. Nemůžete použít žádné rezervované klíče. Seznam rezervovaných klíčů si můžete prohlédnout v části <xref:ItemBody> |
JSONArray | |
JSONObject | |
Location |
Slouží k určení dostupných umístění, čtení je index 1 a zápis index 0. |
MetadataLookUpDiagnostic |
Tento typ obsahuje diagnostické informace týkající se jednoho požadavku na metadata na server. |
OfferDefinition | |
OperationBase | |
OperationResponse | |
PartitionKeyDefinition | |
PartitionKeyRangePropertiesNames | |
PatchOperationInput | |
PermissionBody | |
PermissionDefinition | |
ReadOperationInput | |
ReplaceOperationInput | |
RequestOptions |
Možnosti, které je možné zadat pro požadovaný server vydaný pro servery Azure Cosmos DB.= |
Resource | |
RetryOptions |
Představuje zásadu opakování s omezenými požadavky v databázové službě Azure Cosmos DB. |
SharedOptions |
Možnosti, které je možné zadat pro požadovaný server vydaný pro servery Azure Cosmos DB.= |
SpatialIndex | |
SqlParameter |
Představuje parametr v parametrizovaném dotazu SQL zadaném v SqlQuerySpec. |
SqlQuerySpec |
Představuje dotaz SQL ve službě Azure Cosmos DB. Dotazy se vstupy by měly být parametrizovány, aby byly chráněny před injektákem SQL. Příklad Parametrizovaný dotaz SQL
|
StoredProcedureDefinition | |
TriggerDefinition | |
UniqueKey |
Rozhraní pro jeden jedinečný klíč předaný jako součást UniqueKeyPolicy |
UniqueKeyPolicy |
Rozhraní pro nastavení jedinečných klíčů při vytváření kontejneru |
UpsertOperationInput | |
UserDefinedFunctionDefinition | |
UserDefinition |
Aliasy typu
AggregateType | |
BulkOperationResponse | |
BulkPatchOperation | |
ClientConfigDiagnostic |
Tento typ obsahuje informace související s inicializací |
ClientSideRequestStatistics |
Toto je typ kolekce pro všechny diagnostické informace na straně klienta. |
CreateOperation | |
DeleteOperation | |
ExistingKeyOperation | |
GatewayStatistics | |
GroupByExpressions | |
JSONValue | |
MetadataLookUpDiagnostics |
Tento typ obsahuje diagnostické informace týkající se všech požadavků na metadata na server během operace klienta CosmosDB. |
NonePartitionKeyType |
Vrácený objekt představuje hodnotu klíče oddílu, která umožňuje vytváření a přístup k položkám bez hodnoty klíče oddílu. |
NullPartitionKeyType |
Vrácený objekt představuje hodnotu klíče oddílu, která umožňuje vytváření a přístup k položkám s hodnotou null pro klíč oddílu. |
Operation | |
OperationInput | |
OperationWithItem | |
PartitionKey |
PartitionKey kontejneru. |
PatchOperation | |
PatchRequestBody | |
PrimitivePartitionKeyValue |
Primitivní hodnota klíče oddílu. |
ReadOperation | |
RemoveOperation | |
ReplaceOperation | |
RetryDiagnostics |
Tento typ zaznamenává diagnostické informace týkající se pokusů o opakování během operace klienta CosmosDB. |
TokenProvider | |
UpsertOperation |
Výčty
ConflictResolutionMode | |
ConnectionMode |
Určuje chování připojení CosmosClient. Poznámka: V současné době podporujeme pouze režim brány. |
ConsistencyLevel |
Představuje úrovně konzistence podporované pro operace klienta Služby Azure Cosmos DB. Úrovně konzistence podle síly jsou Silná, Ohraničená instalace, Relace, Konzistentní předpona a Případná. Podrobnější dokumentaci k úrovním konzistence najdete https://aka.ms/cosmos-consistency v tématu . |
CosmosDbDiagnosticLevel |
Úroveň diagnostiky služby Cosmos DB |
DataType |
Definuje cílový datový typ specifikace cesty indexu ve službě Azure Cosmos DB. |
GeospatialType | |
IndexKind |
Určuje podporované typy indexů. |
IndexingMode |
Určuje podporované režimy indexování. |
MetadataLookUpType |
Jedná se o výčet možných typů vyhledávání metadat. |
PartitionKeyDefinitionVersion |
Verze definice PartitionKey |
PartitionKeyKind |
Typ PartitionKey, tj. hash, MultiHash |
PermissionMode |
Výčet hodnot režimu oprávnění |
PriorityLevel |
Představuje úroveň priority přidruženou ke každému požadavku klienta služby Azure Cosmos DB. Ve výchozím nastavení se všechny požadavky považují za požadavky s vysokou prioritou. Podrobnější dokumentaci k omezování na základě priority najdete https://aka.ms/CosmosDB/PriorityBasedExecution v tématu . |
SpatialType | |
TriggerOperation |
Výčet hodnot aktivačních operací určuje operace, při kterých se má trigger spustit. |
TriggerType |
Výčet pro hodnoty typu triggeru Určuje typ triggeru. |
UserDefinedFunctionType |
Výčet pro hodnoty typu udf Určuje typy uživatelem definovaných funkcí. |
Funkce
create |
Experimentální interní vygeneruje pouze datovou část představující konfiguraci oprávnění pro token SAS. |
Podrobnosti funkce
createAuthorizationSasToken(string, SasTokenProperties)
Experimentální interní vygeneruje pouze datovou část představující konfiguraci oprávnění pro token SAS.
function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>
Parametry
- masterKey
-
string
- sasTokenProperties
- SasTokenProperties
Návraty
Promise<string>