Git Product home page Git Product logo

postgraphile-filter-plugins's Introduction

postgraphile-filter-plugins

These plugins add a new filter: argument to Connection types in PostGraphile v4. No changes are made to the existing condition: argument.

Disclaimer

These plugins target the alpha release of PostGraphile. Bug reports and pull requests are very much welcome.

Usage

CLI

postgraphile --append-plugins `pwd`/path/to/this/plugin/index.js

Library

const express = require("express");
const { postgraphql } = require("postgraphile");
const GraphileBuildPgContribConnectionFilter = require("./path/to/this/plugin/index.js");

const app = express();

app.use(
  postgraphql(pgConfig, schema, {
    graphiql: true,
    appendPlugins: [GraphileBuildPgContribConnectionFilter],
  })
);

app.listen(3000);

The following options can be passed via graphqlBuildOptions:

connectionFilterUsesShortNames

Use short names (e.g. eq, ne, lt, lte) for operators

postgraphql(pgConfig, schema, {
  ...
  graphqlBuildOptions: {
    connectionFilterUsesShortNames: true,
  },
})

connectionFilterAllowedFieldTypes

Restrict filters to specific field types

postgraphql(pgConfig, schema, {
  ...
  graphqlBuildOptions: {
    connectionFilterAllowedFieldTypes: ["String", "Int"],
  },
})

To add/remove/modify individual operators, you can edit src/PgConnectionArgFilterOperatorsPlugin.js.

Development

To establish a test environment, create an empty Postgres database (e.g. graphile-build-test) and set a TEST_DATABASE_URL environment variable with your connection string (e.g. postgres://localhost:5432/graphile-build-test). Ensure that psql is installed locally and then run:

npm install
npm test

postgraphile-filter-plugins's People

Contributors

edqallen avatar mattbretl avatar

Watchers

Benjie avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.