@rexfng/google-sheet-db v1.8.0

Google Sheet DB

Description

Google Sheet DB is a library that provides helpers to convert google sheet csv into json, with express routers that serves the data and creates a RESTful api.

Define Environment Variables

Define the follow environment variable. They are all required. | Variable Name | Description | |---------------|-------------| | REDIS_HOST | // sample values: 19324 | | REDIS_PORT | // sample values: redis-19324.c1.us-west-2-2.ec2.cloud.redislabs.com | | REDIS_AUTH_PASS | // sample values: 6X2MOasdfasdfamSY5WCo0 |

Initialize Module

const googleSheetDb = require('@rexfng/google-sheet-db')

Get Sheet Data Helper

const googleSheetDb = require('@rexfng/google-sheet-db')
let googleSheetDbInstance = await googleSheetDb.helpers.getSheetData({sheet, id})

Router Helper

const googleSheetDb = require('@rexfng/google-sheet-db')
let GoogleSheetAPI = googleSheetDb.api

app.use('/', GoogleSheetAPI.getSheetData) // GET 

Get Sheet Data Endpoint

The endpoint takes in JSON Body in the following format http://localhost:3000/{:google-sheet-id} GET

Optional Query

Response Code | CODE| MESSAGE | Details | |-----|----------------------|---| | 200 | SUCCESS | Successfully retrieved data | | 500 | INTERNAL_ERROR | Server side error |

Response

{
	//[JSON]
}

Search Sheet Data Endpoint

The endpoint takes in JSON Body in the following format http://localhost:3000/{:google-sheet-id} GET

Optional Query

Response Code | CODE| MESSAGE | Details | |-----|----------------------|---| | 200 | SUCCESS | Successfully retrieved data | | 500 | INTERNAL_ERROR | Server side error |

Response

{
	//[JSON]
}