Class Users

Readonlydatabase

create

• create(body, options?): Promise<UserResponse>

• Create a database user with the specified UserDefinition.

  Parameters

  • body: UserDefinition

    The specified UserDefinition.
  • Optionaloptions: RequestOptions

  Returns Promise<UserResponse>

query

• query(query, options?): QueryIterator<any>

• Query all users.

  Parameters

  • query: SqlQuerySpec

    Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
  • Optionaloptions: FeedOptions

  Returns QueryIterator<any>
• query<T>(query, options?): QueryIterator<T>

• Query all users.

  Type Parameters

  • T

  Parameters

  • query: SqlQuerySpec

    Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
  • Optionaloptions: FeedOptions

  Returns QueryIterator<T>

readAll

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

• Read all users.-

  Parameters

  • Optionaloptions: FeedOptions

  Returns QueryIterator<UserDefinition & Resource>

  Example: Read all users to array.

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

upsert

• upsert(body, options?): Promise<UserResponse>

• Upsert a database user with a specified UserDefinition.

  Parameters

  • body: UserDefinition

    The specified UserDefinition.
  • Optionaloptions: RequestOptions

  Returns Promise<UserResponse>