Users class

Пакет:

@azure/cosmos

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

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

Свойства

database

Методы

create(UserDefinition, RequestOptions)	Создайте пользователя базы данных с указанным UserDefinition.
query(SqlQuerySpec, FeedOptions)	Запрос всех пользователей.
query<T>(SqlQuerySpec, FeedOptions)	Запрос всех пользователей.
readAll(FeedOptions)	Чтение всех пользователей.- пример Чтение всех пользователей в массив. const {body: usersList} = await database.users.readAll().fetchAll();
upsert(UserDefinition, RequestOptions)	Upsert пользователь базы данных с указанным UserDefinition.

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

database

database: Database

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

Database

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

create(UserDefinition, RequestOptions)

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

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)

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

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

Параметры

query

SqlQuerySpec

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

options

FeedOptions

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

QueryIterator<T>

readAll(FeedOptions)

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

пример

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

const {body: usersList} = await database.users.readAll().fetchAll();

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

Параметры

options

FeedOptions

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

QueryIterator<UserDefinition & Resource>

upsert(UserDefinition, RequestOptions)

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

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

Параметры

body

UserDefinition

Указанный UserDefinition.

options

RequestOptions

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

Promise<UserResponse>