easy-db-google-cloud
v3.0.0
Published
Lite&easy database for Google Cloud Storage.
Downloads
10
Maintainers
Readme
Easy DB for Google Cloud Storage
Lite&easy database for Node.js, based on easy-db-code
.
Include types for TypeScript.
Features
- The same interface in Node, Web, Mobile, Cloud, Server or your own environment.
- Easy reading and updating database without any special tool.
- Handling files directly in easy-db.
API
import easyDB from "easy-db-google-cloud";
const { insert, select, update, remove, file } = easyDB({
bucketName: "easy-db-test",
bucketNameFiles: "easy-db-files", // optional, for allUser access to saved files
keyFilename: "keyFile.json", // optional, for remote development
cacheExpirationTime: 1000, // optional but recommended, it will save a lot of read requests to cloud
distanceWriteFileTime: 100, // optional but recommended if you have low limit for create or update files
});
// INSERT
const idOfRow = await insert("collection1", { myRow: 1 });
const idOfRow = await insert("collection1", (id) => ({ id, myRow: 1 }));
// SELECT
const allCollection1 = await select("collection1");
const myRow1 = await select("collection1", idOfRow);
// UPDATE
await update("collection1", idOfRow, { ...myRow1, update: 1 });
// REMOVE
await remove("collection1", idOfRow); // only one row
Example of use
// Save nickname
await update("myAppName", "nickname", nickname);
// Load nickname
const nickname = await select("myAppName", "nickname");
Google cloud configuration
Creating bucket
- With creating bucket for files:
- Select
uniform
Access control.
- Select
- Set permission for read for all users.
- In bucket set
Permissions
and+ add
user. - Set
allUsers
inNew members
. - Set
Role
as Reader for whole bucket. - Click
SAVE
.
- In bucket set
Get keyFile.json
- Go to
Service Accounts
in Google cloud console. - Three dots and
Manage keys
. - Button
ADD KEY
andJSON
. - Thats all folks.
File saving as url
// Save user with picture
await update("myAppName", "user", {
name: "Example User",
// any file in base64
photo: file("data:image/png;base64,iVB...YI="),
// or
photo: {
type: "EASY_DB_FILE",
url: "data:image/png;base64,iVB...YI=",
},
});
// Load with picture
const user = await select("myAppName", "user");
// user = { name: "Example User", photo: { url: "https://.../1f6bef21.png" } }
Files
- easy-db-bucket
- collection1.json
- easy-db-files-bucket
- j9pSCplbMx7U.png
Update DB without code
Only open file and edit them.
collection1.json
{
"j9pSCplbMx7U": { "myRow": 1, "update": 1 },
"ukAK0wN8xvwK": { "myRow": 2, "update": 36 }
}