Skip to main content

pgInsertSingle

Inserts a single row into the given resource, setting the given attributes (if any).

const $insertedUser = pgInsertSingle(usersResource, {
  username: $username,
});

$pgInsertSingle.set(attr, $value)​

Adds another attribute to be inserted:

const $insertedUser = pgInsertSingle(usersResource);
$insertedUser.set("username", $username);
$insertedUser.set("bio", $bio);

// Roughly equivalent to:
// `INSERT INTO users (username, bio) VALUES ($1, $2);`

$pgInsertSingle.setPlan()​

Returns a SetterStep (a "modifier step", rather than an ExecutableStep) that can be useful when combined with applyPlan plan resolvers in arguments and input fields to build up the attributes to set on the inserted row bit by bit.

$pgInsertSingle.get(attr)​

Returns a PgClassExpressionStep representing the given attribute from the inserted row. This is achieved by selecting the value using the INSERT INTO ... RETURNING ... syntax.

const $id = $insertedUser.get("id");

$pgInsertSingle.record()​

Returns a PgClassExpressionStep representing the full record that was inserted.