Delen via

StoredProcedure class

Pakket:
@azure/cosmos

Bewerkingen voor het lezen, vervangen, verwijderen of uitvoeren van een specifieke, bestaande opgeslagen procedure op id.

Voor bewerkingen om opgeslagen procedures te maken, lezen of opgeslagen procedures op te vragen,

Eigenschappen

container
id
url

Retourneert een referentie-URL naar de resource. Wordt gebruikt voor het koppelen in machtigingen.

Methoden

delete(RequestOptions)

Verwijder de opgegeven StoredProcedure.

Voorbeeld

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

await container.scripts.storedProcedure("<sproc-id>").delete();
execute<T>(PartitionKey, any[], RequestOptions)

Voer de opgegeven StoredProcedureuit.

Het opgegeven type, T, wordt niet afgedwongen door de client. Controleer of het antwoord van de opgeslagen procedure overeenkomt met het type, T, dat u opgeeft.

Voorbeeld

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 { resource: result } = await container.scripts
  .storedProcedure("<sproc-id>")
  .execute(undefined);
read(RequestOptions)

Lees de StoredProcedureDefinition voor de gegeven StoredProcedure.

Voorbeeld

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 { resource: sproc } = await container.scripts.storedProcedure("<sproc-id>").read();
replace(StoredProcedureDefinition, RequestOptions)

Vervang de opgegeven StoredProcedure door de opgegeven StoredProcedureDefinition.

Voorbeeld

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

sproc.body = function () {
  const x = 20;
  console.log(x);
};
const { resource: replacedSproc } = await container.scripts
  .storedProcedure(sproc.id)
  .replace(sproc);

Eigenschapdetails

container 

container: Container

Waarde van eigenschap

Container

id 

id: string

Waarde van eigenschap

string

url

Retourneert een referentie-URL naar de resource. Wordt gebruikt voor het koppelen in machtigingen.

string url

Waarde van eigenschap

string

Methodedetails

delete(RequestOptions)

Verwijder de opgegeven StoredProcedure.

Voorbeeld

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

await container.scripts.storedProcedure("<sproc-id>").delete();

function delete(options?: RequestOptions): Promise<StoredProcedureResponse>

Parameters

options
RequestOptions

Retouren

Promise<StoredProcedureResponse>

execute<T>(PartitionKey, any[], RequestOptions)

Voer de opgegeven StoredProcedureuit.

Het opgegeven type, T, wordt niet afgedwongen door de client. Controleer of het antwoord van de opgeslagen procedure overeenkomt met het type, T, dat u opgeeft.

Voorbeeld

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 { resource: result } = await container.scripts
  .storedProcedure("<sproc-id>")
  .execute(undefined);

function execute<T>(partitionKey: PartitionKey, params?: any[], options?: RequestOptions): Promise<ResourceResponse<T>>

Parameters

partitionKey
PartitionKey

De partitiesleutel die moet worden gebruikt bij het uitvoeren van de opgeslagen procedure

params

any[]

Matrix van parameters die als argumenten moeten worden doorgegeven aan de opgegeven StoredProcedure.

options
RequestOptions

Aanvullende opties, zoals de partitiesleutel om de StoredProcedure aan te roepen. *

Retouren

Promise<ResourceResponse<T>>

read(RequestOptions)

Lees de StoredProcedureDefinition voor de gegeven StoredProcedure.

Voorbeeld

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 { resource: sproc } = await container.scripts.storedProcedure("<sproc-id>").read();

function read(options?: RequestOptions): Promise<StoredProcedureResponse>

Parameters

options
RequestOptions

Retouren

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

Vervang de opgegeven StoredProcedure door de opgegeven StoredProcedureDefinition.

Voorbeeld

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

sproc.body = function () {
  const x = 20;
  console.log(x);
};
const { resource: replacedSproc } = await container.scripts
  .storedProcedure(sproc.id)
  .replace(sproc);

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

Parameters

body
StoredProcedureDefinition

De opgegeven StoredProcedureDefinition om de bestaande definitie te vervangen.

options
RequestOptions

Retouren

Promise<StoredProcedureResponse>