Sdílet prostřednictvím

Databases class

Balíček:
@azure/cosmos

Operace pro vytváření nových databází a čtení a dotazování všech databází

Informace o čtení nebo odstranění existující databáze najdete v tématu Databáze; použít client.database(id).

Poznámka: Všechny tyto operace vyžadují pevné rozpočty. Systém byste měli navrhnout tak, aby tato volání škálovat podlineárně s vaší aplikací. Například nevolejte databases.readAll() před každým voláním item.read(), aby se zajistilo, že databáze existuje; proveďte to jednou při spuštění aplikace.

Vlastnosti

client

Metody

create(DatabaseRequest, RequestOptions)

Odešlete žádost o vytvoření databáze.

Databáze spravuje uživatele, oprávnění a sadu kontejnerů. Každý účet databáze Azure Cosmos DB může podporovat více nezávislých pojmenovaných databází, přičemž databáze je logický kontejner pro data.

Každá databáze se skládá z jednoho nebo více kontejnerů, z nichž každá zase obsahuje jeden nebo více dokumentů. Vzhledem k tomu, že databáze jsou prostředkem pro správu, bude hlavní klíč služby nutný pro přístup k uživatelským rozhraním API a úspěšné dokončení jakékoli akce.

příklad 

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { resource: databaseDefinition, database } = await client.databases.create({
  id: "<name here>",
});
createIfNotExists(DatabaseRequest, RequestOptions)

Zkontrolujte, jestli databáze existuje, a pokud ne, vytvořte ji. Tím se provede operace čtení na základě ID v body, a pokud se nenajde, operace vytvoření.

Databáze spravuje uživatele, oprávnění a sadu kontejnerů. Každý účet databáze Azure Cosmos DB může podporovat více nezávislých pojmenovaných databází, přičemž databáze je logický kontejner pro data.

Každá databáze se skládá z jednoho nebo více kontejnerů, z nichž každá zase obsahuje jeden nebo více dokumentů. Vzhledem k tomu, že databáze jsou prostředkem pro správu, bude hlavní klíč služby nutný pro přístup k uživatelským rozhraním API a úspěšné dokončení jakékoli akce.

příklad 

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
query(string | SqlQuerySpec, FeedOptions)

Dotazuje všechny databáze.

příklad

Čtení všech databází do pole

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @database`,
  parameters: [{ name: "@database", value: "Todo" }],
};
const { resources: databaseList } = await client.databases.query(querySpec).fetchAll();
query<T>(string | SqlQuerySpec, FeedOptions)

Dotazuje všechny databáze.

příklad

Čtení všech databází do pole

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @database`,
  parameters: [{ name: "@database", value: "Todo" }],
};
const { resources: databaseList } = await client.databases.query(querySpec).fetchAll();
readAll(FeedOptions)

Přečte všechny databáze.

příklad

Čtení všech databází do pole

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { resources: databaseList } = await client.databases.readAll().fetchAll();

Podrobnosti vlastnosti

client 

client: CosmosClient

Hodnota vlastnosti

CosmosClient

Podrobnosti metody

create(DatabaseRequest, RequestOptions)

Odešlete žádost o vytvoření databáze.

Databáze spravuje uživatele, oprávnění a sadu kontejnerů. Každý účet databáze Azure Cosmos DB může podporovat více nezávislých pojmenovaných databází, přičemž databáze je logický kontejner pro data.

Každá databáze se skládá z jednoho nebo více kontejnerů, z nichž každá zase obsahuje jeden nebo více dokumentů. Vzhledem k tomu, že databáze jsou prostředkem pro správu, bude hlavní klíč služby nutný pro přístup k uživatelským rozhraním API a úspěšné dokončení jakékoli akce.

příklad 

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { resource: databaseDefinition, database } = await client.databases.create({
  id: "<name here>",
});

function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

Parametry

body
DatabaseRequest

DatabaseDefinition, která představuje databáze, která se má vytvořit.

options
RequestOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, tokeny pokračování atd.

Návraty

Promise<DatabaseResponse>

createIfNotExists(DatabaseRequest, RequestOptions)

Zkontrolujte, jestli databáze existuje, a pokud ne, vytvořte ji. Tím se provede operace čtení na základě ID v body, a pokud se nenajde, operace vytvoření.

Databáze spravuje uživatele, oprávnění a sadu kontejnerů. Každý účet databáze Azure Cosmos DB může podporovat více nezávislých pojmenovaných databází, přičemž databáze je logický kontejner pro data.

Každá databáze se skládá z jednoho nebo více kontejnerů, z nichž každá zase obsahuje jeden nebo více dokumentů. Vzhledem k tomu, že databáze jsou prostředkem pro správu, bude hlavní klíč služby nutný pro přístup k uživatelským rozhraním API a úspěšné dokončení jakékoli akce.

příklad 

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

Parametry

body
DatabaseRequest

DatabaseDefinition, která představuje databáze, která se má vytvořit.

options
RequestOptions

Další možnosti požadavku

Návraty

Promise<DatabaseResponse>

query(string | SqlQuerySpec, FeedOptions)

Dotazuje všechny databáze.

příklad

Čtení všech databází do pole

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @database`,
  parameters: [{ name: "@database", value: "Todo" }],
};
const { resources: databaseList } = await client.databases.query(querySpec).fetchAll();

function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Parametry

query

string | SqlQuerySpec

Konfigurace dotazu pro operaci. Další informace o konfiguraci dotazu najdete v tématu sqlQuerySpec.

options
FeedOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, tokeny pokračování atd.

Návraty

QueryIterator<any>

QueryIterator Umožňuje vrátit všechny databáze v poli nebo je iterovat po jednom.

query<T>(string | SqlQuerySpec, FeedOptions)

Dotazuje všechny databáze.

příklad

Čtení všech databází do pole

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @database`,
  parameters: [{ name: "@database", value: "Todo" }],
};
const { resources: databaseList } = await client.databases.query(querySpec).fetchAll();

function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

Parametry

query

string | SqlQuerySpec

Konfigurace dotazu pro operaci. Další informace o konfiguraci dotazu najdete v tématu sqlQuerySpec.

options
FeedOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, tokeny pokračování atd.

Návraty

QueryIterator<T>

QueryIterator Umožňuje vrátit všechny databáze v poli nebo je iterovat po jednom.

readAll(FeedOptions)

Přečte všechny databáze.

příklad

Čtení všech databází do pole

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { resources: databaseList } = await client.databases.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<DatabaseDefinition & Resource>

Parametry

options
FeedOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, tokeny pokračování atd.

Návraty

QueryIterator<DatabaseDefinition & Resource>

QueryIterator Umožňuje vrátit všechny databáze v poli nebo je iterovat po jednom.