Dela via


UserDefinedFunctions class

Används för att skapa, upsert, fråga eller läsa alla användardefinierade funktioner.

Se UserDefinedFunction för att läsa, ersätta eller ta bort en viss användardefinierad funktion med ID.

Egenskaper

container

Metoder

create(UserDefinedFunctionDefinition, RequestOptions)

Skapa en UserDefinedFunction.

Azure Cosmos DB stöder JavaScript-UDF:er som kan användas i frågor, lagrade procedurer och utlösare.

Mer information finns i JavaScript API-dokumentationen på serversidan.

Exempel

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)

Fråga alla användardefinierade funktioner.

query<T>(SqlQuerySpec, FeedOptions)

Fråga alla användardefinierade funktioner.

Exempel

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)

Läs alla användardefinierade funktioner.

Exempel

Läs alla användardefinierade funktioner till matrisen.

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

Egenskapsinformation

container

container: Container

Egenskapsvärde

Metodinformation

create(UserDefinedFunctionDefinition, RequestOptions)

Skapa en UserDefinedFunction.

Azure Cosmos DB stöder JavaScript-UDF:er som kan användas i frågor, lagrade procedurer och utlösare.

Mer information finns i JavaScript API-dokumentationen på serversidan.

Exempel

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>

Parametrar

options
RequestOptions

Returer

query(SqlQuerySpec, FeedOptions)

Fråga alla användardefinierade funktioner.

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

Parametrar

query
SqlQuerySpec

Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec.

options
FeedOptions

Returer

query<T>(SqlQuerySpec, FeedOptions)

Fråga alla användardefinierade funktioner.

Exempel

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>

Parametrar

query
SqlQuerySpec

Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec.

options
FeedOptions

Returer

readAll(FeedOptions)

Läs alla användardefinierade funktioner.

Exempel

Läs alla användardefinierade funktioner till matrisen.

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>

Parametrar

options
FeedOptions

Returer