Freigeben über

UserDefinedFunctions class

Paket:
@azure/cosmos

Wird zum Erstellen, Upsert, Abfragen oder Lesen aller benutzerdefinierten Funktionen verwendet.

Siehe UserDefinedFunction-, um eine bestimmte benutzerdefinierte Funktion anhand der ID zu lesen, zu ersetzen oder zu löschen.

Eigenschaften

container

Methoden

create(UserDefinedFunctionDefinition, RequestOptions)

Erstellen Sie eine UserDefinedFunction.

Azure Cosmos DB unterstützt JavaScript-UDFs, die in Abfragen, gespeicherten Prozeduren und Triggern verwendet werden können.

Weitere Informationen finden Sie in der serverseitigen JavaScript-API-Dokumentation.

Beispiel

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)

Alle benutzerdefinierten Funktionen abfragen.
query<T>(SqlQuerySpec, FeedOptions)

Alle benutzerdefinierten Funktionen abfragen.

Beispiel

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)

Alle benutzerdefinierten Funktionen lesen.

Beispiel

Alle benutzerdefinierten Funktionen in Array lesen.

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

Details zur Eigenschaft

container 

container: Container

Eigenschaftswert

Container

Details zur Methode

create(UserDefinedFunctionDefinition, RequestOptions)

Erstellen Sie eine UserDefinedFunction.

Azure Cosmos DB unterstützt JavaScript-UDFs, die in Abfragen, gespeicherten Prozeduren und Triggern verwendet werden können.

Weitere Informationen finden Sie in der serverseitigen JavaScript-API-Dokumentation.

Beispiel

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>

Parameter

body
UserDefinedFunctionDefinition
options
RequestOptions

Gibt zurück

Promise<UserDefinedFunctionResponse>

query(SqlQuerySpec, FeedOptions)

Alle benutzerdefinierten Funktionen abfragen.

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

Parameter

query
SqlQuerySpec

Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec-.

options
FeedOptions

Gibt zurück

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Alle benutzerdefinierten Funktionen abfragen.

Beispiel

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>

Parameter

query
SqlQuerySpec

Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec-.

options
FeedOptions

Gibt zurück

QueryIterator<T>

readAll(FeedOptions)

Alle benutzerdefinierten Funktionen lesen.

Beispiel

Alle benutzerdefinierten Funktionen in Array lesen.

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>

Parameter

options
FeedOptions

Gibt zurück

QueryIterator<UserDefinedFunctionDefinition & Resource>