Bagikan melalui

UserDefinedFunctions class

Paket:
@azure/cosmos

Digunakan untuk membuat, meningkatkan, mengkueri, atau membaca semua Fungsi yang Ditentukan Pengguna.

Lihat UserDefinedFunction untuk membaca, mengganti, atau menghapus Fungsi yang Ditentukan Pengguna berdasarkan id tertentu.

Properti

container

Metode

create(UserDefinedFunctionDefinition, RequestOptions)

Membuat UserDefinedFunction.

Azure Cosmos DB mendukung UDF JavaScript yang dapat digunakan di dalam kueri, prosedur tersimpan, dan pemicu.

Untuk detail tambahan, lihat dokumentasi JAVAScript API sisi server.

Contoh

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)

Mengkueri semua Fungsi yang Ditentukan Pengguna.
query<T>(SqlQuerySpec, FeedOptions)

Mengkueri semua Fungsi yang Ditentukan Pengguna.

Contoh

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)

Baca semua Fungsi yang Ditentukan Pengguna.

Contoh

Baca semua Fungsi yang Ditentukan Pengguna untuk array.

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

Detail Properti

container 

container: Container

Nilai Properti

Container

Detail Metode

create(UserDefinedFunctionDefinition, RequestOptions)

Membuat UserDefinedFunction.

Azure Cosmos DB mendukung UDF JavaScript yang dapat digunakan di dalam kueri, prosedur tersimpan, dan pemicu.

Untuk detail tambahan, lihat dokumentasi JAVAScript API sisi server.

Contoh

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>

Parameter

body
UserDefinedFunctionDefinition
options
RequestOptions

Mengembalikan

Promise<UserDefinedFunctionResponse>

query(SqlQuerySpec, FeedOptions)

Mengkueri semua Fungsi yang Ditentukan Pengguna.

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

Parameter

query
SqlQuerySpec

Konfigurasi kueri untuk operasi. Lihat SqlQuerySpec untuk informasi selengkapnya tentang cara mengonfigurasi kueri.

options
FeedOptions

Mengembalikan

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Mengkueri semua Fungsi yang Ditentukan Pengguna.

Contoh

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>

Parameter

query
SqlQuerySpec

Konfigurasi kueri untuk operasi. Lihat SqlQuerySpec untuk informasi selengkapnya tentang cara mengonfigurasi kueri.

options
FeedOptions

Mengembalikan

QueryIterator<T>

readAll(FeedOptions)

Baca semua Fungsi yang Ditentukan Pengguna.

Contoh

Baca semua Fungsi yang Ditentukan Pengguna untuk array.

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>

Parameter

options
FeedOptions

Mengembalikan

QueryIterator<UserDefinedFunctionDefinition & Resource>