UserDefinedFunctions class

Balíček:

@azure/cosmos

Slouží k vytváření, upsertování, dotazování nebo čtení všech uživatelem definovaných funkcí.

Viz UserDefinedFunction ke čtení, nahrazení nebo odstranění dané uživatelem definované funkce podle ID.

Vlastnosti

container

Metody

create(UserDefinedFunctionDefinition, RequestOptions)	Vytvořte UserDefinedFunction. Azure Cosmos DB podporuje uživatelem definované uživatelem JavaScriptu, které se dají použít v dotazech, uložených procedurách a triggerech. Další podrobnosti najdete v dokumentaci k rozhraní JavaScript API na straně serveru. příklad 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)	Dotazování na všechny uživatelem definované funkce
query<T>(SqlQuerySpec, FeedOptions)	Dotazování na všechny uživatelem definované funkce příklad 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)	Přečtěte si všechny uživatelem definované funkce. příklad Čtení všech uživatelem definovaných funkcí do pole 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();

Podrobnosti vlastnosti

container

container: Container

Hodnota vlastnosti

Container

Podrobnosti metody

create(UserDefinedFunctionDefinition, RequestOptions)

Vytvořte UserDefinedFunction.

Azure Cosmos DB podporuje uživatelem definované uživatelem JavaScriptu, které se dají použít v dotazech, uložených procedurách a triggerech.

Další podrobnosti najdete v dokumentaci k rozhraní JavaScript API na straně serveru.

příklad

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

Návraty

Promise<UserDefinedFunctionResponse>

query(SqlQuerySpec, FeedOptions)

Dotazování na všechny uživatelem definované funkce

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

Parametry

query

SqlQuerySpec

Konfigurace dotazu pro operaci. Další informace o konfiguraci dotazu najdete v tématu sqlQuerySpec.

options

FeedOptions

Návraty

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Dotazování na všechny uživatelem definované funkce

příklad

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

Konfigurace dotazu pro operaci. Další informace o konfiguraci dotazu najdete v tématu sqlQuerySpec.

options

FeedOptions

Návraty

QueryIterator<T>

readAll(FeedOptions)

Přečtěte si všechny uživatelem definované funkce.

příklad

Čtení všech uživatelem definovaných funkcí do pole

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

Návraty

QueryIterator<UserDefinedFunctionDefinition & Resource>