Megosztás a következőn keresztül:

UserDefinedFunctions class

Csomag:
@azure/cosmos

Az összes felhasználó által definiált függvény létrehozásához, frissítéséhez, lekérdezéséhez vagy olvasásához használható.

Lásd: UserDefinedFunction egy adott felhasználó által definiált függvény beolvasásához, cseréjéhez vagy törléséhez azonosító alapján.

Tulajdonságok

container

Metódusok

create(UserDefinedFunctionDefinition, RequestOptions)

Hozzon létre egy UserDefinedFunction függvényt.

Az Azure Cosmos DB támogatja a JavaScript UDF-eket, amelyek lekérdezéseken, tárolt eljárásokon és triggereken belül használhatók.

További részletekért tekintse meg a kiszolgálóoldali JavaScript API dokumentációját.

példa

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)

Az összes felhasználó által definiált függvény lekérdezése.
query<T>(SqlQuerySpec, FeedOptions)

Az összes felhasználó által definiált függvény lekérdezése.

példa

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)

Olvassa el az összes felhasználó által definiált függvényt.

példa

Olvassa el az összes felhasználó által definiált függvényt a tömbbe.

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

Tulajdonság adatai

container 

container: Container

Tulajdonság értéke

Container

Metódus adatai

create(UserDefinedFunctionDefinition, RequestOptions)

Hozzon létre egy UserDefinedFunction függvényt.

Az Azure Cosmos DB támogatja a JavaScript UDF-eket, amelyek lekérdezéseken, tárolt eljárásokon és triggereken belül használhatók.

További részletekért tekintse meg a kiszolgálóoldali JavaScript API dokumentációját.

példa

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éterek

body
UserDefinedFunctionDefinition
options
RequestOptions

Válaszok

Promise<UserDefinedFunctionResponse>

query(SqlQuerySpec, FeedOptions)

Az összes felhasználó által definiált függvény lekérdezése.

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

Paraméterek

query
SqlQuerySpec

Lekérdezéskonfiguráció a művelethez. A lekérdezés konfigurálásáról további információt SqlQuerySpec talál.

options
FeedOptions

Válaszok

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Az összes felhasználó által definiált függvény lekérdezése.

példa

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éterek

query
SqlQuerySpec

Lekérdezéskonfiguráció a művelethez. A lekérdezés konfigurálásáról további információt SqlQuerySpec talál.

options
FeedOptions

Válaszok

QueryIterator<T>

readAll(FeedOptions)

Olvassa el az összes felhasználó által definiált függvényt.

példa

Olvassa el az összes felhasználó által definiált függvényt a tömbbe.

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éterek

options
FeedOptions

Válaszok

QueryIterator<UserDefinedFunctionDefinition & Resource>