Condividi tramite

StoredProcedure class

Pacchetto:
@azure/cosmos

Operazioni per la lettura, la sostituzione, l'eliminazione o l'esecuzione di una stored procedure specifica esistente in base all'ID.

Per le operazioni da creare, leggere tutte o eseguire query su stored procedure,

Proprietà

container
id
url

Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.

Metodi

delete(RequestOptions)

Eliminare il storedprocedure specificato.

Esempio

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)

Eseguire l'oggetto StoredProcedure specificato.

Il tipo specificato, T, non viene applicato dal client. Assicurarsi di convalidare la risposta dalla stored procedure corrispondente al tipo, T, specificato.

Esempio

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)

Leggere il StoredProcedureDefinition per il storedprocedure specificato.

Esempio

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)

Sostituire il StoredProcedure specificato con il StoredProcedureDefinition specificato.

Esempio

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

Dettagli proprietà

container 

container: Container

Valore della proprietà

Container

id 

id: string

Valore della proprietà

string

url

Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.

string url

Valore della proprietà

string

Dettagli metodo

delete(RequestOptions)

Eliminare il storedprocedure specificato.

Esempio

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>

Parametri

options
RequestOptions

Restituisce

Promise<StoredProcedureResponse>

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

Eseguire l'oggetto StoredProcedure specificato.

Il tipo specificato, T, non viene applicato dal client. Assicurarsi di convalidare la risposta dalla stored procedure corrispondente al tipo, T, specificato.

Esempio

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

Parametri

partitionKey
PartitionKey

Chiave di partizione da usare durante l'esecuzione della stored procedure

params

any[]

Matrice di parametri da passare come argomenti all'StoredProcedure specificata.

options
RequestOptions

Opzioni aggiuntive, ad esempio la chiave di partizione per richiamare il storedprocedure. *

Restituisce

Promise<ResourceResponse<T>>

read(RequestOptions)

Leggere il StoredProcedureDefinition per il storedprocedure specificato.

Esempio

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>

Parametri

options
RequestOptions

Restituisce

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

Sostituire il StoredProcedure specificato con il StoredProcedureDefinition specificato.

Esempio

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>

Parametri

body
StoredProcedureDefinition

L'StoredProcedureDefinition specificato per sostituire la definizione esistente.

options
RequestOptions

Restituisce

Promise<StoredProcedureResponse>