Compartilhar via

StoredProcedures class

Pacote:
@azure/cosmos

Operações para criação, upserting ou leitura/consulta de todos os procedimentos armazenados.

Para que as operações leiam, substituam, excluam ou executem um procedimento armazenado específico e existente por ID, consulte container.storedProcedure().

Propriedades

container

Métodos

create(StoredProcedureDefinition, RequestOptions)

Crie um StoredProcedure.

O Azure Cosmos DB permite que os procedimentos armazenados sejam executados na camada de armazenamento, diretamente em um contêiner de item. O script é executado em transações ACID na partição de armazenamento primário do contêiner especificado. Para obter detalhes adicionais, consulte a documentação da API JavaScript do lado do servidor.

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);
query(SqlQuerySpec, FeedOptions)

Consultar todos os procedimentos armazenados.

exemplo

Leia todos os procedimentos armazenados na matriz.

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)

Consultar todos os procedimentos armazenados.

exemplo

Leia todos os procedimentos armazenados na matriz.

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)

Leia todos os procedimentos armazenados.

exemplo

Leia todos os procedimentos armazenados na matriz.

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

Detalhes da propriedade

container 

container: Container

Valor da propriedade

Container

Detalhes do método

create(StoredProcedureDefinition, RequestOptions)

Crie um StoredProcedure.

O Azure Cosmos DB permite que os procedimentos armazenados sejam executados na camada de armazenamento, diretamente em um contêiner de item. O script é executado em transações ACID na partição de armazenamento primário do contêiner especificado. Para obter detalhes adicionais, consulte a documentação da API JavaScript do lado do servidor.

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

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

Parâmetros

body
StoredProcedureDefinition
options
RequestOptions

Retornos

Promise<StoredProcedureResponse>

query(SqlQuerySpec, FeedOptions)

Consultar todos os procedimentos armazenados.

exemplo

Leia todos os procedimentos armazenados na matriz.

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>

Parâmetros

query
SqlQuerySpec

Configuração de consulta para a operação. Consulte sqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options
FeedOptions

Retornos

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Consultar todos os procedimentos armazenados.

exemplo

Leia todos os procedimentos armazenados na matriz.

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>

Parâmetros

query
SqlQuerySpec

Configuração de consulta para a operação. Consulte sqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options
FeedOptions

Retornos

QueryIterator<T>

readAll(FeedOptions)

Leia todos os procedimentos armazenados.

exemplo

Leia todos os procedimentos armazenados na matriz.

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>

Parâmetros

options
FeedOptions

Retornos

QueryIterator<StoredProcedureDefinition & Resource>