SAP Sybase IQ Ruby API Reference

SAP Sybase IQ provides a low-level interface to the SAP Sybase IQ C API. The API described in the following sections permits the rapid development of SQL applications. To demonstrate the power of Ruby application development, consider the following sample Ruby program. It loads the SAP Sybase IQ Ruby extension, connects to the sample database, lists column values from the Products table, disconnects, and terminates.

begin
    require 'rubygems'
    gem 'sqlanywhere'
    unless defined? SQLAnywhere
        require 'sqlanywhere'
    end    
end
api = SQLAnywhere::SQLAnywhereInterface.new()
SQLAnywhere::API.sqlany_initialize_interface( api )
api.sqlany_init()
conn = api.sqlany_new_connection()
api.sqlany_connect( conn, "DSN=Sybase IQ Demo" )
stmt = api.sqlany_execute_direct( conn, "SELECT * FROM Products" )
num_rows = api.sqlany_num_rows( stmt )
num_rows.times {
    api.sqlany_fetch_next( stmt )
    num_cols = api.sqlany_num_cols( stmt )
    for col in 1..num_cols do
        info = api.sqlany_get_column_info( stmt, col - 1 )
        unless info[3]==1 # Don't do binary
            rc, value = api.sqlany_get_column( stmt, col - 1 )
            print "#{info[2]}=#{value}\n"
        end
    end
    print "\n"
}
api.sqlany_free_stmt( stmt )
api.sqlany_disconnect(conn)
api.sqlany_free_connection(conn)
api.sqlany_fini()
SQLAnywhere::API.sqlany_finalize_interface( api )

ID=300
Name=Tee Shirt
Description=Tank Top
Size=Small
Color=White
Quantity=28
UnitPrice=9.00

ID=301
Name=Tee Shirt
Description=V-neck
Size=Medium
Color=Orange
Quantity=54
UnitPrice=14.00

• sqlany_affected_rows
  Returns the number of rows affected by execution of the prepared statement.
• sqlany_bind_param Function
  Binds a user-supplied buffer as a parameter to the prepared statement.
• sqlany_clear_error Function
  Clears the last stored error code.
• sqlany_client_version Function
  Returns the current client version.
• sqlany_commit Function
  Commits the current transaction.
• sqlany_connect Function
  Creates a connection to a SQL Anywhere database server using the specified connection object and connection string.
• sqlany_describe_bind_param Function
  Describes the bind parameters of a prepared statement.
• sqlany_disconnect Function
  Disconnects a SQL Anywhere connection. All uncommitted transactions are rolled back.
• sqlany_error Function
  Returns the last error code and message stored in the connection object.
• sqlany_execute Function
  Executes a prepared statement.
• sqlany_execute_direct Function
  Executes the SQL statement specified by the string argument.
• sqlany_execute_immediate Function
  Executes the specified SQL statement immediately without returning a result set. It is useful for statements that do not return result sets.
• sqlany_fetch_absolute Function
  Moves the current row in the result set to the row number specified and then fetches the data at that row.
• sqlany_fetch_next Function
  Returns the next row from the result set. This function first advances the row pointer and then fetches the data at the new row.
• sqlany_fini Function
  Frees resources allocated by the API.
• sqlany_free_connection Function
  Frees the resources associated with a connection object.
• sqlany_free_stmt Function
  Frees resources associated with a statement object.
• sqlany_get_bind_param_info Function
  Retrieves information about the parameters that were bound using sqlany_bind_param.
• sqlany_get_column Function
  Returns the value fetched for the specified column.
• sqlany_get_column_info Function
  Gets column information for the specified result set column.
• sqlany_get_next_result Function
  Advances to the next result set in a multiple result set query.
• sqlany_init Function
  Initializes the interface.
• sqlany_new_connection Function
  Creates a connection object.
• sqlany_num_cols Function
  Returns number of columns in the result set.
• sqlany_num_params Function
  Returns the number of parameters that are expected for a prepared statement.
• sqlany_num_rows Function
  Returns the number of rows in the result set.
• sqlany_prepare Function
  Prepares the supplied SQL string.
• sqlany_rollback Function
  Rolls back the current transaction.
• sqlany_sqlstate Function
  Retrieves the current SQLSTATE.
• Column Types
  The following Ruby class defines the column types returned by some SQL Anywhere Ruby functions.
• Native Column Types
  The following table defines the native column types returned by some SQL Anywhere functions.