https://github.com/graphile-contrib/postgraphile-plugin-upload-field

Upload fields in PostGraphile
https://github.com/graphile-contrib/postgraphile-plugin-upload-field

Last synced: 12 days ago
JSON representation

Upload fields in PostGraphile

• Host: GitHub
• URL: https://github.com/graphile-contrib/postgraphile-plugin-upload-field
• Owner: graphile-contrib
• License: mit
• Created: 2018-03-23T18:50:55.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T21:57:09.000Z (over 1 year ago)
• Last Synced: 2024-10-28T22:14:59.303Z (16 days ago)
• Language: JavaScript
• Size: 1.25 MB
• Stars: 43
• Watchers: 5
• Forks: 4
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Package on npm](https://img.shields.io/npm/v/postgraphile-plugin-upload-field.svg)](https://www.npmjs.com/package/postgraphile-plugin-upload-field) [![CircleCI](https://circleci.com/gh/graphile-contrib/postgraphile-plugin-upload-field.svg?style=svg)](https://circleci.com/gh/graphile-contrib/postgraphile-plugin-upload-field)

# postgraphile-plugin-upload-field

Upload fields in PostGraphile

> Requires `graphql-upload@^10.0.0`

## Usage

```js

const fs = require("fs");

const path = require("path");

const express = require("express");

const { postgraphile } = require("postgraphile");

const PostGraphileUploadFieldPlugin = require("postgraphile-plugin-upload-field");

const { graphqlUploadExpress } = require("graphql-upload");

const app = express();

const UPLOAD_DIR_NAME = 'uploads';

// Serve uploads as static resources

app.use(`/${UPLOAD_DIR_NAME}`, express.static(path.resolve(UPLOAD_DIR_NAME)));

// Attach multipart request handling middleware

app.use(graphqlUploadExpress());

app.use(

  postgraphile("postgres://localhost:5432/upload_example", "public", {

    graphiql: true,

    enableCors: true,

    appendPlugins: [PostGraphileUploadFieldPlugin],

    graphileBuildOptions: {

      uploadFieldDefinitions: [

        {

          match: ({ schema, table, column, tags }) =>

            column === "header_image_file",

          resolve: resolveUpload

        }

      ]

    }

  })

);

app.listen(5000, () => {

  console.log('Server listening on port 5000');

});

async function resolveUpload(upload, _args, _context, _info) {

  const { filename, mimetype, encoding, createReadStream } = upload;

  const stream = createReadStream();

  // Save file to the local filesystem

  const { id, filepath } = await saveLocal({ stream, filename });

  // Return metadata to save it to Postgres

  return filepath;

}

function saveLocal({ stream, filename }) {

  const timestamp = new Date().toISOString().replace(/\D/g, "");

  const id = `${timestamp}_${filename}`;

  const filepath = path.join(UPLOAD_DIR_NAME, id);

  const fsPath = path.join(process.cwd(), filepath);

  return new Promise((resolve, reject) =>

    stream

      .on("error", error => {

        if (stream.truncated)

          // Delete the truncated file

          fs.unlinkSync(fsPath);

        reject(error);

      })

      .on("end", () => resolve({ id, filepath }))

      .pipe(fs.createWriteStream(fsPath))

  );

}

```

## Examples

See https://github.com/mattbretl/postgraphile-upload-example/ for an example implementation.