Delen via

UserDefinedFunctions class

Pakket:
@azure/cosmos

Wordt gebruikt voor het maken, upsert, opvragen of lezen van alle door de gebruiker gedefinieerde functies.

Zie UserDefinedFunction om een bepaalde door de gebruiker gedefinieerde functie te lezen, vervangen of verwijderen op id.

Eigenschappen

container

Methoden

create(UserDefinedFunctionDefinition, RequestOptions)

Maak een UserDefinedFunction.

Azure Cosmos DB ondersteunt JavaScript UDF's die kunnen worden gebruikt in query's, opgeslagen procedures en triggers.

Raadpleeg de JavaScript API-documentatie aan de serverzijde voor meer informatie.

voorbeeld van

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)

Voer een query uit op alle door de gebruiker gedefinieerde functies.
query<T>(SqlQuerySpec, FeedOptions)

Voer een query uit op alle door de gebruiker gedefinieerde functies.

voorbeeld van

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)

Alle door de gebruiker gedefinieerde functies lezen.

voorbeeld van

Lees alle door de gebruiker gedefinieerde functies naar matrix.

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

Eigenschapdetails

container 

container: Container

Waarde van eigenschap

Container

Methodedetails

create(UserDefinedFunctionDefinition, RequestOptions)

Maak een UserDefinedFunction.

Azure Cosmos DB ondersteunt JavaScript UDF's die kunnen worden gebruikt in query's, opgeslagen procedures en triggers.

Raadpleeg de JavaScript API-documentatie aan de serverzijde voor meer informatie.

voorbeeld van

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>

Parameters

body
UserDefinedFunctionDefinition
options
RequestOptions

Retouren

Promise<UserDefinedFunctionResponse>

query(SqlQuerySpec, FeedOptions)

Voer een query uit op alle door de gebruiker gedefinieerde functies.

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

Parameters

query
SqlQuerySpec

Queryconfiguratie voor de bewerking. Zie SqlQuerySpec- voor meer informatie over het configureren van een query.

options
FeedOptions

Retouren

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Voer een query uit op alle door de gebruiker gedefinieerde functies.

voorbeeld van

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>

Parameters

query
SqlQuerySpec

Queryconfiguratie voor de bewerking. Zie SqlQuerySpec- voor meer informatie over het configureren van een query.

options
FeedOptions

Retouren

QueryIterator<T>

readAll(FeedOptions)

Alle door de gebruiker gedefinieerde functies lezen.

voorbeeld van

Lees alle door de gebruiker gedefinieerde functies naar matrix.

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>

Parameters

options
FeedOptions

Retouren

QueryIterator<UserDefinedFunctionDefinition & Resource>