|
1 | 1 | <!--- STARTEXCLUDE ---> |
| 2 | + |
2 | 3 | # Astra DB REST API with Google Cloud Functions in Node.js |
3 | | -*30 minutes, Intermediate, [Start Building](https://github.com/DataStax-Examples/google-cloud-functions-nodejs#prerequisites)* |
| 4 | + |
| 5 | +_30 minutes, Intermediate, [Start Building](https://github.com/DataStax-Examples/google-cloud-functions-nodejs#prerequisites)_ |
4 | 6 |
|
5 | 7 | This example shows how to use [Google Cloud Functions](https://cloud.google.com/functions/) with the [Node.js DataStax Cassandra Driver](https://docs.datastax.com/en/developer/nodejs-driver/latest) to set up a basic REST API for a Cassandra database via HTTP Endpoints. The [Serverless Framework](https://serverless.com/) is used to facilitate the setup and deployment of the functions. |
6 | | -<!--- ENDEXCLUDE ---> |
7 | 8 |
|
| 9 | +<!--- ENDEXCLUDE ---> |
8 | 10 |
|
9 | 11 |  |
10 | 12 |
|
11 | | - |
12 | 13 | ## Objectives |
| 14 | + |
13 | 15 | - How to use the DataStax Cassandra Driver with Google Cloud Functions |
14 | 16 | - How to use the Serverless Framework to set up Google Cloud Functions HTTP Endpoints |
15 | | - |
| 17 | + |
16 | 18 | ## How it works |
| 19 | + |
17 | 20 | 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. |
18 | 21 |
|
19 | 22 | ## Get Started |
| 23 | + |
20 | 24 | To build and play with this app, follow the build instructions that are located here: [https://github.com/DataStax-Examples/google-cloud-functions-nodejs](https://github.com/DataStax-Examples/google-cloud-functions-nodejs#prerequisites) |
21 | 25 |
|
22 | 26 | <!--- STARTEXCLUDE ---> |
| 27 | + |
23 | 28 | ## Prerequisites |
| 29 | + |
24 | 30 | Let's do some initial setup by creating a serverless(!) database. |
25 | 31 |
|
26 | 32 | ### DataStax Astra |
| 33 | + |
27 | 34 | <!--- enter a unique UTM_CODE for your sample app below ---> |
| 35 | + |
28 | 36 | 1. Create a [DataStax Astra account](https://dtsx.io/3jENJkP) if you don't already have one: |
29 | | - |
| 37 | +  |
30 | 38 |
|
31 | 39 | 2. On the home page. Locate the button **`Create Database`** |
32 | | - |
| 40 | +  |
33 | 41 |
|
34 | 42 | 3. Locate the **`Get Started`** button to continue |
35 | | - |
| 43 | +  |
36 | 44 |
|
37 | 45 | 4. Define a **database name**, **keyspace name** and select a database **region**, then click **create database**. |
38 | | - |
| 46 | +  |
39 | 47 |
|
40 | | -5. Your Astra DB will be ready when the status will change from *`Pending`* to **`Active`** 💥💥💥 |
41 | | - |
| 48 | +5. Your Astra DB will be ready when the status will change from _`Pending`_ to **`Active`** 💥💥💥 |
| 49 | +  |
42 | 50 |
|
43 | 51 | 6. After your database is provisioned, we need to generate an Application Token for our App. Go to the `Settings` tab in the database home screen. |
44 | | - |
| 52 | +  |
45 | 53 |
|
46 | 54 | 7. Select `Admin User` for the role for this Sample App and then generate the token. Download the CSV so that we can use the credentials we need later. |
47 | | - |
| 55 | +  |
48 | 56 |
|
49 | 57 | 8. After you have your Application Token, head to the database connect screen and select the driver connection that we need. Go ahead and download the `Secure Bundle` for the driver. |
50 | | - |
| 58 | +  |
51 | 59 |
|
52 | 60 | 9. Make note of where to use the `Client Id` and `Client Secret` that is part of the Application Token that we generated earlier. |
53 | | - |
| 61 | +  |
54 | 62 |
|
55 | 63 | ### Github |
56 | 64 |
|
57 | 65 | 1. Click `Use this template` at the top of the [GitHub Repository](https://github.com/DataStax-Examples/google-cloud-functions-nodejs): |
58 | | - |
| 66 | +  |
59 | 67 |
|
60 | 68 | 2. Enter a repository name and click 'Create repository from template': |
61 | | - |
| 69 | +  |
62 | 70 |
|
63 | 71 | 3. Clone the repository: |
64 | | - |
| 72 | +  |
65 | 73 |
|
66 | 74 | ## 🚀 Getting Started Paths: |
67 | | -*Make sure you've completed the [prerequisites](#prerequisites) before starting this step* |
68 | | - - [Running on your local machine](#running-on-your-local-machine) |
| 75 | + |
| 76 | +_Make sure you've completed the [prerequisites](#prerequisites) before starting this step_ |
| 77 | + |
| 78 | +- [Running on your local machine](#running-on-your-local-machine) |
69 | 79 |
|
70 | 80 | ### Running on your local machine |
71 | | -Before running with this example, head over to the [SETUP-README](SETUP-README.md) for instructions on how to |
| 81 | + |
| 82 | +Before running with this example, head over to the [SETUP-README](https://raw.githubusercontent.com/DataStax-Examples/google-cloud-functions-nodejs/blob/master/SETUP-README.md) for instructions on how to |
| 83 | + |
72 | 84 | 1. launch an instance in Google Cloud |
73 | 85 | 2. install and start a Cassandra database |
74 | 86 | 3. setup your local development environment for Node.js and [serverless](https://serverless.com) |
75 | 87 |
|
76 | 88 | Once the above is completed, you will have all of the needed pieces in place to run this example. |
77 | 89 |
|
78 | 90 | 1. Install the DataStax Cassandra Driver |
| 91 | + |
79 | 92 | ```sh |
80 | 93 | npm install cassandra-driver |
81 | 94 | ``` |
| 95 | + |
82 | 96 | 4. Install serverless-google-cloudfunctions plugin |
| 97 | + |
83 | 98 | ```sh |
84 | 99 | npm install serverless-google-cloudfunctions |
85 | 100 | ``` |
| 101 | + |
86 | 102 | 5. Configure `serverless.yml` with your project-id, credentials file, Contact Points ( public IP of GCP instance ), and Local Data Center ( likely `datacenter1` ) |
87 | 103 |
|
88 | 104 | From the project directory, deploy your function. This should output the endpoints that you can use to access the database. |
| 105 | + |
89 | 106 | ```sh |
90 | 107 | sls deploy |
91 | 108 | ``` |
92 | | -* When you are done, don't forget to clean things up with |
| 109 | + |
| 110 | +- When you are done, don't forget to clean things up with |
| 111 | + |
93 | 112 | ``` |
94 | 113 | sls remove |
95 | 114 | ``` |
96 | 115 |
|
97 | 116 | #### createCatalog |
| 117 | + |
98 | 118 | ```sh |
99 | 119 | curl -X POST https://us-central1-<project-id>.cloudfunctions.net/createCatalog |
100 | | -```` |
| 120 | +``` |
| 121 | + |
101 | 122 | expected output: |
| 123 | + |
102 | 124 | ```sh |
103 | 125 | "Successfully created shopping.catalog schema" |
104 | 126 | ``` |
| 127 | + |
105 | 128 | #### addItem |
| 129 | + |
106 | 130 | Note the `-H "Content-Type:application/json"` is required here. |
| 131 | + |
107 | 132 | ```sh |
108 | 133 | 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 |
109 | 134 | ``` |
| 135 | + |
110 | 136 | expected output: |
| 137 | + |
111 | 138 | ```sh |
112 | 139 | {"query":"INSERT INTO shopping.catalog (item_id, name, description, price) VALUES (?, ?, ?, ?)","item_id":0,"name":"name_0","description":"desc_0","price":10.1} |
113 | 140 | ``` |
| 141 | + |
114 | 142 | #### getItem |
| 143 | + |
115 | 144 | ```sh |
116 | 145 | curl -X GET https://us-central1-<project-id>.cloudfunctions.net/getItem/0 |
117 | 146 | ``` |
| 147 | + |
118 | 148 | expected output: |
| 149 | + |
119 | 150 | ```sh |
120 | 151 | {"query":"SELECT name, description, price FROM shopping.catalog WHERE item_id = ?","item_id":["0"],"name":"name_0","description":"desc_0","price":"10.1"} |
121 | 152 | ``` |
|
0 commit comments