Kuzu::

Database class

Superclass	rb_cObject
Extended With	Loggability

Main Kùzu database class

Public Class Methods

new( path, **options ) → database

Create a new Database using the given path and options.

static VALUE
rkuzu_database_initialize( int argc, VALUE *argv, VALUE self )
{
        rkuzu_database *ptr = CHECK_DATABASE( self );

        if ( !ptr ) {
                VALUE path, options, config;
                VALUE config_argv[1];
                kuzu_system_config *sysconfig;
                char *database_path;

                rb_scan_args( argc, argv, "1:", &path, &options );
                if ( options == Qnil ) options = rb_hash_new();
                config_argv[0] = options;
                config = rb_funcallv_public_kw( rkuzu_cKuzuConfig, rb_intern("from_options"), 1,
                        config_argv, RB_PASS_KEYWORDS );

                sysconfig = rkuzu_get_config( config );
                database_path = StringValueCStr( path );

                ptr = rkuzu_database_alloc();
                if ( kuzu_database_init(database_path, *sysconfig, &ptr->db) != KuzuSuccess ) {
                        xfree( ptr );
                        ptr = NULL;

                        rb_raise( rkuzu_eDatabaseError, "Couldn't create database!" );
                }

                DEBUG_GC( ">>> allocated database %p\n", ptr );
                RTYPEDDATA_DATA( self ) = ptr;

                ptr->path = rb_obj_freeze( rb_obj_dup(path) );
                ptr->config = rb_obj_freeze( config );
        } else {
                rb_raise( rb_eRuntimeError, "cannot reinit database" );
        }

        rb_call_super( 0, 0 );

        return Qtrue;
}

Public Instance Methods

auto_checkpointing?()

Returns true if this database will automatically checkpoint when the size of the WAL file exceeds the checkpoint_threshold.

# File lib/kuzu/database.rb, line 30
def auto_checkpointing?
        return self.config.auto_checkpoint
end

compression_enabled?()

Returns true if this database uses compression for data on disk.

# File lib/kuzu/database.rb, line 36
def compression_enabled?
        return self.config.enable_compression
end

config() → config

Return the Kuzu::Config that reflects the config options the database was created with.

static VALUE
rkuzu_database_config( VALUE self )
{
        rkuzu_database *ptr = CHECK_DATABASE( self );
        return ptr->config;
}

connect()

Return a connection to this database.

# File lib/kuzu/database.rb, line 17
def connect
        return Kuzu::Connection.new( self )
end

inspect()

Return a string representation of the receiver suitable for debugging.

# File lib/kuzu/database.rb, line 42
def inspect
        details = " path:%p read-only:%p" % [
                self.path,
                self.read_only?,
        ]

        default = super
        return default.sub( />/, details + '>' )
end

path() → string or nil

Return the path the database was created with, or nil if it was created in memory.

static VALUE
rkuzu_database_path( VALUE self )
{
        rkuzu_database *ptr = CHECK_DATABASE( self );

        if ( RSTRING_LEN(ptr->path) == 0 ) {
                return Qnil;
        } else {
                return ptr->path;
        }
}

read_only?()

Return true if this database was created in read-only mode.

# File lib/kuzu/database.rb, line 23
def read_only?
        return self.config.read_only
end