CosmosClient class
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
const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});
Příklad
Vytvoření instance klienta pomocí vlastních zásad připojení
const client = new CosmosClient({
endpoint: "<URL HERE>",
key: "<KEY HERE>",
connectionPolicy: {
requestTimeout: 10000,
},
});
Konstruktory
| Cosmos |
Vytvoří nový objekt CosmosClient . Další podrobnosti o možnostech, které můžete použít, najdete v tématu CosmosClientOptions . |
| Cosmos |
Vytvoří nový objekt CosmosClient z připojovací řetězec. Připojovací řetězec databáze najdete na webu Azure Portal. |
Vlastnosti
| databases | Používá se k vytváření nových databází nebo dotazování/čtení všech databází. Slouží Příklad Vytvoření nové databáze |
| offers | Používá se k dotazování & čtení všech nabídek. Slouží |
Metody
| database(string) | Používá se ke čtení, aktualizaci nebo odstraňování existující databáze podle ID nebo přístupu ke kontejnerům patřícím do této databáze. Tím nedojde k volání do sítě. Slouží Příklad Vytvoření nového kontejneru z existující databáze Příklad Odstranění existující databáze |
| dispose() | Vymaže aktualizaci koncového bodu na pozadí. Při ničení CosmosClient v rámci jiného procesu použijte client.dispose(). |
| get |
Získání informací o aktuálním databázovém účtu (včetně podporovaných oblastí atd.) |
| get |
Získá aktuálně používaný koncový bod pro čtení. Užitečné pro účely řešení potíží. Pokud používáme koncové body specifické pro umístění, může adresa URL obsahovat příponu oblasti (např. -eastus). |
| get |
Získá aktuálně používaný koncový bod pro čtení. Užitečné pro účely řešení potíží. Pokud používáme koncové body specifické pro umístění, může adresa URL obsahovat příponu oblasti (např. -eastus). |
| get |
Získá aktuálně používanou adresu URL koncového bodu zápisu. Užitečné pro účely řešení potíží. Pokud používáme koncové body specifické pro umístění, může adresa URL obsahovat příponu oblasti (např. "-eastus"). |
| get |
Získá známé koncové body zápisu. Užitečné pro účely řešení potíží. Pokud používáme koncové body specifické pro umístění, můžou adresy URL obsahovat příponu oblasti (např. "-eastus"). |
| offer(string) | Používá se ke čtení nebo aktualizaci existující nabídky podle ID. |
Podrobnosti konstruktoru
CosmosClient(CosmosClientOptions)
Vytvoří nový objekt CosmosClient . Další podrobnosti o možnostech, které můžete použít, najdete v tématu CosmosClientOptions .
new CosmosClient(options: CosmosClientOptions)Parametry
- options
- CosmosClientOptions
pytel možností; vyžadování konfigurace alespoň koncového bodu a ověřování
CosmosClient(string)
Vytvoří nový objekt CosmosClient z připojovací řetězec. Připojovací řetězec databáze najdete na webu Azure Portal.
new CosmosClient(connectionString: string)Parametry
- connectionString
-
string
Podrobnosti vlastnosti
databases
Používá se k vytváření nových databází nebo dotazování/čtení všech databází.
Slouží .database(id) ke čtení, nahrazení nebo odstranění konkrétní existující databáze pomocí ID.
Příklad
Vytvoření nové databáze
const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
databases: DatabasesHodnota vlastnosti
offers
Používá se k dotazování & čtení všech nabídek.
Slouží .offer(id) ke čtení nebo nahrazení existujících nabídek.
offers: OffersHodnota vlastnosti
Podrobnosti metody
database(string)
Používá se ke čtení, aktualizaci nebo odstraňování existující databáze podle ID nebo přístupu ke kontejnerům patřícím do této databáze.
Tím nedojde k volání do sítě. Slouží .read k získání informací o databázi po získání databázového objektu.
Příklad
Vytvoření nového kontejneru z existující databáze
const container = client.database("<database id>").containers.create("<container id>");
Příklad
Odstranění existující databáze
await client.database("<id here>").delete();
function database(id: string): DatabaseParametry
- id
-
string
ID databáze.
Návraty
dispose()
Vymaže aktualizaci koncového bodu na pozadí. Při ničení CosmosClient v rámci jiného procesu použijte client.dispose().
function dispose()
getDatabaseAccount(RequestOptions)
Získání informací o aktuálním databázovém účtu (včetně podporovaných oblastí atd.)
function getDatabaseAccount(options?: RequestOptions): Promise<ResourceResponse<DatabaseAccount>>Parametry
- options
- RequestOptions
Návraty
Promise<ResourceResponse<DatabaseAccount>>
getReadEndpoint()
Získá aktuálně používaný koncový bod pro čtení. Užitečné pro účely řešení potíží.
Pokud používáme koncové body specifické pro umístění, může adresa URL obsahovat příponu oblasti (např. -eastus).
function getReadEndpoint(): Promise<string>Návraty
Promise<string>
getReadEndpoints()
Získá aktuálně používaný koncový bod pro čtení. Užitečné pro účely řešení potíží.
Pokud používáme koncové body specifické pro umístění, může adresa URL obsahovat příponu oblasti (např. -eastus).
function getReadEndpoints(): Promise<readonly string[]>Návraty
Promise<readonly string[]>
getWriteEndpoint()
Získá aktuálně používanou adresu URL koncového bodu zápisu. Užitečné pro účely řešení potíží.
Pokud používáme koncové body specifické pro umístění, může adresa URL obsahovat příponu oblasti (např. "-eastus").
function getWriteEndpoint(): Promise<string>Návraty
Promise<string>
getWriteEndpoints()
Získá známé koncové body zápisu. Užitečné pro účely řešení potíží.
Pokud používáme koncové body specifické pro umístění, můžou adresy URL obsahovat příponu oblasti (např. "-eastus").
function getWriteEndpoints(): Promise<readonly string[]>Návraty
Promise<readonly string[]>
offer(string)
Používá se ke čtení nebo aktualizaci existující nabídky podle ID.
function offer(id: string): OfferParametry
- id
-
string
ID nabídky.