This example shows how to use Google Cloud Functions with the Node.js DataStax Cassandra Driver to set up a basic REST API for a Cassandra database via HTTP Endpoints. The Serverless Framework is used to facilitate the setup and deployment of the functions.
Contributor(s): Chris Splinter
Objectives
- How to use the DataStax Cassandra Driver with Google Cloud Functions
- How to use the Serverless Framework to set up Google Cloud Functions HTTP Endpoints
Project Layout
- index.js: Contains the Cassandra Driver connection and queries as well as the Google Cloud Function entry points.
- serverless.yml: Used by serverless to deploy and configure the Google Cloud artifacts needed to run the function.
- package.json: Defines the dependencies and descriptive example metadata.
How it works
The Serverless Framework handles the packaging and deployment of the functions to the Google Cloud resources. Once the functions are deployed, the DataStax Cassandra Driver establishes the connection to the database and returns the results via the Google Cloud HTTP Endpoints which can be accessed to interact with the database.
Setup & Running
Setup
Before running with this example, head over to the SETUP-README for instructions on how to
- launch an instance in Google Cloud
- install and start a Cassandra database
- setup your local development environment for Node.js and serverless
Once the above is completed, you will have all of the needed pieces in place to run this example.
- Clone this repository
git clone https://github.com/DataStax-Examples/google-cloud-functions-nodejs.git
- Go to the
google-cloud-functions-nodejs
directory
cd google-cloud-functions-nodejs
- Install the DataStax Cassandra Driver
npm install cassandra-driver
- Install serverless-google-cloudfunctions plugin
npm install serverless-google-cloudfunctions
- Configure
serverless.yml
with your project-id, credentials file, Contact Points ( public IP of GCP instance ), and Local Data Center ( likelydatacenter1
)
Running
From the project directory, deploy your function. This should output the endpoints that you can use to access the database.
sls deploy
- When you are done, don't forget to clean things up with
sls remove
Using the HTTP Endpoints
createCatalog
curl -X POST https://us-central1-<project-id>.cloudfunctions.net/createCatalog
expected output:
"Successfully created shopping.catalog schema"
addItem
Note the -H "Content-Type:application/json"
is required here.
curl -X POST -H "Content-Type:application/json" -d '{"item_id": 0, "name": "name_0", "description": "desc_0", "price": 10.1}' https://us-central1-<project-id>.cloudfunctions.net/addItem
expected output:
{"query":"INSERT INTO shopping.catalog (item_id, name, description, price) VALUES (?, ?, ?, ?)","item_id":0,"name":"name_0","description":"desc_0","price":10.1}
getItem
curl -X GET https://us-central1-<project-id>.cloudfunctions.net/getItem/0
expected output:
{"query":"SELECT name, description, price FROM shopping.catalog WHERE item_id = ?","item_id":["0"],"name":"name_0","description":"desc_0","price":"10.1"}