Compartilhar via

StoredProcedure class

Pacote:
@azure/cosmos

Operações para ler, substituir, excluir ou executar um procedimento armazenado específico e existente por ID.

Para operações para criar, ler tudo ou consultar procedimentos armazenados,

Propriedades

container
id
url

Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.

Métodos

delete(RequestOptions)

Exclua o StoredProceduredeterminado.

Exemplo

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)

Execute o StoredProcedureespecificado.

O tipo especificado, T, não é imposto pelo cliente. Certifique-se de validar a resposta do procedimento armazenado que corresponde ao tipo, T, que você fornece.

Exemplo

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)

Leia o StoredProcedureDefinition para o StoredProceduredeterminado.

Exemplo

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)

Substitua o StoredProcedure especificado pelo StoredProcedureDefinitionespecificado.

Exemplo

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

Detalhes da propriedade

container 

container: Container

Valor da propriedade

Container

id 

id: string

Valor da propriedade

string

url

Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.

string url

Valor da propriedade

string

Detalhes do método

delete(RequestOptions)

Exclua o StoredProceduredeterminado.

Exemplo

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>

Parâmetros

options
RequestOptions

Retornos

Promise<StoredProcedureResponse>

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

Execute o StoredProcedureespecificado.

O tipo especificado, T, não é imposto pelo cliente. Certifique-se de validar a resposta do procedimento armazenado que corresponde ao tipo, T, que você fornece.

Exemplo

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

Parâmetros

partitionKey
PartitionKey

A chave de partição a ser usada ao executar o procedimento armazenado

params

any[]

Matriz de parâmetros a serem passados como argumentos para o StoredProcedurefornecido.

options
RequestOptions

Opções adicionais, como a chave de partição para invocar o StoredProcedure. *

Retornos

Promise<ResourceResponse<T>>

read(RequestOptions)

Leia o StoredProcedureDefinition para o StoredProceduredeterminado.

Exemplo

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>

Parâmetros

options
RequestOptions

Retornos

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

Substitua o StoredProcedure especificado pelo StoredProcedureDefinitionespecificado.

Exemplo

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>

Parâmetros

body
StoredProcedureDefinition

O StoredProcedureDefinition especificado para substituir a definição existente.

options
RequestOptions

Retornos

Promise<StoredProcedureResponse>