Udostępnij za pomocą

UserDefinedFunctions class

Pakiet:
@azure/cosmos

Służy do tworzenia, upsert, wykonywania zapytań lub odczytywania wszystkich funkcji zdefiniowanych przez użytkownika.

Zobacz UserDefinedFunction odczytywać, zastępować lub usuwać daną funkcję zdefiniowaną przez użytkownika według identyfikatora.

Właściwości

container

Metody

create(UserDefinedFunctionDefinition, RequestOptions)

Utwórz element UserDefinedFunction.

Usługa Azure Cosmos DB obsługuje funkcje zdefiniowane przez użytkownika języka JavaScript, które mogą być używane wewnątrz zapytań, procedur składowanych i wyzwalaczy.

Aby uzyskać dodatkowe informacje, zapoznaj się z dokumentacją interfejsu API języka JavaScript po stronie serwera.

Przykład

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)

Wykonaj zapytanie dotyczące wszystkich funkcji zdefiniowanych przez użytkownika.
query<T>(SqlQuerySpec, FeedOptions)

Wykonaj zapytanie dotyczące wszystkich funkcji zdefiniowanych przez użytkownika.

Przykład

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)

Odczytywanie wszystkich funkcji zdefiniowanych przez użytkownika.

Przykład

Odczytaj wszystkie funkcje zdefiniowane przez użytkownika do tablicy.

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

Szczegóły właściwości

container 

container: Container

Wartość właściwości

Container

Szczegóły metody

create(UserDefinedFunctionDefinition, RequestOptions)

Utwórz element UserDefinedFunction.

Usługa Azure Cosmos DB obsługuje funkcje zdefiniowane przez użytkownika języka JavaScript, które mogą być używane wewnątrz zapytań, procedur składowanych i wyzwalaczy.

Aby uzyskać dodatkowe informacje, zapoznaj się z dokumentacją interfejsu API języka JavaScript po stronie serwera.

Przykład

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>

Parametry

body
UserDefinedFunctionDefinition
options
RequestOptions

Zwraca

Promise<UserDefinedFunctionResponse>

query(SqlQuerySpec, FeedOptions)

Wykonaj zapytanie dotyczące wszystkich funkcji zdefiniowanych przez użytkownika.

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

Parametry

query
SqlQuerySpec

Wykonywanie zapytań o konfigurację operacji. Aby uzyskać więcej informacji na temat konfigurowania zapytania, zobacz SqlQuerySpec.

options
FeedOptions

Zwraca

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Wykonaj zapytanie dotyczące wszystkich funkcji zdefiniowanych przez użytkownika.

Przykład

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>

Parametry

query
SqlQuerySpec

Wykonywanie zapytań o konfigurację operacji. Aby uzyskać więcej informacji na temat konfigurowania zapytania, zobacz SqlQuerySpec.

options
FeedOptions

Zwraca

QueryIterator<T>

readAll(FeedOptions)

Odczytywanie wszystkich funkcji zdefiniowanych przez użytkownika.

Przykład

Odczytaj wszystkie funkcje zdefiniowane przez użytkownika do tablicy.

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>

Parametry

options
FeedOptions

Zwraca

QueryIterator<UserDefinedFunctionDefinition & Resource>