Skip to content

Latest commit

 

History

History
195 lines (159 loc) · 6.33 KB

README.md

File metadata and controls

195 lines (159 loc) · 6.33 KB
Raw

Gridsome source MySQL

Gridsome Source Plugin to load data directly from MySQL Database

  • If you don't succeed through a CMS, bypass it and load the data directly from the MySQL Database

  • Specify names of columns containing image urls to download and optimized them with Gridsome. Supports single and comma delimited image urls.

  • Build up your mysql queries as you need to get the data you require.

  • Supports sub queries and references between content types

  • id field from mysql is renamed to mysqlId

  • Content type references via xxx_id(single id) and xxx_ids(comma delimited ids)

View the changelog for any possible changes from previous versions.

Latest Updates

v1.5.0 Support for parsing json.

v1.4.7 Added regex option to clean up image file names

v1.4.5 Support for dynamic routes added

Install

npm install gridsome-source-mysql --save

Setup

Make sure your mysql database is accessible everywhere you are planning to build your site from.

Within plugins in the gridsome-config.js file, add the connection settings and queries for the data you need.

// gridsome-config.js

module.exports = {
  plugins: [
    {
      use: 'gridsome-source-mysql',
      options: {
        connection: {
          host: 'localhost', // required
          port: 3306,
          user: 'root', // required
          password: 'secret', // required
          database: 'my_db', // required
          connectionLimit : 10
        },
        debug: true, // Default false on production
        ignoreImages: false, // Do not download any images
        imageDirectory: 'sql_images',
        regex: /()_\d(.(jpg|png|svg|jpeg))/i, // Default false
        queries: [ // required
          {
            name: 'Author',
            route: '/authors/:path',
            path: 'fullname',
            sql: `SELECT id, fullname, avatar, url FROM author`,
            images: ['avatar'] // Default []
          },
          {
            name: 'Post',
            path: 'title',
            sql: `SELECT id, title, image, gallery, author as author_id, excerpt, body, created FROM post WHERE published = ?`,
            args: [1],
            images: ['image', ['gallery']] //Gallery contains comma delimited string of image url.
          }
        ]
      }
    }
  ]
}

Relationship ids should be in the format of xxx_id where xxx is the name of another query.

Usage

On the above example two content types will be created Post and Author with author_id being a relation:

query {
  allPost {
    edges {
      node {
        title
        path
        image (width: 600, height: 600)
        gallery {
          index
          image (width: 400, height: 400)
        }
        excerpt
        author {
          fullname
          url
          avatar (width: 100, height: 100)
        }
      }
    }
  }
}

Definitions

Options

regex: Specify false to not use or a regex expression that has 2 capture groups. This can be used to remove duplicate files for example the value /()_\d(.(jpg|png|svg|jpeg))/i renames all files that end with _\d eg. _1, _2; since we assume them to be duplicate files. We DO NOT change the source url since it might be the original file (not ending with _\d) isn't used.

Query

Field Type Info
name string Name of the resulting content type
route? string Specify a dynamic route structure eg. /blog/:path
path function(slugify, row, parentRow?): string Return the path for the given row
path { prefix?: string, field: string, suffix?: string } field should exist on each row and will be slugified
path string Name of a field on each row to slugify and use as path
sql string A SQL Query with optional placeholders ? which will be replaced by args in order
args? array Simple array of static values
args? function(parentRow?): array Return array of values based on data from the parentRow or dynamic calculated data, eg. [Date.now()]
json? array Names of fields that contain JSON strings to convert into an object or else null
images? array<string string[]
subs array Array of Query to execute per result of the current query

MySQL Query Examples

Generate comma seperated urls and ids

The following is an example of how you can generated the fields for using as a one-to-many relationship in graphql and also joining image urls.

queries: [
  {
    name: 'Product',
    path: 'slug',
    images: ['image', ['gallery']] // Default []
    sql: `SELECT
      pc.product_id as id,
      cats.category_ids,
      pc.sku,
      pc.name,
      pc.price,
      pc.slug,
      CONCAT('https://example.com/media/', pc.image) as image,
      media.images as 'gallery',
      FROM product_catalog pc
      INNER JOIN (
          SELECT product_id, GROUP_CONCAT(CONCAT('https://example.com/media/catalog/product',value)) AS 'images'
          FROM product_media
          GROUP BY product_id
        ) media
      ON media.product_id = pc.product_id
      INNER JOIN (
          SELECT product_id, GROUP_CONCAT(category_id) AS 'category_ids'
          FROM product_category
          GROUP BY product_id
        ) cats
      ON cats.product_id = pc.product_id
      WHERE pc.status = 1`
  },
  {
    name: 'Category',
    route: '/category/:path',
    path: 'path',
    images: [(row, addImageUrl) => {
      if (row['image']) {
        row['image'] = addImageUrl(`https://example.com/media/${row['image']}`)
      }
    }],
    sql: `SELECT
      category_id AS 'id',
      name,
      image,
      parent_id AS 'category_id',
      position,
      level,
      product_count AS 'count'
      FROM category_catelog
      WHERE active = 1`
  }
]

In the above example cats.category_ids will result in an array of Category content types if you have specified a query for Category

Images in this database were relative, so in order for them to be downloaded they need to be concatenated with the site origin.

In the Category query, we change the parent_id to output as category_id since we want it to be linked to another Category automatically.