npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

postgraphile-db-session-init

v1.1.1

Published

This plugin enables you to run arbitrary SQL prior to each PostGraphile query execution.

Downloads

16

Readme

PostGraphile DB Session Init

This plugin enables you to run arbitrary SQL prior to each PostGraphile query execution.

The SQL that you provide will run after pgSettings. Hence, any session variables that you establish in pgSettings will be accessible in your SQL.

Installation

npm install postgraphile-db-session-init

Usage

The plugin requires a single argument: an object containing the following properties.

const { default: DbSessionInitPlugin } = require("postgraphile-db-session-init")

const dbSessionInitPlugin = DbSessionInitPlugin({
  sql: "INSERT INTO my_table (my_col) VALUES ('test')",
})

const pluginHook = makePluginHook([dbSessionInitPlugin, /* other plugins */])

const app = express()

app.use(
  postgraphile(db, schemas, {
    // ... other settings
    pluginHook,
  })
)

In this example, the DbSessionInitPlugin is used to create an instance of the plugin, initialized with a simple SQL command. The resulting instance is then included within the pluginHook which is passed into the postgraphile middleware during its initialization in the Express application.

Precondition

Defining a precondition function allows you to control when the provided SQL should be executed based on specific conditions.

The precondition function should return a boolean value. If the function returns true (or is undefined), the SQL command will be executed. On the other hand, if the function is returns false, the SQL command will not be executed.

const dbSessionInitPlugin = DbSessionInitPlugin({
  sql: 'INSERT INTO my_audit_log (user_id, action) VALUES ($1, $2)',
  precondition: (options) =>
    options.pgSettings &&
    'role' in options.pgSettings &&
    options.pgSettings.role === 'authenticated_user',
});

In this example, the SQL command will only be executed if the precondition conditions are met, specifically if the role in pgSettings is set to 'authenticated_user'.