Partager via

UserDefinedFunctions class

Paquet:
@azure/cosmos

Utilisé pour créer, upsert, interroger ou lire toutes les fonctions définies par l’utilisateur.

Consultez UserDefinedFunction pour lire, remplacer ou supprimer une fonction définie par l’utilisateur donnée par ID.

Propriétés

container

Méthodes

create(UserDefinedFunctionDefinition, RequestOptions)

Créez un UserDefinedFunction.

Azure Cosmos DB prend en charge les fonctions définies par l’utilisateur JavaScript qui peuvent être utilisées dans des requêtes, des procédures stockées et des déclencheurs.

Pour plus d’informations, reportez-vous à la documentation de l’API JavaScript côté serveur.

exemple de 

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)

Interrogez toutes les fonctions définies par l’utilisateur.
query<T>(SqlQuerySpec, FeedOptions)

Interrogez toutes les fonctions définies par l’utilisateur.

exemple de 

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)

Lisez toutes les fonctions définies par l’utilisateur.

exemple de

Lisez toutes les fonctions définies par l’utilisateur dans le tableau.

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

Détails de la propriété

container 

container: Container

Valeur de propriété

Container

Détails de la méthode

create(UserDefinedFunctionDefinition, RequestOptions)

Créez un UserDefinedFunction.

Azure Cosmos DB prend en charge les fonctions définies par l’utilisateur JavaScript qui peuvent être utilisées dans des requêtes, des procédures stockées et des déclencheurs.

Pour plus d’informations, reportez-vous à la documentation de l’API JavaScript côté serveur.

exemple de 

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>

Paramètres

body
UserDefinedFunctionDefinition
options
RequestOptions

Retours

Promise<UserDefinedFunctionResponse>

query(SqlQuerySpec, FeedOptions)

Interrogez toutes les fonctions définies par l’utilisateur.

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

Paramètres

query
SqlQuerySpec

Configuration de requête pour l’opération. Pour plus d’informations sur la configuration d’une requête, consultez SqlQuerySpec.

options
FeedOptions

Retours

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Interrogez toutes les fonctions définies par l’utilisateur.

exemple de 

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>

Paramètres

query
SqlQuerySpec

Configuration de requête pour l’opération. Pour plus d’informations sur la configuration d’une requête, consultez SqlQuerySpec.

options
FeedOptions

Retours

QueryIterator<T>

readAll(FeedOptions)

Lisez toutes les fonctions définies par l’utilisateur.

exemple de

Lisez toutes les fonctions définies par l’utilisateur dans le tableau.

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>

Paramètres

options
FeedOptions

Retours

QueryIterator<UserDefinedFunctionDefinition & Resource>