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

@topmodel/sql

v1.0.4

Published

SQL plugin compatible with topmodel core (wrapper around Knex.js)

Downloads

4

Readme

@topmodel/sql

SQL connector (compatible with topmodel models)

Note: this plugin is a wrapper around Knex.js

Install

With npm

npm install @topmodel/sql

or yarn

yarn add @topmodel/sql

Then add one of the following, depending on your install

npm install pg
npm install sqlite3
npm install mysql
npm install mysql2
npm install oracledb
npm install mssql

For the following documentation, we will use Postgresql (pg) as an example

Usage

Setup your SQL connector Plugin and pass it through the model options:

import { Model } from '@topmodel/core'
import { SQLPlugin } from '@topmodel/sql'

const { 
    PSQL_HOST, 
    PSQL_USER, 
    PSQL_PASSWORD, 
    PSQL_DB 
} = process.env

const pg = new SQLPlugin({
  client: 'pg',
  host: PSQL_HOST,
  user: PSQL_USER,
  password: PSQL_PASSWORD,
  database: PSQL_DB
})

const options = { db: pg }

class User extends Model {
    constructor(data){
        super(data, options)
    }
}

// User class is now ready to interact with PSQL !

You can then use your User model and persist its data within Postgresql (or any other Knex compatible database)

// example : 

const user = new User({ email: '[email protected]' })
const saved = await user.save()

console.log(saved) // saved user in psql

Table

Note: by default topmodel core will attribute a table name related to your model name, for example model User will become user table in SQL.

If you want to force the collection, please refer to the core model option table here

API

Topmodel db connectors has built-in methods extended to your models :

| Method | Return | Comments | |----------|:-------------|:------| | save() | Promise(Model) | create or update if data.id or data._id`` is specified | | read()| Promise(Model) | will retrieve the data in the database (will requireid) | | del()| Promise(Model) | will delete the data in the database (will requireid`) |

save

Create or update your model in psql

// create
const user = new User({ email: '[email protected]' })

const saved = await user.save()
console.log(saved.body) 

// or update

const user = new User({ 
    id: 'b9f8c112-0750-42eb-a146-a81be4c1df64', 
    email: '[email protected]' 
})
const updated = await user.save()
console.log(updated.body)

read

Read data from the database and populate the Model

const user = new User({ 
    id: 'b9f8c112-0750-42eb-a146-a81be4c1df64' 
})
await user.read()

console.log(user.body) 
// { id: 'b9f8c112-0750-42eb-a146-a81be4c1df64' , email: '[email protected]' }

del

Delete data in the database

const user = new User({ id: 'b9f8c112-0750-42eb-a146-a81be4c1df64' })
const deleted = await user.del()

console.log(deleted) // true