mdbx 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebac91a21c1f1c16214f94cead64d97c1773fb0689cdb6a4a0487bc3dbf12f63
-  data.tar.gz: 6e527eeb9bd430742c1057699653f50c9c9437a3b4770a9213dfb0a3c7102eb1
+  metadata.gz: 97a83bdd83e99ab3b58cf823a914c8a7b75b5b63e33e13cd00f135aa2c8988b4
+  data.tar.gz: aa6687110e91dfe083332fc93299c492ce5628ad41fe26cb36d9ee33531e1039
 SHA512:
-  metadata.gz: 9159f1033372110bb223b3dcfbbfce48e167da861cb078493d21293f85978c3ecbf744f02dbf6e4833aedb5669897c6d13f8662bf4a5a6d8ac05f5495643885e
-  data.tar.gz: e3c23310cf9e05e51f5c0a21dbc50ca7bb60219b776c3745e0f527ec4df201927298e627fed6ab49871bdd4c734ea19810160a317540101d102460bd82392411
+  metadata.gz: 732ecf85ef600ae8edb433b18d67ecf26fbc1332fc673e7e01b20637dbcffff94735a8c1d79cc43c9d293cdda7b7532670f9a0c9f101234367b19aaac03149a9
+  data.tar.gz: 1623ff8c9d4b6e7752ef9faaf4075961119d812c7dfd78bb619fa74eaacb3e7fd1042b66b630e5638010478f61a0f3f232fa6cf2e1a37e40ef3d010a5c3257f6

data/History.md

@@ -1,6 +1,29 @@
 # Release History for MDBX
 
 ---
+## v0.3.0 [2021-04-09] Mahlon E. Smith <mahlon@martini.nu>
+
+Enhancements:
+
+ - Alter the behavior of #clear, so it doesn't destroy collection
+   environments, but just empties them.
+
+ - Add #drop, which explictly -does- destroy a collection environment.
+
+ - Switching to a collection now automatically creates its environment.
+
+ - Add include? and has_key?, for presence checks without allocating
+   value memory or requiring deserialization.
+
+
+Bugfixes:
+
+ - Run all cursor methods through rb_protect, to ensure proper
+   cursor cleanup in the event of an exception mid iteration.
+
+ - Fix the block form of collections to support multiple scopes.
+
+
 ## v0.2.1 [2021-04-06] Mahlon E. Smith <mahlon@martini.nu>
 
 Enhancement:

data/ext/mdbx_ext/database.c

@@ -6,7 +6,10 @@
  */
 #define UNWRAP_DB( val, db ) \
 	rmdbx_db_t *db; \
-	TypedData_Get_Struct( val, rmdbx_db_t, &rmdbx_db_data, db );
+	TypedData_Get_Struct( val, rmdbx_db_t, &rmdbx_db_data, db )
+
+#define CHECK_HANDLE \
+	if ( ! db->state.open ) rb_raise( rmdbx_eDatabaseError, "Closed database." )
 
 
 VALUE rmdbx_cDatabase;
@@ -160,7 +163,7 @@ rmdbx_open_env( VALUE self )
 void
 rmdbx_open_cursor( rmdbx_db_t *db )
 {
-	if ( ! db->state.open ) rb_raise( rmdbx_eDatabaseError, "Closed database." );
+	CHECK_HANDLE;
 	if ( ! db->txn ) rb_raise( rmdbx_eDatabaseError, "No snapshot or transaction currently open." );
 
 	int rc = mdbx_cursor_open( db->txn, db->dbi, &db->cursor );
@@ -215,11 +218,11 @@ rmdbx_close_txn( rmdbx_db_t *db, int txnflag )
 {
 	if ( ! db->txn || db->state.retain_txn > -1 ) return;
 
-	switch ( txnflag ) {
-		case RMDBX_TXN_COMMIT:
-			mdbx_txn_commit( db->txn );
-		default:
-			mdbx_txn_abort( db->txn );
+	if ( txnflag == RMDBX_TXN_COMMIT ) {
+		mdbx_txn_commit( db->txn );
+	}
+	else {
+		mdbx_txn_abort( db->txn );
 	}
 
 	db->txn = 0;
@@ -239,6 +242,7 @@ VALUE
 rmdbx_rb_opentxn( VALUE self, VALUE mode )
 {
 	UNWRAP_DB( self, db );
+	CHECK_HANDLE;
 
 	rmdbx_open_txn( db, RTEST(mode) ? MDBX_TXN_READWRITE : MDBX_TXN_RDONLY );
 	db->state.retain_txn = RTEST(mode) ? 1 : 0;
@@ -273,13 +277,53 @@ rmdbx_rb_closetxn( VALUE self, VALUE write )
  *
  * Empty the current collection on disk.  If collections are not enabled
  * or the database handle is set to the top-level (main) db - this
- * deletes *all records* from the database.  This is not recoverable!
+ * deletes *all records* from the database.
  */
 VALUE
 rmdbx_clear( VALUE self )
 {
 	UNWRAP_DB( self, db );
 
+	rmdbx_open_txn( db, MDBX_TXN_READWRITE );
+	int rc = mdbx_drop( db->txn, db->dbi, false );
+
+	if ( rc != MDBX_SUCCESS )
+		rb_raise( rmdbx_eDatabaseError, "mdbx_drop: (%d) %s", rc, mdbx_strerror(rc) );
+
+	rmdbx_close_txn( db, RMDBX_TXN_COMMIT );
+
+	return Qnil;
+}
+
+
+/*
+ * call-seq:
+ *    db.drop( collection ) -> db
+ *
+ * Destroy a collection.  You must be in the top level database to call
+ * this method.
+ */
+VALUE
+rmdbx_drop( VALUE self, VALUE name )
+{
+	UNWRAP_DB( self, db );
+
+	/* Provide a friendlier error message if max_collections is 0. */
+	if ( db->settings.max_collections == 0 )
+		rb_raise( rmdbx_eDatabaseError, "Unable to drop collection: collections are not enabled." );
+
+	/* All transactions must be closed when dropping a database. */
+	if ( db->txn )
+		rb_raise( rmdbx_eDatabaseError, "Unable to drop collection: transaction open" );
+
+	/* A drop can only be performed from the top-level database. */
+	if ( db->subdb != NULL )
+		rb_raise( rmdbx_eDatabaseError, "Unable to drop collection: switch to top-level db first" );
+
+	name = rb_funcall( name, rb_intern("to_s"), 0 );
+	db->subdb = StringValueCStr( name );
+
+	rmdbx_close_dbi( db ); /* ensure we're reopening within the new subdb */
 	rmdbx_open_txn( db, MDBX_TXN_READWRITE );
 	int rc = mdbx_drop( db->txn, db->dbi, true );
 
@@ -288,10 +332,11 @@ rmdbx_clear( VALUE self )
 
 	rmdbx_close_txn( db, RMDBX_TXN_COMMIT );
 
-	/* Refresh the environment handles. */
-	rmdbx_open_env( self );
+	/* Reset the current collection to the top level. */
+	db->subdb = NULL;
+	rmdbx_close_dbi( db ); /* ensure next access is not in the defunct subdb */
 
-	return Qnil;
+	return self;
 }
 
 
@@ -348,21 +393,15 @@ rmdbx_deserialize( VALUE self, VALUE val )
 }
 
 
-/* call-seq:
- *    db.each_key {|key| block } => self
- *
- * Calls the block once for each key, returning self.
- * A transaction must be opened prior to use.
+/*
+ * Enumerate over keys for the current collection.
  */
 VALUE
-rmdbx_each_key( VALUE self )
+rmdbx_each_key_i( VALUE self )
 {
 	UNWRAP_DB( self, db );
 	MDBX_val key, data;
 
-	rmdbx_open_cursor( db );
-	RETURN_ENUMERATOR( self, 0, 0 );
-
 	if ( mdbx_cursor_get( db->cursor, &key, &data, MDBX_FIRST ) == MDBX_SUCCESS ) {
 		rb_yield( rb_str_new( key.iov_base, key.iov_len ) );
 		while ( mdbx_cursor_get( db->cursor, &key, &data, MDBX_NEXT ) == MDBX_SUCCESS ) {
@@ -370,27 +409,45 @@ rmdbx_each_key( VALUE self )
 		}
 	}
 
-	mdbx_cursor_close( db->cursor );
-	db->cursor = NULL;
 	return self;
 }
 
 
 /* call-seq:
- *    db.each_value {|value| block } => self
+ *    db.each_key {|key| block } => self
  *
- * Calls the block once for each value, returning self.
+ * Calls the block once for each key, returning self.
  * A transaction must be opened prior to use.
  */
 VALUE
-rmdbx_each_value( VALUE self )
+rmdbx_each_key( VALUE self )
 {
 	UNWRAP_DB( self, db );
-	MDBX_val key, data;
+	int state;
 
+	CHECK_HANDLE;
 	rmdbx_open_cursor( db );
 	RETURN_ENUMERATOR( self, 0, 0 );
 
+	rb_protect( rmdbx_each_key_i, self, &state );
+
+	mdbx_cursor_close( db->cursor );
+	db->cursor = NULL;
+
+	if ( state ) rb_jump_tag( state );
+
+	return self;
+}
+
+
+/* Enumerate over values for the current collection.
+ */
+VALUE
+rmdbx_each_value_i( VALUE self )
+{
+	UNWRAP_DB( self, db );
+	MDBX_val key, data;
+
 	if ( mdbx_cursor_get( db->cursor, &key, &data, MDBX_FIRST ) == MDBX_SUCCESS ) {
 		VALUE rv = rb_str_new( data.iov_base, data.iov_len );
 		rb_yield( rmdbx_deserialize( self, rv ) );
@@ -401,27 +458,45 @@ rmdbx_each_value( VALUE self )
 		}
 	}
 
-	mdbx_cursor_close( db->cursor );
-	db->cursor = NULL;
 	return self;
 }
 
 
 /* call-seq:
- *    db.each_pair {|key, value| block } => self
+ *    db.each_value {|value| block } => self
  *
- * Calls the block once for each key and value, returning self.
+ * Calls the block once for each value, returning self.
  * A transaction must be opened prior to use.
  */
 VALUE
-rmdbx_each_pair( VALUE self )
+rmdbx_each_value( VALUE self )
 {
 	UNWRAP_DB( self, db );
-	MDBX_val key, data;
+	int state;
 
+	CHECK_HANDLE;
 	rmdbx_open_cursor( db );
 	RETURN_ENUMERATOR( self, 0, 0 );
 
+	rb_protect( rmdbx_each_value_i, self, &state );
+
+	mdbx_cursor_close( db->cursor );
+	db->cursor = NULL;
+
+	if ( state ) rb_jump_tag( state );
+
+	return self;
+}
+
+
+/* Enumerate over key and value pairs for the current collection.
+ */
+VALUE
+rmdbx_each_pair_i( VALUE self )
+{
+	UNWRAP_DB( self, db );
+	MDBX_val key, data;
+
 	if ( mdbx_cursor_get( db->cursor, &key, &data, MDBX_FIRST ) == MDBX_SUCCESS ) {
 		VALUE rkey = rb_str_new( key.iov_base, key.iov_len );
 		VALUE rval = rb_str_new( data.iov_base, data.iov_len );
@@ -434,12 +509,38 @@ rmdbx_each_pair( VALUE self )
 		}
 	}
 
+	return self;
+}
+
+
+/* call-seq:
+ *    db.each_pair {|key, value| block } => self
+ *
+ * Calls the block once for each key and value, returning self.
+ * A transaction must be opened prior to use.
+ */
+VALUE
+rmdbx_each_pair( VALUE self )
+{
+	UNWRAP_DB( self, db );
+	int state;
+
+	CHECK_HANDLE;
+	rmdbx_open_cursor( db );
+	RETURN_ENUMERATOR( self, 0, 0 );
+
+	rb_protect( rmdbx_each_pair_i, self, &state );
+
 	mdbx_cursor_close( db->cursor );
 	db->cursor = NULL;
+
+	if ( state ) rb_jump_tag( state );
+
 	return self;
 }
 
 
+
 /* call-seq:
  *    db.length -> Integer
  *
@@ -451,7 +552,7 @@ rmdbx_length( VALUE self )
 	UNWRAP_DB( self, db );
 	MDBX_stat mstat;
 
-	if ( ! db->state.open ) rb_raise( rmdbx_eDatabaseError, "Closed database." );
+	CHECK_HANDLE;
 	rmdbx_open_txn( db, MDBX_TXN_RDONLY );
 
 	int rc = mdbx_dbi_stat( db->txn, db->dbi, &mstat, sizeof(mstat) );
@@ -465,6 +566,39 @@ rmdbx_length( VALUE self )
 }
 
 
+/* call-seq:
+ *    db.include?( 'key' ) => bool
+ *
+ * Returns true if the current collection contains +key+.
+ */
+VALUE
+rmdbx_include( VALUE self, VALUE key )
+{
+	int rc;
+	UNWRAP_DB( self, db );
+
+	CHECK_HANDLE;
+	rmdbx_open_txn( db, MDBX_TXN_RDONLY );
+
+	MDBX_val ckey = rmdbx_key_for( key );
+	MDBX_val data;
+	rc = mdbx_get( db->txn, db->dbi, &ckey, &data );
+	rmdbx_close_txn( db, RMDBX_TXN_ROLLBACK );
+
+	switch ( rc ) {
+		case MDBX_SUCCESS:
+			return Qtrue;
+
+		case MDBX_NOTFOUND:
+			return Qfalse;
+
+		default:
+			rmdbx_close( self );
+			rb_raise( rmdbx_eDatabaseError, "Unable to fetch key: (%d) %s", rc, mdbx_strerror(rc) );
+	}
+}
+
+
 /* call-seq:
  *    db[ 'key' ] => value
  *
@@ -476,7 +610,7 @@ rmdbx_get_val( VALUE self, VALUE key )
 	int rc;
 	UNWRAP_DB( self, db );
 
-	if ( ! db->state.open ) rb_raise( rmdbx_eDatabaseError, "Closed database." );
+	CHECK_HANDLE;
 	rmdbx_open_txn( db, MDBX_TXN_RDONLY );
 
 	MDBX_val ckey = rmdbx_key_for( key );
@@ -503,7 +637,8 @@ rmdbx_get_val( VALUE self, VALUE key )
 /* call-seq:
  *    db[ 'key' ] = value
  *
- * Set a single value for +key+.
+ * Set a single value for +key+.  If the value is +nil+, the
+ * key is removed.
  */
 VALUE
 rmdbx_put_val( VALUE self, VALUE key, VALUE val )
@@ -511,7 +646,7 @@ rmdbx_put_val( VALUE self, VALUE key, VALUE val )
 	int rc;
 	UNWRAP_DB( self, db );
 
-	if ( ! db->state.open ) rb_raise( rmdbx_eDatabaseError, "Closed database." );
+	CHECK_HANDLE;
 	rmdbx_open_txn( db, MDBX_TXN_READWRITE );
 
 	MDBX_val ckey = rmdbx_key_for( key );
@@ -552,41 +687,32 @@ VALUE
 rmdbx_stats( VALUE self )
 {
 	UNWRAP_DB( self, db );
-	if ( ! db->state.open ) rb_raise( rmdbx_eDatabaseError, "Closed database." );
+	CHECK_HANDLE;
 
 	return rmdbx_gather_stats( db );
 }
 
 
 /*
- * call-seq:
- *    db.collection -> (collection name, or nil if in main)
- *    db.collection( 'collection_name' ) -> db
- *    db.collection( nil ) -> db (main)
- *
- * Gets or sets the sub-database "collection" that read/write
- * operations apply to.
- * Passing +nil+ sets the database to the main, top-level namespace.
- * If a block is passed, the collection automatically reverts to the
- * prior collection when it exits.
- *
- *    db.collection( 'collection_name' ) do
- *        [ ... ]
- *    end # reverts to the previous collection name
- *
+ * Return the currently selected collection, or +nil+ if at the
+ * top-level.
  */
 VALUE
-rmdbx_set_subdb( int argc, VALUE *argv, VALUE self )
+rmdbx_get_subdb( VALUE self )
 {
 	UNWRAP_DB( self, db );
-	VALUE subdb, block;
-	char *prev_db = NULL;
+	return ( db->subdb == NULL ) ? Qnil : rb_str_new_cstr( db->subdb );
+}
 
-	rb_scan_args( argc, argv, "01&", &subdb, &block );
-	if ( argc == 0 ) {
-		if ( db->subdb == NULL ) return Qnil;
-		return rb_str_new_cstr( db->subdb );
-	}
+
+/*
+ * Sets the current collection name for read/write operations.
+ *
+ */
+VALUE
+rmdbx_set_subdb( VALUE self, VALUE name )
+{
+	UNWRAP_DB( self, db );
 
 	/* Provide a friendlier error message if max_collections is 0. */
 	if ( db->settings.max_collections == 0 )
@@ -596,38 +722,14 @@ rmdbx_set_subdb( int argc, VALUE *argv, VALUE self )
 	if ( db->txn )
 		rb_raise( rmdbx_eDatabaseError, "Unable to change collection: transaction open" );
 
-	/* Retain the prior database collection if a block was passed.
-	 */
-	if ( rb_block_given_p() && db->subdb != NULL ) {
-		prev_db = (char *) malloc( strlen(db->subdb) + 1 );
-		strcpy( prev_db, db->subdb );
-	}
+	db->subdb = NIL_P( name ) ? NULL : StringValueCStr( name );
 
-	if ( NIL_P(subdb) ) {
-		db->subdb = NULL;
-	}
-	else {
-		subdb = rb_funcall( subdb, rb_intern("to_s"), 0 );
-		db->subdb = StringValueCStr( subdb );
-	}
+	/* Reset the db handle and issue a single transaction to reify
+	   the collection.
+	*/
 	rmdbx_close_dbi( db );
-
-	/*
-	  FIXME:  Immediate transaction write to auto-create new env?
-	  Fetching from here at the moment causes an error if you
-	  haven't written anything to the new collection yet.
-	 */
-
-	/* Revert to the previous collection after the block is done.
-	 */
-	if ( rb_block_given_p() ) {
-		rb_yield( self );
-		if ( db->subdb != prev_db ) {
-			db->subdb = prev_db;
-			rmdbx_close_dbi( db );
-		}
-		xfree( prev_db );
-	}
+	rmdbx_open_txn( db, MDBX_TXN_READWRITE );
+	rmdbx_close_txn( db, RMDBX_TXN_COMMIT );
 
 	return self;
 }
@@ -767,16 +869,18 @@ rmdbx_init_database()
 
 	rb_define_protected_method( rmdbx_cDatabase, "initialize", rmdbx_database_initialize, -1 );
 	rb_define_protected_method( rmdbx_cDatabase, "initialize_copy", rmdbx_init_copy, 1 );
-	rb_define_method( rmdbx_cDatabase, "collection", rmdbx_set_subdb, -1 );
+
+	rb_define_method( rmdbx_cDatabase, "clear", rmdbx_clear, 0 );
 	rb_define_method( rmdbx_cDatabase, "close", rmdbx_close, 0 );
-	rb_define_method( rmdbx_cDatabase, "reopen", rmdbx_open_env, 0 );
 	rb_define_method( rmdbx_cDatabase, "closed?", rmdbx_closed_p, 0 );
-	rb_define_method( rmdbx_cDatabase, "in_transaction?", rmdbx_in_transaction_p, 0 );
-	rb_define_method( rmdbx_cDatabase, "clear", rmdbx_clear, 0 );
+	rb_define_method( rmdbx_cDatabase, "drop", rmdbx_drop, 1 );
 	rb_define_method( rmdbx_cDatabase, "each_key", rmdbx_each_key, 0 );
-	rb_define_method( rmdbx_cDatabase, "each_value", rmdbx_each_value, 0 );
 	rb_define_method( rmdbx_cDatabase, "each_pair", rmdbx_each_pair, 0 );
+	rb_define_method( rmdbx_cDatabase, "each_value", rmdbx_each_value, 0 );
+	rb_define_method( rmdbx_cDatabase, "in_transaction?", rmdbx_in_transaction_p, 0 );
+	rb_define_method( rmdbx_cDatabase, "include?", rmdbx_include, 1 );
 	rb_define_method( rmdbx_cDatabase, "length", rmdbx_length, 0 );
+	rb_define_method( rmdbx_cDatabase, "reopen", rmdbx_open_env, 0 );
 	rb_define_method( rmdbx_cDatabase, "[]", rmdbx_get_val, 1 );
 	rb_define_method( rmdbx_cDatabase, "[]=", rmdbx_put_val, 2 );
 
@@ -784,6 +888,10 @@ rmdbx_init_database()
 	rb_define_protected_method( rmdbx_cDatabase, "open_transaction",  rmdbx_rb_opentxn, 1 );
 	rb_define_protected_method( rmdbx_cDatabase, "close_transaction", rmdbx_rb_closetxn, 1 );
 
+	/* Collection functions */
+	rb_define_protected_method( rmdbx_cDatabase, "get_subdb", rmdbx_get_subdb, 0 );
+	rb_define_protected_method( rmdbx_cDatabase, "set_subdb", rmdbx_set_subdb, 1 );
+
 	rb_define_protected_method( rmdbx_cDatabase, "raw_stats", rmdbx_stats, 0 );
 
 	rb_require( "mdbx/database" );

data/lib/mdbx.rb

@@ -10,7 +10,7 @@ require 'mdbx_ext'
 module MDBX
 
 	# The version of this gem.
-	VERSION = '0.2.1'
+	VERSION = '0.3.1'
 
 end # module MDBX
 

data/lib/mdbx/database.rb

@@ -128,16 +128,43 @@ class MDBX::Database
 	attr_accessor :deserializer
 
 
+	alias_method :size, :length
+	alias_method :each, :each_pair
+	alias_method :has_key?, :include?
+
+
+	### Gets or sets the sub-database "collection" that read/write
+	### operations apply to. If a block is passed, the collection
+	### automatically reverts to the prior collection when it exits.
+	###
+	###  db.collection #=> (collection name, or nil if in main)
+	###  db.collection( 'collection_name' ) #=> db
+	###
+	###  db.collection( 'collection_name' ) do
+	###      [ ... ]
+	###  end # reverts to the previous collection name
+	###
+	def collection( name=nil )
+		current = self.get_subdb
+		return current unless name
+
+		self.set_subdb( name.to_s )
+		yield( self ) if block_given?
+
+		return self
+
+	ensure
+		self.set_subdb( current ) if name && block_given?
+	end
+	alias_method :namespace, :collection
+
+
 	### Switch to the top-level collection.
 	###
 	def main
-		return self.collection( nil )
+		return self.set_subdb( nil )
 	end
 
-	alias_method :namespace, :collection
-	alias_method :size, :length
-	alias_method :each, :each_pair
-
 
 	#
 	# Transaction methods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mdbx
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Mahlon E. Smith
@@ -34,7 +34,7 @@ cert_chain:
   49pOzX5KHZLTS9DKeaP/xcGPz6C8MiwQdYrZarr2SHRASX1zFa79rkItO8kE6RDr
   b6WDF79UvZ55ajtE00TiwqjQL/ZPEtbd
   -----END CERTIFICATE-----
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry