1 Star 0 Fork 1

mz / redixDB

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Build Status License Docker Contributors

a fast NoSQL DB, that uses the same RESP protocol and capable to store terabytes of data, also it integrates with your mobile/web apps to add real-time features, soon you can use it as a document store cause it should become a multi-model db. Redix is used in production, you can use it in your apps with no worries.

Features

  • Core data structure: KV, List, Hashmap with advanced implementations.
  • Advanced Publish/Subscribe using webhook and websocket!
  • Pluggable Storage Engine (badgerdb, boltdb, leveldb, null)
  • Very compatible with any redis client including redis-cli
  • Standalone with no external dependencies
  • Helpers commands for Time, Encode <hex|md5|sha1|sha256|sha512> <payload>, RANDINT, RANDSTR
  • Implements RATELIMIT helpers natively.

Why

I started this software to learn more about data modeling, data structures and how to map any data to pure key value, I don't need to build a redis clone, but I need to build something with my own concepts in my own style. I decided to use RESP (redis protocol) so you can use Redix with any redis client out there.

Install

  • Using Homebrew:
    • Add Homebrew Tap brew tap alash3al/redix https://github.com/alash3al/redix
    • Install Redix brew install alash3al/redix/redix
  • From Binaries: go there and choose your platform based binary, then download and execute from the command line with -h flag to see the help text.
  • Using Docker: docker run -P -v /path/to/redix-data:/root/redix-data alash3al/redix
  • From Source: go get github.com/alash3al/redix.

Configurations

It is so easy to configure Redix, there is no configuration files, it is all about running ./redix after you download it from the releases, if you downloaded i.e 'redix_linux_amd64' and unziped it.

$ ./redix_linux_amd64 -h

  -engine string
        the storage engine to be used, available (default "leveldb")
  -http-addr string
        the address of the http server (default ":7090")
  -resp-addr string
        the address of resp server (default ":6380")
  -storage string
        the storage directory (default "./redix-data")
  -verbose
        verbose or not
  -workers int
        the default workers number (default ...)

Examples


# i.e: $mykey1 = "this is my value"
$ redis-cli -p 6380 set mykey1 "this is my value"

# i.e: $mykey1 = "this is my value" and expire it after 10 seconds
$ redis-cli -p 6380 set mykey1 "this is my value" 10000

# i.e: echo $mykey1
$ redis-cli -p 6380 get mykey1

# i.e: $mymap1[x] = y
$ redis-cli -p 6380 hset mymap1 x y

# i.e: $mymap1[x] = y and expires it after 10 seconds
$ redis-cli -p 6380 hset mymap1 x y 10000

# i.e: sha512 of "test"
$ redis-cli -p 6380 encode sha512 test

# you want to notify an endpoint i.e: "http://localhost:800/new-data" that there is new data available, in other words, you want to subscribe a webhook to channel updates.
$ redis-cli -p 6380 webhookset testchan http://localhost:800/new-data

# add data to a list
# i.e: [].push(....)
$ redis-cli -p 6380 lpush mylist1 "I'm Mohammed" "I like to Go using Go" "I love coding"

# search in the list
$ redis-cli -p 6380 lsrch mylist1 "mo(.*)"

DB Engines

  • Redix supports two engines called badger and bolt
  • badger is the default, it is inspired by Facebook RocksDB, it meant to be fast on-disk engine, read more
  • bolt is our alternate engine, it is inspired by LMDB, read more

Supported Commands

Redix doesn't implement all redis commands, but instead it supports the core concepts that will help you to build any type of data models on top of it, there are more commands and features in all next releases.

# Basic

  • PING
  • QUIT
  • SELECT

# Strings

  • SET <key> <value> [<TTL "millisecond">]
  • MSET <key1> <value1> [<key2> <value2> ...]
  • GET <key> [<default value>]
  • MGET <key1> [<key2> ...]
  • DEL <key1> [<key2> ...]
  • EXISTS <key>
  • INCR <key> [<by>]
  • TTL <key> returns -1 if key will never expire, -2 if it doesn't exists (expired), otherwise will returns the seconds remain before the key will expire.
  • KEYS [<regexp-pattern>]

# HASHES

I enhanced the HASH MAP implementation and added some features like TTL per nested key, also you can check whether the hash map itself exists or not using HEXISTS <hashmapname> or a nested key exists using HEXISTS <hashmapname> <keyname>.

  • HSET <HASHMAP> <KEY> <VALUE> [<TTL "millesecond">]
  • HMSET <HASHMAP> <key1> <value1> [<key2> <value2> ...]
  • HGET <HASHMAP> <KEY>
  • HDEL <HASHMAP> [<key1> <key2> ...] (deletes the map itself or keys in the map)
  • HGETALL <HASHMAP>
  • HMSET <HASHMAP> <key1> <val1> [<key2> <val2> ...]
  • HEXISTS <HASHMAP> [<key>].
  • HINCR <HASHMAP> <key> [<by>]
  • HTTL <HASHMAP> <key>, the same as TTL but for HASHMAP
  • HKEYS <HASHMAP>
  • HLEN <HASHMAP>

# LIST

I applied a new concept, you can push or push-unique values into the list, based on that I don't need to implement two different data structures, as well as, you can quickly iterate over a list in a high performance way, every push will return the internal offset of the value, also, the iterator lrange will tell you the next offset you can start from.

  • LPUSH <LIST> <val1> [<val2> ...] (push the item into the list "it doesn't check for uniqueness, it will append anyway (duplicate)")
  • LPUSHU <LIST> <val1> [<val2> ...] (push the item into the list only if it isn't exists)
  • LRANGE <LIST> [<offset> <size>]
  • LREM <LIST> [<val1> <val2> <val3> ...] (deletes the list itself or values in the list)
  • LCOUNT <LIST> (get the list members count)
  • LCARD <LIST> (alias of LCOUNT)
  • LSUM <LIST> (sum the members of the list "in case they were numbers")
  • LAVG <LIST> (get the avg of the members of the list "in case they were numbers")
  • LMIN <LIST> (get the minimum of the members of the list "in case they were numbers")
  • LMAX <LIST> (get the maximum of the members of the list "in case they were numbers")
  • LSRCH <LIST> <NEEDLE> (text-search using (string search or regex) in the list)
  • LSRCHCOUNT <LIST> <NEEDLE> (size of text-search result using (string search or regex) in the list)

# SET

  • SADD <LIST> <val1> [<val2> ...] (alias of LUPUSH)
  • SMEMBERS <LIST> [<offset> <size>] (alias of LRANGE)
  • SSCAN <LIST> [<offset> <size>] (alias of LRANGE)
  • SCARD <LIST> (aliad of LCOUNT)
  • SREM <LIST> [<val1> <val2> <val3> ...] (alias of LREM)

# Pub/Sub

Redix has very simple pub/sub functionality, you can subscribe to internal logs on the * channel or any custom defined channel, and publish to any custom channel.

  • SUBSCRIBE [<channel1> <channel2>], if there is no channel specified, it will be set to *
  • PUBLISH <channel> <payload>
  • WEBHOOKSET <channel> <httpurl>, register a http endpoint so it can be notified through JSON POST request with the channel updates, this command will return a reference ID so you can manage it later.
  • WEBHOOKDEL <ID>, stops listening on a channel using the above reference ID.
  • WEBSOCKETOPEN <channel>, opens a websocket endpoint and returns its id, so you can receive updates through ws://server.address:port/stream/ws/{generated_id_here}
  • WEBSOCKETCLOSE <ID>, closes the specified websocket endpoint using the above generated id.

# Ratelimit

  • RATELIMITSET <bucket> <limit> <seconds>, create a new $bucket that accepts num of $limit of actions per the specified num of $seconds, it will returns 1 for success.
  • RATELIMITTAKE <bucket>, do an action in the specified bucket and take an item from it, it will return -1 if the bucket not exists or it has unlimited actions $limit < 1, 0 if there are no more actions to be done right now, reminder of actions on success.
  • RATELIMITGET <bucket>, returns array [$limit, $seconds, $remaining_time, $counter] information for the specified bucket

# Utils

some useful utils that you can use within your app to remove some hassle from it.

  • ENCODE <method> <payload>, encode the specified <payload> using the specified <method> (md5, sha1, sha256, sha512, hex)
  • UUIDV4, generates a uuid-v4 string, i.e 0b98aa17-eb06-42b8-b39f-fd7ba6aba7cd.
  • UNIQID, generates a unique string.
  • RANDSTR [<size>, default size is 10], generates a random string using the specified length.
  • RANDINT <min> <max>, generates a random string between the specified <min> and <max>.
  • TIME, returns the current time in utc, seconds and nanoseconds
  • DBSIZE, returns the database size in bytes.
  • GC, runs the Garbage Collector.
  • ECHO [<arg1> <arg2> ...]
  • INFO
  • FLUSHDB, clear the database
  • FLUSHALL, clear all databases

TODO

  • Basic Commands
  • Strings Commands
  • Hashmap Commands
  • List Commands
  • PubSub Commands
  • Utils Commands
  • Adding BoltDB engine
  • Adding LevelDB engine
  • Adding Null engine
  • Adding RAM engine
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [2018] [Mohamed Al Ashaal <m7medalash3al@gmail.com>] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

fork from https://alash3al.github.io/redix/ 展开 收起
Go
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Go
1
https://gitee.com/mz/redixDB.git
git@gitee.com:mz/redixDB.git
mz
redixDB
redixDB
master

搜索帮助