Users class

Balíček:

@azure/cosmos

Slouží k vytváření, upsertování, dotazování a čtení všech uživatelů.

Informace o přečtení, nahrazení nebo odstranění konkrétního uživatele podle ID najdete v tématu Uživatel.

Vlastnosti

database

Metody

create(UserDefinition, RequestOptions)	Vytvořte uživatele databáze se zadaným userDefinition.
query(SqlQuerySpec, FeedOptions)	Zadejte dotaz na všechny uživatele.
query<T>(SqlQuerySpec, FeedOptions)	Zadejte dotaz na všechny uživatele.
readAll(FeedOptions)	Číst všechny uživatele. příklad Čtení všech uživatelů do pole const {body: usersList} = await database.users.readAll().fetchAll();
upsert(UserDefinition, RequestOptions)	Přenesení uživatele databáze se zadaným UserDefinition.

Podrobnosti vlastnosti

database

database: Database

Hodnota vlastnosti

Database

Podrobnosti metody

create(UserDefinition, RequestOptions)

Vytvořte uživatele databáze se zadaným userDefinition.

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

Parametry

body

UserDefinition

Zadaný UserDefinition.

options

RequestOptions

Návraty

Promise<UserResponse>

query(SqlQuerySpec, FeedOptions)

Zadejte dotaz na všechny uživatele.

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

Parametry

query

SqlQuerySpec

Konfigurace dotazu pro operaci. Další informace o konfiguraci dotazu najdete v tématu sqlQuerySpec.

options

FeedOptions

Návraty

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Zadejte dotaz na všechny uživatele.

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

Parametry

query

SqlQuerySpec

Konfigurace dotazu pro operaci. Další informace o konfiguraci dotazu najdete v tématu sqlQuerySpec.

options

FeedOptions

Návraty

QueryIterator<T>

readAll(FeedOptions)

Číst všechny uživatele.

příklad

Čtení všech uživatelů do pole

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

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

Parametry

options

FeedOptions

Návraty

QueryIterator<UserDefinition & Resource>

upsert(UserDefinition, RequestOptions)

Přenesení uživatele databáze se zadaným UserDefinition.

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

Parametry

body

UserDefinition

Zadaný UserDefinition.

options

RequestOptions

Návraty

Promise<UserResponse>