Merge pull request #286 from appwrite/feat-node-databases

Feat: Node Database templates

node/query-mongo-atlas/README.md

@@ -0,0 +1,50 @@
+# 🗄️ Node.js Query Mongo Atlas Function
+
+A function to store warehouses to SQL database, and query to list them.
+
+## 🧰 Usage
+
+### GET /
+
+- Save one warehouse and query to return all of them.
+
+**Response**
+
+Sample `200` Response:
+
+```js
+[
+  {
+    "_id": "664897aff5fc199b80c1a132",
+    "location": "Street 283, Earth",
+    "capacity": 60
+  },
+  {
+    "_id": "664897f58f2d686e85b93692",
+    "location": "Street 593, Earth",
+    "capacity": 60
+  },
+  // ...
+]
+```
+
+## ⚙️ Configuration
+
+| Setting           | Value         |
+| ----------------- | ------------- |
+| Runtime           | Node (18.0)   |
+| Entrypoint        | `src/main.js` |
+| Build Commands    | `npm install` |
+| Permissions       | `any`         |
+| Timeout (Seconds) | 15            |
+
+## 🔒 Environment Variables
+
+### MONGO_URI
+
+The endpoint to connect to your Mongo database.
+
+| Question     | Answer                         |
+| ------------ | ------------------------------ |
+| Required     | Yes                            |
+| Sample Value | `mongodb+srv://appwrite:[email protected]/?retryWrites=true&w=majority&appName=Appwrite` |

node/query-mongo-atlas/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "query-mongo-atlas",
+  "version": "1.0.0",
+  "main": "src/main.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "dependencies": {
+    "mongodb": "^6.6.2"
+  }
+}

node/query-mongo-atlas/src/main.js

@@ -0,0 +1,25 @@
+import { throwIfMissing } from "./utils.js";
+import { getClient, insertTestData, listWarehouses } from "./mongo.js";
+
+/**
+ * Global connection. Reused between executions
+ */
+let client;
+
+export default async ({ req, res, log, error }) => {
+    throwIfMissing(process.env, ['MONGO_URI']);
+
+    if(req.method !== 'GET') {
+        return res.send('Not found.', 404);
+    }
+
+    if (!client) {
+        client = await getClient();
+    }
+
+    await insertTestData(client);
+
+    const warehouses = await listWarehouses(client);
+
+    return res.json(warehouses);
+}

node/query-mongo-atlas/src/mongo.js

@@ -0,0 +1,46 @@
+import { MongoClient, ServerApiVersion } from 'mongodb';
+
+/**
+ * Throws an error if any of the keys are missing from the object
+ */
+export async function getClient() {
+    const client = new MongoClient(process.env.MONGO_URI, {
+        serverApi: {
+            version: ServerApiVersion.v1,
+            strict: true,
+            deprecationErrors: true,
+        }
+    });
+
+    await client.connect();
+
+    return client;
+}
+
+/**
+ * Insert a sample warehouse
+ */
+export async function insertTestData(client) {
+    const location = `Street ${Math.round(Math.random() * 1000)}, Earth`; // Random address
+    const capacity = 10 + Math.round(Math.random() * 10) * 10; // Random number: 10,20,30,...,90,100
+
+    await client.db("main").collection("warehouses").insertOne({
+        location,
+        capacity
+    });
+}
+
+/**
+ * Get all warehouses
+ */
+export async function listWarehouses(client, page = 1) {
+    const limit = 100;
+    const cursor = client.db("main").collection("warehouses").find().limit(limit).skip((page - 1) * limit);
+
+    const documents = [];
+    for await (const doc of cursor) {
+        documents.push(doc);
+    }
+
+    return documents;
+}

node/query-mongo-atlas/src/utils.js

@@ -0,0 +1,14 @@
+/**
+ * Throws an error if any of the keys are missing from the object
+ */
+export function throwIfMissing(obj, keys) {
+    const missing = [];
+    for (let key of keys) {
+      if (!(key in obj) || !obj[key]) {
+        missing.push(key);
+      }
+    }
+    if (missing.length > 0) {
+      throw new Error(`Missing required fields: ${missing.join(', ')}`);
+    }
+  }