Users class

  • Referencia
Paquete:
@azure/cosmos

Se usa para crear, upsert, consultar y leer todos los usuarios.

Consulte Usuario para leer, reemplazar o eliminar un usuario específico por identificador.

Propiedades

database

Métodos

create(UserDefinition, RequestOptions)

Cree un usuario de base de datos con el userDefinition especificado.
query(SqlQuerySpec, FeedOptions)

Consulte a todos los usuarios.
query<T>(SqlQuerySpec, FeedOptions)

Consulte a todos los usuarios.
readAll(FeedOptions)

Leer todos los usuarios.

Ejemplo

Lee todos los usuarios en la matriz.

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

Upsert un usuario de base de datos con un userDefinition especificado.

Detalles de las propiedades

database 

database: Database

Valor de propiedad

Database

Detalles del método

create(UserDefinition, RequestOptions)

Cree un usuario de base de datos con el userDefinition especificado.

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

Parámetros

body
UserDefinition

UserDefinition especificado.

options
RequestOptions

Devoluciones

Promise<UserResponse>

query(SqlQuerySpec, FeedOptions)

Consulte a todos los usuarios.

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

Parámetros

query
SqlQuerySpec

Consulta de la configuración de la operación. Consulte SqlQuerySpec para obtener más información sobre cómo configurar una consulta.

options
FeedOptions

Devoluciones

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Consulte a todos los usuarios.

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

Parámetros

query
SqlQuerySpec

Consulta de la configuración de la operación. Consulte SqlQuerySpec para obtener más información sobre cómo configurar una consulta.

options
FeedOptions

Devoluciones

QueryIterator<T>

readAll(FeedOptions)

Leer todos los usuarios.

Ejemplo

Lee todos los usuarios en la matriz.

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

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

Parámetros

options
FeedOptions

Devoluciones

QueryIterator<UserDefinition & Resource>

upsert(UserDefinition, RequestOptions)

Upsert un usuario de base de datos con un userDefinition especificado.

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

Parámetros

body
UserDefinition

UserDefinition especificado.

options
RequestOptions

Devoluciones

Promise<UserResponse>