Condividi tramite

UserDefinedFunctions class

Pacchetto:
@azure/cosmos

Usato per creare, upsert, eseguire query o leggere tutte le funzioni definite dall'utente.

Vedere UserDefinedFunction per leggere, sostituire o eliminare una determinata funzione definita dall'utente in base all'ID.

Proprietà

container

Metodi

create(UserDefinedFunctionDefinition, RequestOptions)

Creare un oggetto UserDefinedFunction.

Azure Cosmos DB supporta funzioni definite dall'utente JavaScript che possono essere usate all'interno di query, stored procedure e trigger.

Per altri dettagli, vedere la documentazione dell'API JavaScript sul lato server.

esempio di

import { CosmosClient, UserDefinedFunctionDefinition } 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 udfDefinition: UserDefinedFunctionDefinition = {
  id: "sample udf",
  body: "function () { const x = 10; }",
};

const { resource: udf } = await container.scripts.userDefinedFunctions.create(udfDefinition);
query(SqlQuerySpec, FeedOptions)

Eseguire una query su tutte le funzioni definite dall'utente.
query<T>(SqlQuerySpec, FeedOptions)

Eseguire una query su tutte le funzioni definite dall'utente.

esempio di

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 querySpec = {
  query: "SELECT * FROM root r WHERE r.id=@id",
  parameters: [
    {
      name: "@id",
      value: "<udf-id>",
    },
  ],
};
const { resources: results } = await container.scripts.userDefinedFunctions
  .query(querySpec)
  .fetchAll();
readAll(FeedOptions)

Leggere tutte le funzioni definite dall'utente.

esempio di

Leggere tutte le funzioni definite dall'utente nella matrice.

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: udfList } = await container.scripts.userDefinedFunctions.readAll().fetchAll();

Dettagli proprietà

container 

container: Container

Valore della proprietà

Container

Dettagli metodo

create(UserDefinedFunctionDefinition, RequestOptions)

Creare un oggetto UserDefinedFunction.

Azure Cosmos DB supporta funzioni definite dall'utente JavaScript che possono essere usate all'interno di query, stored procedure e trigger.

Per altri dettagli, vedere la documentazione dell'API JavaScript sul lato server.

esempio di

import { CosmosClient, UserDefinedFunctionDefinition } 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 udfDefinition: UserDefinedFunctionDefinition = {
  id: "sample udf",
  body: "function () { const x = 10; }",
};

const { resource: udf } = await container.scripts.userDefinedFunctions.create(udfDefinition);

function create(body: UserDefinedFunctionDefinition, options?: RequestOptions): Promise<UserDefinedFunctionResponse>

Parametri

body
UserDefinedFunctionDefinition
options
RequestOptions

Restituisce

Promise<UserDefinedFunctionResponse>

query(SqlQuerySpec, FeedOptions)

Eseguire una query su tutte le funzioni definite dall'utente.

function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Parametri

query
SqlQuerySpec

Configurazione della query per l'operazione. Per altre informazioni su come configurare una query, vedere SqlQuerySpec.

options
FeedOptions

Restituisce

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Eseguire una query su tutte le funzioni definite dall'utente.

esempio di

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 querySpec = {
  query: "SELECT * FROM root r WHERE r.id=@id",
  parameters: [
    {
      name: "@id",
      value: "<udf-id>",
    },
  ],
};
const { resources: results } = await container.scripts.userDefinedFunctions
  .query(querySpec)
  .fetchAll();

function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

Parametri

query
SqlQuerySpec

Configurazione della query per l'operazione. Per altre informazioni su come configurare una query, vedere SqlQuerySpec.

options
FeedOptions

Restituisce

QueryIterator<T>

readAll(FeedOptions)

Leggere tutte le funzioni definite dall'utente.

esempio di

Leggere tutte le funzioni definite dall'utente nella matrice.

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: udfList } = await container.scripts.userDefinedFunctions.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<UserDefinedFunctionDefinition & Resource>

Parametri

options
FeedOptions

Restituisce

QueryIterator<UserDefinedFunctionDefinition & Resource>