Users class

Pacote:

@azure/cosmos

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

Consulte de 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 especificado UserDefinition.
query(SqlQuerySpec, FeedOptions)	Consulte todos os usuários.
query<T>(SqlQuerySpec, FeedOptions)	Consulte todos os usuários.
readAll(FeedOptions)	Leia todos os usuários.- Exemplo Leia todos os usuários para a matriz. const {body: usersList} = await database.users.readAll().fetchAll();
upsert(UserDefinition, RequestOptions)	Upsert um usuário de banco de dados com um especificado UserDefinition.

Detalhes de Propriedade

database

database: Database

Valor de Propriedade

Database

Detalhes de Método

create(UserDefinition, RequestOptions)

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

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

Parâmetros

body

UserDefinition

O especificado UserDefinition.

options

RequestOptions

Devoluções

Promise<UserResponse>

query(SqlQuerySpec, FeedOptions)

Consulte 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

Devoluções

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Consulte 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

Devoluções

QueryIterator<T>

readAll(FeedOptions)

Leia todos os usuários.-

Exemplo

Leia todos os usuários 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 usuário de banco de dados com um especificado UserDefinition.

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

Parâmetros

body

UserDefinition

O especificado UserDefinition.

options

RequestOptions

Devoluções

Promise<UserResponse>