Illustration Image

Cassandra.Link

The best knowledge base on Apache Cassandra®

Helping platform leaders, architects, engineers, and operators build scalable real time data platforms.

10/23/2020

Reading time:2 min

DataStax-Examples/azure-functions-nodejs

by DataStax-Examples

This example shows how to use Azure 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 SplinterObjectivesHow to use the DataStax Cassandra Driver with Azure FunctionsHow to use the Serverless Framework to set up Azure Functions HTTP EndpointsProject Layoutindex.js: Contains the DataStax Cassandra Driver connection and queries as well as the Azure Functions entry points.serverless.yml: Used by serverless to deploy and configure the Azure artifacts needed to run the function.package.json: Defines the dependencies and descriptive example metadata.How it worksThe Serverless Framework handles the packaging and deployment of the functions to the Azure resources. Once the functions are deployed, the DataStax Cassandra Driver establishes the connection to the database and returns the results to the Azure HTTP Endpoints which can be accessed to interact with the database.Setup & RunningSetupBefore running with this example, head over to the SETUP-README for instructions on how tolaunch an instance in Azureinstall and start an Apache Cassandra databasesetup your local development environment for Node.js and serverlessOnce the above is completed, you will have all of the needed pieces in place to run this example.Clone this repositorygit clone https://github.com/DataStax-Examples/azure-functions-nodejs.gitGo to the directorycd azure-functions-nodejsInstall the DataStax Cassandra Drivernpm install cassandra-driverInstall serverless-azure-functions pluginnpm install serverless-azure-functionsConfigure serverless.yml with your Contact Points ( public IP of Azure instance ), and Local Data Center ( likely datacenter1 )RunningFrom the project directory, deploy your function. This should output the endpoints that you can use to access the database.sls deployWhen you are done, don't forget to clean things up withsls removeUsing the HTTP EndpointscreateCatalogNote the -d '{}' is required herecurl -X POST -d '{}' <function-app-name>.azurewebsites.net/api/catalog/createexpected output:Successfully created shopping.catalog schemaaddItemcurl -X POST -d '{"item_id": 0, "name": "name_0", "description": "desc_0", "price": 10.1}' <function-app-name>.azurewebsites.net/api/catalog/addexpected output:{"query":"INSERT INTO shopping.catalog (item_id, name, description, price) VALUES (?, ?, ?, ?)","item_id":0,"name":"name_0","description":"desc_0","price":10.1}getItemcurl -X GET <function-app-name>.azurewebsites.net/api/catalog/get/0expected output:{"query":"SELECT name, description, price FROM shopping.catalog WHERE item_id = ?","item_id":"0","name":"name_0","description":"desc_0","price":"10.1"}

Illustration Image

This example shows how to use Azure 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 Azure Functions
  • How to use the Serverless Framework to set up Azure Functions HTTP Endpoints

Project Layout

  • index.js: Contains the DataStax Cassandra Driver connection and queries as well as the Azure Functions entry points.
  • serverless.yml: Used by serverless to deploy and configure the Azure 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 Azure resources. Once the functions are deployed, the DataStax Cassandra Driver establishes the connection to the database and returns the results to the Azure 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

  1. launch an instance in Azure
  2. install and start an Apache Cassandra database
  3. 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.

  1. Clone this repository
git clone https://github.com/DataStax-Examples/azure-functions-nodejs.git
  1. Go to the directory
cd azure-functions-nodejs
  1. Install the DataStax Cassandra Driver
npm install cassandra-driver
  1. Install serverless-azure-functions plugin
npm install serverless-azure-functions
  1. Configure serverless.yml with your Contact Points ( public IP of Azure instance ), and Local Data Center ( likely datacenter1 )

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

Note the -d '{}' is required here

curl -X POST -d '{}' <function-app-name>.azurewebsites.net/api/catalog/create

expected output:

Successfully created shopping.catalog schema

addItem

curl -X POST -d '{"item_id": 0, "name": "name_0", "description": "desc_0", "price": 10.1}' <function-app-name>.azurewebsites.net/api/catalog/add

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 <function-app-name>.azurewebsites.net/api/catalog/get/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"}

Related Articles

examples
cassandra
datastax

GitHub - datastaxdevs/workshop-betterreads: Clone of Good Reads using Spring and Cassandra

datastaxdevs

12/2/2023

Checkout Planet Cassandra

Claim Your Free Planet Cassandra Contributor T-shirt!

Make your contribution and score a FREE Planet Cassandra Contributor T-Shirt! 
We value our incredible Cassandra community, and we want to express our gratitude by sending an exclusive Planet Cassandra Contributor T-Shirt you can wear with pride.

Join Our Newsletter!

Sign up below to receive email updates and see what's going on with our company

Explore Related Topics

AllKafkaSparkScyllaSStableKubernetesApiGithubGraphQl

Explore Further

serverless