Users class

Used to create, upsert, query, and read all users.

Properties

database

Methods

create(UserDefinition, RequestOptions)

Create a database user with the specified <xref:UserDefinition>.

query(SqlQuerySpec, FeedOptions)

Query all users.

query(SqlQuerySpec, FeedOptions)

Query all users.

readAll(FeedOptions)

Read all users.

upsert(UserDefinition, RequestOptions)

Upsert a database user with a specified <xref:UserDefinition>.

Property Details

database

database: Database

Property Value

Method Details

create(UserDefinition, RequestOptions)

Create a database user with the specified <xref:UserDefinition>.

function create(body: UserDefinition, options?: RequestOptions)

Parameters

body
UserDefinition

The specified <xref:UserDefinition>.

options
RequestOptions

Returns

Promise<UserResponse>

query(SqlQuerySpec, FeedOptions)

Query all users.

function query(query: SqlQuerySpec, options?: FeedOptions)

Parameters

query
SqlQuerySpec

Query configuration for the operation. See <xref:SqlQuerySpec> for more info on how to configure a query.

options
FeedOptions

Returns

query(SqlQuerySpec, FeedOptions)

Query all users.

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

Parameters

query
SqlQuerySpec

Query configuration for the operation. See <xref:SqlQuerySpec> for more info on how to configure a query.

options
FeedOptions

Returns

readAll(FeedOptions)

Read all users.

function readAll(options?: FeedOptions)

Parameters

options
FeedOptions

Returns

QueryIterator<Resource>

upsert(UserDefinition, RequestOptions)

Upsert a database user with a specified <xref:UserDefinition>.

function upsert(body: UserDefinition, options?: RequestOptions)

Parameters

body
UserDefinition

The specified <xref:UserDefinition>.

options
RequestOptions

Returns

Promise<UserResponse>