In trying to write Thrift API documentation for the new website with code
examples, I've discovered ;) that the Thrift API is confusing.  There are
get_, next_, set_, offer_ APIs and some of them operate on mutators and
scanners and some don't and it's not clear by the name, which is which.  I
propose changing the Thrift APIs as show below at the end of this post.

NOTE 1:   We will keep the old APIs so that you don't have to change your
programs right away

NOTE 2:  The syntax and semantics of the four existing set APIs
(set_cell, set_cell_as_array, set_cells ,
set_cells_as_arrays, set_cells_serialized), unfortunately, will have to
change.  Programs that use these APIs will need to get modified to upgrade
to the new release.

I plan to roll these changes in the upcoming 0.9.5.4 release.  If you have
any comments or objections, please let me know.

- Doug

Namespace APIs
--------------
namespace_open
namespace_close
namespace_create
namespace_drop
namespace_exists

Mutator APIs
------------
mutator_open
mutator_close
mutator_flush
mutator_set_cell
mutator_set_cell_as_array
mutator_set_cells
mutator_set_cells_as_arrays
mutator_set_cells_serialized

Scanner APIs
------------
scanner_open
scanner_close
scanner_get_cells
scanner_get_cells_as_arrays
scanner_get_cells_serialized
scanner_get_row
scanner_get_row_as_arrays
scanner_get_row_serialized

Asynchronous APIs
-----------------
async_mutator_close
async_mutator_open
async_mutator_flush
async_scanner_open
async_scanner_close
async_mutator_set_cell_as_array
async_mutator_set_cell
async_mutator_set_cells_as_arrays
async_mutator_set_cells
async_mutator_set_cells_serialized
future_cancel
future_open
future_close
future_get_result
future_get_result_as_arrays
future_get_result_serialized
future_has_outstanding
future_is_cancelled
future_is_empty
future_is_full

Convenience APIs
----------------
get_cell
get_cells
get_cells_as_arrays
get_cells_serialized
get_listing
get_row
get_row_as_arrays
get_row_serialized
set_cell
set_cell_as_array
set_cells
set_cells_as_arrays
set_cells_serialized

- Doug

-- 
You received this message because you are subscribed to the Google Groups 
"Hypertable Development" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/hypertable-dev?hl=en.

Reply via email to