Partager via

StoredProcedure class

Paquet:
@azure/cosmos

Opérations de lecture, de remplacement, de suppression ou d’exécution d’une procédure stockée existante spécifique par ID.

Pour que les opérations créent, lisent toutes ou interrogent des procédures stockées,

Propriétés

container
id
url

Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.

Méthodes

delete(RequestOptions)

Supprimez la stockée stockéedonnée.

Exemple

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)

Exécutez le storedProceduredonné.

Le type spécifié, T, n’est pas appliqué par le client. Veillez à valider la réponse de la procédure stockée correspond au type, T, que vous fournissez.

Exemple

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)

Lisez le storedProcedureDefinition pour le StoredProceduredonné.

Exemple

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)

Remplacez le StoredProcedure spécifié par le StoredProcedureDefinition spécifié.

Exemple

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

Détails de la propriété

container 

container: Container

Valeur de propriété

Container

id 

id: string

Valeur de propriété

string

url

Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.

string url

Valeur de propriété

string

Détails de la méthode

delete(RequestOptions)

Supprimez la stockée stockéedonnée.

Exemple

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>

Paramètres

options
RequestOptions

Retours

Promise<StoredProcedureResponse>

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

Exécutez le storedProceduredonné.

Le type spécifié, T, n’est pas appliqué par le client. Veillez à valider la réponse de la procédure stockée correspond au type, T, que vous fournissez.

Exemple

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

Paramètres

partitionKey
PartitionKey

Clé de partition à utiliser lors de l’exécution de la procédure stockée

params

any[]

Tableau de paramètres à passer en tant qu’arguments au StoredProcedure donné.

options
RequestOptions

Options supplémentaires, telles que la clé de partition sur laquelle appeler le StoredProcedure activé. *

Retours

Promise<ResourceResponse<T>>

read(RequestOptions)

Lisez le storedProcedureDefinition pour le StoredProceduredonné.

Exemple

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>

Paramètres

options
RequestOptions

Retours

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

Remplacez le StoredProcedure spécifié par le StoredProcedureDefinition spécifié.

Exemple

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>

Paramètres

body
StoredProcedureDefinition

L'StoredProcedureDefinition spécifié pour remplacer la définition existante.

options
RequestOptions

Retours

Promise<StoredProcedureResponse>