leoafarias / neardb Goto Github PK

Simple document db made for infinitely scalable globally distributed reads.

License: MIT License

TypeScript 94.25% JavaScript 5.75%

s3 database json-database edge-computing edge cache serverless lambda react-native iot

neardb's Introduction

NearDB is a simple database that leverages cloud infrastructure like document storage and CDN to deliver an inexpensive unbelievably scalable document database optimized for reads and perfect for edge applications.

Motivation

While working on building edge applications for higher performance and lower latency there is a need store persistent data also on edge.

Distributed database solutions but they are very involved and costly while having a lower global footprint than a CDN.

Leverage ubiquitous and mature infrastructure like cloud storage and CDNs to deliver a persistent, performance, and inexpensive db solution from the edge.

Use with Edge Apps/Functions

Zeit Now - Global Serverless Deployments
Cloudflare Workers - Serverless applications on Cloudflare's global network
Lambda@Edge - Run Lambda functions on CloudFront
Fly.io - Javascript at the edge

Works with the following for database storage

AWS S3
Google Cloud Storage
Digital Ocean Spaces
Minio
any S3 API compatible storage service

Client-side compatibility

Keep in mind while using this for client-side that ACL is done on the bucket/CDN level. It was designed for edge server use so client implementation can be a bit tricky. Open an issue with your specific case, I would love to hear how you plan on using it.

Browser
React Native

Who is this for

This is perfect for persistent data that is read frequently and needs to be avaialble on the edge application to deliver dynamic data while keeping the costs low. Some examples of the best uses are:

Key-value
Configuration
Cached data

Probably not for you if

You plan on using this as your primary database for an app that has complex data needs.
You need transactions. (I have some ideas on how to accomplish this, but its currently not implemented.)
Do many writes/sec in the same document. Reads are incredibly efficient, fast and inexpensive; however, writes are always at the origin.

Documentation & Guides

See NearDB.org

TypeDoc

See the documentation generated from TypeDoc.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE file for details

neardb's People

Contributors

Stargazers

Watchers

Forkers

codacy-badger rimenes v-dorosh dandv freshy969 tehuel ianko joegang2021 domitechs

neardb's Issues

Unterminated sentence in the README

Configure headers needed for your CDN here. Cache rules, or tokens can be set up through

The automated release is failing 🚨

🚨 The automated release from the `master` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

mLab support?

mLab supports 0.5GB of free document-oriented storage.

Add Google Cloud Storage example

How would one use GCS? I can't quite figure it out from the README.

By comparison, @lukechilds's keyv is much clearer in how to get started.

How to get a list of PathItem?

For example, I created country/russia and country/usa by collection:

  const GDPofRussia = await neardb.collection('country/russia').doc('GDP').set({
    value: '1699876580000',
    currency: 'USD'
  })

  const GDPofUSA = await neardb.collection('country/usa').doc('GDP').set({
    value: '21433226580000',
    currency: 'USD'
  })

and I want to get a list of country collection:

['russia', 'usa']

Maybe, your implementation are different

[email protected] Broken

Heya, really excited about this project and its goals, unfortunately the latest relase: 0.2.0 on NPM is broken, the s3_1.default is present, which has been addressed in future versions & your current codebase.

The beta release is working fine.

Please update the NPM release version when convenient

Additionally if you added the following script, it would enable people to checkout from github directly autocompiling ts to js for your matching releases
"postinstall": "tsc --outDir ./build"

https://stackoverflow.com/a/58257602