Users class

  • Referência
Pacote:
@azure/cosmos

Utilizado para criar, atualizar, consultar e ler todos os utilizadores.

Consulte Utilizador para ler, substituir ou eliminar um Utilizador específico por ID.

Propriedades

database

Métodos

create(UserDefinition, RequestOptions)

Crie um utilizador de base de dados com a UserDefinition especificada.
query(SqlQuerySpec, FeedOptions)

Consultar todos os utilizadores.
query<T>(SqlQuerySpec, FeedOptions)

Consultar todos os utilizadores.
readAll(FeedOptions)

Leia todos os utilizadores.-

Exemplo

Leia todos os utilizadores para a matriz.

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

Upsert um utilizador de base de dados com uma UserDefinition especificada.

Detalhes de Propriedade

database 

database: Database

Valor de Propriedade

Database

Detalhes de Método

create(UserDefinition, RequestOptions)

Crie um utilizador de base de dados com a UserDefinition especificada.

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

Parâmetros

body
UserDefinition

O UserDefinition especificado.

options
RequestOptions

Devoluções

Promise<UserResponse>

query(SqlQuerySpec, FeedOptions)

Consultar todos os utilizadores.

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

Parâmetros

query
SqlQuerySpec

Configuração da consulta para a operação. Veja SqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options
FeedOptions

Devoluções

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Consultar todos os utilizadores.

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

Parâmetros

query
SqlQuerySpec

Configuração da consulta para a operação. Veja SqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options
FeedOptions

Devoluções

QueryIterator<T>

readAll(FeedOptions)

Leia todos os utilizadores.-

Exemplo

Leia todos os utilizadores para a matriz.

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

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

Parâmetros

options
FeedOptions

Devoluções

QueryIterator<UserDefinition & Resource>

upsert(UserDefinition, RequestOptions)

Upsert um utilizador de base de dados com uma UserDefinition especificada.

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

Parâmetros

body
UserDefinition

O UserDefinition especificado.

options
RequestOptions

Devoluções

Promise<UserResponse>