Using Google Sheets as a database.

• Installation
• Options
• Lib
  • Lib properties
  • Lib methods
    • registerRoutes(routeEnabling?, middlewares?)
• Routing
  • Errors
  • Routes
    • Routes overview
    • Routes detail
      • GET /database/content
      • DELETE /database
      • GET /database
      • PATCH /database
      • POST /database
      • PUT /database
• Detail API reference

Installation

• Install: npm install --save @sheetbase/database

• Usage:

// 1. import module
import { DatabaseModule } from "@sheetbase/database";

// 2. create an instance
export class App {
  // the object
  databaseModule: DatabaseModule;

  // initiate the instance
  constructor() {
    this.databaseModule = new DatabaseModule(/* options */);
  }
}

Options

Lib

The Lib class.

Lib properties

Lib methods

registerRoutes(routeEnabling?, middlewares?)

Expose the module routes

Parameters

Returns

RouterService<>

Routing

DatabaseModule provides REST API endpoints allowing clients to access server resources. Theses enpoints are not exposed by default, to expose the endpoints:

DatabaseModule.registerRoutes(routeEnabling?);

Errors

DatabaseModule returns these routing errors, you may use the error code to customize the message:

• database/content-no-id: No doc id.
• database/no-input: No path/table/sheet.

Routes

Routes overview

Routes detail

GET /database/content

Get doc content

Request query

Response

object

DELETE /database

DISABLED Delete an item from the database (proxy to: post /database)

Request body

Response

void

GET /database

DISABLED Get data from the database

Request query

Response

Record<string, unknown> | unknown[]

PATCH /database

DISABLED Update an item from the database (proxy to: post /database)

Request body

Response

void

POST /database

DISABLED Add/update/delete data from database

Request body

Response

void

PUT /database

DISABLED Add a new item do the database (proxy to: post /database)

Request body

Response

void

@sheetbase/database is released under the MIT license.