다음을 통해 공유

UserDefinedFunction class

  • 참조
패키지:
@azure/cosmos

ID별로 지정된 사용자 정의 함수를 읽거나 바꾸거나 삭제하는 데 사용됩니다.

UserDefinedFunction 참조하여 모든 사용자 정의 함수를 만들고, 업서트하고, 쿼리하고, 읽습니다.

속성

container
id
url

리소스에 대한 참조 URL을 반환합니다. 사용 권한에서 연결에 사용됩니다.

메서드

delete(RequestOptions)

지정된 <xref:UserDefined>삭제합니다.

예시

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" });

await container.scripts.userDefinedFunction("<udf-id>").delete();
read(RequestOptions)

지정된 UserDefinedFunction대한 UserDefinedFunctionDefinition 읽습니다.

예시

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 { resource: udf } = await container.scripts.userDefinedFunction("<udf-id>").read();
replace(UserDefinedFunctionDefinition, RequestOptions)

지정된 UserDefinedFunction 지정된 UserDefinedFunctionDefinition바꿉다.

예시

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; }",
};
await container.scripts.userDefinedFunctions.create(udfDefinition);

udfDefinition.body = "function () { const x = 20; }";
const { resource: replacedUdf } = await container.scripts
  .userDefinedFunction(udfDefinition.id)
  .replace(udfDefinition);

속성 세부 정보

container 

container: Container

속성 값

Container

id 

id: string

속성 값

string

url

리소스에 대한 참조 URL을 반환합니다. 사용 권한에서 연결에 사용됩니다.

string url

속성 값

string

메서드 세부 정보

delete(RequestOptions)

지정된 <xref:UserDefined>삭제합니다.

예시

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" });

await container.scripts.userDefinedFunction("<udf-id>").delete();

function delete(options?: RequestOptions): Promise<UserDefinedFunctionResponse>

매개 변수

options
RequestOptions

반환

Promise<UserDefinedFunctionResponse>

read(RequestOptions)

지정된 UserDefinedFunction대한 UserDefinedFunctionDefinition 읽습니다.

예시

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 { resource: udf } = await container.scripts.userDefinedFunction("<udf-id>").read();

function read(options?: RequestOptions): Promise<UserDefinedFunctionResponse>

매개 변수

options
RequestOptions

반환

Promise<UserDefinedFunctionResponse>

replace(UserDefinedFunctionDefinition, RequestOptions)

지정된 UserDefinedFunction 지정된 UserDefinedFunctionDefinition바꿉다.

예시

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; }",
};
await container.scripts.userDefinedFunctions.create(udfDefinition);

udfDefinition.body = "function () { const x = 20; }";
const { resource: replacedUdf } = await container.scripts
  .userDefinedFunction(udfDefinition.id)
  .replace(udfDefinition);

function replace(body: UserDefinedFunctionDefinition, options?: RequestOptions): Promise<UserDefinedFunctionResponse>

매개 변수

body
UserDefinedFunctionDefinition
options
RequestOptions

반환

Promise<UserDefinedFunctionResponse>