Users class
すべてのユーザーの作成、アップサート、クエリ、読み取りに使用されます。
特定 のユーザー を ID で読み取り、置換、または削除するには、「ユーザー」を参照してください。
プロパティ
| database |
メソッド
| create(User |
指定した UserDefinition を使用してデータベース ユーザーを作成します。 |
| query(Sql |
すべてのユーザーにクエリを実行します。 |
| query<T>(Sql |
すべてのユーザーにクエリを実行します。 |
| read |
すべてのユーザーを読み取る.- 例 すべてのユーザーを配列に読み取る。 |
| upsert(User |
指定した UserDefinition を持つデータベース ユーザーをアップサートします。 |
プロパティの詳細
database
メソッドの詳細
create(UserDefinition, RequestOptions)
指定した UserDefinition を使用してデータベース ユーザーを作成します。
function create(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>パラメーター
- body
- UserDefinition
指定した UserDefinition。
- options
- RequestOptions
戻り値
Promise<UserResponse>
query(SqlQuerySpec, FeedOptions)
すべてのユーザーにクエリを実行します。
function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>パラメーター
- query
- SqlQuerySpec
操作のクエリ構成。 クエリを構成する方法の詳細については、「 SqlQuerySpec 」を参照してください。
- options
- FeedOptions
戻り値
QueryIterator<any>
query<T>(SqlQuerySpec, FeedOptions)
すべてのユーザーにクエリを実行します。
function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>パラメーター
- query
- SqlQuerySpec
操作のクエリ構成。 クエリを構成する方法の詳細については、「 SqlQuerySpec 」を参照してください。
- options
- FeedOptions
戻り値
readAll(FeedOptions)
すべてのユーザーを読み取る.-
例
すべてのユーザーを配列に読み取る。
const {body: usersList} = await database.users.readAll().fetchAll();
function readAll(options?: FeedOptions): QueryIterator<UserDefinition & Resource>パラメーター
- options
- FeedOptions
戻り値
upsert(UserDefinition, RequestOptions)
指定した UserDefinition を持つデータベース ユーザーをアップサートします。
function upsert(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>パラメーター
- body
- UserDefinition
指定した UserDefinition。
- options
- RequestOptions
戻り値
Promise<UserResponse>