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-plugin-zombodb

v1.0.0-beta.5

Published

Full text searching using ZomboDB indexes

Downloads

7

Readme

Package on npm CircleCI

postgraphile-plugin-zombodb

This plugin implements a full text search operator for tables that have a ZomboDB index, using Elasticsearch.

Getting Started

CLI

postgraphile --append-plugins postgraphile-plugin-zombodb

See here for more information about loading plugins with PostGraphile.

Library

const express = require('express');
const { postgraphile } = require('postgraphile');
const PostGraphileZomboDBPlugin = require('postgraphile-plugin-zombodb');

const app = express();

app.use(
  postgraphile(pgConfig, schema, {
    appendPlugins: [
      PostGraphileZomboDBPlugin,
    ],
  })
);

app.listen(5000);

Schema

The plugin discovers all ZomboDB indexes and adds a search input argument for each table with an index. For help with getting started with ZomboDB, check out the tutorial.

Searching

The plugin passes the search string directly to the ZomboDB extension. See ZomboDB's Query DSL documentation for how to structure queries.

Scoring

A Float score column will be automatically added to the GraphQL type for each indexed table, named _score by default.

This score field can be used for ordering and is automatically added to the orderBy enum for the table.

Examples

query {
  allPosts(
    search: {
      query: "+cat and +dog"
      minScore: 0.5
    }
    orderBy: _SCORE_DESC
  }) {
    ...
    _score
  }
}

To Do

  • This plugin does not yet map limit/offset and order by parameters into ZomboDB's query DSL, and so searches on huge tables may not be particularly performant.
  • Match highlighting.
  • Structured queries.