Users class

Пакет:

@azure/cosmos

Используется для создания, upsert, запроса и чтения всех пользователей.

См. пользователя для чтения, замены или удаления определенного пользователя по идентификатору.

Свойства

database

Методы

create(UserDefinition, RequestOptions)	Создайте пользователя базы данных с указанным UserDefinition. пример 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" }); await database.users.create({ id: "<user-id>" });
query(SqlQuerySpec, FeedOptions)	Запрос всех пользователей.
query<T>(SqlQuerySpec, FeedOptions)	Запрос всех пользователей. пример Запрос пользователя с id. import { CosmosClient, SqlQuerySpec } 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 querySpec: SqlQuerySpec = { query: `SELECT * FROM root r WHERE r.id = @user`, parameters: [{ name: "@user", value: "<user-id>" }], }; const { resources: permisssion } = await database.users.query(querySpec).fetchAll();
readAll(FeedOptions)	Чтение всех пользователей.- пример Чтение всех пользователей в массив. 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 { resources: usersList } = await database.users.readAll().fetchAll();
upsert(UserDefinition, RequestOptions)	Upsert пользователь базы данных с указанным UserDefinition. пример 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" }); await database.users.upsert({ id: "<user-id>" });

Сведения о свойстве

database

database: Database

Значение свойства

Database

Сведения о методе

create(UserDefinition, RequestOptions)

Создайте пользователя базы данных с указанным UserDefinition.

пример

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

await database.users.create({ id: "<user-id>" });

function create(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>

Параметры

body

UserDefinition

Указанный UserDefinition.

options

RequestOptions

Возвращаемое значение

Promise<UserResponse>

query(SqlQuerySpec, FeedOptions)

Запрос всех пользователей.

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

Параметры

query

SqlQuerySpec

Настройка запроса для операции. Дополнительные сведения о настройке запроса см. в SqlQuerySpec.

options

FeedOptions

Возвращаемое значение

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Запрос всех пользователей.

пример

Запрос пользователя с id.

import { CosmosClient, SqlQuerySpec } 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 querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @user`,
  parameters: [{ name: "@user", value: "<user-id>" }],
};
const { resources: permisssion } = await database.users.query(querySpec).fetchAll();

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

Параметры

query

SqlQuerySpec

Настройка запроса для операции. Дополнительные сведения о настройке запроса см. в SqlQuerySpec.

options

FeedOptions

Возвращаемое значение

QueryIterator<T>

readAll(FeedOptions)

Чтение всех пользователей.-

пример

Чтение всех пользователей в массив.

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 { resources: usersList } = await database.users.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<UserDefinition & Resource>

Параметры

options

FeedOptions

Возвращаемое значение

QueryIterator<UserDefinition & Resource>

upsert(UserDefinition, RequestOptions)

Upsert пользователь базы данных с указанным UserDefinition.

пример

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

await database.users.upsert({ id: "<user-id>" });

function upsert(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>

Параметры

body

UserDefinition

Указанный UserDefinition.

options

RequestOptions

Возвращаемое значение

Promise<UserResponse>