amalgalite 0.1.0

data/ext/amalgalite3_database.c

@@ -0,0 +1,458 @@
+#include "amalgalite3.h"
+/**
+ * Copyright (c) 2008 Jeremy Hinegardner
+ * All rights reserved.  See LICENSE and/or COPYING for details.
+ *
+ * vim: shiftwidth=4 
+ */ 
+
+VALUE cAS_Database;    /* class  Amalgliate::SQLite3::Database  */
+
+/**
+ * Document-method: open
+ *
+ * call-seq:
+ *    Amalagliate::SQLite3::Database.open( filename, flags = READWRITE | CREATE ) -> Database
+ *
+ * Create a new SQLite3 database with a UTF-8 encoding.
+ *
+ */ 
+VALUE am_sqlite3_database_open(int argc, VALUE *argv, VALUE class)
+{
+    VALUE  self = am_sqlite3_database_alloc(class);
+    VALUE  rFlags;
+    VALUE  rFilename;
+    int     flags = SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE;
+    char*   filename;
+    int     rc;
+    am_sqlite3* am_db;
+
+
+    /* at least a filename argument is required */
+    rb_scan_args( argc, argv, "11", &rFilename, &rFlags );
+
+    /* convert flags to the sqlite version */
+    flags  = ( Qnil == rFlags ) ? flags : FIX2INT(rFlags);
+    filename = StringValuePtr(rFilename);
+
+    /* extract the sqlite3 wrapper struct */
+    Data_Get_Struct(self, am_sqlite3, am_db);
+
+    /* open the sqlite3 database */
+    rc = sqlite3_open_v2( filename, &(am_db->db), flags, 0);
+    if ( SQLITE_OK != rc ) {
+        rb_raise(eAS_Error, "Failure to open database %s : [SQLITE_ERROR %d] : %s\n",
+                filename, rc, sqlite3_errmsg(am_db->db));
+    }
+
+    /* by default turn on the extended result codes */
+    rc = sqlite3_extended_result_codes( am_db->db, 1);
+    if ( SQLITE_OK != rc ) {
+        rb_raise(eAS_Error, "Failure to set extended result codes %s : [SQLITE_ERROR %d] : %s\n",
+                filename, rc, sqlite3_errmsg(am_db->db));
+    }
+
+    return self;
+}
+
+/**
+ * call-seq:
+ *    Amalgalite::SQLite3::Database.open16( filename ) -> SQLite3::Database
+ *
+ * Create a new SQLite3 database with a UTF-16 encoding
+ *
+ */
+VALUE am_sqlite3_database_open16(VALUE class, VALUE rFilename)
+{
+    VALUE       self = am_sqlite3_database_alloc(class);
+    char*       filename = StringValuePtr(rFilename);
+    am_sqlite3* am_db;
+    int         rc;
+
+    Data_Get_Struct(self, am_sqlite3, am_db);
+    rc = sqlite3_open16( filename, &(am_db->db) );
+    if ( SQLITE_OK != rc ) {
+        rb_raise(eAS_Error, "Failure to open UTF-16 database %s : [SQLITE_ERROR %d] : %s\n",
+                filename, rc, sqlite3_errmsg( am_db->db ));
+    }
+
+    /* by default turn on the extended result codes */
+    rc = sqlite3_extended_result_codes( am_db->db, 1);
+    if ( SQLITE_OK != rc ) {
+        rb_raise(eAS_Error, "Failure to set extended result codes on UTF-16 database %s : [SQLITE_ERROR %d] : %s\n",
+                filename, rc, sqlite3_errmsg16(am_db->db));
+    }
+
+    return self;
+}
+
+/**
+ * call-seq:
+ *    database.close 
+ *
+ * Close the database
+ */
+VALUE am_sqlite3_database_close(VALUE self)
+{
+    am_sqlite3   *am_db;
+    int           rc = 0;
+
+    Data_Get_Struct(self, am_sqlite3, am_db);
+    rc = sqlite3_close( am_db->db );
+    if ( SQLITE_OK != rc ) {
+        rb_raise(eAS_Error, "Failure to close database : [SQLITE_ERROR %d] : %s\n",
+                rc, sqlite3_errmsg( am_db->db ));
+    }
+
+    return self;
+                
+}
+
+/**
+ * call-seq:
+ *    database.last_insert_rowid -> Integer
+ *
+ * Return the rowid of the last row inserted into the database from this
+ * database connection.  
+ */
+VALUE am_sqlite3_database_last_insert_rowid(VALUE self)
+{
+    am_sqlite3   *am_db;
+    sqlite3_int64 last_id;
+
+    Data_Get_Struct(self, am_sqlite3, am_db);
+    last_id = sqlite3_last_insert_rowid( am_db->db );
+
+    return SQLINT64_2NUM( last_id );
+}
+
+/**
+ * call-seq:
+ *    database.autocommit? -> true or false
+ *
+ * return true if the database is in autocommit mode, otherwise return false
+ *
+ */
+VALUE am_sqlite3_database_is_autocommit(VALUE self)
+{
+    am_sqlite3   *am_db;
+    int           rc;
+
+    Data_Get_Struct(self, am_sqlite3, am_db);
+    rc = sqlite3_get_autocommit( am_db->db );
+    
+    return ( 0 == rc ) ? Qfalse : Qtrue ;
+}
+
+/**
+ * call-seq:
+ *    database.row_changes -> Integer
+ *
+ * return the number of rows changed with the most recent INSERT, UPDATE or 
+ * DELETE statement.
+ *
+ */
+VALUE am_sqlite3_database_row_changes(VALUE self)
+{
+    am_sqlite3   *am_db;
+    int           rc;
+
+    Data_Get_Struct(self, am_sqlite3, am_db);
+    rc = sqlite3_changes( am_db->db );
+    
+    return INT2FIX(rc);
+}
+
+/**
+ * call-seq:
+ *    database.total_changes -> Integer
+ *
+ * return the number of rows changed by INSERT, UPDATE or DELETE statements 
+ * in the database connection since the connection was opened.
+ *
+ */
+VALUE am_sqlite3_database_total_changes(VALUE self)
+{
+    am_sqlite3   *am_db;
+    int           rc;
+
+    Data_Get_Struct(self, am_sqlite3, am_db);
+    rc = sqlite3_total_changes( am_db->db );
+    
+    return INT2FIX(rc);
+}
+
+
+/**
+ * call-seq:
+ *    database.prepare( sql ) -> SQLite3::Statement
+ *
+ * Create a new SQLite3 statement.
+ */
+VALUE am_sqlite3_database_prepare(VALUE self, VALUE rSQL) 
+{
+    VALUE            sql = StringValue( rSQL );
+    VALUE            stmt = am_sqlite3_statement_alloc(cAS_Statement); 
+    am_sqlite3      *am_db;
+    am_sqlite3_stmt *am_stmt;
+    const char      *tail;
+    int              rc;
+
+    Data_Get_Struct(self, am_sqlite3, am_db);
+
+    Data_Get_Struct(stmt, am_sqlite3_stmt, am_stmt);
+    rc = sqlite3_prepare_v2( am_db->db, RSTRING(sql)->ptr, RSTRING(sql)->len, 
+                            &(am_stmt->stmt), &tail);
+    if ( SQLITE_OK != rc) {
+        rb_raise(eAS_Error, "Failure to prepare statement %s : [SQLITE_ERROR %d] : %s\n",
+                RSTRING(sql)->ptr, rc, sqlite3_errmsg(am_db->db));
+        am_sqlite3_statement_free( am_stmt );
+    }
+
+    if ( tail != NULL ) {
+        am_stmt->remaining_sql = rb_str_new2( tail );
+    } else {
+        am_stmt->remaining_sql = Qnil;
+    }
+
+    return stmt;
+}
+
+/**
+ * This function is registered with a sqlite3 database using the sqlite3_trace
+ * function.  During the registration process a handle on a VALUE is also
+ * registered.  
+ *
+ * When this function is called, it calls the 'trace' method on the tap object, 
+ * which is the VALUE that was registered during the sqlite3_trace call.
+ *
+ * This function corresponds to the SQLite xTrace function specification.
+ *
+ */
+void amalgalite_xTrace(void* tap, const char* msg)
+{
+    VALUE     trace_obj = (VALUE) tap;
+
+    rb_funcall( trace_obj, rb_intern("trace"), 1, rb_str_new2( msg ) );
+    return;
+}
+    
+
+/**
+ * call-seq:
+ *   database.register_trace_tap( tap_obj )
+ *
+ * This registers an object to be called with every trace event in SQLite.
+ * 
+ * This is an experimental api and is subject to change, or removal.
+ *
+ */
+VALUE am_sqlite3_database_register_trace_tap(VALUE self, VALUE tap)
+{
+    am_sqlite3   *am_db;
+    int           rc;
+
+    Data_Get_Struct(self, am_sqlite3, am_db);
+
+    /* Qnil, unregister the item and tell the garbage collector we are done with
+     * it.
+     */
+    if ( Qnil == tap ) {
+
+        sqlite3_trace( am_db->db, NULL, NULL );
+        rb_gc_unregister_address( &(am_db->trace_obj) );
+        am_db->trace_obj = Qnil;
+
+    /* register the item and store the reference to the object in the am_db
+     * structure.  We also have to tell the Ruby garbage collector that we
+     * point to the Ruby object from C.
+     */
+    } else {
+
+        am_db->trace_obj = tap;
+        rb_gc_register_address( &(am_db->trace_obj) );
+        sqlite3_trace( am_db->db, amalgalite_xTrace, (void *)am_db->trace_obj );
+    }
+
+    return Qnil;
+}    
+
+/**
+ * the amagliate trace function to be registered with register_trace_tap
+ * When it is called, it calls the 'trace' method on the tap object.
+ *
+ * This function conforms to the sqlite3 xProfile function specification.
+ */
+void amalgalite_xProfile(void* tap, const char* msg, sqlite3_uint64 time)
+{
+    VALUE     trace_obj = (VALUE) tap;
+
+    rb_funcall( trace_obj, rb_intern("profile"), 
+                2, rb_str_new2( msg ), SQLUINT64_2NUM(time) );
+
+    return;
+}
+
+/**
+ * call-seq:
+ *   database.register_profile_tap( tap_obj )
+ *
+ * This registers an object to be called with every profile event in SQLite.
+ *
+ * This is an experimental api and is subject to change or removal.
+ *
+ */
+VALUE am_sqlite3_database_register_profile_tap(VALUE self, VALUE tap)
+{
+    am_sqlite3   *am_db;
+    int           rc;
+
+    Data_Get_Struct(self, am_sqlite3, am_db);
+
+    /* Qnil, unregister the item and tell the garbage collector we are done with
+     * it.
+     */
+
+    if ( tap == Qnil ) {
+        sqlite3_profile( am_db->db, NULL, NULL );
+        rb_gc_unregister_address( &(am_db->profile_obj) );
+        am_db->profile_obj = Qnil;
+
+    /* register the item and store the reference to the object in the am_db
+     * structure.  We also have to tell the Ruby garbage collector that we
+     * point to the Ruby object from C.
+     */
+    } else {
+        am_db->profile_obj = tap;
+        rb_gc_register_address( &(am_db->profile_obj) );
+        sqlite3_profile( am_db->db, amalgalite_xProfile, (void *)am_db->profile_obj );
+    }
+    return Qnil;
+}    
+
+/**
+ * call-seq:
+ *    datatabase.table_column_metadata( db_name, table_name, column_name) -> Hash
+ *
+ * Returns a hash containing the meta information about the column.  The
+ * available keys are:
+ *
+ * declared_data_type::       the declared data type of the column
+ * collation_sequence_name::  the name of the collation sequence for the column
+ * not_null_constraint::      True if the column has a NOT NULL constraint
+ * primary_key::              True if the column is part of a primary key
+ * auto_increment::           True if the column is AUTO INCREMENT
+ *
+ */
+VALUE am_sqlite3_database_table_column_metadata(VALUE self, VALUE db_name, VALUE tbl_name, VALUE col_name)
+{
+    am_sqlite3  *am_db;
+    int         rc;
+
+    /* input */
+    const char  *zDbName      = StringValuePtr( db_name );
+    const char  *zTableName   = StringValuePtr( tbl_name );
+    const char  *zColumnName  = StringValuePtr( col_name ); 
+
+    /* output */
+    const char *pzDataType = NULL;
+    const char *pzCollSeq  = NULL;
+    int         pNotNull, pPrimaryKey, pAutoinc;
+    VALUE       rHash      = rb_hash_new();
+    VALUE       rStr       = Qnil;
+
+    Data_Get_Struct(self, am_sqlite3, am_db);
+
+    rc = sqlite3_table_column_metadata( am_db->db,
+                                        zDbName, zTableName, zColumnName,
+                                        &pzDataType, &pzCollSeq,
+                                        &pNotNull, &pPrimaryKey, &pAutoinc);
+    if ( SQLITE_OK != rc ) {
+       rb_raise(eAS_Error, "Failure retrieveing column meta data for table '%s' column '%s' : [SQLITE_ERROR %d] : %s\n",
+                zTableName, zColumnName, rc, sqlite3_errmsg( am_db-> db ));
+  
+    }
+    
+    rStr = ( NULL == pzDataType) ? Qnil : rb_str_new2( pzDataType );
+    rb_hash_aset( rHash, rb_str_new2("declared_data_type"), rStr );
+
+    rStr = ( NULL == pzCollSeq) ? Qnil : rb_str_new2( pzCollSeq );
+    rb_hash_aset( rHash, rb_str_new2("collation_sequence_name"), rStr );
+
+    rb_hash_aset( rHash, rb_str_new2("not_null_constraint"),     ( pNotNull    ? Qtrue : Qfalse ));
+    rb_hash_aset( rHash, rb_str_new2("primary_key"),             ( pPrimaryKey ? Qtrue : Qfalse ));
+    rb_hash_aset( rHash, rb_str_new2("auto_increment"),          ( pAutoinc   ? Qtrue : Qfalse ));
+
+    return rHash;
+}
+
+/***********************************************************************
+ * Ruby life cycle methods
+ ***********************************************************************/
+
+
+/*
+ * garbage collector free method for the am_data structure.  Make sure to un
+ * registere the trace and profile objects if they are not Qnil
+ */
+void am_sqlite3_database_free(am_sqlite3* am_db)
+{
+    if ( Qnil != am_db->trace_obj ) {
+        rb_gc_unregister_address( &(am_db->trace_obj) );
+        am_db->trace_obj = Qnil;
+    }
+
+    if ( Qnil != am_db->profile_obj) {
+        rb_gc_unregister_address( &(am_db->profile_obj) );
+        am_db->profile_obj = Qnil;
+    }
+
+    free(am_db);
+    return;
+}
+
+/*
+ * allocate the am_data structure
+ */
+VALUE am_sqlite3_database_alloc(VALUE klass)
+{
+    am_sqlite3*  am_db = ALLOC(am_sqlite3);
+    VALUE          obj ;
+
+    am_db->trace_obj   = Qnil;
+    am_db->profile_obj = Qnil;
+
+    obj = Data_Wrap_Struct(klass, NULL, am_sqlite3_database_free, am_db);
+    return obj;
+}
+
+void Init_amalgalite3_database( )
+{
+    
+    /** :stopdoc:
+     * These calls are here just to allow for rdoc generation
+     * :startdoc:
+     */
+    VALUE ma  = rb_define_module("Amalgalite");
+    VALUE mas = rb_define_module_under(ma, "SQLite3");
+  
+    /* 
+     * Encapsulate an SQLite3 database
+     */
+    cAS_Database = rb_define_class_under( mas, "Database", rb_cObject); 
+
+    rb_define_alloc_func(cAS_Database, am_sqlite3_database_alloc); 
+    rb_define_singleton_method(cAS_Database, "open", am_sqlite3_database_open, -1); 
+    rb_define_singleton_method(cAS_Database, "open16", am_sqlite3_database_open16, 1); 
+    rb_define_method(cAS_Database, "prepare", am_sqlite3_database_prepare, 1); 
+    rb_define_method(cAS_Database, "close", am_sqlite3_database_close, 0); /* in amalgalite3_database.c */
+    rb_define_method(cAS_Database, "last_insert_rowid", am_sqlite3_database_last_insert_rowid, 0); /* in amalgalite3_database.c */
+    rb_define_method(cAS_Database, "autocommit?", am_sqlite3_database_is_autocommit, 0); /* in amalgalite3_database.c */
+    rb_define_method(cAS_Database, "register_trace_tap", am_sqlite3_database_register_trace_tap, 1); /* in amalgalite3_database.c */
+    rb_define_method(cAS_Database, "register_profile_tap", am_sqlite3_database_register_profile_tap, 1); /* in amalgalite3_database.c */
+    rb_define_method(cAS_Database, "table_column_metadata", am_sqlite3_database_table_column_metadata, 3); /* in amalgalite3_database.c */
+    rb_define_method(cAS_Database, "row_changes", am_sqlite3_database_row_changes, 0); /* in amalgalite3_database.c */
+    rb_define_method(cAS_Database, "total_changes", am_sqlite3_database_total_changes, 0); /* in amalgalite3_database.c */
+
+}
+