Freigeben über

StoredProcedures class

Paket:
@azure/cosmos

Vorgänge zum Erstellen, Upserting oder Lesen/Abfragen aller gespeicherten Prozeduren.

Informationen zum Lesen, Ersetzen, Löschen oder Ausführen einer bestimmten, vorhandenen gespeicherten Prozedur anhand der ID finden Sie unter container.storedProcedure().

Eigenschaften

container

Methoden

create(StoredProcedureDefinition, RequestOptions)

Erstellen Sie eine storedProcedure.

Azure Cosmos DB ermöglicht es gespeicherten Prozeduren, direkt für einen Elementcontainer in der Speicherebene auszuführen. Das Skript wird unter ACID-Transaktionen auf der primären Speicherpartition des angegebenen Containers ausgeführt. Weitere Informationen finden Sie in der serverseitigen JavaScript-API-Dokumentation.

Beispiel

import { CosmosClient, StoredProcedureDefinition } 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" });
const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const sprocDefinition: StoredProcedureDefinition = {
  id: "sample sproc",
  body: "function () { const x = 10; }",
};

const { resource: sproc } = await container.scripts.storedProcedures.create(sprocDefinition);
query(SqlQuerySpec, FeedOptions)

Alle gespeicherten Prozeduren abfragen.

Beispiel

Alle gespeicherten Prozeduren in Array lesen.

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 { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @sproc`,
  parameters: [{ name: "@sproc", value: "Todo" }],
};
const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .query(querySpec)
  .fetchAll();
query<T>(SqlQuerySpec, FeedOptions)

Alle gespeicherten Prozeduren abfragen.

Beispiel

Alle gespeicherten Prozeduren in Array lesen.

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 { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @sproc`,
  parameters: [{ name: "@sproc", value: "Todo" }],
};
const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .query(querySpec)
  .fetchAll();
readAll(FeedOptions)

Alle gespeicherten Prozeduren lesen.

Beispiel

Alle gespeicherten Prozeduren in Array lesen.

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" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .readAll()
  .fetchAll();

Details zur Eigenschaft

container 

container: Container

Eigenschaftswert

Container

Details zur Methode

create(StoredProcedureDefinition, RequestOptions)

Erstellen Sie eine storedProcedure.

Azure Cosmos DB ermöglicht es gespeicherten Prozeduren, direkt für einen Elementcontainer in der Speicherebene auszuführen. Das Skript wird unter ACID-Transaktionen auf der primären Speicherpartition des angegebenen Containers ausgeführt. Weitere Informationen finden Sie in der serverseitigen JavaScript-API-Dokumentation.

Beispiel

import { CosmosClient, StoredProcedureDefinition } 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" });
const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const sprocDefinition: StoredProcedureDefinition = {
  id: "sample sproc",
  body: "function () { const x = 10; }",
};

const { resource: sproc } = await container.scripts.storedProcedures.create(sprocDefinition);

function create(body: StoredProcedureDefinition, options?: RequestOptions): Promise<StoredProcedureResponse>

Parameter

body
StoredProcedureDefinition
options
RequestOptions

Gibt zurück

Promise<StoredProcedureResponse>

query(SqlQuerySpec, FeedOptions)

Alle gespeicherten Prozeduren abfragen.

Beispiel

Alle gespeicherten Prozeduren in Array lesen.

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 { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @sproc`,
  parameters: [{ name: "@sproc", value: "Todo" }],
};
const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .query(querySpec)
  .fetchAll();

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

Parameter

query
SqlQuerySpec

Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec-.

options
FeedOptions

Gibt zurück

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Alle gespeicherten Prozeduren abfragen.

Beispiel

Alle gespeicherten Prozeduren in Array lesen.

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 { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @sproc`,
  parameters: [{ name: "@sproc", value: "Todo" }],
};
const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .query(querySpec)
  .fetchAll();

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

Parameter

query
SqlQuerySpec

Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec-.

options
FeedOptions

Gibt zurück

QueryIterator<T>

readAll(FeedOptions)

Alle gespeicherten Prozeduren lesen.

Beispiel

Alle gespeicherten Prozeduren in Array lesen.

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" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .readAll()
  .fetchAll();

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

Parameter

options
FeedOptions

Gibt zurück

QueryIterator<StoredProcedureDefinition & Resource>