├── LICENSE ├── README.md ├── package.json └── worker.js /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Supported By](https://raw.githubusercontent.com/tuhinpal/tuhinpal/master/supported-by-banner.svg)](https://ddevi.com/?utm_source=tuhin_github_cloudflaredb) 2 | 3 | 4 |

5 | whatsbot 6 |
7 |

8 |

The low latency database powered by Cloudflare Worker and KV

9 |

10 | 11 | ### *Features :* 12 | - Globally Available 13 | - Lowest Latancy 14 | - Serverless 15 | - Rest API 16 | - Token Based Authenticated Request Support 17 | 18 | ### *API :* 19 | 20 | #### 1. Save a Payload (JSON) 21 | 22 | - Request: 23 | 24 | ``` 25 | Method: POST 26 | Content-Type: application/json 27 | URL (Secured with Token): https://.workers.dev/?key= 28 | URL (Not Secured): https://.workers.dev/ 29 | BODY: Json Data (Not Parsed) 30 | ``` 31 | 32 | - Response: 33 | ``` 34 | { 35 | "status": true, 36 | "_id": "16125252787azq", 37 | "query": "https://.workers.dev/16125252787azq", 38 | "data": { 39 | "i_am": "writing a readme" 40 | } 41 | } 42 | ``` 43 | - Set an ID manually: 44 | ``` 45 | Send this 👇 46 | 47 | "_id":"my-unique-id" 48 | 49 | with Body 50 | ``` 51 | 52 | #### 2. Get a saved Data: 53 | 54 | - Request: 55 | 56 | ``` 57 | Method: GET 58 | URL: https://.workers.dev/<_id> 59 | ``` 60 | 61 | - Response: 62 | 63 | ``` 64 | { 65 | "status": true, 66 | "_id": "16125252787azq", 67 | "data": { 68 | "i_am": "writing a readme" 69 | } 70 | } 71 | ``` 72 | 73 | #### 3. Delete a Data: 74 | 75 | - Request: 76 | 77 | ``` 78 | Method: DELETE 79 | URL (Secured with Token): https://.workers.dev/<_id>?key= 80 | URL (Not Secured): https://.workers.dev/<_id> 81 | ``` 82 | 83 | - Response: 84 | 85 | ``` 86 | { 87 | "status": true, 88 | "msg": "Deleted Successfully" 89 | } 90 | ``` 91 | 92 | ### *Deploy :* 93 | 94 | - Open [Cloudflare Worker](https://workers.cloudflare.com "Cloudflare Worker") Page 95 | - Click on KV 96 | - In Namespace Name section Type a Name & Click on Add, a namespace will created. 97 | - Now click on Workers & Create a worker 98 | - Copy the code of [worker.js](https://github.com/cachecleanerjeet/CloudflareDB/blob/main/worker.js "worker.js") , paste into Worker & Click on Save & Deploy 99 | - Now go back to worker main page, here you will see that your created worker listed there, click on that. 100 | - Click on Settings 101 | - In KV Namespace Bindings section click on Add Binding 102 | - Write TUHIN in Variable name & select your recently created Namespace for KV namespace. 103 | - You just made your Cloudflare DB, Now Read the API Endpoint and use it in your Project 😪 104 | 105 | ### *Secure with Token :* 106 | *You can impliment token based authentication system for POST and DELETE requests* 107 | 108 | - Write your key in POSTKEY to secure POST requests with a Token (Line No: 12) 109 | - Write your key in DELETEKEY to secure DELETE requests with a Token (Line No: 13) 110 | 111 | ### *Note for Kangers :* 112 | 113 | Kanging will not make you a developer. So, don't be a kanger ⚠ 114 | 115 | ### *License & Copyright :* 116 | - This Project is [Apache-2.0](https://github.com/cachecleanerjeet/CloudflareDB/blob/main/LICENSE) Licensed 117 | - Copyright 2021 by [Tuhin Kanti Pal](https://github.com/cachecleanerjeet) 118 | 119 | ### *Connect :* 120 | - [Channel](https://telegram.dog/tprojects) 121 | - [Support Group](https://telegram.dog/t_projects) 122 | 123 | 124 | ### Thanks to Cloudflare to give these services for free 🥰 125 | 126 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cloudflare-db", 3 | "version": "1.0.0", 4 | "description": "The low latency database powered by Cloudflare Worker and KV", 5 | "repository": { 6 | "type": "git", 7 | "url": "git+https://github.com/cachecleanerjeet/CloudflareDB.git" 8 | }, 9 | "keywords": [ 10 | "Cloudflare", 11 | "Cloudflare-Worker" 12 | ], 13 | "author": "Tuhin Kanti Pal", 14 | "license": "Apache-2.0", 15 | "bugs": { 16 | "url": "https://github.com/cachecleanerjeet/CloudflareDB/issues" 17 | }, 18 | "homepage": "https://github.com/cachecleanerjeet/CloudflareDB#readme" 19 | } -------------------------------------------------------------------------------- /worker.js: -------------------------------------------------------------------------------- 1 | /** @type {any} Your Key to secure POST requests with a token. null if allowed */ 2 | const POSTKEY = null; 3 | 4 | /** @type {any} Your Key to secure DELETE requests with a token. null if allowed */ 5 | const DELETEKEY = null; 6 | 7 | /** You can edit this variable to change KV Name Binding */ 8 | const KV_NAMESPACE = TUHIN; 9 | 10 | /** 11 | * Handle the request 12 | * @param {Request} request 13 | */ 14 | async function handleRequest(request) { 15 | try { 16 | /** @type {string} Hostname of the worker */ 17 | const host = request.headers.get("host"); 18 | 19 | /** @type {string} Path of the request */ 20 | const path = new URL(request.url).pathname; 21 | 22 | /** 23 | * Handle the request 24 | * @param {string} key Key to be searched from URL param 25 | * @return {string} Value of the key 26 | */ 27 | function getUrlParam(key) { 28 | return new URL(request.url).searchParams.get(key); 29 | } 30 | 31 | switch (request.method) { 32 | case "OPTIONS": { 33 | /** Handle Preflight */ 34 | return jsonResponse({ 35 | data: { msg: "Preflight request success 🤝" }, 36 | }); 37 | } 38 | case "POST": { 39 | /** Handle POST */ 40 | if (POSTKEY && getUrlParam("key") !== POSTKEY) { 41 | /** Unauthorized */ 42 | return jsonResponse({ 43 | data: { status: false, msg: "Invalid key, Unauthorized!" }, 44 | status: 403, 45 | }); 46 | } else { 47 | /** Authorized to save payload */ 48 | 49 | /** @type {object} Request payload */ 50 | var payload = await request.json(); 51 | 52 | /** @type {object} Save and return payload */ 53 | var save = await savePayload(payload); 54 | 55 | /** Send response */ 56 | return jsonResponse({ 57 | data: { 58 | status: true, 59 | _id: save._id, 60 | query: `https://${host}/${save._id}`, 61 | data: save, 62 | }, 63 | }); 64 | } 65 | } 66 | case "GET": { 67 | /** Handle GET */ 68 | 69 | if (path === "/") { 70 | return jsonResponse({ 71 | data: { 72 | status: "Running", 73 | }, 74 | }); 75 | } else { 76 | /** @type {object} Retrive payload from ID */ 77 | var getData = await KV_NAMESPACE.get(path.substring(1)); 78 | if (getData) { 79 | return jsonResponse({ 80 | data: JSON.parse(getData), 81 | }); 82 | } else { 83 | return jsonResponse({ 84 | data: { 85 | status: false, 86 | msg: "Not Found", 87 | }, 88 | status: 404, 89 | }); 90 | } 91 | } 92 | } 93 | case "DELETE": { 94 | if (DELETEKEY && getUrlParam("key") !== DELETEKEY) { 95 | /** Unauthorized */ 96 | return jsonResponse({ 97 | data: { status: false, msg: "Invalid key, Unauthorized!" }, 98 | status: 403, 99 | }); 100 | } else { 101 | /** Authorized to delete payload */ 102 | 103 | await KV_NAMESPACE.delete(path.substring(1)); 104 | return jsonResponse({ 105 | data: { 106 | status: true, 107 | msg: "Deleted Successfully", 108 | }, 109 | }); 110 | } 111 | } 112 | default: { 113 | /** Handle unknown request */ 114 | throw new Error("Invalid request method"); 115 | } 116 | } 117 | } catch (error) { 118 | return jsonResponse({ 119 | data: { status: false, msg: error.message }, 120 | status: 500, 121 | }); 122 | } 123 | } 124 | 125 | /** 126 | * Send a JSON response to the client 127 | * 128 | * @param {object} obj - Response 129 | * @param {any} obj.data - Body of the response 130 | * @param {number} obj.status - Status code of the response 131 | * @param {object} obj.headers - Headers of the response 132 | * @returns {Response} 133 | */ 134 | function jsonResponse({ data = null, status = 200, headers = {} }) { 135 | return new Response(JSON.stringify(data), { 136 | status, 137 | headers: { 138 | "Access-Control-Allow-Headers": "*", 139 | "Access-Control-Allow-Methods": "GET,POST,DELETE,OPTIONS", 140 | "Access-Control-Max-Age": "86400", 141 | "Content-Type": "application/json", 142 | "Cache-Control": "no-cache, no-store, must-revalidate", 143 | ...headers, 144 | }, 145 | }); 146 | } 147 | 148 | /** 149 | * Send a JSON response to the client 150 | * 151 | * @param {Object} payload - Payload to be saved 152 | */ 153 | async function savePayload(payload) { 154 | if (!payload._id) 155 | payload._id = 156 | new Date().getTime() + Math.random().toString(36).substring(9); 157 | await KV_NAMESPACE.put(payload._id, JSON.stringify(payload)); 158 | return payload; 159 | } 160 | 161 | addEventListener("fetch", (event) => { 162 | event.respondWith(handleRequest(event.request)); 163 | }); 164 | --------------------------------------------------------------------------------