Поделиться через

UserDefinedFunctions class

Пакет:
@azure/cosmos

Используется для создания, upsert, запроса или чтения всех пользовательских функций.

См. UserDefinedFunction для чтения, замены или удаления определенной определяемой пользователем функции по идентификатору.

Свойства

container

Методы

create(UserDefinedFunctionDefinition, RequestOptions)

Создайте userDefinedFunction.

Azure Cosmos DB поддерживает определяемые пользователем Функции JavaScript, которые можно использовать в запросах, хранимых процедурах и триггерах.

Дополнительные сведения см. в документации по API JavaScript на стороне сервера.

пример 

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)

Запрос всех определяемых пользователем функций.
query<T>(SqlQuerySpec, FeedOptions)

Запрос всех определяемых пользователем функций.

пример 

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)

Чтение всех определяемых пользователем функций.

пример

Чтение всех определяемых пользователем функций для массива.

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

Сведения о свойстве

container 

container: Container

Значение свойства

Container

Сведения о методе

create(UserDefinedFunctionDefinition, RequestOptions)

Создайте userDefinedFunction.

Azure Cosmos DB поддерживает определяемые пользователем Функции JavaScript, которые можно использовать в запросах, хранимых процедурах и триггерах.

Дополнительные сведения см. в документации по API JavaScript на стороне сервера.

пример 

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>

Параметры

body
UserDefinedFunctionDefinition
options
RequestOptions

Возвращаемое значение

Promise<UserDefinedFunctionResponse>

query(SqlQuerySpec, FeedOptions)

Запрос всех определяемых пользователем функций.

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

Параметры

query
SqlQuerySpec

Настройка запроса для операции. Дополнительные сведения о настройке запроса см. в SqlQuerySpec.

options
FeedOptions

Возвращаемое значение

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Запрос всех определяемых пользователем функций.

пример 

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>

Параметры

query
SqlQuerySpec

Настройка запроса для операции. Дополнительные сведения о настройке запроса см. в SqlQuerySpec.

options
FeedOptions

Возвращаемое значение

QueryIterator<T>

readAll(FeedOptions)

Чтение всех определяемых пользователем функций.

пример

Чтение всех определяемых пользователем функций для массива.

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>

Параметры

options
FeedOptions

Возвращаемое значение

QueryIterator<UserDefinedFunctionDefinition & Resource>