rocksdb-jruby 1.0.0.pre0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf5dad2e75b48e8cbebb0946397110fb2455a746
+  data.tar.gz: df2ba841ba5f181dc75fe160bc830e62d4c8330e
+SHA512:
+  metadata.gz: 6688b22d9228e0ec4db377da7737ffca2964ce3afddda0cdae03f9ab0521a2d9d5665d0a7a09e713fc23b3dfcb2616097adf2913c42d6ca06bf48c82fbea0f43
+  data.tar.gz: b6f2ac8064108acbf9780b85253c879ae1a7f03f8c3b87f33a0300d5a2e9840b7f66ad8ea42096251c58805ee0618dadb4c097338722bbf3213aebb6a83b235b

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--markup markdown
+lib/**/*.rb
+-- README.md

data/README.md

@@ -0,0 +1,64 @@
+# RocksDB bindings for JRuby
+
+[![Build Status](https://travis-ci.org/burtcorp/rocksdb-jruby.png?branch=master)](https://travis-ci.org/burtcorp/rocksdb-jruby)
+
+_If you're reading this on GitHub, please note that this is the readme for the development version and that some features described here might not yet have been released. You can find the readme for a specific version via the release tags ([here is an example](https://github.com/burtcorp/rocksdb-jruby/releases/tag/v0.1.0))._
+
+## Installation
+
+rocksdb-jruby is available from RubyGems. Either install it manually:
+
+```
+$ gem install rocksdb-jruby
+```
+
+or add this to your `Gemfile`:
+
+```ruby
+gem 'rocksdb-jruby', require: 'rocks_db'
+```
+
+## Usage
+
+```ruby
+require 'rocks_db'
+
+db = RocksDb.open('path/to/database')
+
+# basic key operations
+db.put('foo', 'bar')
+puts db.get('foo') # => 'bar'
+db.delete('foo')
+
+# iterating over a range of keys
+10.times { |i| db.put("foo#{i.to_s.rjust(2, '0')}", i.to_s) }
+db.each(from: 'foo', to: 'foo08') do |key, value|
+  puts "#{key} => #{value}"
+end
+
+# batch mutations
+db.batch do |batch|
+  batch.put('foo', 'bar')
+  batch.delete('bar')
+end
+
+# read from a snapshot
+db.put('foo', 'bar')
+snapshot = db.snapshot
+db.put('foo', 'baz')
+puts snapshot.get('foo') # => 'bar'
+puts db.get('foo') # => 'baz'
+```
+
+## How to build and run the tests
+
+The best place to see how to build and run the tests is to look at the `.travis.yml` file, but if you just want to get going run:
+
+```
+$ bundle install
+$ bundle exec rake
+```
+
+# Copyright
+
+© 2016 Burt AB, see LICENSE.txt (BSD 3-Clause).

data/lib/rocks_db/batch.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module RocksDb
+  class Batch
+    # @!method put(key, value)
+    #   Puts a value into the database
+    #
+    #   @return [nil]
+
+    # @!method delete(key)
+    #   Deletes a value from the database
+    #
+    #   @return [nil]
+  end
+end

data/lib/rocks_db/db.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+
+module RocksDb
+  #
+  class Db
+    # @!method close
+    #   Closes the database handle.
+    #
+    #   This should be done when you are done using the database.
+    #
+    #   @return [nil]
+
+    # @!method put(key, value)
+    #   Puts a value into the database
+    #
+    #   @return [nil]
+
+    # @!method get(key)
+    #   Retrieves a value from the database
+    #
+    #   @return [String] the value
+
+    # @!method delete(key)
+    #   Deletes a value from the database
+    #
+    #   @return [nil]
+
+    # @!method batch(&block)
+    #   Yields a batch object that can be used to do multiple mutations as one
+    #   atomic operation
+    #
+    #   Batching can be used both to perform multiple operations that must be
+    #   performed atomically, or to speed up bulk loads.
+    #
+    #   @see RocksDb::Batch
+    #   @yieldparam [RocksDb::Batch] batch the batch
+    #   @return [nil]
+
+    # @!method snapshot
+    #   Returns a view of the database as it looks at this point in time
+    #
+    #   Mutations that happen after the snapshot has been created are not
+    #   visible when using the snapshot (e.g. {RocksDb::Snapshot#get} will not
+    #   return values that are written after the snaphot was created).
+    #
+    #   The snapshot must be closed using {RocksDb::Snapshot#close} when you
+    #   are done with it.
+    #
+    #   When a block is given the snapshot is automatically closed when the
+    #   block returns.
+    #
+    #   @see RocksDb::Snapshot
+    #   @return [nil, RocksDb::Snapshot] a snapshot or nil if a block is given
+
+    # @!method each(options={}, &block)
+    #   Iterate over all or a subset of all keys and values.
+    #
+    #   Without any options this will yield every key and value in the database
+    #   in order. Most of the time you want to specify the `:from` and/or `:to`
+    #   and/or `:limit` to control which portion of the database that will be
+    #   iterated over.
+    #
+    #   You can also iterate in reverse order by setting the `:reverse` option
+    #   to `true`. Note that when you iterate in reverse order, the key specifed
+    #   in `:from` will still be the first key yielded, and that the `:to` key
+    #   should be a key _before_ the `:from` key in regular order.
+    #
+    #   @param [Hash] options
+    #   @option options [String] :from (nil) the key to start the iteration from
+    #   @option options [String] :to (nil) the key to end the iteration at
+    #   @option options [Integer] :limit (nil) the maximum number of keys to
+    #     iterate over. Negative values are ignored.
+    #   @option options [true, false] :reverse (false) whether or not to iterate
+    #     in reverse order
+    #   @yieldparam [String] key a key
+    #   @yieldparam [String] value a value
+    #   @return [Enumerable] an enumerable of the same keys and values as the
+    #     call would have yielded if a block was given
+  end
+end

data/lib/rocks_db/error.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module RocksDb
+  #
+  class Error < StandardError
+  end
+end

data/lib/rocks_db/lazy_enumerable.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+module RocksDb
+  # @private
+  module LazyEnumerable
+    include Enumerable
+
+    def map(&transform)
+      LazyMap.new(self, &transform)
+    end
+
+    def select(&filter)
+      LazySelect.new(self, &filter)
+    end
+  end
+
+  # @private
+  class LazyMap
+    include LazyEnumerable
+
+    def initialize(enum, &transform)
+      @enum = enum
+      @transform = transform
+    end
+
+    def each(&block)
+      if block
+        @enum.each do |element|
+          block.call(@transform.call(element))
+        end
+      end
+      self
+    end
+  end
+
+  # @private
+  class LazySelect
+    include LazyEnumerable
+
+    def initialize(enum, &filter)
+      @enum = enum
+      @filter = filter
+    end
+
+    def each(&block)
+      if block
+        @enum.each do |element|
+          block.call(element) if @filter.call(element)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/rocks_db/snapshot.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module RocksDb
+  class Snapshot
+    # @!method close
+    #   Tells the database that it doesn't have to track this snapshot anymore
+    #
+    #   This should be done when you are done using the snapshot. Do not attempt
+    #   to use the snapshot after having called this method.
+    #
+    #   @return [nil]
+
+    # @!method get(key)
+    #   Retrieves a value from the database
+    #
+    #   @return [String] the value
+
+    # @!method each(options={}, &block)
+    #   Iterate over all or a subset of all keys and values.
+    #
+    #   Please refer to {RocksDb::Db#each} for the full documentation.
+    #
+    #   @see RocksDb::Db#each
+    #   @return [Enumerable] an enumerable of the same values as the
+    #     call would have yielded to the block
+  end
+end

data/lib/rocks_db/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module RocksDb
+  VERSION = '1.0.0.pre0'
+end

data/lib/rocks_db.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'rocks_db/ext/rocks_db.jar'
+
+Java::IoBurtRocksdb::RocksDbLibrary.new.load(JRuby.runtime, false)
+
+require 'rocks_db/version'
+require 'rocks_db/lazy_enumerable'
+
+module RocksDb
+  # @private
+  class Iterator
+    include LazyEnumerable
+  end
+
+  # @!method open(path, options={}, &block)
+  #   Open and/or create a database
+  #
+  #   A database is a directory of files on disk, specified by a path to the
+  #   directory. A database may only be opened by one process at a time, but
+  #   within a process the database can safely be used concurrently by multiple
+  #   threads.
+  #
+  #   When a block is given the database is yielded to the block and closed when
+  #   the block returns.
+  #
+  #   @param [String] path the path to the database
+  #   @yieldparam [RocksDb::Db] db a database object
+  #   @param [Hash] options
+  #   @option options [true, false] :create_if_missing (true) Whether or not to
+  #     create the database if it does not already exist.
+  #   @option options [true, false] :error_if_exists (false) Whether or not to
+  #     throw an error when the database already exists.
+  #   @raise [RocksDb::Error] raised when an internal error occurs, and when
+  #     the `:error_if_exists` options is true and the database already exists.
+  #   @return [nil, RocksDb::Db] a database object or nil when a block is given
+end

data/lib/rocksrb.rb

@@ -0,0 +1 @@
+require 'rocks_db'

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: rocksdb-jruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre0
+platform: java
+authors:
+- Theo Hultberg
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-09-09 00:00:00.000000000 Z
+dependencies: []
+description: RocksDB bindings for JRuby
+email: theo@burtcorp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- README.md
+- lib/rocks_db.rb
+- lib/rocks_db/batch.rb
+- lib/rocks_db/db.rb
+- lib/rocks_db/error.rb
+- lib/rocks_db/ext/rocks_db.jar
+- lib/rocks_db/lazy_enumerable.rb
+- lib/rocks_db/snapshot.rb
+- lib/rocks_db/version.rb
+- lib/rocksrb.rb
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.6
+signing_key:
+specification_version: 4
+summary: RocksDB for JRuby
+test_files: []