Users class

  • Referência
Pacote:
@azure/cosmos

Usado para criar, upsert, consultar e ler todos os usuários.

Consulte Usuário para ler, substituir ou excluir um Usuário específico por ID.

Propriedades

database

Métodos

create(UserDefinition, RequestOptions)

Crie um usuário de banco de dados com o UserDefinition especificado.
query(SqlQuerySpec, FeedOptions)

Consultar todos os usuários.
query<T>(SqlQuerySpec, FeedOptions)

Consultar todos os usuários.
readAll(FeedOptions)

Ler todos os usuários.-

Exemplo

Ler todos os usuários na matriz.

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

Upsert um usuário de banco de dados com um UserDefinition especificado.

Detalhes da propriedade

database 

database: Database

Valor da propriedade

Database

Detalhes do método

create(UserDefinition, RequestOptions)

Crie um usuário de banco de dados com o UserDefinition especificado.

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

Parâmetros

body
UserDefinition

O UserDefinition especificado.

options
RequestOptions

Retornos

Promise<UserResponse>

query(SqlQuerySpec, FeedOptions)

Consultar todos os usuários.

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

Parâmetros

query
SqlQuerySpec

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

options
FeedOptions

Retornos

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Consultar todos os usuários.

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

Parâmetros

query
SqlQuerySpec

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

options
FeedOptions

Retornos

QueryIterator<T>

readAll(FeedOptions)

Ler todos os usuários.-

Exemplo

Ler todos os usuários na matriz.

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

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

Parâmetros

options
FeedOptions

Retornos

QueryIterator<UserDefinition & Resource>

upsert(UserDefinition, RequestOptions)

Upsert um usuário de banco de dados com um UserDefinition especificado.

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

Parâmetros

body
UserDefinition

O UserDefinition especificado.

options
RequestOptions

Retornos

Promise<UserResponse>