Dela via

Databases class

Paket:
@azure/cosmos

Åtgärder för att skapa nya databaser och läsa/köra frågor mot alla databaser

Se Database för att läsa eller ta bort en befintlig databas. använd client.database(id).

Obs! Alla dessa åtgärder anropar en fast budget. Du bör utforma systemet så att dessa anrop skalas sublinearly med ditt program. Anropa till exempel inte databases.readAll() före varje enskilt item.read()-anrop för att säkerställa att databasen finns. gör detta en gång när programmet startas.

Egenskaper

client

Metoder

create(DatabaseRequest, RequestOptions)

Skicka en begäran om att skapa en databas.

En databas hanterar användare, behörigheter och en uppsättning containrar. Varje Azure Cosmos DB-databaskonto har stöd för flera oberoende namngivna databaser, där databasen är den logiska containern för data.

Varje databas består av en eller flera containrar som var och en i sin tur innehåller ett eller flera dokument. Eftersom databaser är en administrativ resurs krävs tjänsthuvudnyckeln för att få åtkomst till och slutföra alla åtgärder med hjälp av användar-API:erna.

Exempel

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)

Kontrollera om det finns en databas och skapa den om den inte finns. Detta gör en läsåtgärd baserat på ID:t i body, och om det inte hittas, en skapandeåtgärd.

En databas hanterar användare, behörigheter och en uppsättning containrar. Varje Azure Cosmos DB-databaskonto har stöd för flera oberoende namngivna databaser, där databasen är den logiska containern för data.

Varje databas består av en eller flera containrar som var och en i sin tur innehåller ett eller flera dokument. Eftersom databaser är en administrativ resurs krävs tjänsthuvudnyckeln för att få åtkomst till och slutföra alla åtgärder med hjälp av användar-API:erna.

Exempel

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)

Kör frågor mot alla databaser.

Exempel

Läs alla databaser till matrisen.

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)

Kör frågor mot alla databaser.

Exempel

Läs alla databaser till matrisen.

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)

Läser alla databaser.

Exempel

Läs alla databaser till matrisen.

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();

Egenskapsinformation

client 

client: CosmosClient

Egenskapsvärde

CosmosClient

Metodinformation

create(DatabaseRequest, RequestOptions)

Skicka en begäran om att skapa en databas.

En databas hanterar användare, behörigheter och en uppsättning containrar. Varje Azure Cosmos DB-databaskonto har stöd för flera oberoende namngivna databaser, där databasen är den logiska containern för data.

Varje databas består av en eller flera containrar som var och en i sin tur innehåller ett eller flera dokument. Eftersom databaser är en administrativ resurs krävs tjänsthuvudnyckeln för att få åtkomst till och slutföra alla åtgärder med hjälp av användar-API:erna.

Exempel

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>

Parametrar

body
DatabaseRequest

DatabaseDefinition som representerar Database som ska skapas.

options
RequestOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

Promise<DatabaseResponse>

createIfNotExists(DatabaseRequest, RequestOptions)

Kontrollera om det finns en databas och skapa den om den inte finns. Detta gör en läsåtgärd baserat på ID:t i body, och om det inte hittas, en skapandeåtgärd.

En databas hanterar användare, behörigheter och en uppsättning containrar. Varje Azure Cosmos DB-databaskonto har stöd för flera oberoende namngivna databaser, där databasen är den logiska containern för data.

Varje databas består av en eller flera containrar som var och en i sin tur innehåller ett eller flera dokument. Eftersom databaser är en administrativ resurs krävs tjänsthuvudnyckeln för att få åtkomst till och slutföra alla åtgärder med hjälp av användar-API:erna.

Exempel

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>

Parametrar

body
DatabaseRequest

DatabaseDefinition som representerar Database som ska skapas.

options
RequestOptions

Ytterligare alternativ för begäran

Returer

Promise<DatabaseResponse>

query(string | SqlQuerySpec, FeedOptions)

Kör frågor mot alla databaser.

Exempel

Läs alla databaser till matrisen.

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>

Parametrar

query

string | SqlQuerySpec

Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec.

options
FeedOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

QueryIterator<any>

QueryIterator Gör att du kan returnera alla databaser i en matris eller iterera över dem en i taget.

query<T>(string | SqlQuerySpec, FeedOptions)

Kör frågor mot alla databaser.

Exempel

Läs alla databaser till matrisen.

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>

Parametrar

query

string | SqlQuerySpec

Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec.

options
FeedOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

QueryIterator<T>

QueryIterator Gör att du kan returnera alla databaser i en matris eller iterera över dem en i taget.

readAll(FeedOptions)

Läser alla databaser.

Exempel

Läs alla databaser till matrisen.

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>

Parametrar

options
FeedOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

QueryIterator<DatabaseDefinition & Resource>

QueryIterator Gör att du kan returnera alla databaser i en matris eller iterera över dem en i taget.