Click here to Skip to main content
15,861,168 members
Articles / Database Development / NoSQL

RaptorDB - the Key Value Store

Rate me:
Please Sign up or sign in to vote.
4.89/5 (118 votes)
22 Jan 2012CPOL22 min read 904.9K   9.9K   266  
Smallest, fastest embedded nosql persisted dictionary using b+tree or MurMur hash indexing. (Now with Hybrid WAH bitmap indexes)
using System;
using System.Diagnostics;
using System.Collections;
using System.Runtime.InteropServices;
using System.IO;
using System.Text;
using System.Collections.Generic;

namespace RaptorDB
{
    public class StorageFile
    {
        System.IO.Stream _writefile;
        System.IO.Stream _readfile;
        private int _maxKeyLen;

        public static byte[] _fileheader = { (byte)'M', (byte)'G', (byte)'D', (byte)'B',
                                              0, // -- [flags] = [shutdownOK:1],
                                              0  // -- [maxkeylen] 
                                           };

        public static byte[] _rowheader = { (byte)'M', (byte)'G', (byte)'R' ,
                                           0,               // 4     [keylen]
                                           0,0,0,0,0,0,0,0, // 5-12  [datetime] 8 bytes = insert time
                                           0,0,0,0,         // 13-16 [data length] 4 bytes
                                           0,               // 17 -- [flags] = isCommited:1 
                                                            //                 isRollback:1
                                                            //                 isCompressed:1
                                                            //                 isDeleted:1
                                                            //                 isVersioned:1 
                                           0                // 18 -- [crc] = header crc check
                                       };
        private enum HDR_POS
        {
            KeyLen = 3,
            DateTime = 4,
            DataLength = 12,
            Flags = 16,
            CRC = 17
        }

        public bool SkipDateTime = false;

        public StorageFile(System.IO.Stream file, int maxkeylen)
        {
            _writefile = file;
            _maxKeyLen = maxkeylen;
            if (_writefile.Length == 0)
            {
                // new file
                byte b = (byte)maxkeylen;
                _fileheader[5] = b;
                _writefile.Write(_fileheader, 0, _fileheader.Length);
                _writefile.Flush();
            }
            else
            {
                // TODO : check file header exists
                // TODO : check file flags ok
            }
            bw = new BinaryWriter(ms, Encoding.UTF8);
        }

        public IEnumerable<KeyValuePair< byte[],byte[]>> Traverse()
        {
            long offset = 0;
            offset = _fileheader.Length;

            while (offset < _writefile.Length)
            {
                long pointer = offset;
                byte[] key ;
                offset = NextOffset(offset, out key);
                KeyValuePair<byte[], byte[]> kv = new KeyValuePair<byte[], byte[]>(
                    key, ReadData(pointer) );

                yield return kv;
            }
        }

        private long NextOffset(long curroffset, out byte[] key)
        {
            long next = _writefile.Length;
            // seek offset in file
            byte[] hdr = new byte[_rowheader.Length];
            _writefile.Seek(curroffset, System.IO.SeekOrigin.Begin);
            // read header
            _writefile.Read(hdr, 0, _rowheader.Length);
            key = new byte[hdr[(int)HDR_POS.KeyLen]];
            _writefile.Read(key, 0, hdr[(int)HDR_POS.KeyLen]);
            // check header
            if (CheckHeader(hdr))
            {
                next = curroffset + hdr.Length + Helper.ToInt32(hdr, (int)HDR_POS.DataLength) + hdr[(int)HDR_POS.KeyLen];
            }

            return next;
        }

        public long WriteData(byte[] key, byte[] data)
        {
            byte[] k = key;
            int kl = k.Length;

            // seek end of file
            long offset = _writefile.Seek(0L, System.IO.SeekOrigin.End);
            byte[] hdr = CreateRowHeader(kl, data.Length);
            // write header info
            _writefile.Write(hdr, 0, hdr.Length);
            // write key
            _writefile.Write(k, 0, kl);
            // write data block
            _writefile.Write(data, 0, data.Length);
            _writefile.Flush();
            // return starting offset
            return offset;
        }

        MemoryStream ms = new MemoryStream();
        BinaryWriter bw;
        private byte[] CreateRowHeader(int keylen, int datalen)
        {
            ms.Seek(0L, SeekOrigin.Begin);
            bw.Write(_rowheader, 0, 3);
            bw.Write((byte)keylen);
            if (SkipDateTime == false)
                bw.Write(FastDateTime.Now.Ticks);
            else
                bw.Write(0L);
            bw.Write(datalen);
            bw.Write((byte)0);
            bw.Write((byte)0);
            bw.Flush();
            return ms.ToArray();
        }

        public byte[] ReadData(long offset)
        {
            // seek offset in file
            byte[] hdr = new byte[_rowheader.Length];
            _writefile.Seek(offset, System.IO.SeekOrigin.Begin);
            // read header
            _writefile.Read(hdr, 0, _rowheader.Length);
            // check header
            if (CheckHeader(hdr))
            {
                // skip key bytes
                _writefile.Seek(hdr[(int)HDR_POS.KeyLen], System.IO.SeekOrigin.Current);
                int dl = Helper.ToInt32(hdr, (int)HDR_POS.DataLength);
                byte[] data = new byte[dl];
                // read data block
                _writefile.Read(data, 0, dl);
                return data;
            }
            else
                throw new Exception("data header error");
        }

        private bool CheckHeader(byte[] hdr)
        {
            if (hdr[0] != (byte)'M' && hdr[1] != (byte)'G' && hdr[2] != (byte)'R' && hdr[(int)HDR_POS.CRC] != 0)
                return false;
            return true;
        }

        public void Shutdown()
        {
            this._writefile.Flush();
            this._writefile.Close();
        }
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Architect -
United Kingdom United Kingdom
Mehdi first started programming when he was 8 on BBC+128k machine in 6512 processor language, after various hardware and software changes he eventually came across .net and c# which he has been using since v1.0.
He is formally educated as a system analyst Industrial engineer, but his programming passion continues.

* Mehdi is the 5th person to get 6 out of 7 Platinum's on Code-Project (13th Jan'12)
* Mehdi is the 3rd person to get 7 out of 7 Platinum's on Code-Project (26th Aug'16)

Comments and Discussions