UserDefinedFunctions class

  • Référence
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 par id.

Propriétés

container

Méthodes

create(UserDefinedFunctionDefinition, RequestOptions)

Créez un UserDefinedFunction.

Azure Cosmos DB prend en charge les fonctions UDF JavaScript qui peuvent être utilisées dans les requêtes, les procédures stockées et les déclencheurs.

Pour plus d’informations, consultez la documentation de l’API JavaScript côté serveur.
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.
readAll(FeedOptions)

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

Exemple

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

const {body: udfList} = await container.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 UDF JavaScript qui peuvent être utilisées dans les requêtes, les procédures stockées et les déclencheurs.

Pour plus d’informations, consultez la documentation de l’API JavaScript côté serveur.

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.

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

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

const {body: udfList} = await container.userDefinedFunctions.readAll().fetchAll();

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

Paramètres

options
FeedOptions

Retours

QueryIterator<UserDefinedFunctionDefinition & Resource>