rakibtg / sleekdb
SleekDB - A 30Kb NoSQL Database made using PHP
Fund package maintenance!
sleekdb
Installs: 82 596
Dependents: 18
Suggesters: 0
Security: 0
Stars: 896
Watchers: 38
Forks: 81
Open Issues: 31
Requires
- php: >=7.0
- ext-json: *
- ext-mbstring: *
Requires (Dev)
- phpunit/phpunit: ^6.5
- spatie/phpunit-watcher: ^1.8
- dev-master
- 2.15
- 2.14
- 2.13
- 2.12.1
- 2.12
- 2.11.1
- 2.11
- 2.10.2
- 2.10.1
- 2.10
- 2.9
- 2.8.2
- 2.8.1
- 2.8
- 2.7.2
- 2.7.1
- 2.7
- 2.6
- 2.5
- 2.4
- 2.3
- 2.2
- 2.1.2
- 2.1.1
- 2.1
- 2.0.1
- 2.0
- 1.5.1
- 1.5.0
- 1.0.3
- 1.0.2
- 1.0.1
- 0.7.1
- 0.7
- 0.5.2
- 0.5.1
- 0.5
- dev-v3-alpha
- dev-version/2.15
- dev-dev
- dev-version/2.14
- dev-feature/document-saving
- dev-version/2.13
- dev-version/2.12.1
- dev-version/2.12
- dev-version/2.11.1
- dev-version/2.11
- dev-version/2.10.2
- dev-version/2.10.1
- dev-version/2.10
- dev-version/2.9
- dev-version/2.8.2
- dev-version/2.8.1
- dev-version/2.8
- dev-version/2.7.2
- dev-version/2.7.1
- dev-version/2.7
- dev-version/2.6
- dev-version/2.5
- dev-version/2.4
- dev-version/2.3
- dev-version/2.2
- dev-version/2.1.2
- dev-version/2.1.1
- dev-version/2.1
- dev-version/2.0.1
- dev-feature/cli
- dev-version/2.0
- dev-feature/cache
- dev-feature/join
- dev-version/1.5.1
- dev-version/1.5.0
This package is auto-updated.
Last update: 2024-09-03 21:34:28 UTC
README
SleekDB - A NoSQL Database made using PHP
Full documentation: https://sleekdb.github.io/
SleekDB is a simple flat file NoSQL like database implemented in PHP without any third-party dependencies that store data in plain JSON files.
It is not designed to handle heavy-load IO operations, it is designed to have a simple solution where all we need a database for managing a few gigabytes of data. You can think of it as a database for low to medium operation loads.
Features
-
⚡ Lightweight, faster
Stores data in plain-text utilizing JSON format, no binary conversion needed to store or fetch the data. Default query cache layer.
-
🔆 Schema free data storage
SleekDB does not require any schema, so you can insert any types of data you want.
-
🔍 Query on nested properties
It supports schema free data, so you can filter and use conditions on nested properties of the JSON documents!
where( 'post.author.role', '=', 'admin' )
SleekDB will look for data at:
{ "post": { "author": { "role": "admin" } } }
-
✨ Dependency free, only needs PHP to run
Supports PHP 7+. Requires no third-party plugins or software.
-
🚀 Default caching layer
SleekDB will serve data from cache by default and regenerate cache automatically! Query results will be cached and later reused from a single file instead of traversing all the available files.
-
🌈 Rich Conditions and Filters
Use multiple conditional comparisons, text search, sorting on multiple properties and nested properties. Some useful methods are:
-
👍 Process data on demand
SleekDB does not require any background process or network protocol in order to process data when you use it in a PHP project. All data for a query will be fetched at runtime within the same PHP process.
-
😍 Runs everywhere
Runs perfectly on shared-servers or VPS too.
-
🍰 Easy to learn and implement
SleekDB provides a very simple elegant API to handle all of your data.
-
🍰 Easily import/export or backup data
SleekDB use files to store information. That makes tasks like backup, import and export very easy.
-
💪 Actively maintained
SleekDB is created by @rakibtg who is using it in various types of applications which are in production right now. Our other contributor and active maintainer is Timucin who is making SleekDB much better in terms of code quality and new features.
-
📔 Well documented
The official documentation of SleekDB does not just provide a good api documentation. It is filled with examples!