ReadMe.md

ButterDB

ButterDB is an ORM HTTP API for Google Sheets allowing your applications to fetch and manipulate data from a Google spreadsheet using POJOs (Plain-Old-Java-Objects) and Object-Relational Mapping techniques. JSON Objects sent to ButterDB endpoints are deserialized into your custom POJO and ButterDB maps the POJO to a line in the 'database' (i.e. Google spreadsheet), performing the 'database' interactions on your behalf.

For more detailed information on interacting with resources, see Endpoints. For the remainder of this document, a Google Spreadsheet is referred to as 'object storage' and a custom POJO is an ObjectModel implementation since ButterDB requires it inherit the ObjectModel interface.

Database interactions are facilitated through Google's APIs. ButterDB's CRUD functionality utilizes the Google Sheets API while query functionality utilizes the Google Visualization API.

A single running instance of ButterDB can process many ObjectModel implementations. Behind the scenes, ButterDB will use a different Google Sheet per ObjectModel implementation. However, since ButterDB relies on other APIs, we inherit their usage limitations. See Limitations to perform the calculations for your application to determine if ButterDB is a good fit for your stack. Likewise, see Optimizations for notes on how ButterDB tries to reduce the number of API calls.

POJOs and Implementing ObjectModel

POJOs that implement the ObjectModel interface inherit the ability to be serialized/deserialized into/from JSON which allows ButterDB to read & write any custom object.

ButterDB deserializes JSON into ObjectModel subclasses and, thus, the JSON must contain additional type information denoted by the property "@class". The annotation @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) at the top of your ObjectModel implementations instruct com.fasterxml.jackson to include this property on seralization.

For example, here is a payload to send to the /{ objectStorage }/create endpoint which stores a new object.

{
    "@class": "com.github.megbailey.butter.domain.SampleObjectImpl",
    "ID": 1,
    "Property": "this is a property"
}

Once you've created your ObjectModel implementation, place it alongside the ObjectModel.java and recompile the application. ButterDB will now recognize your ObjectModel implementation. See Setup for authorizing ButterDB as a GCP project and Steps to Run for full compilation instructions.

Endpoints

ButterDB Object Manipulation (DML) Base URL: localhost:3000/api/v1/orm

Method	Name	Endpoint	Description
GET	All Objects	/{ objectStorage }	Retrieve all objects contained in the storage.
GET	Query Objects	/{ objectStorage }/{ query }	Query the storage for objects. More documention on querying for objects.
POST	Create Object(s)	/{ objectStorage }/create	Insert a new object into storage.
DELETE	Delete Object(s) from a query	/{ objectStorage }/delete/{ query }	Delete an object from a query.
ButterDB Data Definition endpoints (DDL)
Base URL: localhost:3000/api/v1

Method	Name	Endpoint	Description
PUT	Create object storage	/create/{ objectStorage }	Create storage for a new object model. Equivalent of adding a sheet to a Google spreadsheet.
DELETE	Delete object storage	/delete/{ objectStorage }	Delete storage for an old object model. Equivalent of deleteing a sheet from a Google spreadsheet.

note: {} denotes your ObjectModel implementation

Limitations

ButterDB relies on Google Spreadsheet and APIs and thus is subject to Google's limitations and usage requirements (google's api usage documentation).

Google has a limit of 5 million cells of data per spreadsheet which can be spread out over any number of sheets. Because of these two limitations, ButterDB is best suited to support smaller projects that will utilize more reads than writes and that don't warrant the efficiency of a traditional relational database that can scale with your data.

If you plan on running multiple instances of ButterDB, consider creating a Google account for that instance to spread out api quotas. If ButterrDB will be included in a long-standing project, a separate google account is a good security practice.

Setup

First things first, ButterDB's foundation is a Google Spreadsheet. Navigate to Google Drive and create a Google Spreadsheet. This will hold the object storages for a single ButterDB instance.

In order to interact with Google's Sheets services via a 3d party i.e. ButterDB, you'll need to tell Google you give the application permission to use your Google account.

• Create a new Google Cloud Project
• Enable the Google Sheets API
• Create a service account for the instance
• Navigate to 'Keys' tab in the service account menu and generate a JSON key. This will initiate a download.
• Rename the downloaded file to client_secret.json and place in src/main/resources in this project.
• Navigate back to Google Drive to the new spreadsheet and share the new spreadsheet (with editor rights) with the service account email from GCP console.

Configuration file (this section is //TODO)

• Copy the ID of the spreadsheet in the URL and set the (//TODO: config file) spreadsheetID in the getGSpreadsheet @Bean.
• (optional) change the path of client_secret